Compare commits
139 Commits
Author | SHA1 | Date | |
---|---|---|---|
aedf9f3115 | |||
25320bdf5c | |||
33c83de1fb | |||
07a56fcaca | |||
7bc986251f | |||
cdde7da5f9 | |||
82c00fe444 | |||
93682e9ec4 | |||
d339da7e11 | |||
8b51992959 | |||
cb3bfaf438 | |||
91b7317b80 | |||
400b193210 | |||
7f6a6434d2 | |||
a1414877a1 | |||
a4927f9c17 | |||
264c3d95fd | |||
fd06aa04f4 | |||
a576872471 | |||
333b59c37e | |||
054b7dca2b | |||
33209773c8 | |||
625cadea5e | |||
de05001f3e | |||
5aa10261e5 | |||
070574c8d7 | |||
a304f34f31 | |||
26b5db3782 | |||
dadad3fa96 | |||
2ab35db571 | |||
4a17953298 | |||
8c633b3c30 | |||
e100a6e026 | |||
3e7148c938 | |||
3554e2543d | |||
44a86542ec | |||
b63d2edd29 | |||
a4e0112767 | |||
b40837b6a7 | |||
7ecb565de9 | |||
41a38aeb56 | |||
0be87e2f45 | |||
2edcb3947e | |||
51753df662 | |||
36c002581a | |||
db1cfe4746 | |||
2c254a2ecf | |||
425bc6150a | |||
b2aaa51882 | |||
8ee6623984 | |||
91ec17c51d | |||
646dbdaa3a | |||
4550fcd375 | |||
4d1b992193 | |||
cf2d482798 | |||
43853e4d71 | |||
6a650b9f1b | |||
c76cc6baf7 | |||
659fa9ba95 | |||
97c47ed696 | |||
b69bd24cec | |||
3317168d12 | |||
433fad502d | |||
f583b05f73 | |||
3f50311487 | |||
ee16740d0b | |||
63c73536a2 | |||
2f7ebfc47a | |||
372d2605bb | |||
2ecf6c00b8 | |||
2f3d8cecd3 | |||
54bbab232e | |||
380407b5e8 | |||
2a5583946c | |||
80e36a34ee | |||
1f90f4abff | |||
3c7f5f1e2d | |||
8104609306 | |||
a3077f7800 | |||
c947121243 | |||
4b3f0649fa | |||
523c62530f | |||
aa57617fc7 | |||
ef89a33dfc | |||
474a730a09 | |||
e3b029c240 | |||
290824190d | |||
923d78caab | |||
6587b74a23 | |||
aa0a35f258 | |||
09b8809ede | |||
e25566490b | |||
3ed7473066 | |||
1202a68b01 | |||
c67d43e16d | |||
df74769533 | |||
5aef714497 | |||
24701afcb2 | |||
cbfbd4ee67 | |||
6df449394d | |||
27b6119bbb | |||
b22abef889 | |||
4d8a7a4202 | |||
72bc08e973 | |||
430f636ae4 | |||
bbc8f13ecf | |||
a01f07f62c | |||
36316e63b2 | |||
5c5e88c226 | |||
af968f65df | |||
f0cc2f4cd6 | |||
f167226830 | |||
3e49b365b6 | |||
c833374fdd | |||
778f057d87 | |||
8f57bf4dd5 | |||
5a9f07002f | |||
ca5ff20107 | |||
a406ff648a | |||
dab1f8514b | |||
b80c1f9090 | |||
fcd2616a3c | |||
1723193d27 | |||
88cd04d0e2 | |||
c4faa56d0d | |||
20ad0d0b38 | |||
5221d3ee84 | |||
1f50f54fe9 | |||
12199a668e | |||
82df431adf | |||
71f0a9d37f | |||
5f16cdd830 | |||
966cb88c82 | |||
7f4d72f0d6 | |||
3df47307a3 | |||
e3b84af278 | |||
a6c4a99d82 | |||
8d506f8220 | |||
bd9ed5feb5 |
13
.gitignore
vendored
13
.gitignore
vendored
@ -1,13 +1,4 @@
|
||||
.idea/
|
||||
.c9/
|
||||
node_modules/
|
||||
test/assets/**/node_modules/
|
||||
test/assets/**/docs/
|
||||
test/assets/**/typings/
|
||||
test/assets/**/coverage/
|
||||
ts/*.js
|
||||
ts/*.js.map
|
||||
ts/typings/
|
||||
docs/
|
||||
|
||||
test/
|
||||
pages/
|
||||
.DS_Store
|
@ -3,7 +3,8 @@ image: hosttoday/ht-docker-node:npmci
|
||||
stages:
|
||||
- test
|
||||
- release
|
||||
- page
|
||||
- trigger
|
||||
- pages
|
||||
|
||||
testLEGACY:
|
||||
stage: test
|
||||
@ -11,6 +12,7 @@ testLEGACY:
|
||||
- npmci test legacy
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
testLTS:
|
||||
stage: test
|
||||
@ -34,17 +36,24 @@ release:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
|
||||
pages:
|
||||
stage: page
|
||||
|
||||
trigger:
|
||||
stage: trigger
|
||||
script:
|
||||
- npmci test lts
|
||||
- mkdir .public
|
||||
- cp -r test/assets/docs/ .public
|
||||
- cp -r test/assets/coverage/ .public
|
||||
- mv .public public
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
|
||||
pages:
|
||||
image: hosttoday/ht-docker-node:npmpage
|
||||
stage: pages
|
||||
script:
|
||||
- npmci command npmpage --host gitlab
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
only:
|
||||
- tags
|
15
.travis.yml
15
.travis.yml
@ -1,15 +0,0 @@
|
||||
language: node_js
|
||||
node_js:
|
||||
- 4.3.1
|
||||
- stable
|
||||
deploy:
|
||||
provider: npm
|
||||
email: npm@lossless.digital
|
||||
api_key:
|
||||
secure: k075QdAcmEdmAoVaP5vclLnZmhbZB39v85VIUMWAKXbIAU+liHrYZRlIEYfAaIUrf6sha+zAo/U/vjAN7c5ArB7J/HjCLJ3lsi2fWtaSRlYQrYX9/EhU0S+YZjRE8Jrn4hGTcce6I2mANBnEzvzlXrlKaqVvSqOqTO9nJ5aDBCGa5XT3EwlHKkRlAlL3ZOLrRg38R343E8ifZBsbn9G0e+RgDt0sic3WD8NME9lpsQ/99UZKH00duHbhF9nme5Sjdh86y01hvsaBf+CLR4gfS2IntnrCSrZbETFrsOBUyMnJZDQ3qlrjcEaiTkpJ4iSIqr+ftwGMMD6S1MxCTPqkp64UIeMz2Tg41HqoaeIg7z8cF0APv6M9ZAdWhsU43GqsMe70dK900JZpQAkQxMf/6NpPpGfZug6TwqLYSIRzvjvNrhYfuyoGfXdAxrM3SJMkIq6rwE+T/y36kZaC3CrQRyNZypNz0vW1M9HLjJUi2vO0U/CDn8tvi1p6ChrDXDfV3H2UIAMHFlAF+GrT7dMWwD+p+d8mc9gpAFEF9zMqAIJamPhwboJxoHjKQrqrq5czNm75ETL77AzfnU6CfQlG5dTIFnGId8y0ZxXvtpBruDoyC1+ZF23MYZmb+ipxQZM2oLCjNLeL3aEePc/JlSm6Gn8w3sIkZTG261F0XZxdApw=
|
||||
on:
|
||||
tags: true
|
||||
repo: pushrocks/npmts
|
||||
env:
|
||||
global:
|
||||
secure: kPKBMnEKoC+K5dXpl11NhuK3LSp0c0fRO60Akj3QeQBjUWnVAcF0Ht30c31y0lnJaMEzXhmUIKdR7RQnlmw5be4TYGINzY7FD3Dcv7o+HO1ZQrkpMWSu46jF6ZJer9moGjZ8e0rX8wZyB9SqsXYlwWRzqvxfOVxQfTvU3BEnJKHbhq+R5JMJ8dwLBPNTJKMWKq85KNsjo3ap0BjxdBUoRLzvrn31VOPH30BkvmLGc5YiIz5QmITll/T2wmQKYTNT2qDlEJ729B8pYa3eNlCNi89AxsLDGCmEoJAVrPsyw5g+gAyBqZ1GRULy83UJbELUq7cse3MRLMSwCAm4f0INRAuqcyiKYJ4+LHd0NwKrFQ/dQ0pvyBTbbEjNemXaakkWH7S6F03UvF+u+tiQ7C97XH0CRsseGlm36zCkAClEhtWVWA4U0Q5c6zqRAAOYOI0xquXalRKPTJe7fCYewp2eqmlp8drt8MxancyKI/ynXNoR5vGFzDTSRoPjTlaYQPmbiH4+Nd5+6Qoj94PEIqghebIPDQo3C7vWts4WGccux5b2q524UgB63hjJQA6+GQOo1q4RibouS6WScn8/tW/ZOEP+sNhDfkeiZUIjye+Q3PyzonGHefgSQ8wBbsc8LOX0cKUcEFWr14nhdQ9ZeW+hrSSF04TbM4zGJPGcKhmT2UU=
|
139
README.md
139
README.md
@ -1,137 +1,28 @@
|
||||
# npmts
|
||||
Write npm modules with TypeScript without hassle.
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
|
||||
## Status
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://gitlab.com/pushrocks/npmts)
|
||||
[](https://github.com/pushrocks/npmts)
|
||||
[](https://pushrocks.gitlab.io/npmts/docs)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://ci.appveyor.com/project/philkunz/npmts/branch/master)
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://david-dm.org/pushrocks/npmts)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||
[](https://codecov.io/github/pushrocks/npmts?branch=master)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
|
||||
## What is NPMTS?
|
||||
## Introduction
|
||||
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
|
||||
By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works.
|
||||
|
||||
There is a docker image available that includes npmts to make CI a breeze:
|
||||
[hosttoday/ht-docker-npmg on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-npmg/)
|
||||
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||
|
||||
### Install
|
||||
First install npmts as dev dependency:
|
||||
For further information read the docs.
|
||||
|
||||
```sh
|
||||
npm install npmts --save-dev
|
||||
```
|
||||
|
||||
Then use it in package.json's script section to trigger a build:
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"test": "npmts"
|
||||
}
|
||||
```
|
||||
|
||||
### Default task execution order
|
||||
|
||||
1. Check config in ./npmts.json
|
||||
1. Clean up from any previous builds (old js files)
|
||||
1. Install typings
|
||||
1. Transpile TypeScript with inline sourcemaps
|
||||
1. Create Declaration Files
|
||||
1. Create JsDoc Documentation
|
||||
1. Instrumentalize created JavaScript files with istanbul
|
||||
1. Run Tests
|
||||
1. Create Coverage report
|
||||
1. Upload Coverage reports to codecov.io (Tests must pass, codecov.io must be activated, by default only triggers on travis)
|
||||
1. Upload JsDoc Documentation to gh-pages branch on GitHub. (Tests must pass, requires GitHub Token)
|
||||
|
||||
#### npmts.json
|
||||
the npmts.json is the main config file. You can use it to customize the behaviour of NPMTS.
|
||||
|
||||
```json
|
||||
{
|
||||
"mode":"default",
|
||||
"codecov":{
|
||||
"publish":true,
|
||||
"token":"sometoken"
|
||||
},
|
||||
"ts":{
|
||||
"./customdir/*.ts":"./"
|
||||
},
|
||||
"docs": {
|
||||
"publish":true,
|
||||
"destination":"github"
|
||||
},
|
||||
"tsOptions":{
|
||||
"declaration":false,
|
||||
"target":"ES6"
|
||||
},
|
||||
"typings":[
|
||||
"./ts/typings.json",
|
||||
"./subts1/typings.json",
|
||||
"./subts2/typings.json",
|
||||
"./customdir/typings.json"
|
||||
],
|
||||
"typingsInclude":"auto",
|
||||
"cli":true
|
||||
}
|
||||
```
|
||||
|
||||
| key | default value | description |
|
||||
| --- | --- | --- |
|
||||
| `"codecov"` | `true` | if true, coverage data will be uploaded to codecov when running on travis |
|
||||
| `"docs"` | `{"publish":"false"}` | `{"publish":true, destination:"github"}` lets you control what happens with your module documentation |
|
||||
| `"mode"` | `"default"` | "default" will do some defualt stuff, "custom" only does what you specify |
|
||||
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
|
||||
| `"typings"` | `["./ts/typings.json"]` | allows you to specify multiple locations for typings.json to install. This is needed for modules that do not yet bundle typings |
|
||||
| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
|
||||
|
||||
#### Typings
|
||||
**npmts** looks for `./ts/typings.json` by default and installs any defined typings to `.ts/typings/`.
|
||||
|
||||
> Note: You can reference the typings files in any of your TypeScript code with a
|
||||
`/// <reference path="/some/path/main.d.ts">`
|
||||
We are currently working on a "typingsInclude" option, that will autoload any typings during compilation.
|
||||
tsconfig is NOT supported, since it would render this module useless
|
||||
|
||||
#### TypeScript
|
||||
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
||||
`./dist/*.js` and `./test/test.js`
|
||||
|
||||
Use commonjs module system for wiring up files.
|
||||
|
||||
#### Declaration files
|
||||
**npmts** also creates an `./dist/index.d.ts` declaration file by default.
|
||||
You can reference it in your package.json like this.
|
||||
|
||||
```json
|
||||
"main": "dist/index.js",
|
||||
"typings": ".dist/index.d.ts",
|
||||
```
|
||||
|
||||
This is in line with the latest TypeScript best practices.
|
||||
You can then import plugins via the TypeScript `import` Syntax
|
||||
and tsc will pick up the declaration file automatically.
|
||||
|
||||
> Note: If you don't want declaration files, set tsOptions.declaration to false in npmts.json
|
||||
|
||||
#### Instrumentalize Code
|
||||
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
||||
|
||||
#### Tests
|
||||
When Typings have been installed, TypeScript + Declaration files have been transpiled and the resulting JS has been instrumentalized,
|
||||
npmts looks for `.test/test.ts` which will be transpiled to test.js and run with mocha.
|
||||
|
||||
Any errors will be shown with reference to their originating source in TypeScript
|
||||
thanks to autogenerated source maps.
|
||||
|
||||
## Example Usage in modules:
|
||||
* [gulp-typings](https://www.npmjs.com/package/gulp-typings)
|
||||
* [gulp-browser](https://www.npmjs.com/package/gulp-typings)
|
||||
|
||||
> We will add more options over time.
|
||||
|
||||
## About the authors:
|
||||
[](https://lossless.com/)
|
||||
|
||||
[](https://paypal.me/lossless)
|
||||
[](https://push.rocks)
|
||||
|
10
appveyor.yml
10
appveyor.yml
@ -1,10 +0,0 @@
|
||||
environment:
|
||||
nodejs_version: "4"
|
||||
install:
|
||||
- ps: Install-Product node $env:nodejs_version
|
||||
- npm install
|
||||
test_script:
|
||||
- node --version
|
||||
- npm --version
|
||||
- npm test
|
||||
build: off
|
@ -1 +0,0 @@
|
||||
#!/usr/bin/env node
|
@ -1,49 +0,0 @@
|
||||
// import gulp
|
||||
var plugins = {
|
||||
beautylog: require("beautylog"),
|
||||
gulp: require("gulp"),
|
||||
g:{
|
||||
typescript: require("gulp-typescript"),
|
||||
typings:require("gulp-typings")
|
||||
},
|
||||
mergeStream: require("merge2"),
|
||||
path: require("path")
|
||||
};
|
||||
|
||||
paths = {
|
||||
packageBase: plugins.path.resolve(
|
||||
plugins.path.join(__dirname,"../")
|
||||
)
|
||||
};
|
||||
|
||||
plugins.beautylog.log('now compiling NPMTS');
|
||||
|
||||
plugins.gulp.task("typings",function(){
|
||||
var stream = plugins.gulp.src(plugins.path.join(paths.packageBase,"ts/typings.json"))
|
||||
.pipe(plugins.g.typings());
|
||||
return stream;
|
||||
});
|
||||
|
||||
plugins.gulp.task("TS",["typings"], function() {
|
||||
var stream = plugins.gulp.src([
|
||||
plugins.path.join(paths.packageBase,'ts/**/*.ts'),
|
||||
"!" + plugins.path.join(paths.packageBase,'ts/typings/**/*.d.ts')
|
||||
])
|
||||
.pipe(plugins.g.typescript({
|
||||
target:"ES5",
|
||||
module:"commonjs"
|
||||
}))
|
||||
.pipe(plugins.gulp.dest(plugins.path.join(paths.packageBase, 'dist/')));
|
||||
return stream;
|
||||
});
|
||||
|
||||
plugins.gulp.task("CLI",function(){
|
||||
var stream = plugins.gulp.src(plugins.path.join(paths.packageBase,"assets/cli.js"))
|
||||
.pipe(plugins.gulp.dest(plugins.path.join(paths.packageBase, 'dist/')))
|
||||
});
|
||||
|
||||
plugins.gulp.task('default',['TS',"CLI"], function() {
|
||||
plugins.beautylog.success('Typescript compiled');
|
||||
});
|
||||
|
||||
plugins.gulp.start.apply(plugins.gulp, ['default']);
|
1
dist/index.d.ts
vendored
Normal file
1
dist/index.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
||||
import "typings-global";
|
30
dist/index.js
vendored
30
dist/index.js
vendored
@ -1,14 +1,28 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
/* ================================================== *
|
||||
Starting NPMTS main process.
|
||||
* ================================================== */
|
||||
var early = require("early");
|
||||
early.start("NPMTS");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
early.stop();
|
||||
plugins.beautylog.figletSync("NPMTS");
|
||||
try {
|
||||
npmts_promisechain_1.promisechain();
|
||||
}
|
||||
catch (err) {
|
||||
console.log(err);
|
||||
}
|
||||
early.stop()
|
||||
.then(function () {
|
||||
var npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
|
||||
var npmtsCli = new plugins.smartcli.Smartcli();
|
||||
npmtsCli.standardTask()
|
||||
.then(function (argvArg) {
|
||||
plugins.beautylog.figletSync("NPMTS");
|
||||
plugins.beautylog.info("npmts version: " + npmtsProjectInfo.version);
|
||||
try {
|
||||
npmts_promisechain_1.promisechain(argvArg);
|
||||
}
|
||||
catch (err) {
|
||||
console.log(err);
|
||||
}
|
||||
});
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version);
|
||||
npmtsCli.startParse();
|
||||
});
|
||||
|
4
dist/npmts.assets.d.ts
vendored
Normal file
4
dist/npmts.assets.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
export declare var run: (configArg: any) => plugins.Q.Promise<{}>;
|
3
dist/npmts.assets.js
vendored
3
dist/npmts.assets.js
vendored
@ -8,11 +8,12 @@ exports.run = function (configArg) {
|
||||
var config = configArg;
|
||||
npmts_promisechain_1.npmtsOra.text("now looking at " + "required assets".yellow);
|
||||
if (config.cli == true) {
|
||||
plugins.smartfile.fsaction.copy(plugins.path.join(paths.npmtsAssetsDir, "cli.js"), paths.distDir);
|
||||
plugins.smartfile.fs.copySync(plugins.path.join(paths.npmtsAssetsDir, "cli.js"), plugins.path.join(paths.distDir, "cli.js"));
|
||||
plugins.beautylog.ok("installed CLI assets!");
|
||||
done.resolve(config);
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.ok("No additional assets required!");
|
||||
done.resolve(config);
|
||||
}
|
||||
return done.promise;
|
||||
|
5
dist/npmts.check.d.ts
vendored
Normal file
5
dist/npmts.check.d.ts
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
/// <reference types="q" />
|
||||
import * as plugins from "./npmts.plugins";
|
||||
import { ProjectinfoNpm } from "projectinfo";
|
||||
export declare let projectInfo: ProjectinfoNpm;
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
129
dist/npmts.check.js
vendored
Normal file
129
dist/npmts.check.js
vendored
Normal file
@ -0,0 +1,129 @@
|
||||
"use strict";
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
var projectinfo_1 = require("projectinfo");
|
||||
var checkProjectTypings = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
exports.projectInfo = new projectinfo_1.ProjectinfoNpm(paths.cwd);
|
||||
if (typeof exports.projectInfo.packageJson.typings == "undefined") {
|
||||
plugins.beautylog.error("please add typings field to package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
;
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
var depcheckOptions = {
|
||||
ignoreBinPackage: false,
|
||||
parsers: {
|
||||
'*.ts': plugins.depcheck.parser.typescript,
|
||||
},
|
||||
detectors: [
|
||||
plugins.depcheck.detector.requireCallExpression,
|
||||
plugins.depcheck.detector.importDeclaration
|
||||
],
|
||||
specials: [
|
||||
plugins.depcheck.special.eslint,
|
||||
plugins.depcheck.special.webpack
|
||||
],
|
||||
};
|
||||
var checkDependencies = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [
|
||||
'test',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [
|
||||
"@types/*",
|
||||
"babel-preset-*"
|
||||
]
|
||||
});
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
|
||||
for (var _i = 0, _a = unused.dependencies; _i < _a.length; _i++) {
|
||||
var item = _a[_i];
|
||||
plugins.beautylog.warn("Watch out: unused dependency " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
|
||||
var item = _c[_b];
|
||||
plugins.beautylog.error("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||
var item = _e[_d];
|
||||
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
|
||||
var item = _g[_f];
|
||||
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
||||
}
|
||||
;
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
var checkDevDependencies = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [
|
||||
'ts',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [
|
||||
"@types/*",
|
||||
"babel-preset-*"
|
||||
]
|
||||
});
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
|
||||
for (var _i = 0, _a = unused.devDependencies; _i < _a.length; _i++) {
|
||||
var item = _a[_i];
|
||||
plugins.beautylog.log("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
|
||||
var item = _c[_b];
|
||||
plugins.beautylog.error("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||
var item = _e[_d];
|
||||
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
|
||||
var item = _g[_f];
|
||||
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
||||
}
|
||||
;
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
var checkNodeVersion = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text("running project checks..."),
|
||||
checkProjectTypings(configArg)
|
||||
.then(checkDependencies)
|
||||
.then(checkDevDependencies)
|
||||
.then(checkNodeVersion)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
4
dist/npmts.clean.d.ts
vendored
Normal file
4
dist/npmts.clean.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
18
dist/npmts.clean.js
vendored
18
dist/npmts.clean.js
vendored
@ -4,24 +4,18 @@ var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
var removeDist = function () {
|
||||
npmts_promisechain_1.npmtsOra.text("cleaning " + "dist".yellow + " folder");
|
||||
return plugins.smartfile.fsaction.remove(paths.distDir);
|
||||
npmts_promisechain_1.npmtsOra.text("cleaning dist folder");
|
||||
return plugins.smartfile.fs.remove(paths.distDir);
|
||||
};
|
||||
var removeTypings = function () {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text("cleaning " + "typings".yellow + " folder");
|
||||
if (false) {
|
||||
}
|
||||
else {
|
||||
done.resolve();
|
||||
}
|
||||
return done.promise;
|
||||
var removePages = function () {
|
||||
npmts_promisechain_1.npmtsOra.text("cleaning pages folder");
|
||||
return plugins.smartfile.fs.remove(paths.pagesDir);
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
npmts_promisechain_1.npmtsOra.text("cleaning up from previous builds...");
|
||||
var done = plugins.Q.defer();
|
||||
removeDist()
|
||||
.then(removeTypings)
|
||||
.then(removePages)
|
||||
.then(function () {
|
||||
plugins.beautylog.ok("Cleaned up from previous builds!");
|
||||
done.resolve(configArg);
|
||||
|
2
dist/npmts.cli.js
vendored
2
dist/npmts.cli.js
vendored
@ -1,2 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
4
dist/npmts.compile.d.ts
vendored
Normal file
4
dist/npmts.compile.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
1
dist/npmts.compile.helpers.d.ts
vendored
Normal file
1
dist/npmts.compile.helpers.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
||||
export declare let checkOutputPath: (tsArrayArg: any, keyArg: any) => boolean;
|
90
dist/npmts.compile.js
vendored
90
dist/npmts.compile.js
vendored
@ -1,68 +1,48 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var helpers = require("./npmts.compile.helpers");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
/**
|
||||
* handles definition to make them fit for modular use
|
||||
*/
|
||||
var definitionHandler = function (configArg) {
|
||||
npmts_promisechain_1.npmtsOra.text("now making declaration files ready");
|
||||
var done = plugins.Q.defer();
|
||||
var configTsLenght = Object.keys(configArg.ts).length;
|
||||
if (configTsLenght == 0) {
|
||||
plugins.beautylog.warn("No TS file and thus no definitions found!");
|
||||
done.resolve(configArg); //if there are no definition files, resolve...
|
||||
}
|
||||
var localCounter = 0;
|
||||
for (var key in configArg.ts) {
|
||||
var distPath = configArg.ts[key];
|
||||
var stream = plugins.gulp.src(plugins.path.join(distPath, "**/*.d.ts"))
|
||||
.pipe(plugins.g.replace(plugins.smartstring.typescript.regexReferencePath, ""))
|
||||
.pipe(plugins.gulp.dest(distPath))
|
||||
.pipe(plugins.g.gFunction(function () {
|
||||
localCounter++;
|
||||
if (localCounter == configTsLenght) {
|
||||
plugins.beautylog.ok("made declaration files ready!");
|
||||
done.resolve(configArg);
|
||||
}
|
||||
;
|
||||
}, "atEnd"));
|
||||
}
|
||||
return done.promise;
|
||||
};
|
||||
var promiseArray = [];
|
||||
var compileTs = function (tsFileArrayArg, tsOptionsArg) {
|
||||
if (tsOptionsArg === void 0) { tsOptionsArg = {}; }
|
||||
var done = plugins.Q.defer();
|
||||
var moduleStream = plugins.merge2({ end: false });
|
||||
var tsOptionsDefault = {
|
||||
var compilerOptionsDefault = {
|
||||
declaration: true,
|
||||
target: "ES5",
|
||||
module: "commonjs"
|
||||
module: "CommonJS",
|
||||
target: "ES6"
|
||||
};
|
||||
/**
|
||||
* merges default ts options with those found in npmts.json
|
||||
*/
|
||||
var tsOptions = function (keyArg) {
|
||||
return plugins.lodashObject.assign(tsOptionsDefault, tsOptionsArg);
|
||||
var compilerOptions = function (keyArg) {
|
||||
var tsOptionsCombined = plugins.lodashObject.merge(compilerOptionsDefault, tsOptionsArg);
|
||||
var compilerOptions = {
|
||||
declaration: tsOptionsCombined.declaration,
|
||||
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
||||
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target]
|
||||
};
|
||||
return compilerOptions;
|
||||
};
|
||||
var _loop_1 = function(keyArg) {
|
||||
plugins.beautylog.info("TypeScript assignment: transpile from " + keyArg.blue + " to " + tsFileArrayArg[keyArg].blue);
|
||||
if (helpers.checkOutputPath(tsFileArrayArg, keyArg)) {
|
||||
var filesReadPromise = plugins.smartfile.fs.listFileTree(process.cwd(), keyArg)
|
||||
.then(function (filesToConvertArg) {
|
||||
var filesToConvertAbsolute = plugins.smartpath.transform.toAbsolute(filesToConvertArg, process.cwd());
|
||||
var destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg], process.cwd());
|
||||
var filesCompiledPromise = plugins.tsn.compile(filesToConvertAbsolute, destDir, compilerOptions(keyArg));
|
||||
promiseArray.push(filesCompiledPromise);
|
||||
});
|
||||
promiseArray.push(filesReadPromise);
|
||||
}
|
||||
};
|
||||
for (var keyArg in tsFileArrayArg) {
|
||||
if (helpers.checkOutputPath(tsFileArrayArg, keyArg)) {
|
||||
var tsStream = plugins.gulp.src([plugins.path.join(paths.cwd, keyArg), "!**/typings/**"])
|
||||
.pipe(plugins.g.sourcemaps.init()) // This means sourcemaps will be generated
|
||||
.pipe(plugins.g.typescript(tsOptions(keyArg)));
|
||||
var jsStream = tsStream.js
|
||||
.pipe(plugins.g.sourcemaps.write()) // Now the sourcemaps are added to the .js file
|
||||
.pipe(plugins.gulp.dest(tsFileArrayArg[keyArg]));
|
||||
var declarationStream = tsStream.dts
|
||||
.pipe(plugins.gulp.dest(tsFileArrayArg[keyArg]));
|
||||
moduleStream.add(tsStream, jsStream, declarationStream);
|
||||
}
|
||||
_loop_1(keyArg);
|
||||
}
|
||||
moduleStream.on("queueDrain", function () {
|
||||
done.resolve();
|
||||
});
|
||||
;
|
||||
plugins.Q.all(promiseArray)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
@ -71,15 +51,13 @@ exports.run = function (configArg) {
|
||||
npmts_promisechain_1.npmtsOra.text("now compiling " + "TypeScript".yellow);
|
||||
compileTs(config.ts, config.tsOptions)
|
||||
.then(function () {
|
||||
compileTs(config.testTs);
|
||||
plugins.beautylog.ok("compiled main TypeScript!");
|
||||
plugins.beautylog.log("now compiling tests!");
|
||||
return compileTs(config.testTs);
|
||||
})
|
||||
.then(function () {
|
||||
plugins.beautylog.ok("compiled TypeScript!");
|
||||
definitionHandler(config)
|
||||
.then(function () {
|
||||
done.resolve(config);
|
||||
});
|
||||
plugins.beautylog.ok("compiled all TypeScript!");
|
||||
done.resolve(config);
|
||||
});
|
||||
/*==================== END TS Compilation =====================*/
|
||||
return done.promise;
|
||||
};
|
||||
|
31
dist/npmts.configfile.js
vendored
31
dist/npmts.configfile.js
vendored
@ -1,31 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
exports.run = function () {
|
||||
var done = plugins.Q.defer();
|
||||
var config = {};
|
||||
var configPath = plugins.path.join(paths.cwd, "npmts.json");
|
||||
if (plugins.smartfile.checks.fileExistsSync(configPath)) {
|
||||
plugins.beautylog.info("npmts.json".blue + " config file found!");
|
||||
config = plugins.smartfile.local.toObjectSync(configPath);
|
||||
switch (config.mode) {
|
||||
case "default":
|
||||
case "custom":
|
||||
plugins.beautylog.ok("mode is " + config.mode.yellow);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
|
||||
process.exit(1);
|
||||
}
|
||||
;
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
|
||||
config.mode = "default";
|
||||
done.resolve(config);
|
||||
}
|
||||
;
|
||||
return done.promise;
|
||||
};
|
21
dist/npmts.install.js
vendored
21
dist/npmts.install.js
vendored
@ -1,21 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
exports.run = function (configArg) {
|
||||
var config = configArg;
|
||||
var done = plugins.Q.defer();
|
||||
/* -------------------------------------------------
|
||||
* ----------- install typings ---------------
|
||||
* ----------------------------------------------- */
|
||||
npmts_promisechain_1.npmtsOra.text("now installing " + "typings".yellow);
|
||||
var absoluteTypingsArray = plugins.smartpath.transform.toAbsolute(config.typings, paths.cwd);
|
||||
plugins.gulp.src(absoluteTypingsArray)
|
||||
.pipe(plugins.g.typings())
|
||||
.pipe(plugins.g.gFunction(function () {
|
||||
plugins.beautylog.ok("typings installed!");
|
||||
done.resolve(config);
|
||||
}, "atEnd"));
|
||||
return done.promise;
|
||||
};
|
56
dist/npmts.jsdoc.js
vendored
56
dist/npmts.jsdoc.js
vendored
@ -1,56 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
var genJsdoc = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text("now generating " + "JsDoc documentation".yellow);
|
||||
plugins.gulp.src([
|
||||
plugins.path.join(paths.cwd, "README.md"),
|
||||
plugins.path.join(paths.distDir, "**/*.js")
|
||||
])
|
||||
.pipe(plugins.g.jsdoc3({
|
||||
opts: {
|
||||
destination: paths.docsDir
|
||||
}
|
||||
}, function () {
|
||||
plugins.beautylog.ok("JsDoc documentation has been generated!");
|
||||
done.resolve(configArg);
|
||||
}));
|
||||
return done.promise;
|
||||
};
|
||||
exports.publishDocs = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var gitUrl = plugins.projectinfo.npm(paths.cwd, {
|
||||
gitAccessToken: process.env.GITHUB_TOKEN
|
||||
}).git.httpsUrl;
|
||||
var deployScript = ""
|
||||
+ "cd " + paths.docsDir + " "
|
||||
+ "&& git init " + "> /dev/null 2>&1 "
|
||||
+ "&& git config user.name \"TRAVIS CI\" " + "> /dev/null 2>&1 "
|
||||
+ "&& git config user.email \"travis@shipzone.io\" " + "> /dev/null 2>&1 "
|
||||
+ "&& git add . " + "> /dev/null 2>&1 "
|
||||
+ "&& git commit -m \"Deploy to GitHub Pages\" " + "> /dev/null 2>&1 "
|
||||
+ "&& git push --force --quiet "
|
||||
+ "\"" + gitUrl + "\" "
|
||||
+ "master:gh-pages " + "> /dev/null 2>&1";
|
||||
plugins.beautylog.log("now publishing JsDoc documentation to GitHub");
|
||||
if (!plugins.shelljs.which('git')) {
|
||||
plugins.beautylog.error('Git is not installed!');
|
||||
plugins.shelljs.exit(1);
|
||||
}
|
||||
else if (plugins.shelljs.exec(deployScript).code !== 0) {
|
||||
plugins.beautylog.error('Git failed!');
|
||||
plugins.shelljs.exit(1);
|
||||
}
|
||||
plugins.beautylog.ok("JsDoc documentation has been deployed to GitHub!");
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
genJsdoc(configArg)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
15
dist/npmts.options.d.ts
vendored
Normal file
15
dist/npmts.options.d.ts
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
export declare type npmtsMode = "default" | "custom";
|
||||
export interface npmtsConfig {
|
||||
argv: any;
|
||||
coverageTreshold: number;
|
||||
docs: boolean;
|
||||
mode: npmtsMode;
|
||||
test: boolean;
|
||||
testTs: any;
|
||||
ts: any;
|
||||
tsOptions: any;
|
||||
}
|
||||
export declare var run: (argvArg: any) => plugins.Q.Promise<{}>;
|
79
dist/npmts.options.js
vendored
79
dist/npmts.options.js
vendored
@ -1,32 +1,44 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
exports.isCi = function () {
|
||||
return plugins.smartci.check.isCi();
|
||||
};
|
||||
exports.isRelease = function () {
|
||||
return plugins.smartci.check.isCi()
|
||||
&& plugins.smartci.check.isTaggedCommit();
|
||||
};
|
||||
exports.doPublish = function () {
|
||||
try {
|
||||
return exports.isRelease()
|
||||
&& plugins.smartci.get.subJobNumber() == 1;
|
||||
}
|
||||
catch (err) {
|
||||
return false;
|
||||
}
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
;
|
||||
exports.run = function (argvArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
npmts_promisechain_1.npmtsOra.text("now determining build options...");
|
||||
var defaultConfig = {
|
||||
argv: undefined,
|
||||
coverageTreshold: 70,
|
||||
docs: true,
|
||||
mode: "default",
|
||||
test: true,
|
||||
testTs: {},
|
||||
ts: {},
|
||||
tsOptions: {}
|
||||
};
|
||||
// mix with configfile
|
||||
npmts_promisechain_1.npmtsOra.text("looking for npmextra.json");
|
||||
var config = plugins.npmextra.dataFor({
|
||||
toolName: "npmts",
|
||||
defaultSettings: defaultConfig,
|
||||
cwd: paths.cwd
|
||||
});
|
||||
// add argv
|
||||
config.argv = argvArg;
|
||||
// check mode
|
||||
switch (config.mode) {
|
||||
case "default":
|
||||
case "custom":
|
||||
plugins.beautylog.ok("mode is " + config.mode);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error("mode not recognised!");
|
||||
process.exit(1);
|
||||
}
|
||||
;
|
||||
//handle default mode
|
||||
if (config.mode == "default") {
|
||||
config.typings = [
|
||||
"./ts/typings.json"
|
||||
];
|
||||
config.ts = (_a = {},
|
||||
_a["./ts/**/*.ts"] = "./dist/",
|
||||
_a
|
||||
@ -35,20 +47,17 @@ exports.run = function (configArg) {
|
||||
_b["./test/test.ts"] = "./test/",
|
||||
_b
|
||||
);
|
||||
config.test = ["./index.js"];
|
||||
}
|
||||
//check if config.tsOptions is available
|
||||
config.tsOptions ? void (0) : config.tsOptions = {};
|
||||
// handle state of current build
|
||||
exports.isRelease() ? plugins.beautylog.info("All right: This is a RELEASE build!")
|
||||
: plugins.beautylog.info("NOT A RELEASE build!");
|
||||
exports.isRelease() && exports.doPublish() ? plugins.beautylog.info("All right: This is the first subBuild, so this one publishes COVERAGE + DOCS when tests succeed!")
|
||||
: plugins.beautylog.info("We are not publishing anything!");
|
||||
config.coverageTreshold ? void (0) : config.coverageTreshold = 70;
|
||||
// handle docs
|
||||
config.docs ? void (0) : config.docs = {};
|
||||
config.docs.publish ? void (0) : config.docs.publish = false;
|
||||
exports.doPublish() ? void (0) : config.docs.publish = false;
|
||||
;
|
||||
// mix with commandline
|
||||
if (config.argv.notest) {
|
||||
config.test = false;
|
||||
}
|
||||
;
|
||||
if (config.argv.nodocs) {
|
||||
config.docs = false;
|
||||
}
|
||||
;
|
||||
plugins.beautylog.ok("build options are ready!");
|
||||
done.resolve(config);
|
||||
return done.promise;
|
||||
|
13
dist/npmts.paths.d.ts
vendored
Normal file
13
dist/npmts.paths.d.ts
vendored
Normal file
@ -0,0 +1,13 @@
|
||||
import "typings-global";
|
||||
export declare let npmtsPackageRoot: string;
|
||||
export declare let cwd: string;
|
||||
export declare let tsDir: string;
|
||||
export declare let distDir: string;
|
||||
export declare let testDir: string;
|
||||
export declare let typingsDir: string;
|
||||
export declare let coverageDir: string;
|
||||
export declare let pagesDir: string;
|
||||
export declare let pagesApiDir: string;
|
||||
export declare let npmtsAssetsDir: string;
|
||||
export declare let indexTS: string;
|
||||
export declare let testTS: string;
|
11
dist/npmts.paths.js
vendored
11
dist/npmts.paths.js
vendored
@ -1,14 +1,19 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
exports.cwd = plugins.smartcli.get.cwd().path;
|
||||
//Directories
|
||||
// NPMTS Paths
|
||||
exports.npmtsPackageRoot = plugins.path.join(__dirname, "../");
|
||||
// Project paths
|
||||
exports.cwd = process.cwd();
|
||||
// Directories
|
||||
exports.tsDir = plugins.path.join(exports.cwd, "ts/");
|
||||
exports.distDir = plugins.path.join(exports.cwd, "dist/");
|
||||
exports.docsDir = plugins.path.join(exports.cwd, "docs/");
|
||||
exports.testDir = plugins.path.join(exports.cwd, "test/");
|
||||
exports.typingsDir = plugins.path.join(exports.cwd, "ts/typings/");
|
||||
exports.coverageDir = plugins.path.join(exports.cwd, "coverage/");
|
||||
// Pages
|
||||
exports.pagesDir = plugins.path.join(exports.cwd, "pages/");
|
||||
exports.pagesApiDir = plugins.path.join(exports.pagesDir, "/api");
|
||||
exports.npmtsAssetsDir = plugins.path.join(__dirname, "../assets/");
|
||||
//Files
|
||||
exports.indexTS = plugins.path.join(exports.cwd, "ts/index.ts");
|
||||
|
27
dist/npmts.plugins.d.ts
vendored
Normal file
27
dist/npmts.plugins.d.ts
vendored
Normal file
@ -0,0 +1,27 @@
|
||||
import "typings-global";
|
||||
export import beautylog = require("beautylog");
|
||||
export declare let depcheck: any;
|
||||
export import gulp = require("gulp");
|
||||
export declare let g: {
|
||||
babel: any;
|
||||
istanbul: any;
|
||||
gFunction: any;
|
||||
injectModules: any;
|
||||
mocha: any;
|
||||
sourcemaps: any;
|
||||
typedoc: any;
|
||||
};
|
||||
export import lodashObject = require('lodash');
|
||||
export import npmextra = require("npmextra");
|
||||
export import projectinfo = require("projectinfo");
|
||||
export import path = require("path");
|
||||
export import Q = require("q");
|
||||
export import shelljs = require("shelljs");
|
||||
export import smartcli = require("smartcli");
|
||||
export import smartcov = require("smartcov");
|
||||
export import smartenv = require("smartenv");
|
||||
export import smartfile = require("smartfile");
|
||||
export import smartpath = require("smartpath");
|
||||
export import smartstring = require("smartstring");
|
||||
export declare let sourceMapSupport: any;
|
||||
export import tsn = require("tsn");
|
17
dist/npmts.plugins.js
vendored
17
dist/npmts.plugins.js
vendored
@ -1,25 +1,23 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
exports.beautylog = require("beautylog");
|
||||
exports.fs = require("fs-extra");
|
||||
exports.depcheck = require("depcheck");
|
||||
exports.gulp = require("gulp");
|
||||
exports.g = {
|
||||
gFunction: require("gulp-function"),
|
||||
babel: require("gulp-babel"),
|
||||
istanbul: require("gulp-istanbul"),
|
||||
jsdoc3: require("gulp-jsdoc3"),
|
||||
gFunction: require("gulp-function"),
|
||||
injectModules: require("gulp-inject-modules"),
|
||||
mocha: require("gulp-mocha"),
|
||||
replace: require("gulp-replace"),
|
||||
sourcemaps: require("gulp-sourcemaps"),
|
||||
typescript: require("gulp-typescript"),
|
||||
typings: require("gulp-typings")
|
||||
typedoc: require("gulp-typedoc")
|
||||
};
|
||||
exports.lodashObject = require('lodash/fp/object');
|
||||
exports.merge2 = require("merge2");
|
||||
exports.lodashObject = require('lodash');
|
||||
exports.npmextra = require("npmextra");
|
||||
exports.projectinfo = require("projectinfo");
|
||||
exports.path = require("path");
|
||||
exports.Q = require("q");
|
||||
exports.shelljs = require("shelljs");
|
||||
exports.smartci = require("smartci");
|
||||
exports.smartcli = require("smartcli");
|
||||
exports.smartcov = require("smartcov");
|
||||
exports.smartenv = require("smartenv");
|
||||
@ -27,3 +25,4 @@ exports.smartfile = require("smartfile");
|
||||
exports.smartpath = require("smartpath");
|
||||
exports.smartstring = require("smartstring");
|
||||
exports.sourceMapSupport = require("source-map-support").install(); // this is required to display errors correctly during testing
|
||||
exports.tsn = require("tsn");
|
||||
|
6
dist/npmts.promisechain.d.ts
vendored
Normal file
6
dist/npmts.promisechain.d.ts
vendored
Normal file
@ -0,0 +1,6 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import { Ora } from "beautylog";
|
||||
export declare let npmtsOra: Ora;
|
||||
export declare let promisechain: (argvArg: any) => plugins.Q.Promise<{}>;
|
18
dist/npmts.promisechain.js
vendored
18
dist/npmts.promisechain.js
vendored
@ -2,27 +2,23 @@
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
exports.npmtsOra = new plugins.beautylog.Ora("setting up TaskChain", "cyan");
|
||||
exports.npmtsOra.start();
|
||||
var NpmtsAssets = require("./npmts.assets");
|
||||
var NpmtsCheck = require("./npmts.check");
|
||||
var NpmtsClean = require("./npmts.clean");
|
||||
var NpmtsCompile = require("./npmts.compile");
|
||||
var NpmtsConfigFile = require("./npmts.configfile");
|
||||
var NpmtsInstall = require("./npmts.install");
|
||||
var NpmtsJsdoc = require("./npmts.jsdoc");
|
||||
var NpmtsTypeDoc = require("./npmts.typedoc");
|
||||
var NpmtsOptions = require("./npmts.options");
|
||||
var NpmtsPublish = require("./npmts.publish");
|
||||
var NpmtsTests = require("./npmts.tests");
|
||||
exports.promisechain = function () {
|
||||
exports.promisechain = function (argvArg) {
|
||||
var done = plugins.Q.defer();
|
||||
NpmtsConfigFile.run()
|
||||
.then(NpmtsOptions.run)
|
||||
exports.npmtsOra.start();
|
||||
NpmtsOptions.run(argvArg)
|
||||
.then(NpmtsClean.run)
|
||||
.then(NpmtsInstall.run)
|
||||
.then(NpmtsCheck.run)
|
||||
.then(NpmtsCompile.run)
|
||||
.then(NpmtsAssets.run)
|
||||
.then(NpmtsJsdoc.run)
|
||||
.then(NpmtsTypeDoc.run)
|
||||
.then(NpmtsTests.run)
|
||||
.then(NpmtsPublish.run)
|
||||
.then(function (configArg) {
|
||||
var shipString = "" +
|
||||
"\n" +
|
||||
|
13
dist/npmts.publish.js
vendored
13
dist/npmts.publish.js
vendored
@ -1,13 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var NpmtsJsdoc = require("./npmts.jsdoc");
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
var promiseArray = [];
|
||||
config.docs.publish ? promiseArray.push(NpmtsJsdoc.publishDocs(configArg)) : void (0);
|
||||
promiseArray.length === 0 ? plugins.beautylog.info("Did not publish anything!") : void (0);
|
||||
plugins.Q.all(promiseArray).then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
4
dist/npmts.tests.d.ts
vendored
Normal file
4
dist/npmts.tests.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
85
dist/npmts.tests.js
vendored
85
dist/npmts.tests.js
vendored
@ -7,45 +7,49 @@ var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
*
|
||||
* @returns {*}
|
||||
*/
|
||||
var istanbul = function (configArg) {
|
||||
npmts_promisechain_1.npmtsOra.text("Instrumentalizing transpiled JS...");
|
||||
var mocha = function (configArg) {
|
||||
npmts_promisechain_1.npmtsOra.text("Instrumentalizing and testing transpiled JS");
|
||||
npmts_promisechain_1.npmtsOra.end(); // end npmtsOra for tests.
|
||||
var done = plugins.Q.defer();
|
||||
var stream = plugins.gulp.src([plugins.path.join(paths.cwd, "dist/*.js")])
|
||||
.pipe(plugins.g.istanbul()) // Covering files
|
||||
.pipe(plugins.g.istanbul.hookRequire()) // Force `require` to return covered files
|
||||
.pipe(plugins.g.gFunction(function () {
|
||||
plugins.beautylog.ok("JS has been instrumentalized to get test code coverage!");
|
||||
done.resolve(configArg);
|
||||
}, "atEnd"));
|
||||
return done.promise;
|
||||
};
|
||||
/**
|
||||
*
|
||||
* @returns {*}
|
||||
*/
|
||||
var mocha = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.end(); // end npmtsOra for tests.
|
||||
var stream = plugins.gulp.src(["./test/test.js"])
|
||||
.pipe(plugins.g.mocha())
|
||||
.pipe(plugins.g.istanbul.writeReports()) // Creating the reports after tests ran
|
||||
.pipe(plugins.g.gFunction(function () {
|
||||
plugins.beautylog.ok("Tests have passed!");
|
||||
done.resolve(configArg);
|
||||
}, "atEnd"));
|
||||
.pipe(plugins.g.sourcemaps.init())
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve("babel-preset-es2015")
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.istanbul({}))
|
||||
.pipe(plugins.g.sourcemaps.write())
|
||||
.pipe(plugins.g.injectModules())
|
||||
.on("finish", function () {
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, "test/test.js")])
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve("babel-preset-es2015")
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.injectModules())
|
||||
.pipe(plugins.g.mocha())
|
||||
.pipe(plugins.g.istanbul.writeReports({
|
||||
dir: plugins.path.join(paths.cwd, "./coverage"),
|
||||
reporters: ['lcovonly', 'json', 'text', 'text-summary']
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(function () {
|
||||
plugins.beautylog.ok("Tested!");
|
||||
done.resolve(configArg);
|
||||
}, "atEnd"));
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
var coverage = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, "lcov.info"))
|
||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, "lcov.info"), 2)
|
||||
.then(function (percentageArg) {
|
||||
if (percentageArg >= configArg.coverageTreshold) {
|
||||
plugins.beautylog.ok("your coverage of " + percentageArg.toString().blue + "% ".blue + "exceeds your treshold of " +
|
||||
configArg.coverageTreshold.toString().blue + "%".blue);
|
||||
plugins.beautylog.ok(percentageArg.toString() + "% coverage exceeds your treshold of " + configArg.coverageTreshold.toString() + "%");
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.warn("your coverage of " + percentageArg + "% " + "fails your treshold of " +
|
||||
configArg.coverageTreshold + "%");
|
||||
plugins.beautylog.warn(percentageArg.toString() + "% coverage fails your treshold of " + configArg.coverageTreshold.toString() + "%");
|
||||
plugins.beautylog.error("exiting due to coverage failure");
|
||||
process.exit(1);
|
||||
}
|
||||
@ -56,13 +60,20 @@ var coverage = function (configArg) {
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
npmts_promisechain_1.npmtsOra.text("now starting tests");
|
||||
plugins.beautylog.log("-------------------------------------------------------\n" +
|
||||
"*************************** TESTS: ***************************\n" +
|
||||
"--------------------------------------------------------------");
|
||||
istanbul(config)
|
||||
.then(mocha)
|
||||
.then(coverage)
|
||||
.then(done.resolve);
|
||||
if (config.test === true) {
|
||||
npmts_promisechain_1.npmtsOra.text("now starting tests");
|
||||
plugins.beautylog.log("-------------------------------------------------------\n" +
|
||||
"*************************** TESTS: ***************************\n" +
|
||||
"--------------------------------------------------------------");
|
||||
mocha(config)
|
||||
.then(coverage)
|
||||
.then(function () {
|
||||
done.resolve(config);
|
||||
});
|
||||
}
|
||||
else {
|
||||
npmts_promisechain_1.npmtsOra.end();
|
||||
done.resolve(config);
|
||||
}
|
||||
return done.promise;
|
||||
};
|
||||
|
4
dist/npmts.typedoc.d.ts
vendored
Normal file
4
dist/npmts.typedoc.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
43
dist/npmts.typedoc.js
vendored
Normal file
43
dist/npmts.typedoc.js
vendored
Normal file
@ -0,0 +1,43 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
var npmts_check_1 = require("./npmts.check");
|
||||
var genTypeDoc = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text("now generating " + "TypeDoc documentation".yellow);
|
||||
plugins.beautylog.log("TypeDoc Output:");
|
||||
plugins.gulp.src(plugins.path.join(paths.tsDir, "**/*.ts"))
|
||||
.pipe(plugins.g.typedoc({
|
||||
// TypeScript options (see typescript docs)
|
||||
module: "commonjs",
|
||||
target: "es6",
|
||||
includeDeclarations: true,
|
||||
// Output options (see typedoc docs)
|
||||
out: paths.pagesApiDir,
|
||||
json: plugins.path.join(paths.pagesApiDir, "file.json"),
|
||||
// TypeDoc options (see typedoc docs)
|
||||
name: npmts_check_1.projectInfo.name,
|
||||
readme: plugins.path.join(paths.cwd, "README.md"),
|
||||
// theme: "default",
|
||||
ignoreCompilerErrors: true,
|
||||
version: true,
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(done.resolve, "atEnd"));
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
if (configArg.docs) {
|
||||
genTypeDoc(configArg)
|
||||
.then(function () {
|
||||
done.resolve(configArg);
|
||||
});
|
||||
}
|
||||
else {
|
||||
done.resolve(configArg);
|
||||
}
|
||||
;
|
||||
return done.promise;
|
||||
};
|
15
docs/book.json
Normal file
15
docs/book.json
Normal file
@ -0,0 +1,15 @@
|
||||
{
|
||||
"structure": {
|
||||
"readme": "index.md"
|
||||
},
|
||||
"plugins": [
|
||||
"tonic",
|
||||
"edit-link"
|
||||
],
|
||||
"pluginsConfig": {
|
||||
"edit-link": {
|
||||
"base": "https://gitlab.com/pushrocks/npmts/edit/master/docs/",
|
||||
"label": "Edit on GitLab"
|
||||
}
|
||||
}
|
||||
}
|
80
docs/config.md
Normal file
80
docs/config.md
Normal file
@ -0,0 +1,80 @@
|
||||
# Configuration of NPMTS
|
||||
npmts can be configured to your needs:
|
||||
|
||||
### npmextra.json
|
||||
the npmts section in npmextra.json can be used to configure npmts.
|
||||
|
||||
**Default**
|
||||
>Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
|
||||
with default behaviour.
|
||||
|
||||
```json
|
||||
{
|
||||
"npmts":{
|
||||
"mode":"default"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Custom settings**
|
||||
```json
|
||||
{
|
||||
"mode":"custom",
|
||||
"docs":false,
|
||||
"test":true,
|
||||
"npmts":{
|
||||
"ts":{
|
||||
"./customdir/*.ts":"./"
|
||||
},
|
||||
"tsOptions":{
|
||||
"declaration":false,
|
||||
"target":"ES6"
|
||||
},
|
||||
"cli":true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
| key | default value | description |
|
||||
| --- | --- | --- |
|
||||
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
|
||||
| `"docs"` | `true` | create docs for your module |
|
||||
| `"test"` | `true` | test your module |
|
||||
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
|
||||
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
|
||||
| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
|
||||
|
||||
### TypeScript
|
||||
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
||||
`./dist/*.js` and `./test/test.js`
|
||||
|
||||
Use commonjs module system for wiring up files.
|
||||
|
||||
### Declaration files
|
||||
**npmts** also creates declaration files like `./dist/index.d.ts` by default.
|
||||
You can reference it in your package.json like this.
|
||||
|
||||
```json
|
||||
"main": "dist/index.js",
|
||||
"typings": ".dist/index.d.ts",
|
||||
```
|
||||
|
||||
This is in line with the latest TypeScript best practices.
|
||||
You can then import plugins via the TypeScript `import` Syntax
|
||||
and tsc will pick up the declaration file automatically.
|
||||
|
||||
### TypeDoc
|
||||
By default TypeDoc will create docs for your module in `./pages/api/` directory.
|
||||
> Note: Use [npmpage](https://www.npmjs.com/package/npmpage) to build a website for the module.
|
||||
It also allows you to integrate api docs with a gitbook located in `./docs/`
|
||||
|
||||
## Some notes:
|
||||
#### Typings for third party modules that do not bundle declaration files
|
||||
NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
|
||||
|
||||
#### Instrumentalize Code
|
||||
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
||||
|
||||
#### Tests
|
||||
Any errors will be shown with reference to their originating source in TypeScript
|
||||
thanks to autogenerated source maps.
|
8
docs/default.md
Normal file
8
docs/default.md
Normal file
@ -0,0 +1,8 @@
|
||||
# Default task execution order
|
||||
|
||||
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
|
||||
1. **Clean:** Clean up from any previous builds (old js files)
|
||||
1. **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies
|
||||
1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
|
||||
1. **Documentation:** Create TypeDoc Documentation from TypeScript files
|
||||
1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
|
13
docs/examples.md
Normal file
13
docs/examples.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Examples for NPMTS
|
||||
|
||||
## Example Usage in modules:
|
||||
* [gulp-browser](https://www.npmjs.com/package/gulp-browser)
|
||||
|
||||
> We will add more options over time.
|
||||
|
||||
## Tips and tricks:
|
||||
|
||||
* Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available.
|
||||
* Use [npmpage](https://www.npmjs.com/package/npmpage) to create a webpage from coverage reports and TypeDoc for the module
|
||||
* Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds
|
||||
* Use [npmdocker](https://www.npmjs.com/package/npmdocker) for running tests consistently with docker.
|
28
docs/index.md
Normal file
28
docs/index.md
Normal file
@ -0,0 +1,28 @@
|
||||
# npmts
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://gitlab.com/pushrocks/npmts)
|
||||
[](https://github.com/pushrocks/npmts)
|
||||
[](https://pushrocks.gitlab.io/npmts/docs)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://david-dm.org/pushrocks/npmts)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
|
||||
## Introduction
|
||||
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
|
||||
By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works.
|
||||
|
||||
There is a docker image available that includes npmts to make CI a breeze:
|
||||
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||
|
||||
For further information read the docs.
|
||||
|
||||
[](https://push.rocks)
|
14
docs/info.md
Normal file
14
docs/info.md
Normal file
@ -0,0 +1,14 @@
|
||||
# Info
|
||||
|
||||
## Future Scope:
|
||||
* automatically manage badges in README
|
||||
* manage tslint to enforce code best practices
|
||||
* tear down any differences between local and CI environments by using brand new npmdocker
|
||||
|
||||
## About the authors:
|
||||
[](https://lossless.com/)
|
||||
|
||||
[](https://paypal.me/lossless)
|
||||
|
||||
## Legal Info
|
||||
https://lossless.gmbh
|
18
docs/install.md
Normal file
18
docs/install.md
Normal file
@ -0,0 +1,18 @@
|
||||
# Install NPMTS
|
||||
First install npmts globally, then install the npmts-g locally.
|
||||
|
||||
> **npmts-g* checks if the global version of npmts suffices the modules requirements.
|
||||
If not it installs npmts locally in the right version during npm install.
|
||||
|
||||
```sh
|
||||
npm install npmts -g # installs npmts globally
|
||||
npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency
|
||||
```
|
||||
|
||||
Then add it to your package.json's script section to trigger a build:
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"test": "(npmts)"
|
||||
}
|
||||
```
|
8
docs/summary.md
Normal file
8
docs/summary.md
Normal file
@ -0,0 +1,8 @@
|
||||
# Summary
|
||||
|
||||
* [1. Intro](index.md)
|
||||
* [2. Install](install.md)
|
||||
* [3. Default Behaviour](default.md)
|
||||
* [4. Configuration](config.md)
|
||||
* [5. Examples](examples.md)
|
||||
* [6. Info](info.md)
|
70
package.json
70
package.json
@ -1,15 +1,21 @@
|
||||
{
|
||||
"name": "npmts",
|
||||
"version": "5.2.4",
|
||||
"description": "write npm modules with TypeScript",
|
||||
"version": "5.4.26",
|
||||
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
||||
"main": "dist/index.js",
|
||||
"bin": {
|
||||
"npmts": "dist/cli.js"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "(npm run compile && npm run check)",
|
||||
"check": "(cd ./test/assets && node ../../dist/index.js)",
|
||||
"compile": "(cd compile && node compile.js)"
|
||||
"test": "(npm run compile && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest && npm run checkNoDocs)",
|
||||
"compile": "(rm -rf test/ && rm -r dist/ && mkdir dist/ && tsc && cp assets/cli.js dist/ )",
|
||||
"setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
|
||||
"typedoc": "(typedoc --out ./pages/api --target ES6 ./ts/)",
|
||||
"npmpage": "(npmpage)",
|
||||
"check": "(cd test && npm install && node ../dist/index.js)",
|
||||
"checkVersion": "(cd test/ && node ../dist/index.js -v)",
|
||||
"checkNoTest": "(cd test && node ../dist/index.js --notest)",
|
||||
"checkNoDocs": "(cd test && node ../dist/index.js --nodocs)"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@ -26,34 +32,38 @@
|
||||
},
|
||||
"homepage": "https://gitlab.com/pushrocks/npmts#readme",
|
||||
"dependencies": {
|
||||
"beautylog": "5.0.6",
|
||||
"early": "^2.0.1",
|
||||
"fs-extra": "^0.30.0",
|
||||
"@types/gulp": "^3.8.31",
|
||||
"@types/minimatch": "^2.0.28",
|
||||
"@types/q": "^0.x.x",
|
||||
"@types/shelljs": "^0.3.30",
|
||||
"babel-preset-es2015": "^6.14.0",
|
||||
"beautylog": "5.0.22",
|
||||
"depcheck": "^0.6.4",
|
||||
"early": "^2.0.26",
|
||||
"gulp": "3.9.1",
|
||||
"gulp-concat": "^2.6.0",
|
||||
"gulp-function": "^1.3.1",
|
||||
"gulp-if": "^2.0.1",
|
||||
"gulp-istanbul": "^0.10.4",
|
||||
"gulp-jsdoc3": "^0.2.1",
|
||||
"gulp-mocha": "^2.2.0",
|
||||
"gulp-replace": "^0.5.4",
|
||||
"gulp-sourcemaps": "^2.0.0-alpha",
|
||||
"gulp-typescript": "2.13.4",
|
||||
"gulp-typings": "2.0.0",
|
||||
"lodash": "^4.13.1",
|
||||
"merge2": "1.0.2",
|
||||
"projectinfo": "1.0.1",
|
||||
"gulp-babel": "^6.1.2",
|
||||
"gulp-function": "^1.3.6",
|
||||
"gulp-inject-modules": "^1.0.0",
|
||||
"gulp-istanbul": "^1.1.1",
|
||||
"gulp-mocha": "^3.0.1",
|
||||
"gulp-sourcemaps": "^1.6.0",
|
||||
"gulp-typedoc": "^2.0.0",
|
||||
"lodash": "^4.15.0",
|
||||
"npmextra": "^1.0.9",
|
||||
"projectinfo": "1.0.3",
|
||||
"q": "^1.4.1",
|
||||
"shelljs": "^0.7.0",
|
||||
"smartci": "0.0.1",
|
||||
"smartcli": "0.0.11",
|
||||
"smartcov": "0.0.6",
|
||||
"shelljs": "^0.7.4",
|
||||
"smartcli": "1.0.5",
|
||||
"smartcov": "1.0.0",
|
||||
"smartenv": "1.2.5",
|
||||
"smartfile": "3.0.10",
|
||||
"smartpath": "3.2.1",
|
||||
"smartstring": "^2.0.1",
|
||||
"source-map-support": "^0.4.0",
|
||||
"typings-global": "*"
|
||||
"smartfile": "4.0.15",
|
||||
"smartpath": "3.2.2",
|
||||
"smartstring": "^2.0.17",
|
||||
"source-map-support": "^0.4.2",
|
||||
"tsn": "^1.0.12",
|
||||
"typedoc": "^0.4.5",
|
||||
"typescript": "next",
|
||||
"typings-global": "^1.0.14"
|
||||
},
|
||||
"devDependencies": {}
|
||||
}
|
||||
|
@ -1,3 +0,0 @@
|
||||
var hello = "hello";
|
||||
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImN1c3RvbS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxJQUFJLEtBQUssR0FBRyxPQUFPLENBQUMiLCJmaWxlIjoiY3VzdG9tLmpzIiwic291cmNlc0NvbnRlbnQiOlsidmFyIGhlbGxvID0gXCJoZWxsb1wiOyJdLCJzb3VyY2VSb290IjoiL3NvdXJjZS8ifQ==
|
@ -1,2 +0,0 @@
|
||||
var hello = "hello";
|
||||
//# sourceMappingURL=custom.js.map
|
@ -1 +0,0 @@
|
||||
{"version":3,"file":"custom.js","sourceRoot":"","sources":["custom.ts"],"names":[],"mappings":"AAAA,IAAI,KAAK,GAAG,OAAO,CAAC"}
|
@ -1 +0,0 @@
|
||||
var hello = "hello";
|
@ -1,2 +0,0 @@
|
||||
var something = "something";
|
||||
//# sourceMappingURL=tsfile1.js.map
|
@ -1 +0,0 @@
|
||||
{"version":3,"file":"tsfile1.js","sourceRoot":"","sources":["tsfile1.ts"],"names":[],"mappings":"AAAA,IAAI,SAAS,GAAG,WAAW,CAAC"}
|
@ -1 +0,0 @@
|
||||
var something = "something";
|
@ -1,7 +0,0 @@
|
||||
{
|
||||
"ambientDependencies": {
|
||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
|
||||
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
|
||||
}
|
||||
}
|
3
test/assets/dist/index.d.ts
vendored
3
test/assets/dist/index.d.ts
vendored
@ -1,3 +0,0 @@
|
||||
declare let testplugin: {
|
||||
logSomething: () => void;
|
||||
};
|
9
test/assets/dist/index.js
vendored
9
test/assets/dist/index.js
vendored
@ -1,9 +0,0 @@
|
||||
/// <reference path="./typings/index.d.ts" />
|
||||
var testplugin = {
|
||||
logSomething: function () {
|
||||
console.log("only function executed");
|
||||
}
|
||||
};
|
||||
module.exports = testplugin;
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLDZDQUE2QztBQUM3QyxJQUFJLFVBQVUsR0FBRztJQUNiLFlBQVksRUFBRTtRQUNWLE9BQU8sQ0FBQyxHQUFHLENBQUMsd0JBQXdCLENBQUMsQ0FBQztJQUMxQyxDQUFDO0NBQ0osQ0FBQztBQUNGLE1BQU0sQ0FBQyxPQUFPLEdBQUcsVUFBVSxDQUFDIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9pbmRleC5kLnRzXCIgLz5cbmxldCB0ZXN0cGx1Z2luID0ge1xuICAgIGxvZ1NvbWV0aGluZzogZnVuY3Rpb24oKXtcbiAgICAgICAgY29uc29sZS5sb2coXCJvbmx5IGZ1bmN0aW9uIGV4ZWN1dGVkXCIpO1xuICAgIH1cbn07XG5tb2R1bGUuZXhwb3J0cyA9IHRlc3RwbHVnaW47Il19
|
@ -1,19 +0,0 @@
|
||||
{
|
||||
"mode":"default",
|
||||
"ts":{
|
||||
"./customdir/*.ts":"./"
|
||||
},
|
||||
"tsOptions":{
|
||||
"target":"ES5"
|
||||
},
|
||||
"typings":[
|
||||
"./ts/typings.json",
|
||||
"./subts1/typings.json",
|
||||
"./subts2/typings.json",
|
||||
"./customdir/typings.json"
|
||||
],
|
||||
"docs": {
|
||||
"publish":true
|
||||
},
|
||||
"cli":true
|
||||
}
|
@ -1,16 +0,0 @@
|
||||
{
|
||||
"name": "testpackage",
|
||||
"version": "2.0.0",
|
||||
"description": "",
|
||||
"main": "index.js",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/pushrocks/npmts.git"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "(npmts)"
|
||||
},
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"dependencies": {}
|
||||
}
|
@ -1,7 +0,0 @@
|
||||
{
|
||||
"ambientDependencies": {
|
||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
|
||||
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
|
||||
}
|
||||
}
|
BIN
test/assets/test/.DS_Store
vendored
BIN
test/assets/test/.DS_Store
vendored
Binary file not shown.
2
test/assets/test/test.d.ts
vendored
2
test/assets/test/test.d.ts
vendored
@ -1,2 +0,0 @@
|
||||
/// <reference path="../ts/typings/index.d.ts" />
|
||||
declare var testplugin: any;
|
@ -1,11 +0,0 @@
|
||||
/// <reference path="../ts/typings/index.d.ts" />
|
||||
var testplugin = require("../dist/index.js");
|
||||
describe("testplugins", function () {
|
||||
describe(".logSomething", function () {
|
||||
it("should log something", function () {
|
||||
testplugin.logSomething();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsaURBQWlEO0FBQ2pELElBQUksVUFBVSxHQUFHLE9BQU8sQ0FBQyxrQkFBa0IsQ0FBQyxDQUFDO0FBQzdDLFFBQVEsQ0FBQyxhQUFhLEVBQUM7SUFDbkIsUUFBUSxDQUFDLGVBQWUsRUFBQztRQUNyQixFQUFFLENBQUMsc0JBQXNCLEVBQUM7WUFDdEIsVUFBVSxDQUFDLFlBQVksRUFBRSxDQUFBO1FBQzdCLENBQUMsQ0FBQyxDQUFDO0lBQ1AsQ0FBQyxDQUFDLENBQUM7QUFDUCxDQUFDLENBQUMsQ0FBQyIsImZpbGUiOiJ0ZXN0LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4uL3RzL3R5cGluZ3MvaW5kZXguZC50c1wiIC8+XG52YXIgdGVzdHBsdWdpbiA9IHJlcXVpcmUoXCIuLi9kaXN0L2luZGV4LmpzXCIpO1xuZGVzY3JpYmUoXCJ0ZXN0cGx1Z2luc1wiLGZ1bmN0aW9uKCl7XG4gICAgZGVzY3JpYmUoXCIubG9nU29tZXRoaW5nXCIsZnVuY3Rpb24oKXtcbiAgICAgICAgaXQoXCJzaG91bGQgbG9nIHNvbWV0aGluZ1wiLGZ1bmN0aW9uKCl7XG4gICAgICAgICAgICB0ZXN0cGx1Z2luLmxvZ1NvbWV0aGluZygpXG4gICAgICAgIH0pO1xuICAgIH0pO1xufSk7Il19
|
@ -1,9 +0,0 @@
|
||||
/// <reference path="../ts/typings/index.d.ts" />
|
||||
var testplugin = require("../dist/index.js");
|
||||
describe("testplugins",function(){
|
||||
describe(".logSomething",function(){
|
||||
it("should log something",function(){
|
||||
testplugin.logSomething()
|
||||
});
|
||||
});
|
||||
});
|
@ -1,8 +0,0 @@
|
||||
{
|
||||
"ambientDependencies": {
|
||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
|
||||
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
|
||||
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
|
||||
}
|
||||
}
|
@ -1,7 +0,0 @@
|
||||
/// <reference path="./typings/index.d.ts" />
|
||||
let testplugin = {
|
||||
logSomething: function(){
|
||||
console.log("only function executed");
|
||||
}
|
||||
};
|
||||
module.exports = testplugin;
|
@ -1,8 +0,0 @@
|
||||
{
|
||||
"globalDependencies": {
|
||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts",
|
||||
"mocha": "github:Bartvds/tsd-deftools/typings/DefinitelyTyped/mocha/mocha.d.ts",
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts",
|
||||
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts"
|
||||
}
|
||||
}
|
@ -1,3 +0,0 @@
|
||||
var something = "something";
|
||||
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRzZmlsZTEudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsSUFBSSxTQUFTLEdBQUcsV0FBVyxDQUFDIiwiZmlsZSI6InRzZmlsZTEuanMiLCJzb3VyY2VzQ29udGVudCI6WyJ2YXIgc29tZXRoaW5nID0gXCJzb21ldGhpbmdcIjsiXSwic291cmNlUm9vdCI6Ii9zb3VyY2UvIn0=
|
32
ts/index.ts
32
ts/index.ts
@ -1,16 +1,30 @@
|
||||
import "typings-global";
|
||||
|
||||
/* ================================================== *
|
||||
Starting NPMTS main process.
|
||||
* ================================================== */
|
||||
import * as early from "early";
|
||||
early.start("NPMTS");
|
||||
import * as plugins from "./npmts.plugins"
|
||||
import * as paths from "./npmts.paths";
|
||||
import {promisechain} from "./npmts.promisechain";
|
||||
early.stop();
|
||||
early.stop()
|
||||
.then(() => {
|
||||
let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
|
||||
|
||||
plugins.beautylog.figletSync("NPMTS");
|
||||
|
||||
try {
|
||||
promisechain();
|
||||
}
|
||||
catch(err){
|
||||
console.log(err);
|
||||
}
|
||||
let npmtsCli = new plugins.smartcli.Smartcli();
|
||||
npmtsCli.standardTask()
|
||||
.then((argvArg) => {
|
||||
plugins.beautylog.figletSync("NPMTS");
|
||||
plugins.beautylog.info("npmts version: " + npmtsProjectInfo.version);
|
||||
try {
|
||||
promisechain(argvArg);
|
||||
}
|
||||
catch(err){
|
||||
console.log(err);
|
||||
}
|
||||
});
|
||||
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version);
|
||||
npmtsCli.startParse();
|
||||
});
|
@ -8,10 +8,14 @@ export var run = function(configArg){
|
||||
let config = configArg;
|
||||
npmtsOra.text("now looking at " + "required assets".yellow);
|
||||
if(config.cli == true){
|
||||
plugins.smartfile.fsaction.copy(plugins.path.join(paths.npmtsAssetsDir,"cli.js"),paths.distDir);
|
||||
plugins.smartfile.fs.copySync(
|
||||
plugins.path.join(paths.npmtsAssetsDir,"cli.js"),
|
||||
plugins.path.join(paths.distDir,"cli.js")
|
||||
);
|
||||
plugins.beautylog.ok("installed CLI assets!");
|
||||
done.resolve(config);
|
||||
} else {
|
||||
plugins.beautylog.ok("No additional assets required!")
|
||||
done.resolve(config);
|
||||
}
|
||||
return done.promise;
|
||||
|
121
ts/npmts.check.ts
Normal file
121
ts/npmts.check.ts
Normal file
@ -0,0 +1,121 @@
|
||||
import * as plugins from "./npmts.plugins";
|
||||
import * as paths from "./npmts.paths";
|
||||
import { npmtsOra } from "./npmts.promisechain";
|
||||
|
||||
import {ProjectinfoNpm} from "projectinfo";
|
||||
|
||||
export let projectInfo:ProjectinfoNpm;
|
||||
|
||||
let checkProjectTypings = (configArg) => {
|
||||
let done = plugins.Q.defer();
|
||||
projectInfo = new ProjectinfoNpm(paths.cwd);
|
||||
if(typeof projectInfo.packageJson.typings == "undefined"){
|
||||
plugins.beautylog.error(`please add typings field to package.json`);
|
||||
process.exit(1);
|
||||
};
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
const depcheckOptions = {
|
||||
ignoreBinPackage: false, // ignore the packages with bin entry
|
||||
parsers: { // the target parsers
|
||||
'*.ts': plugins.depcheck.parser.typescript,
|
||||
},
|
||||
detectors: [ // the target detectors
|
||||
plugins.depcheck.detector.requireCallExpression,
|
||||
plugins.depcheck.detector.importDeclaration
|
||||
],
|
||||
specials: [ // the target special parsers
|
||||
plugins.depcheck.special.eslint,
|
||||
plugins.depcheck.special.webpack
|
||||
],
|
||||
};
|
||||
|
||||
let checkDependencies = (configArg) => {
|
||||
let done = plugins.Q.defer();
|
||||
let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [ // folder with these names will be ignored
|
||||
'test',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [ // ignore dependencies that matches these globs
|
||||
"@types/*",
|
||||
"babel-preset-*"
|
||||
]
|
||||
})
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
||||
for (let item of unused.dependencies) {
|
||||
plugins.beautylog.warn(`Watch out: unused dependency ${item.red}`);
|
||||
};
|
||||
for (let item of unused.missing) {
|
||||
plugins.beautylog.error(`unused devDependency ${item.red}`);
|
||||
};
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
for (let item of unused.invalidFiles) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
||||
};
|
||||
for (let item of unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
|
||||
};
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
let checkDevDependencies = (configArg) => {
|
||||
let done = plugins.Q.defer();
|
||||
let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [ // folder with these names will be ignored
|
||||
'ts',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [ // ignore dependencies that matches these globs
|
||||
"@types/*",
|
||||
"babel-preset-*"
|
||||
]
|
||||
})
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
||||
for (let item of unused.devDependencies) {
|
||||
plugins.beautylog.log(`unused devDependency ${item.red}`);
|
||||
};
|
||||
for (let item of unused.missing) {
|
||||
plugins.beautylog.error(`unused devDependency ${item.red}`);
|
||||
};
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
for (let item of unused.invalidFiles) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
||||
};
|
||||
for (let item of unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
|
||||
};
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
let checkNodeVersion = (configArg) => {
|
||||
let done = plugins.Q.defer();
|
||||
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
}
|
||||
|
||||
export let run = (configArg) => {
|
||||
let done = plugins.Q.defer();
|
||||
npmtsOra.text("running project checks..."),
|
||||
checkProjectTypings(configArg)
|
||||
.then(checkDependencies)
|
||||
.then(checkDevDependencies)
|
||||
.then(checkNodeVersion)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
}
|
@ -4,27 +4,20 @@ import paths = require("./npmts.paths");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
|
||||
let removeDist = function(){
|
||||
npmtsOra.text("cleaning " + "dist".yellow + " folder");
|
||||
return plugins.smartfile.fsaction.remove(paths.distDir);
|
||||
npmtsOra.text("cleaning dist folder");
|
||||
return plugins.smartfile.fs.remove(paths.distDir);
|
||||
};
|
||||
|
||||
let removeTypings = function(){
|
||||
let done = plugins.Q.defer();
|
||||
npmtsOra.text("cleaning " + "typings".yellow + " folder");
|
||||
if(false){
|
||||
//plugins.smartfile.fsaction.remove(paths.typingsDir)
|
||||
// .then(done.resolve);
|
||||
} else {
|
||||
done.resolve();
|
||||
}
|
||||
return done.promise;
|
||||
let removePages = function(){
|
||||
npmtsOra.text("cleaning pages folder");
|
||||
return plugins.smartfile.fs.remove(paths.pagesDir);
|
||||
};
|
||||
|
||||
export let run = function(configArg){
|
||||
npmtsOra.text("cleaning up from previous builds...");
|
||||
let done = plugins.Q.defer();
|
||||
removeDist()
|
||||
.then(removeTypings)
|
||||
.then(removePages)
|
||||
.then(function(){
|
||||
plugins.beautylog.ok("Cleaned up from previous builds!");
|
||||
done.resolve(configArg);
|
||||
|
@ -1 +0,0 @@
|
||||
import "typings-global";
|
@ -4,68 +4,47 @@ import paths = require("./npmts.paths");
|
||||
import helpers = require("./npmts.compile.helpers");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
|
||||
/**
|
||||
* handles definition to make them fit for modular use
|
||||
*/
|
||||
let definitionHandler = function(configArg){
|
||||
npmtsOra.text("now making declaration files ready");
|
||||
let promiseArray = [];
|
||||
let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => {
|
||||
let done = plugins.Q.defer();
|
||||
let configTsLenght = Object.keys(configArg.ts).length;
|
||||
if(configTsLenght == 0) {
|
||||
plugins.beautylog.warn("No TS file and thus no definitions found!");
|
||||
done.resolve(configArg); //if there are no definition files, resolve...
|
||||
}
|
||||
let localCounter = 0;
|
||||
for (let key in configArg.ts){
|
||||
let distPath = configArg.ts[key];
|
||||
let stream = plugins.gulp.src(plugins.path.join(distPath,"**/*.d.ts"))
|
||||
.pipe(plugins.g.replace(plugins.smartstring.typescript.regexReferencePath,""))
|
||||
.pipe(plugins.gulp.dest(distPath))
|
||||
.pipe(plugins.g.gFunction(function(){
|
||||
localCounter++
|
||||
if(localCounter == configTsLenght){
|
||||
plugins.beautylog.ok("made declaration files ready!");
|
||||
done.resolve(configArg)
|
||||
};
|
||||
},"atEnd"));
|
||||
|
||||
}
|
||||
return done.promise;
|
||||
}
|
||||
|
||||
let compileTs = (tsFileArrayArg,tsOptionsArg = {}) => {
|
||||
let done = plugins.Q.defer();
|
||||
let moduleStream = plugins.merge2({ end: false });
|
||||
|
||||
let tsOptionsDefault = {
|
||||
let compilerOptionsDefault = {
|
||||
declaration: true,
|
||||
target: "ES5",
|
||||
module: "commonjs"
|
||||
module: "CommonJS",
|
||||
target: "ES6"
|
||||
};
|
||||
|
||||
/**
|
||||
* merges default ts options with those found in npmts.json
|
||||
*/
|
||||
let tsOptions = function (keyArg:string) {
|
||||
return plugins.lodashObject.assign(tsOptionsDefault, tsOptionsArg)
|
||||
let compilerOptions = function (keyArg:string) {
|
||||
let tsOptionsCombined = plugins.lodashObject.merge(compilerOptionsDefault, tsOptionsArg);
|
||||
let compilerOptions:plugins.tsn.CompilerOptions = {
|
||||
declaration: tsOptionsCombined.declaration,
|
||||
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
||||
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target]
|
||||
};
|
||||
return compilerOptions;
|
||||
};
|
||||
for (let keyArg in tsFileArrayArg) {
|
||||
plugins.beautylog.info(`TypeScript assignment: transpile from ${keyArg.blue} to ${tsFileArrayArg[keyArg].blue}`);
|
||||
if (helpers.checkOutputPath(tsFileArrayArg,keyArg)) {
|
||||
let tsStream = plugins.gulp.src([plugins.path.join(paths.cwd, keyArg), "!**/typings/**"])
|
||||
.pipe(plugins.g.sourcemaps.init()) // This means sourcemaps will be generated
|
||||
.pipe(plugins.g.typescript(tsOptions(keyArg)));
|
||||
|
||||
let jsStream = tsStream.js
|
||||
.pipe(plugins.g.sourcemaps.write()) // Now the sourcemaps are added to the .js file
|
||||
.pipe(plugins.gulp.dest(tsFileArrayArg[keyArg]));
|
||||
let declarationStream = tsStream.dts
|
||||
.pipe(plugins.gulp.dest(tsFileArrayArg[keyArg]));
|
||||
moduleStream.add(tsStream,jsStream,declarationStream);
|
||||
let filesReadPromise = plugins.smartfile.fs.listFileTree(process.cwd(),keyArg)
|
||||
.then((filesToConvertArg) => {
|
||||
let filesToConvertAbsolute = plugins.smartpath.transform.toAbsolute(filesToConvertArg,process.cwd());
|
||||
let destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg],process.cwd());
|
||||
let filesCompiledPromise = plugins.tsn.compile(
|
||||
filesToConvertAbsolute,
|
||||
destDir,
|
||||
compilerOptions(keyArg)
|
||||
);
|
||||
promiseArray.push(filesCompiledPromise);
|
||||
});
|
||||
promiseArray.push(filesReadPromise);
|
||||
}
|
||||
}
|
||||
moduleStream.on("queueDrain",() => {
|
||||
done.resolve();
|
||||
})
|
||||
};
|
||||
plugins.Q.all(promiseArray)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
}
|
||||
|
||||
@ -77,18 +56,13 @@ export let run = function (configArg) {
|
||||
|
||||
compileTs(config.ts,config.tsOptions)
|
||||
.then(() => {
|
||||
compileTs(config.testTs);
|
||||
plugins.beautylog.ok("compiled main TypeScript!");
|
||||
plugins.beautylog.log("now compiling tests!");
|
||||
return compileTs(config.testTs);
|
||||
})
|
||||
.then(function () {
|
||||
plugins.beautylog.ok("compiled TypeScript!");
|
||||
definitionHandler(config)
|
||||
.then(function(){
|
||||
done.resolve(config);
|
||||
});
|
||||
plugins.beautylog.ok("compiled all TypeScript!");
|
||||
done.resolve(config);
|
||||
});
|
||||
/*==================== END TS Compilation =====================*/
|
||||
|
||||
|
||||
|
||||
return done.promise;
|
||||
};
|
||||
|
@ -1,27 +0,0 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
export var run = function(){
|
||||
var done = plugins.Q.defer();
|
||||
var config:any = {};
|
||||
var configPath = plugins.path.join(paths.cwd,"npmts.json");
|
||||
if(plugins.smartfile.checks.fileExistsSync(configPath)){
|
||||
plugins.beautylog.info("npmts.json".blue + " config file found!");
|
||||
config = plugins.smartfile.local.toObjectSync(configPath);
|
||||
switch (config.mode){
|
||||
case "default":
|
||||
case "custom":
|
||||
plugins.beautylog.ok("mode is " + config.mode.yellow);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
|
||||
process.exit(1);
|
||||
};
|
||||
} else {
|
||||
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
|
||||
config.mode = "default";
|
||||
done.resolve(config);
|
||||
};
|
||||
return done.promise;
|
||||
};
|
@ -1,21 +0,0 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
|
||||
export var run = function(configArg){
|
||||
var config = configArg;
|
||||
var done = plugins.Q.defer();
|
||||
/* -------------------------------------------------
|
||||
* ----------- install typings ---------------
|
||||
* ----------------------------------------------- */
|
||||
npmtsOra.text("now installing " + "typings".yellow);
|
||||
var absoluteTypingsArray = plugins.smartpath.transform.toAbsolute(config.typings,paths.cwd);
|
||||
plugins.gulp.src(absoluteTypingsArray)
|
||||
.pipe(plugins.g.typings())
|
||||
.pipe(plugins.g.gFunction(function(){
|
||||
plugins.beautylog.ok("typings installed!");
|
||||
done.resolve(config);
|
||||
},"atEnd"));
|
||||
return done.promise;
|
||||
};
|
@ -1,65 +0,0 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
|
||||
let genJsdoc = function(configArg){
|
||||
let done = plugins.Q.defer();
|
||||
npmtsOra.text("now generating " + "JsDoc documentation".yellow);
|
||||
plugins.gulp.src([
|
||||
plugins.path.join(paths.cwd,"README.md"),
|
||||
plugins.path.join(paths.distDir,"**/*.js")
|
||||
])
|
||||
.pipe(plugins.g.jsdoc3({
|
||||
opts: {
|
||||
destination: paths.docsDir
|
||||
}
|
||||
}, function(){
|
||||
plugins.beautylog.ok("JsDoc documentation has been generated!");
|
||||
done.resolve(configArg)
|
||||
}));
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
export let publishDocs = function(configArg){
|
||||
let done = plugins.Q.defer();
|
||||
let gitUrl = plugins.projectinfo.npm(
|
||||
paths.cwd,
|
||||
{
|
||||
gitAccessToken:process.env.GITHUB_TOKEN
|
||||
}
|
||||
).git.httpsUrl;
|
||||
|
||||
let deployScript = ""
|
||||
+ "cd " + paths.docsDir + " "
|
||||
+ "&& git init " + "> /dev/null 2>&1 "
|
||||
+ "&& git config user.name \"TRAVIS CI\" " + "> /dev/null 2>&1 "
|
||||
+ "&& git config user.email \"travis@shipzone.io\" " + "> /dev/null 2>&1 "
|
||||
+ "&& git add . " + "> /dev/null 2>&1 "
|
||||
+ "&& git commit -m \"Deploy to GitHub Pages\" " + "> /dev/null 2>&1 "
|
||||
+ "&& git push --force --quiet "
|
||||
+ "\"" + gitUrl + "\" "
|
||||
+ "master:gh-pages " + "> /dev/null 2>&1";
|
||||
|
||||
|
||||
plugins.beautylog.log("now publishing JsDoc documentation to GitHub");
|
||||
if (!plugins.shelljs.which('git')) {
|
||||
plugins.beautylog.error('Git is not installed!');
|
||||
plugins.shelljs.exit(1);
|
||||
} else if (plugins.shelljs.exec(deployScript).code !== 0) {
|
||||
plugins.beautylog.error('Git failed!');
|
||||
plugins.shelljs.exit(1);
|
||||
}
|
||||
plugins.beautylog.ok("JsDoc documentation has been deployed to GitHub!");
|
||||
done.resolve(configArg);
|
||||
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
|
||||
export let run = function(configArg){
|
||||
let done = plugins.Q.defer();
|
||||
genJsdoc(configArg)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
@ -1,64 +1,79 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
|
||||
export let isCi = function(){
|
||||
return plugins.smartci.check.isCi();
|
||||
export type npmtsMode = "default" | "custom"
|
||||
|
||||
export interface npmtsConfig {
|
||||
argv:any,
|
||||
coverageTreshold:number,
|
||||
docs:boolean,
|
||||
mode: npmtsMode,
|
||||
test:boolean,
|
||||
testTs:any,
|
||||
ts:any,
|
||||
tsOptions:any
|
||||
|
||||
};
|
||||
|
||||
export let isRelease = function():boolean {
|
||||
return plugins.smartci.check.isCi()
|
||||
&& plugins.smartci.check.isTaggedCommit();
|
||||
};
|
||||
|
||||
export let doPublish = function():boolean {
|
||||
try {
|
||||
return isRelease()
|
||||
&& plugins.smartci.get.subJobNumber() == 1;
|
||||
}
|
||||
catch (err){
|
||||
return false;
|
||||
}
|
||||
};
|
||||
export var run = function(argvArg){
|
||||
let done = plugins.Q.defer();
|
||||
let defaultConfig:npmtsConfig = {
|
||||
argv:undefined,
|
||||
coverageTreshold: 70,
|
||||
docs: true,
|
||||
mode:"default",
|
||||
test:true,
|
||||
testTs:{},
|
||||
ts:{},
|
||||
tsOptions: {}
|
||||
};
|
||||
|
||||
export var run = function(configArg){
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
|
||||
npmtsOra.text("now determining build options...");
|
||||
// mix with configfile
|
||||
npmtsOra.text("looking for npmextra.json");
|
||||
let config:npmtsConfig = plugins.npmextra.dataFor({
|
||||
toolName:"npmts",
|
||||
defaultSettings:defaultConfig,
|
||||
cwd:paths.cwd
|
||||
});
|
||||
|
||||
// add argv
|
||||
config.argv = argvArg;
|
||||
|
||||
// check mode
|
||||
switch (config.mode){
|
||||
case "default":
|
||||
case "custom":
|
||||
plugins.beautylog.ok("mode is " + config.mode);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error(`mode not recognised!`);
|
||||
process.exit(1);
|
||||
};
|
||||
|
||||
//handle default mode
|
||||
if (config.mode == "default"){
|
||||
config.typings = [
|
||||
"./ts/typings.json"
|
||||
];
|
||||
config.ts = {
|
||||
["./ts/**/*.ts"]: "./dist/"
|
||||
};
|
||||
config.testTs = {
|
||||
["./test/test.ts"]: "./test/"
|
||||
};
|
||||
config.test = ["./index.js"];
|
||||
}
|
||||
|
||||
//check if config.tsOptions is available
|
||||
config.tsOptions ? void(0) : config.tsOptions = {};
|
||||
};
|
||||
|
||||
// handle state of current build
|
||||
|
||||
isRelease() ? plugins.beautylog.info("All right: This is a RELEASE build!")
|
||||
: plugins.beautylog.info("NOT A RELEASE build!");
|
||||
isRelease() && doPublish() ? plugins.beautylog.info("All right: This is the first subBuild, so this one publishes COVERAGE + DOCS when tests succeed!")
|
||||
: plugins.beautylog.info("We are not publishing anything!");
|
||||
// mix with commandline
|
||||
if(config.argv.notest){
|
||||
config.test = false;
|
||||
};
|
||||
if(config.argv.nodocs){
|
||||
config.docs = false;
|
||||
};
|
||||
|
||||
|
||||
|
||||
config.coverageTreshold ? void(0) : config.coverageTreshold = 70;
|
||||
|
||||
// handle docs
|
||||
config.docs ? void(0) : config.docs = {};
|
||||
config.docs.publish ? void(0) : config.docs.publish = false;
|
||||
doPublish() ? void(0) : config.docs.publish = false;
|
||||
|
||||
plugins.beautylog.ok("build options are ready!");
|
||||
done.resolve(config);
|
||||
|
@ -1,16 +1,24 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
|
||||
export let cwd = plugins.smartcli.get.cwd().path;
|
||||
// NPMTS Paths
|
||||
export let npmtsPackageRoot = plugins.path.join(__dirname,"../");
|
||||
|
||||
//Directories
|
||||
|
||||
// Project paths
|
||||
export let cwd = process.cwd();
|
||||
|
||||
// Directories
|
||||
export let tsDir = plugins.path.join(cwd,"ts/");
|
||||
export let distDir = plugins.path.join(cwd,"dist/");
|
||||
export let docsDir = plugins.path.join(cwd,"docs/");
|
||||
export let testDir = plugins.path.join(cwd,"test/");
|
||||
export let typingsDir = plugins.path.join(cwd,"ts/typings/");
|
||||
export let coverageDir = plugins.path.join(cwd,"coverage/");
|
||||
|
||||
// Pages
|
||||
export let pagesDir = plugins.path.join(cwd,"pages/");
|
||||
export let pagesApiDir = plugins.path.join(pagesDir,"/api");
|
||||
|
||||
export let npmtsAssetsDir = plugins.path.join(__dirname,"../assets/");
|
||||
|
||||
//Files
|
||||
|
@ -1,29 +1,27 @@
|
||||
import "typings-global";
|
||||
export import beautylog = require("beautylog");
|
||||
export let fs = require("fs-extra");
|
||||
export let gulp = require("gulp");
|
||||
export let depcheck = require("depcheck");
|
||||
export import gulp = require("gulp");
|
||||
export let g = {
|
||||
gFunction: require("gulp-function"),
|
||||
babel: require("gulp-babel"),
|
||||
istanbul: require("gulp-istanbul"),
|
||||
jsdoc3: require("gulp-jsdoc3"),
|
||||
gFunction: require("gulp-function"),
|
||||
injectModules: require("gulp-inject-modules"),
|
||||
mocha: require("gulp-mocha"),
|
||||
replace: require("gulp-replace"),
|
||||
sourcemaps: require("gulp-sourcemaps"),
|
||||
typescript: require("gulp-typescript"),
|
||||
typings: require("gulp-typings")
|
||||
|
||||
typedoc: require("gulp-typedoc")
|
||||
};
|
||||
export let lodashObject = require('lodash/fp/object');
|
||||
export let merge2 = require("merge2");
|
||||
export let projectinfo = require("projectinfo");
|
||||
export let path = require("path");
|
||||
export let Q = require("q");
|
||||
export let shelljs = require("shelljs");
|
||||
export let smartci = require("smartci");
|
||||
export let smartcli = require("smartcli");
|
||||
export let smartcov = require("smartcov");
|
||||
export let smartenv = require("smartenv");
|
||||
export let smartfile = require("smartfile");
|
||||
export import lodashObject = require('lodash');
|
||||
export import npmextra = require("npmextra");
|
||||
export import projectinfo = require("projectinfo");
|
||||
export import path = require("path");
|
||||
export import Q = require("q");
|
||||
export import shelljs = require("shelljs");
|
||||
export import smartcli = require("smartcli");
|
||||
export import smartcov = require("smartcov");
|
||||
export import smartenv = require("smartenv");
|
||||
export import smartfile = require("smartfile");
|
||||
export import smartpath = require("smartpath");
|
||||
export import smartstring = require("smartstring");
|
||||
export let sourceMapSupport = require("source-map-support").install(); // this is required to display errors correctly during testing
|
||||
export let sourceMapSupport = require("source-map-support").install(); // this is required to display errors correctly during testing
|
||||
export import tsn = require("tsn");
|
@ -1,30 +1,27 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import {Ora} from "beautylog"
|
||||
|
||||
export let npmtsOra = new plugins.beautylog.Ora("setting up TaskChain","cyan");
|
||||
npmtsOra.start();
|
||||
|
||||
import NpmtsAssets = require("./npmts.assets");
|
||||
import NpmtsCheck = require("./npmts.check");
|
||||
import NpmtsClean = require("./npmts.clean");
|
||||
import NpmtsCompile = require("./npmts.compile");
|
||||
import NpmtsConfigFile = require("./npmts.configfile");
|
||||
import NpmtsInstall = require("./npmts.install");
|
||||
import NpmtsJsdoc = require("./npmts.jsdoc");
|
||||
import NpmtsTypeDoc = require("./npmts.typedoc");
|
||||
import NpmtsOptions = require("./npmts.options");
|
||||
import NpmtsPublish = require("./npmts.publish");
|
||||
import NpmtsTests = require("./npmts.tests");
|
||||
|
||||
export let promisechain = function(){
|
||||
export let promisechain = function(argvArg){
|
||||
let done = plugins.Q.defer();
|
||||
NpmtsConfigFile.run()
|
||||
.then(NpmtsOptions.run)
|
||||
npmtsOra.start();
|
||||
NpmtsOptions.run(argvArg)
|
||||
.then(NpmtsClean.run)
|
||||
.then(NpmtsInstall.run)
|
||||
.then(NpmtsCheck.run)
|
||||
.then(NpmtsCompile.run)
|
||||
.then(NpmtsAssets.run)
|
||||
.then(NpmtsJsdoc.run)
|
||||
.then(NpmtsTypeDoc.run)
|
||||
.then(NpmtsTests.run)
|
||||
.then(NpmtsPublish.run)
|
||||
.then(function(configArg){
|
||||
let shipString = "" +
|
||||
"\n" +
|
||||
|
@ -1,15 +0,0 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
import NpmtsJsdoc = require("./npmts.jsdoc");
|
||||
|
||||
export let run = function(configArg){
|
||||
let done = plugins.Q.defer();
|
||||
let config = configArg;
|
||||
let promiseArray = [];
|
||||
config.docs.publish ? promiseArray.push(NpmtsJsdoc.publishDocs(configArg)) : void(0);
|
||||
promiseArray.length === 0 ? plugins.beautylog.info("Did not publish anything!") : void(0);
|
||||
|
||||
plugins.Q.all(promiseArray).then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
@ -7,49 +7,53 @@ import {npmtsOra} from "./npmts.promisechain";
|
||||
*
|
||||
* @returns {*}
|
||||
*/
|
||||
let istanbul = function (configArg) {
|
||||
npmtsOra.text("Instrumentalizing transpiled JS...");
|
||||
let mocha = function (configArg) {
|
||||
npmtsOra.text("Instrumentalizing and testing transpiled JS");
|
||||
npmtsOra.end(); // end npmtsOra for tests.
|
||||
let done = plugins.Q.defer();
|
||||
var stream = plugins.gulp.src([plugins.path.join(paths.cwd,"dist/*.js")])
|
||||
.pipe(plugins.g.istanbul()) // Covering files
|
||||
.pipe(plugins.g.istanbul.hookRequire()) // Force `require` to return covered files
|
||||
.pipe(plugins.g.gFunction(function(){
|
||||
plugins.beautylog.ok("JS has been instrumentalized to get test code coverage!");
|
||||
done.resolve(configArg);
|
||||
},"atEnd"));
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
* @returns {*}
|
||||
*/
|
||||
let mocha = function (configArg) {
|
||||
let done = plugins.Q.defer();
|
||||
npmtsOra.end(); // end npmtsOra for tests.
|
||||
let stream = plugins.gulp.src(["./test/test.js"])
|
||||
.pipe(plugins.g.mocha())
|
||||
.pipe(plugins.g.istanbul.writeReports()) // Creating the reports after tests ran
|
||||
.pipe(plugins.g.gFunction(function(){
|
||||
plugins.beautylog.ok("Tests have passed!");
|
||||
done.resolve(configArg);
|
||||
},"atEnd"));
|
||||
.pipe(plugins.g.sourcemaps.init())
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve("babel-preset-es2015")
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.istanbul({
|
||||
}))
|
||||
.pipe(plugins.g.sourcemaps.write())
|
||||
.pipe(plugins.g.injectModules())
|
||||
.on("finish",function(){
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd,"test/test.js")])
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve("babel-preset-es2015")
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.injectModules())
|
||||
.pipe(plugins.g.mocha())
|
||||
.pipe(plugins.g.istanbul.writeReports({
|
||||
dir: plugins.path.join(paths.cwd,"./coverage"),
|
||||
reporters: [ 'lcovonly', 'json', 'text', 'text-summary']
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(function(){
|
||||
plugins.beautylog.ok("Tested!");
|
||||
done.resolve(configArg);
|
||||
},"atEnd"));
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
let coverage = function(configArg){
|
||||
let done = plugins.Q.defer();
|
||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir,"lcov.info"))
|
||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir,"lcov.info"),2)
|
||||
.then(function(percentageArg){
|
||||
if (percentageArg >= configArg.coverageTreshold){
|
||||
plugins.beautylog.ok(
|
||||
"your coverage of " + percentageArg.toString().blue + "% ".blue + "exceeds your treshold of " +
|
||||
configArg.coverageTreshold.toString().blue + "%".blue
|
||||
`${percentageArg.toString()}% coverage exceeds your treshold of ${configArg.coverageTreshold.toString()}%`
|
||||
);
|
||||
} else {
|
||||
plugins.beautylog.warn(
|
||||
"your coverage of " + percentageArg + "% " + "fails your treshold of " +
|
||||
configArg.coverageTreshold + "%"
|
||||
`${percentageArg.toString()}% coverage fails your treshold of ${configArg.coverageTreshold.toString()}%`
|
||||
);
|
||||
plugins.beautylog.error("exiting due to coverage failure");
|
||||
process.exit(1);
|
||||
@ -62,17 +66,22 @@ let coverage = function(configArg){
|
||||
export let run = function(configArg) {
|
||||
let done = plugins.Q.defer();
|
||||
let config = configArg;
|
||||
if(config.test === true){
|
||||
npmtsOra.text("now starting tests");
|
||||
plugins.beautylog.log(
|
||||
"-------------------------------------------------------\n" +
|
||||
"*************************** TESTS: ***************************\n" +
|
||||
"--------------------------------------------------------------"
|
||||
);
|
||||
|
||||
npmtsOra.text("now starting tests");
|
||||
plugins.beautylog.log(
|
||||
"-------------------------------------------------------\n" +
|
||||
"*************************** TESTS: ***************************\n" +
|
||||
"--------------------------------------------------------------"
|
||||
);
|
||||
|
||||
istanbul(config)
|
||||
.then(mocha)
|
||||
.then(coverage)
|
||||
.then(done.resolve);
|
||||
mocha(config)
|
||||
.then(coverage)
|
||||
.then(() => {
|
||||
done.resolve(config);
|
||||
});
|
||||
} else {
|
||||
npmtsOra.end();
|
||||
done.resolve(config);
|
||||
}
|
||||
return done.promise;
|
||||
};
|
46
ts/npmts.typedoc.ts
Normal file
46
ts/npmts.typedoc.ts
Normal file
@ -0,0 +1,46 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
import { npmtsOra } from "./npmts.promisechain";
|
||||
|
||||
import {projectInfo} from "./npmts.check";
|
||||
|
||||
let genTypeDoc = function (configArg) {
|
||||
let done = plugins.Q.defer();
|
||||
npmtsOra.text("now generating " + "TypeDoc documentation".yellow);
|
||||
plugins.beautylog.log("TypeDoc Output:");
|
||||
plugins.gulp.src(plugins.path.join(paths.tsDir, "**/*.ts"))
|
||||
.pipe(plugins.g.typedoc({
|
||||
// TypeScript options (see typescript docs)
|
||||
module: "commonjs",
|
||||
target: "es6",
|
||||
includeDeclarations: true,
|
||||
|
||||
// Output options (see typedoc docs)
|
||||
out: paths.pagesApiDir,
|
||||
json: plugins.path.join(paths.pagesApiDir, "file.json"),
|
||||
|
||||
// TypeDoc options (see typedoc docs)
|
||||
name: projectInfo.name,
|
||||
readme: plugins.path.join(paths.cwd,"README.md"),
|
||||
// theme: "default",
|
||||
ignoreCompilerErrors: true,
|
||||
version: true,
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(done.resolve, "atEnd"));
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
|
||||
export let run = function (configArg) {
|
||||
let done = plugins.Q.defer();
|
||||
if (configArg.docs) {
|
||||
genTypeDoc(configArg)
|
||||
.then(() => {
|
||||
done.resolve(configArg);
|
||||
});
|
||||
} else {
|
||||
done.resolve(configArg);
|
||||
};
|
||||
return done.promise;
|
||||
};
|
@ -1,8 +0,0 @@
|
||||
{
|
||||
"globalDependencies": {
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
|
||||
"istanbul": "registry:dt/istanbul#0.4.0+20160316155526",
|
||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
|
||||
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
|
||||
}
|
||||
}
|
8
tsconfig.json
Normal file
8
tsconfig.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"declaration": true,
|
||||
"module": "commonjs",
|
||||
"target": "ES5",
|
||||
"outDir": "./dist/"
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user