Compare commits
228 Commits
Author | SHA1 | Date | |
---|---|---|---|
7999e00965 | |||
10883d08a8 | |||
4fedb088dd | |||
3f07127159 | |||
a57c3f03a8 | |||
15bdab9ba6 | |||
668fd0998f | |||
e0611f3f64 | |||
928f3212a3 | |||
7c7e45ad54 | |||
797d9e2bcd | |||
578cd2d097 | |||
5a7dd901f0 | |||
2104fc01e6 | |||
4eacef56d5 | |||
5722deb7a0 | |||
50d71dde67 | |||
13123e180d | |||
b13db4184b | |||
19f6097ab9 | |||
34066d8a13 | |||
df87337f4d | |||
105e5c2ff0 | |||
7115b699ba | |||
8c7ac4c1d0 | |||
fc8154b431 | |||
896e0095fa | |||
7e46b55de5 | |||
6553e7432c | |||
cf4db90aef | |||
8896d3ef76 | |||
c0b7dc2547 | |||
d65f19d108 | |||
5de4646453 | |||
44e9fcc977 | |||
784aec1ec3 | |||
61b7bbb168 | |||
1d662ddef4 | |||
f7351c914e | |||
7132ae11a8 | |||
b195b8911b | |||
e331e870d9 | |||
3a6bd3b583 | |||
594bccfc82 | |||
d9f1d36d14 | |||
f12c4aabd8 | |||
b62f7d8b31 | |||
56cccb1b14 | |||
850df45d7f | |||
2b1f371d8a | |||
8196ca50a7 | |||
ad96661dda | |||
2fc6c3d358 | |||
0c74fb3343 | |||
d821a2efa6 | |||
66f2321d99 | |||
816f4f57fb | |||
9bdf3ec4c7 | |||
b9d4953bcd | |||
8c0fcdf5b7 | |||
a477cc00e7 | |||
00b9a742ab | |||
f5b8ab84cf | |||
4fc4efc0b9 | |||
30136f01a8 | |||
d1d85819d7 | |||
e267fce3bb | |||
f964b2737f | |||
6ac634e178 | |||
3105f8f401 | |||
70b83fcafc | |||
7e8e4b1891 | |||
aa8279c281 | |||
7564e1fd18 | |||
a6fbe7da33 | |||
e0f208ba41 | |||
d2cf4346d4 | |||
b769dcae4f | |||
7b58535dda | |||
f16103a632 | |||
befed099c5 | |||
6c0fa380a9 | |||
22de2c784f | |||
e8fe4f1720 | |||
d7443bbf17 | |||
c4668bc0a6 | |||
bc489b6bf3 | |||
e2d0a7a939 | |||
0f5e451e60 | |||
3595bf3590 | |||
efe73d0fd0 | |||
c52322ec12 | |||
b7cf9949bf | |||
beac49d5d2 | |||
25993bd66f | |||
83b324054a | |||
2c574fe015 | |||
3b50365ea9 | |||
e6f487eeee | |||
07c100ae44 | |||
55888cce89 | |||
d4c66af0d8 | |||
9359b5f7e9 | |||
87c0ec5728 | |||
aeb79f053f | |||
e01ecb9369 | |||
fd29434fa6 | |||
4684b9616c | |||
a2701bc3be | |||
425a86b33c | |||
20631eb0a8 | |||
27287d24fb | |||
1b2393c7ed | |||
330b0527c5 | |||
4485b5bfc6 | |||
cf6f636d3e | |||
37e726a45f | |||
|
0f0f2dd4ed | ||
|
9033eede2c | ||
e65e7da26b | |||
ef5c5eb2b8 | |||
ed156e6de8 | |||
d889a20572 | |||
da1ec0329f | |||
95e3f9cb10 | |||
def19f76e9 | |||
455c89d68d | |||
|
2bd187b704 | ||
|
29dff4c0e3 | ||
f236d77952 | |||
c91a8d8e69 | |||
0d5c49fe60 | |||
2112b4527d | |||
bd3873a359 | |||
6ec0ccac34 | |||
9bff7db97b | |||
2305be0daa | |||
9cd24695db | |||
46c79e711b | |||
4b07c9951f | |||
559b5553eb | |||
87ceed6f8f | |||
ee36914a42 | |||
7dc6cdb250 | |||
3ea6585992 | |||
0f0592cdaf | |||
cf438ae431 | |||
6cbf7cedc8 | |||
77bba7f865 | |||
49fc7e4687 | |||
7ee0c349e3 | |||
f706376e48 | |||
8d8cdde15d | |||
dc98d893b1 | |||
6070249cd2 | |||
05ce3e133d | |||
5f5a421453 | |||
d5d0052ecf | |||
9caa301f40 | |||
5fb2f3a81f | |||
873c7af7a4 | |||
5e82218d92 | |||
354b1b1bf7 | |||
|
467670863a | ||
07195d207d | |||
b60bb25b0f | |||
a7af34622b | |||
9c58be69bf | |||
1681fc729d | |||
50e2895ad9 | |||
95ba650a14 | |||
83aa10eb52 | |||
ebc3cb70ff | |||
9b595e75cd | |||
4e85589dea | |||
2b44f61ace | |||
0928a6d9d2 | |||
e464afd544 | |||
468d07f5f3 | |||
|
ae68ddfaf8 | ||
|
ad275d2113 | ||
f99605da8f | |||
508aa23e59 | |||
ce7f28404a | |||
237b084411 | |||
bc6a7ae1da | |||
31fdd4c0a7 | |||
c820350bb6 | |||
92bf6d7bab | |||
e77bece3fc | |||
df96486d2f | |||
980db3eb28 | |||
34d3d4d963 | |||
a3c02cad4e | |||
a12190638d | |||
f2a36e7a45 | |||
60c025e638 | |||
5d16734c00 | |||
65fe421de1 | |||
d94d66ef19 | |||
3e4ac03a63 | |||
0948fa806c | |||
53980160df | |||
886f1ae6f4 | |||
4602e7e3c9 | |||
1dbb5f6f36 | |||
1023bf9f3c | |||
78bebcda25 | |||
74deee70a3 | |||
019864a484 | |||
80db0fc581 | |||
9a25b4ef91 | |||
|
9f42a20e4b | ||
dbb8fd0fff | |||
4368713ad5 | |||
58cea5cb48 | |||
329e0dc101 | |||
da45d002a3 | |||
59e811247f | |||
7bcd2f4f5d | |||
78d77c003c | |||
aca85d2ff3 | |||
f03c4a45c2 | |||
faf55e4e31 | |||
b78fe35e88 | |||
7ab4561727 | |||
200f44a792 | |||
312dc4bd7f |
24
.gitignore
vendored
24
.gitignore
vendored
@ -1,6 +1,20 @@
|
|||||||
node_modules/
|
.nogit/
|
||||||
test/
|
|
||||||
pages/
|
# artifacts
|
||||||
|
coverage/
|
||||||
public/
|
public/
|
||||||
npm-debug/
|
pages/
|
||||||
.DS_Store
|
|
||||||
|
# installs
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# caches
|
||||||
|
.yarn/
|
||||||
|
.cache/
|
||||||
|
.rpt2_cache
|
||||||
|
|
||||||
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_*/
|
||||||
|
|
||||||
|
# custom
|
112
.gitlab-ci.yml
112
.gitlab-ci.yml
@ -1,59 +1,127 @@
|
|||||||
image: hosttoday/ht-docker-node:npmci
|
# gitzone ci_default
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
|
cache:
|
||||||
|
paths:
|
||||||
|
- .npmci_cache/
|
||||||
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- test
|
- security
|
||||||
- release
|
- test
|
||||||
- trigger
|
- release
|
||||||
- pages
|
- metadata
|
||||||
|
|
||||||
testLEGACY:
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
mirror:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci git mirror
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
audit:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command npm audit --audit-level=high
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# test stage
|
||||||
|
# ====================
|
||||||
|
|
||||||
|
testStable:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci test legacy
|
- npmci npm prepare
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
allow_failure: true
|
- priv
|
||||||
|
|
||||||
testLTS:
|
testBuild:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci test lts
|
- npmci npm prepare
|
||||||
tags:
|
- npmci node install stable
|
||||||
- docker
|
- npmci npm install
|
||||||
|
- npmci command npm run build
|
||||||
testSTABLE:
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test stable
|
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
script:
|
script:
|
||||||
- npmci publish
|
- npmci node install stable
|
||||||
|
- npmci npm publish
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# metadata stage
|
||||||
|
# ====================
|
||||||
|
codequality:
|
||||||
|
stage: metadata
|
||||||
|
allow_failure: true
|
||||||
|
script:
|
||||||
|
- npmci command npm install -g tslint typescript
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
trigger:
|
trigger:
|
||||||
stage: trigger
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci trigger
|
- npmci trigger
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
image: hosttoday/ht-docker-node:npmpage
|
stage: metadata
|
||||||
stage: pages
|
|
||||||
script:
|
script:
|
||||||
- npmci command npmpage --host gitlab
|
- npmci node install lts
|
||||||
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command tsdoc
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
artifacts:
|
artifacts:
|
||||||
expire_in: 1 week
|
expire_in: 1 week
|
||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
|
allow_failure: true
|
||||||
|
@ -1,7 +0,0 @@
|
|||||||
.idea/
|
|
||||||
compile/
|
|
||||||
coverage/
|
|
||||||
test/
|
|
||||||
docs/
|
|
||||||
examples
|
|
||||||
.gitignore
|
|
29
.vscode/launch.json
vendored
Normal file
29
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"name": "current file",
|
||||||
|
"type": "node",
|
||||||
|
"request": "launch",
|
||||||
|
"args": [
|
||||||
|
"${relativeFile}"
|
||||||
|
],
|
||||||
|
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||||
|
"cwd": "${workspaceRoot}",
|
||||||
|
"protocol": "inspector",
|
||||||
|
"internalConsoleOptions": "openOnSessionStart"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "test.ts",
|
||||||
|
"type": "node",
|
||||||
|
"request": "launch",
|
||||||
|
"args": [
|
||||||
|
"test/test.ts"
|
||||||
|
],
|
||||||
|
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||||
|
"cwd": "${workspaceRoot}",
|
||||||
|
"protocol": "inspector",
|
||||||
|
"internalConsoleOptions": "openOnSessionStart"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"json.schemas": [
|
||||||
|
{
|
||||||
|
"fileMatch": ["/npmextra.json"],
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"npmci": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for npmci"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
@ -1,7 +0,0 @@
|
|||||||
Please view this file on the master branch, on stable branches it's out of date.
|
|
||||||
|
|
||||||
v 6.0.0 (unreleased)
|
|
||||||
- handle bithound
|
|
||||||
- check package.json
|
|
||||||
- check .gitlab-ci-yml
|
|
||||||
- check appveyor.yml
|
|
44
README.md
44
README.md
@ -1,44 +0,0 @@
|
|||||||
# 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/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
|
||||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/npmts)
|
|
||||||
[](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
|
||||||
[](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/)
|
|
||||||
[](http://standardjs.com/)
|
|
||||||
|
|
||||||
## Introduction
|
|
||||||
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
|
||||||
|
|
||||||
npmts will
|
|
||||||
|
|
||||||
1. check your dependencies and package.json
|
|
||||||
1. transpile your code with tsc,
|
|
||||||
1. document your code with typedoc,
|
|
||||||
1. test your code with mocha
|
|
||||||
1. create coverage with istanbul
|
|
||||||
|
|
||||||
This works on your machine and in CI. There is a prebuild 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:
|
|
||||||
1. [Intro](https://pushrocks.gitlab.io/npmts/index.html)
|
|
||||||
2. [Install](https://pushrocks.gitlab.io/npmts/install.html)
|
|
||||||
3. [Default Behaviour](https://pushrocks.gitlab.io/npmts/default.html)
|
|
||||||
4. [Configuration](https://pushrocks.gitlab.io/npmts/config.html)
|
|
||||||
5. [Examples](https://pushrocks.gitlab.io/npmts/examples.html)
|
|
||||||
6. [Info](https://pushrocks.gitlab.io/npmts/info.html)
|
|
||||||
|
|
||||||
[](https://push.rocks)
|
|
@ -1,2 +0,0 @@
|
|||||||
#!/usr/bin/env node
|
|
||||||
var index = require("../{{pathToIndex}}");
|
|
@ -1,2 +0,0 @@
|
|||||||
#!/usr/bin/env node
|
|
||||||
var index = require("../dist/index.js");
|
|
4
cli.js
Normal file
4
cli.js
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
process.env.CLI_CALL = 'true';
|
||||||
|
const cliTool = require('./dist_ts/index');
|
||||||
|
cliTool.runCli();
|
5
cli.ts.js
Normal file
5
cli.ts.js
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
process.env.CLI_CALL = 'true';
|
||||||
|
require('@gitzone/tsrun');
|
||||||
|
const cliTool = require('./ts/index');
|
||||||
|
cliTool.runCli();
|
1
dist/index.d.ts
vendored
1
dist/index.d.ts
vendored
@ -0,0 +1 @@
|
|||||||
|
export {};
|
6
dist/index.js
vendored
6
dist/index.js
vendored
@ -1,14 +1,14 @@
|
|||||||
|
"use strict";
|
||||||
/* ================================================== *
|
/* ================================================== *
|
||||||
**** NPMTS ****
|
**** NPMTS ****
|
||||||
Fabulous TypeScript development
|
Fabulous TypeScript development
|
||||||
* ================================================== */
|
* ================================================== */
|
||||||
"use strict";
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
const early = require("early");
|
const early = require("early");
|
||||||
early.start('NPMTS');
|
early.start('NPMTS');
|
||||||
const plugins = require("./npmts.plugins");
|
const plugins = require("./npmts.plugins");
|
||||||
const cli = require("./npmts.cli");
|
const cli = require("./npmts.cli");
|
||||||
early.stop()
|
early.stop().then(() => {
|
||||||
.then(() => {
|
|
||||||
let loaded = plugins; // to make sure plugins get actually loaded
|
let loaded = plugins; // to make sure plugins get actually loaded
|
||||||
cli.run();
|
cli.run();
|
||||||
});
|
});
|
||||||
|
4
dist/mod00/index.d.ts
vendored
4
dist/mod00/index.d.ts
vendored
@ -1,4 +0,0 @@
|
|||||||
/// <reference types="q" />
|
|
||||||
import * as q from 'q';
|
|
||||||
import { INpmtsConfig } from '../npmts.config';
|
|
||||||
export declare let run: (configArg: INpmtsConfig) => q.Promise<INpmtsConfig>;
|
|
22
dist/mod00/index.js
vendored
22
dist/mod00/index.js
vendored
@ -1,22 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
/* ------------------------------------------
|
|
||||||
* This module compiles TypeScript files
|
|
||||||
* -------------------------------------------- */
|
|
||||||
const q = require("q");
|
|
||||||
const npmts_log_1 = require("../npmts.log");
|
|
||||||
const NpmtsAssets = require("./mod00.assets");
|
|
||||||
const NpmtsCheck = require("./mod00.check");
|
|
||||||
const NpmtsClean = require("./mod00.clean");
|
|
||||||
const NpmtsCompile = require("./mod00.compile");
|
|
||||||
exports.run = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
npmts_log_1.npmtsOra.text('starting TypeScript Compilation');
|
|
||||||
NpmtsClean.run(configArg)
|
|
||||||
.then(NpmtsCheck.run)
|
|
||||||
.then(NpmtsCompile.run)
|
|
||||||
.then(NpmtsAssets.run)
|
|
||||||
.then(function () {
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
3
dist/mod00/mod00.assets.d.ts
vendored
3
dist/mod00/mod00.assets.d.ts
vendored
@ -1,3 +0,0 @@
|
|||||||
/// <reference types="q" />
|
|
||||||
import * as q from 'q';
|
|
||||||
export declare var run: (configArg: any) => q.Promise<{}>;
|
|
5
dist/mod00/mod00.check.d.ts
vendored
5
dist/mod00/mod00.check.d.ts
vendored
@ -1,5 +0,0 @@
|
|||||||
/// <reference types="q" />
|
|
||||||
import * as q from 'q';
|
|
||||||
import { ProjectinfoNpm } from 'projectinfo';
|
|
||||||
export declare let projectInfo: ProjectinfoNpm;
|
|
||||||
export declare let run: (configArg: any) => q.Promise<{}>;
|
|
3
dist/mod00/mod00.clean.d.ts
vendored
3
dist/mod00/mod00.clean.d.ts
vendored
@ -1,3 +0,0 @@
|
|||||||
/// <reference types="q" />
|
|
||||||
import * as q from 'q';
|
|
||||||
export declare let run: (configArg: any) => q.Promise<{}>;
|
|
42
dist/mod00/mod00.clean.js
vendored
42
dist/mod00/mod00.clean.js
vendored
@ -1,42 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
const q = require("q");
|
|
||||||
const paths = require("../npmts.paths");
|
|
||||||
const npmts_log_1 = require("../npmts.log");
|
|
||||||
const plugins = require("./mod00.plugins");
|
|
||||||
/**
|
|
||||||
* removes the dist directory which will be entirely rebuild
|
|
||||||
*/
|
|
||||||
let removeDist = function () {
|
|
||||||
npmts_log_1.npmtsOra.text('cleaning dist folder');
|
|
||||||
return plugins.smartfile.fs.remove(paths.distDir);
|
|
||||||
};
|
|
||||||
/**
|
|
||||||
* remove .d.ts files from testDirctory
|
|
||||||
*/
|
|
||||||
let removeTestDeclarations = function () {
|
|
||||||
let done = q.defer();
|
|
||||||
plugins.smartfile.fs.listFileTree('./test/', '**/*.d.ts').then(fileArray => {
|
|
||||||
let fileArrayToRemove = plugins.smartpath.transform.toAbsolute(fileArray, process.cwd() + '//test/');
|
|
||||||
plugins.smartfile.fs.removeManySync(fileArrayToRemove);
|
|
||||||
done.resolve();
|
|
||||||
});
|
|
||||||
};
|
|
||||||
/**
|
|
||||||
* remove old pages
|
|
||||||
*/
|
|
||||||
let removePages = function () {
|
|
||||||
npmts_log_1.npmtsOra.text('cleaning pages folder');
|
|
||||||
return plugins.smartfile.fs.remove(paths.pagesDir);
|
|
||||||
};
|
|
||||||
exports.run = function (configArg) {
|
|
||||||
npmts_log_1.npmtsOra.text('cleaning up from previous builds...');
|
|
||||||
let done = q.defer();
|
|
||||||
removeDist()
|
|
||||||
.then(removeTestDeclarations)
|
|
||||||
.then(removePages)
|
|
||||||
.then(function () {
|
|
||||||
plugins.beautylog.ok('Cleaned up from previous builds!');
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
3
dist/mod00/mod00.compile.d.ts
vendored
3
dist/mod00/mod00.compile.d.ts
vendored
@ -1,3 +0,0 @@
|
|||||||
/// <reference types="q" />
|
|
||||||
import * as q from 'q';
|
|
||||||
export declare let run: (configArg: any) => q.Promise<{}>;
|
|
21
dist/mod00/mod00.compile.js
vendored
21
dist/mod00/mod00.compile.js
vendored
@ -1,21 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
const q = require("q");
|
|
||||||
const paths = require("../npmts.paths");
|
|
||||||
const npmts_log_1 = require("../npmts.log");
|
|
||||||
const plugins = require("./mod00.plugins");
|
|
||||||
exports.run = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
let config = configArg;
|
|
||||||
npmts_log_1.npmtsOra.text('now compiling ' + 'TypeScript'.yellow);
|
|
||||||
plugins.tsn.compileGlobStringObject(config.ts, config.tsOptions, paths.cwd)
|
|
||||||
.then(() => {
|
|
||||||
plugins.beautylog.ok('compiled main TypeScript!');
|
|
||||||
plugins.beautylog.log('now compiling tests!');
|
|
||||||
return plugins.tsn.compileGlobStringObject(config.testTs, config.tsOptions, paths.cwd);
|
|
||||||
})
|
|
||||||
.then(function () {
|
|
||||||
plugins.beautylog.ok('compiled all TypeScript!');
|
|
||||||
done.resolve(config);
|
|
||||||
}).catch(err => { console.log(err); });
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
4
dist/mod01/index.d.ts
vendored
4
dist/mod01/index.d.ts
vendored
@ -1,4 +0,0 @@
|
|||||||
/// <reference types="q" />
|
|
||||||
import * as q from 'q';
|
|
||||||
import { INpmtsConfig } from '../npmts.config';
|
|
||||||
export declare let run: (configArg: INpmtsConfig) => q.Promise<INpmtsConfig>;
|
|
54
dist/mod01/index.js
vendored
54
dist/mod01/index.js
vendored
@ -1,54 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
/* ------------------------------------------
|
|
||||||
* This module creates TypeScript documentation
|
|
||||||
* -------------------------------------------- */
|
|
||||||
const q = require("q");
|
|
||||||
const paths = require("../npmts.paths");
|
|
||||||
const npmts_log_1 = require("../npmts.log");
|
|
||||||
const plugins = require("./mod01.plugins");
|
|
||||||
const mod00_check_1 = require("../mod00/mod00.check");
|
|
||||||
let genTypeDoc = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
npmts_log_1.npmtsOra.text('now generating ' + 'TypeDoc documentation'.yellow);
|
|
||||||
plugins.beautylog.log('TypeDoc Output:');
|
|
||||||
let localSmartstream = new plugins.smartstream.Smartstream([
|
|
||||||
plugins.gulp.src(plugins.path.join(paths.tsDir, '**/*.ts')),
|
|
||||||
plugins.gulpTypedoc({
|
|
||||||
// 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: mod00_check_1.projectInfo.name,
|
|
||||||
readme: plugins.path.join(paths.cwd, 'README.md'),
|
|
||||||
// theme: "default",
|
|
||||||
version: true
|
|
||||||
})
|
|
||||||
]);
|
|
||||||
localSmartstream.run().then(() => {
|
|
||||||
plugins.beautylog.ok('TypeDoc documentation generated!');
|
|
||||||
done.resolve(configArg);
|
|
||||||
}, (err) => {
|
|
||||||
plugins.beautylog.warn('TypeDoc documentation generation failed!');
|
|
||||||
console.log(err);
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
exports.run = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
if (configArg.docs) {
|
|
||||||
genTypeDoc(configArg)
|
|
||||||
.then(() => {
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
done.resolve(configArg);
|
|
||||||
}
|
|
||||||
;
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
4
dist/mod01/mod01.plugins.d.ts
vendored
4
dist/mod01/mod01.plugins.d.ts
vendored
@ -1,4 +0,0 @@
|
|||||||
export * from '../npmts.plugins';
|
|
||||||
import * as gulp from 'gulp';
|
|
||||||
declare let gulpTypedoc: any;
|
|
||||||
export { gulp, gulpTypedoc };
|
|
4
dist/mod02/index.d.ts
vendored
4
dist/mod02/index.d.ts
vendored
@ -1,4 +0,0 @@
|
|||||||
/// <reference types="q" />
|
|
||||||
import * as q from 'q';
|
|
||||||
import { INpmtsConfig } from '../npmts.config';
|
|
||||||
export declare let run: (configArg: INpmtsConfig) => q.Promise<INpmtsConfig>;
|
|
109
dist/mod02/index.js
vendored
109
dist/mod02/index.js
vendored
@ -1,109 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
/* ------------------------------------------
|
|
||||||
* This module tests the compiled TypeScript files
|
|
||||||
* -------------------------------------------- */
|
|
||||||
const plugins = require("./mod02.plugins");
|
|
||||||
const paths = require("../npmts.paths");
|
|
||||||
const q = require("q");
|
|
||||||
const npmts_log_1 = require("../npmts.log");
|
|
||||||
/**
|
|
||||||
* runs mocha
|
|
||||||
* @returns INpmtsConfig
|
|
||||||
*/
|
|
||||||
let mocha = function (configArg) {
|
|
||||||
npmts_log_1.npmtsOra.text('Instrumentalizing and testing transpiled JS');
|
|
||||||
npmts_log_1.npmtsOra.end(); // end npmtsOra for tests.
|
|
||||||
let done = q.defer();
|
|
||||||
let coverageSmartstream = new plugins.smartstream.Smartstream([
|
|
||||||
plugins.gulp.src([plugins.path.join(paths.cwd, './dist/**/*.js')]),
|
|
||||||
plugins.gulpSourcemaps.init(),
|
|
||||||
plugins.gulpBabel({
|
|
||||||
presets: [
|
|
||||||
require.resolve('babel-preset-es2015')
|
|
||||||
]
|
|
||||||
}),
|
|
||||||
plugins.gulpIstanbul({}),
|
|
||||||
plugins.gulpSourcemaps.write(),
|
|
||||||
plugins.gulpInjectModules(),
|
|
||||||
plugins.through2.obj((file, enc, cb) => {
|
|
||||||
console.log(file);
|
|
||||||
cb();
|
|
||||||
}, (cb) => {
|
|
||||||
cb();
|
|
||||||
})
|
|
||||||
]);
|
|
||||||
let localSmartstream = new plugins.smartstream.Smartstream([
|
|
||||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')]),
|
|
||||||
plugins.gulpBabel({
|
|
||||||
presets: [
|
|
||||||
require.resolve('babel-preset-es2015')
|
|
||||||
]
|
|
||||||
}),
|
|
||||||
plugins.gulpInjectModules(),
|
|
||||||
plugins.gulpMocha(),
|
|
||||||
plugins.gulpIstanbul.writeReports({
|
|
||||||
dir: plugins.path.join(paths.cwd, './coverage'),
|
|
||||||
reporters: ['lcovonly', 'json', 'text', 'text-summary']
|
|
||||||
})
|
|
||||||
]);
|
|
||||||
coverageSmartstream.run()
|
|
||||||
.then(() => {
|
|
||||||
plugins.beautylog.info('code is now transpiled to ES5, instrumented with istanbul, and injected for mocha!');
|
|
||||||
return localSmartstream.run()
|
|
||||||
.then(() => { done.resolve(configArg); }, (err) => {
|
|
||||||
plugins.beautylog.error('Tests failed!');
|
|
||||||
console.log(err);
|
|
||||||
if (configArg.watch) {
|
|
||||||
done.resolve(configArg);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}, (err) => {
|
|
||||||
console.log(err);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
let coverage = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, 'lcov.info'), 2)
|
|
||||||
.then(function (percentageArg) {
|
|
||||||
if (percentageArg >= configArg.coverageTreshold) {
|
|
||||||
plugins.beautylog.ok(`${percentageArg.toString()}% `
|
|
||||||
+ `coverage exceeds your treshold of `
|
|
||||||
+ `${configArg.coverageTreshold.toString()}%`);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.warn(`${percentageArg.toString()}% `
|
|
||||||
+ `coverage fails your treshold of `
|
|
||||||
+ `${configArg.coverageTreshold.toString()}%`);
|
|
||||||
plugins.beautylog.error('exiting due to coverage failure');
|
|
||||||
if (!configArg.watch) {
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
exports.run = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
let config = configArg;
|
|
||||||
if (config.test === true) {
|
|
||||||
npmts_log_1.npmtsOra.text('now starting tests');
|
|
||||||
plugins.beautylog.log('------------------------------------------------------\n' +
|
|
||||||
'*************************** TESTS: ***************************\n' +
|
|
||||||
'--------------------------------------------------------------');
|
|
||||||
mocha(config)
|
|
||||||
.then(coverage)
|
|
||||||
.then(() => {
|
|
||||||
done.resolve(config);
|
|
||||||
}).catch(err => { console.log(err); });
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
npmts_log_1.npmtsOra.end();
|
|
||||||
done.resolve(config);
|
|
||||||
}
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
9
dist/mod02/mod02.plugins.d.ts
vendored
9
dist/mod02/mod02.plugins.d.ts
vendored
@ -1,9 +0,0 @@
|
|||||||
export * from '../npmts.plugins';
|
|
||||||
import * as gulp from 'gulp';
|
|
||||||
import * as gulpBabel from 'gulp-babel';
|
|
||||||
import * as gulpIstanbul from 'gulp-istanbul';
|
|
||||||
import * as gulpFunction from 'gulp-function';
|
|
||||||
declare let gulpInjectModules: any;
|
|
||||||
import * as gulpMocha from 'gulp-mocha';
|
|
||||||
import * as gulpSourcemaps from 'gulp-sourcemaps';
|
|
||||||
export { gulp, gulpBabel, gulpIstanbul, gulpFunction, gulpInjectModules, gulpMocha, gulpSourcemaps };
|
|
19
dist/mod02/mod02.plugins.js
vendored
19
dist/mod02/mod02.plugins.js
vendored
@ -1,19 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
function __export(m) {
|
|
||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
|
||||||
}
|
|
||||||
__export(require("../npmts.plugins"));
|
|
||||||
const gulp = require("gulp");
|
|
||||||
exports.gulp = gulp;
|
|
||||||
const gulpBabel = require("gulp-babel");
|
|
||||||
exports.gulpBabel = gulpBabel;
|
|
||||||
const gulpIstanbul = require("gulp-istanbul");
|
|
||||||
exports.gulpIstanbul = gulpIstanbul;
|
|
||||||
const gulpFunction = require("gulp-function");
|
|
||||||
exports.gulpFunction = gulpFunction;
|
|
||||||
let gulpInjectModules = require('gulp-inject-modules');
|
|
||||||
exports.gulpInjectModules = gulpInjectModules;
|
|
||||||
const gulpMocha = require("gulp-mocha");
|
|
||||||
exports.gulpMocha = gulpMocha;
|
|
||||||
const gulpSourcemaps = require("gulp-sourcemaps");
|
|
||||||
exports.gulpSourcemaps = gulpSourcemaps;
|
|
2
dist/mod_compile/index.d.ts
vendored
Normal file
2
dist/mod_compile/index.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
import { INpmtsConfig } from '../npmts.config';
|
||||||
|
export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;
|
24
dist/mod_compile/index.js
vendored
Normal file
24
dist/mod_compile/index.js
vendored
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
"use strict";
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
/* ------------------------------------------
|
||||||
|
* This module compiles the module's TypeScript files
|
||||||
|
* Note: Test files are only compiled in memory
|
||||||
|
* -------------------------------------------- */
|
||||||
|
const q = require("smartq");
|
||||||
|
const plugins = require("./mod.plugins");
|
||||||
|
const NpmtsAssets = require("./mod.assets");
|
||||||
|
const NpmtsCheck = require("./mod.check");
|
||||||
|
const NpmtsClean = require("./mod.clean");
|
||||||
|
const NpmtsCompile = require("./mod.compile");
|
||||||
|
exports.run = function (configArg) {
|
||||||
|
let done = q.defer();
|
||||||
|
plugins.beautylog.ora.text('starting TypeScript Compilation');
|
||||||
|
NpmtsClean.run(configArg)
|
||||||
|
.then(NpmtsCheck.run)
|
||||||
|
.then(NpmtsCompile.run)
|
||||||
|
.then(NpmtsAssets.run)
|
||||||
|
.then(function () {
|
||||||
|
done.resolve(configArg);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
1
dist/mod_compile/mod.assets.d.ts
vendored
Normal file
1
dist/mod_compile/mod.assets.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
export declare let run: (configArg: any) => Promise<{}>;
|
@ -1,15 +1,15 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
const q = require("q");
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
const q = require("smartq");
|
||||||
const paths = require("../npmts.paths");
|
const paths = require("../npmts.paths");
|
||||||
const npmts_log_1 = require("../npmts.log");
|
const plugins = require("./mod.plugins");
|
||||||
const plugins = require("./mod00.plugins");
|
const mod_check_1 = require("../mod_compile/mod.check");
|
||||||
const mod00_check_1 = require("../mod00/mod00.check");
|
|
||||||
exports.run = function (configArg) {
|
exports.run = function (configArg) {
|
||||||
let done = q.defer();
|
let done = q.defer();
|
||||||
let config = configArg;
|
let config = configArg;
|
||||||
npmts_log_1.npmtsOra.text('now looking at ' + 'required assets'.yellow);
|
plugins.beautylog.ora.text('now looking at ' + 'required assets');
|
||||||
if (config.cli === true) {
|
if (config.cli === true) {
|
||||||
let mainJsPath = mod00_check_1.projectInfo.packageJson.main;
|
let mainJsPath = mod_check_1.projectInfo.packageJson.main;
|
||||||
let cliJsString = plugins.smartfile.fs.toStringSync(plugins.path.join(paths.npmtsAssetsDir, 'cli.js'));
|
let cliJsString = plugins.smartfile.fs.toStringSync(plugins.path.join(paths.npmtsAssetsDir, 'cli.js'));
|
||||||
cliJsString = cliJsString.replace('{{pathToIndex}}', mainJsPath);
|
cliJsString = cliJsString.replace('{{pathToIndex}}', mainJsPath);
|
||||||
plugins.smartfile.memory.toFsSync(cliJsString, plugins.path.join(paths.distDir, 'cli.js'));
|
plugins.smartfile.memory.toFsSync(cliJsString, plugins.path.join(paths.distDir, 'cli.js'));
|
4
dist/mod_compile/mod.check.d.ts
vendored
Normal file
4
dist/mod_compile/mod.check.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
import { ProjectinfoNpm } from 'projectinfo';
|
||||||
|
import { INpmtsConfig } from '../npmts.config';
|
||||||
|
export declare let projectInfo: ProjectinfoNpm;
|
||||||
|
export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;
|
@ -1,50 +1,62 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
const q = require("q");
|
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
||||||
|
return new (P || (P = Promise))(function (resolve, reject) {
|
||||||
|
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
||||||
|
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
||||||
|
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
|
||||||
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
||||||
|
});
|
||||||
|
};
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
const q = require("smartq");
|
||||||
const projectinfo_1 = require("projectinfo");
|
const projectinfo_1 = require("projectinfo");
|
||||||
const paths = require("../npmts.paths");
|
const paths = require("../npmts.paths");
|
||||||
const npmts_log_1 = require("../npmts.log");
|
const plugins = require("./mod.plugins");
|
||||||
const plugins = require("./mod00.plugins");
|
|
||||||
let checkProjectTypings = (configArg) => {
|
let checkProjectTypings = (configArg) => {
|
||||||
let done = q.defer();
|
let done = q.defer();
|
||||||
npmts_log_1.npmtsOra.text('Check Module: Check Project Typings...');
|
plugins.beautylog.ora.text('Check Module: Check Project Typings...');
|
||||||
exports.projectInfo = new projectinfo_1.ProjectinfoNpm(paths.cwd);
|
exports.projectInfo = new projectinfo_1.ProjectinfoNpm(paths.cwd);
|
||||||
if (typeof exports.projectInfo.packageJson.typings === 'undefined') {
|
if (typeof exports.projectInfo.packageJson.typings === 'undefined') {
|
||||||
plugins.beautylog.error(`please add typings field to package.json`);
|
plugins.beautylog.error(`please add typings field to package.json`);
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
;
|
|
||||||
done.resolve(configArg);
|
done.resolve(configArg);
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
const depcheckOptions = {
|
const depcheckOptions = {
|
||||||
ignoreBinPackage: false,
|
ignoreBinPackage: false,
|
||||||
parsers: {
|
parsers: {
|
||||||
|
// the target parsers
|
||||||
'*.ts': plugins.depcheck.parser.typescript
|
'*.ts': plugins.depcheck.parser.typescript
|
||||||
},
|
},
|
||||||
detectors: [
|
detectors: [
|
||||||
|
// the target detectors
|
||||||
plugins.depcheck.detector.requireCallExpression,
|
plugins.depcheck.detector.requireCallExpression,
|
||||||
plugins.depcheck.detector.importDeclaration
|
plugins.depcheck.detector.importDeclaration
|
||||||
],
|
],
|
||||||
specials: [
|
specials: [
|
||||||
|
// the target special parsers
|
||||||
plugins.depcheck.special.eslint,
|
plugins.depcheck.special.eslint,
|
||||||
plugins.depcheck.special.webpack
|
plugins.depcheck.special.webpack
|
||||||
]
|
]
|
||||||
};
|
};
|
||||||
let checkDependencies = (configArg) => {
|
let checkDependencies = (configArg) => {
|
||||||
let done = q.defer();
|
let done = q.defer();
|
||||||
npmts_log_1.npmtsOra.text('Check Module: Check Dependencies...');
|
plugins.beautylog.ora.text('Check Module: Check Dependencies...');
|
||||||
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
|
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
|
||||||
ignoreDirs: [
|
ignoreDirs: [
|
||||||
|
// folder with these names will be ignored
|
||||||
'test',
|
'test',
|
||||||
'dist',
|
'dist',
|
||||||
'bower_components'
|
'bower_components'
|
||||||
],
|
],
|
||||||
ignoreMatches: [
|
ignoreMatches: [
|
||||||
|
// ignore dependencies that matches these globs
|
||||||
'@types/*',
|
'@types/*',
|
||||||
'babel-preset-*'
|
'babel-preset-*'
|
||||||
]
|
]
|
||||||
});
|
});
|
||||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
plugins.depcheck(paths.cwd, depcheckOptionsMerged, unused => {
|
||||||
for (let item of unused.dependencies) {
|
for (let item of unused.dependencies) {
|
||||||
plugins.beautylog.warn(`Watch out: unused dependency "${item}"`);
|
plugins.beautylog.warn(`Watch out: unused dependency "${item}"`);
|
||||||
}
|
}
|
||||||
@ -56,11 +68,10 @@ let checkDependencies = (configArg) => {
|
|||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
for (let item in unused.invalidFiles) {
|
for (let item in unused.invalidFiles) {
|
||||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
plugins.beautylog.warn(`Watch out: could not parse file ${item}`);
|
||||||
}
|
}
|
||||||
;
|
|
||||||
for (let item in unused.invalidDirs) {
|
for (let item in unused.invalidDirs) {
|
||||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
|
plugins.beautylog.warn(`Watch out: could not parse directory ${item}`);
|
||||||
}
|
}
|
||||||
done.resolve(configArg);
|
done.resolve(configArg);
|
||||||
});
|
});
|
||||||
@ -68,34 +79,36 @@ let checkDependencies = (configArg) => {
|
|||||||
};
|
};
|
||||||
let checkDevDependencies = (configArg) => {
|
let checkDevDependencies = (configArg) => {
|
||||||
let done = q.defer();
|
let done = q.defer();
|
||||||
npmts_log_1.npmtsOra.text('Check Module: Check devDependencies...');
|
plugins.beautylog.ora.text('Check Module: Check devDependencies...');
|
||||||
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
|
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
|
||||||
ignoreDirs: [
|
ignoreDirs: [
|
||||||
|
// folder with these names will be ignored
|
||||||
'ts',
|
'ts',
|
||||||
'dist',
|
'dist',
|
||||||
'bower_components'
|
'bower_components'
|
||||||
],
|
],
|
||||||
ignoreMatches: [
|
ignoreMatches: [
|
||||||
|
// ignore dependencies that matches these globs
|
||||||
'@types/*',
|
'@types/*',
|
||||||
'babel-preset-*'
|
'babel-preset-*'
|
||||||
]
|
]
|
||||||
});
|
});
|
||||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
plugins.depcheck(paths.cwd, depcheckOptionsMerged, unused => {
|
||||||
for (let item of unused.devDependencies) {
|
for (let item of unused.devDependencies) {
|
||||||
plugins.beautylog.log(`unused devDependency ${item.red}`);
|
plugins.beautylog.log(`unused devDependency ${item}`);
|
||||||
}
|
}
|
||||||
for (let item in unused.missing) {
|
for (let item in unused.missing) {
|
||||||
plugins.beautylog.error(`unused devDependency ${item.red}`);
|
plugins.beautylog.error(`missing devDependency ${item}`);
|
||||||
}
|
}
|
||||||
if (unused.missing.length > 0) {
|
if (unused.missing.length > 0) {
|
||||||
plugins.beautylog.info('exiting due to missing dependencies in package.json');
|
plugins.beautylog.info('exiting due to missing dependencies in package.json');
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
for (let item in unused.invalidFiles) {
|
for (let item in unused.invalidFiles) {
|
||||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
plugins.beautylog.warn(`Watch out: could not parse file ${item}`);
|
||||||
}
|
}
|
||||||
for (let item in unused.invalidDirs) {
|
for (let item in unused.invalidDirs) {
|
||||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
|
plugins.beautylog.warn(`Watch out: could not parse directory ${item}`);
|
||||||
}
|
}
|
||||||
done.resolve(configArg);
|
done.resolve(configArg);
|
||||||
});
|
});
|
||||||
@ -103,18 +116,21 @@ let checkDevDependencies = (configArg) => {
|
|||||||
};
|
};
|
||||||
let checkNodeVersion = (configArg) => {
|
let checkNodeVersion = (configArg) => {
|
||||||
let done = q.defer();
|
let done = q.defer();
|
||||||
npmts_log_1.npmtsOra.text('checking node version');
|
plugins.beautylog.ora.text('checking node version');
|
||||||
done.resolve(configArg);
|
done.resolve(configArg);
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
exports.run = (configArg) => {
|
exports.run = (configArg) => __awaiter(this, void 0, void 0, function* () {
|
||||||
let done = q.defer();
|
plugins.beautylog.ora.text('Check Module: ...');
|
||||||
npmts_log_1.npmtsOra.text('Check Module: ...');
|
if (configArg.checkDependencies) {
|
||||||
checkProjectTypings(configArg)
|
configArg = yield checkProjectTypings(configArg);
|
||||||
.then(checkDependencies)
|
configArg = yield checkDependencies(configArg);
|
||||||
.then(checkDevDependencies)
|
configArg = yield checkDevDependencies(configArg);
|
||||||
.then(checkNodeVersion)
|
configArg = yield checkNodeVersion(configArg);
|
||||||
.then(done.resolve)
|
return configArg;
|
||||||
.catch((err) => { console.log(err); });
|
}
|
||||||
return done.promise;
|
else {
|
||||||
};
|
configArg = yield checkProjectTypings(configArg);
|
||||||
|
return configArg;
|
||||||
|
}
|
||||||
|
});
|
1
dist/mod_compile/mod.clean.d.ts
vendored
Normal file
1
dist/mod_compile/mod.clean.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
export declare let run: (configArg: any) => Promise<{}>;
|
30
dist/mod_compile/mod.clean.js
vendored
Normal file
30
dist/mod_compile/mod.clean.js
vendored
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
"use strict";
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
const q = require("smartq");
|
||||||
|
const paths = require("../npmts.paths");
|
||||||
|
const plugins = require("./mod.plugins");
|
||||||
|
/**
|
||||||
|
* removes the dist directory which will be entirely rebuild
|
||||||
|
*/
|
||||||
|
let removeDist = function () {
|
||||||
|
plugins.beautylog.ora.text('cleaning dist folder');
|
||||||
|
return plugins.smartfile.fs.remove(paths.distDir);
|
||||||
|
};
|
||||||
|
/**
|
||||||
|
* remove old pages
|
||||||
|
*/
|
||||||
|
let removePages = function () {
|
||||||
|
plugins.beautylog.ora.text('cleaning pages folder');
|
||||||
|
return plugins.smartfile.fs.remove(paths.pagesDir);
|
||||||
|
};
|
||||||
|
exports.run = function (configArg) {
|
||||||
|
plugins.beautylog.ora.text('cleaning up from previous builds...');
|
||||||
|
let done = q.defer();
|
||||||
|
removeDist()
|
||||||
|
.then(removePages)
|
||||||
|
.then(function () {
|
||||||
|
plugins.beautylog.ok('Cleaned up from previous builds!');
|
||||||
|
done.resolve(configArg);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
1
dist/mod_compile/mod.compile.d.ts
vendored
Normal file
1
dist/mod_compile/mod.compile.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
export declare let run: (configArg: any) => Promise<{}>;
|
20
dist/mod_compile/mod.compile.js
vendored
Normal file
20
dist/mod_compile/mod.compile.js
vendored
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
"use strict";
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
const q = require("smartq");
|
||||||
|
const paths = require("../npmts.paths");
|
||||||
|
const plugins = require("./mod.plugins");
|
||||||
|
exports.run = function (configArg) {
|
||||||
|
let done = q.defer();
|
||||||
|
let config = configArg;
|
||||||
|
plugins.beautylog.ora.text('now compiling ' + 'TypeScript');
|
||||||
|
plugins.tsn
|
||||||
|
.compileGlobStringObject(config.ts, config.tsOptions, paths.cwd)
|
||||||
|
.then(() => {
|
||||||
|
plugins.beautylog.ok(`compiled the module's TypeScript!`);
|
||||||
|
done.resolve(config);
|
||||||
|
})
|
||||||
|
.catch(err => {
|
||||||
|
console.log(err);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
@ -1,6 +1,5 @@
|
|||||||
export * from '../npmts.plugins';
|
export * from '../npmts.plugins';
|
||||||
import * as tsn from 'tsn';
|
import * as tsn from 'tsn';
|
||||||
import * as shelljs from 'shelljs';
|
|
||||||
import * as smartchok from 'smartchok';
|
import * as smartchok from 'smartchok';
|
||||||
import * as smartstream from 'smartstream';
|
import * as smartstream from 'smartstream';
|
||||||
export { tsn, shelljs, smartchok, smartstream };
|
export { tsn, smartchok, smartstream };
|
@ -2,11 +2,10 @@
|
|||||||
function __export(m) {
|
function __export(m) {
|
||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
||||||
}
|
}
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
__export(require("../npmts.plugins"));
|
__export(require("../npmts.plugins"));
|
||||||
const tsn = require("tsn");
|
const tsn = require("tsn");
|
||||||
exports.tsn = tsn;
|
exports.tsn = tsn;
|
||||||
const shelljs = require("shelljs");
|
|
||||||
exports.shelljs = shelljs;
|
|
||||||
const smartchok = require("smartchok");
|
const smartchok = require("smartchok");
|
||||||
exports.smartchok = smartchok;
|
exports.smartchok = smartchok;
|
||||||
const smartstream = require("smartstream");
|
const smartstream = require("smartstream");
|
2
dist/mod_docs/index.d.ts
vendored
Normal file
2
dist/mod_docs/index.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
import { INpmtsConfig } from '../npmts.config';
|
||||||
|
export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;
|
11
dist/mod_docs/index.js
vendored
Normal file
11
dist/mod_docs/index.js
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
"use strict";
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
/* ------------------------------------------
|
||||||
|
* This module creates TypeScript documentation
|
||||||
|
* -------------------------------------------- */
|
||||||
|
const q = require("smartq");
|
||||||
|
exports.run = function (configArg) {
|
||||||
|
let done = q.defer();
|
||||||
|
done.resolve(configArg);
|
||||||
|
return done.promise;
|
||||||
|
};
|
1
dist/mod_docs/mod.plugins.d.ts
vendored
Normal file
1
dist/mod_docs/mod.plugins.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
export * from '../npmts.plugins';
|
@ -2,8 +2,5 @@
|
|||||||
function __export(m) {
|
function __export(m) {
|
||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
||||||
}
|
}
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
__export(require("../npmts.plugins"));
|
__export(require("../npmts.plugins"));
|
||||||
const gulp = require("gulp");
|
|
||||||
exports.gulp = gulp;
|
|
||||||
let gulpTypedoc = require('gulp-typedoc');
|
|
||||||
exports.gulpTypedoc = gulpTypedoc;
|
|
6
dist/mod_test/index.d.ts
vendored
Normal file
6
dist/mod_test/index.d.ts
vendored
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
import { INpmtsConfig } from '../npmts.config';
|
||||||
|
/**
|
||||||
|
* run this module
|
||||||
|
* @param configArg some config for how to run this module
|
||||||
|
*/
|
||||||
|
export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;
|
132
dist/mod_test/index.js
vendored
Normal file
132
dist/mod_test/index.js
vendored
Normal file
@ -0,0 +1,132 @@
|
|||||||
|
"use strict";
|
||||||
|
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
||||||
|
return new (P || (P = Promise))(function (resolve, reject) {
|
||||||
|
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
||||||
|
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
||||||
|
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
|
||||||
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
||||||
|
});
|
||||||
|
};
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
/* ------------------------------------------
|
||||||
|
* This module tests the compiled TypeScript files
|
||||||
|
* -------------------------------------------- */
|
||||||
|
const plugins = require("./mod.plugins");
|
||||||
|
const paths = require("../npmts.paths");
|
||||||
|
const q = require("smartq");
|
||||||
|
let testTypeScriptConfig = {
|
||||||
|
target: 'ES5',
|
||||||
|
emitDecoratorMetadata: true,
|
||||||
|
experimentalDecorators: true,
|
||||||
|
lib: ['DOM', 'ESNext']
|
||||||
|
};
|
||||||
|
/**
|
||||||
|
* runs mocha
|
||||||
|
* @returns INpmtsConfig
|
||||||
|
*/
|
||||||
|
let tap = function (configArg) {
|
||||||
|
let done = q.defer();
|
||||||
|
/**
|
||||||
|
* the TabBuffer for npmts
|
||||||
|
*/
|
||||||
|
let npmtsTapBuffer = new plugins.tapbuffer.TabBuffer();
|
||||||
|
npmtsTapBuffer.setConfig(configArg.testConfig);
|
||||||
|
/**
|
||||||
|
* handle the testable files
|
||||||
|
*/
|
||||||
|
let testableFilesSmartstream = new plugins.smartstream.Smartstream([
|
||||||
|
plugins.smartgulp.src([plugins.path.join(paths.cwd, './ts/**/*.ts')]),
|
||||||
|
plugins.gulpSourcemaps.init(),
|
||||||
|
plugins.gulpTypeScript(testTypeScriptConfig),
|
||||||
|
plugins.gulpSourcemaps.write(),
|
||||||
|
npmtsTapBuffer.pipeTestableFiles(),
|
||||||
|
plugins.smartstream.cleanPipe()
|
||||||
|
]);
|
||||||
|
/**
|
||||||
|
* handle the test files
|
||||||
|
*/
|
||||||
|
let testFilesSmartstream = new plugins.smartstream.Smartstream([
|
||||||
|
plugins.smartgulp.src([plugins.path.join(paths.cwd, 'test/*.ts')]),
|
||||||
|
plugins.gulpSourcemaps.init(),
|
||||||
|
plugins.gulpTypeScript(testTypeScriptConfig),
|
||||||
|
plugins.gulpSourcemaps.write(),
|
||||||
|
npmtsTapBuffer.pipeTestFiles(),
|
||||||
|
plugins.smartstream.cleanPipe()
|
||||||
|
]);
|
||||||
|
// lets run the smartstream
|
||||||
|
Promise.all([testableFilesSmartstream.run(), testFilesSmartstream.run()]).then(() => __awaiter(this, void 0, void 0, function* () {
|
||||||
|
configArg.runData.coverageLcovInfo = yield npmtsTapBuffer.runTests();
|
||||||
|
done.resolve(configArg);
|
||||||
|
}), err => {
|
||||||
|
plugins.beautylog.error('Tests failed!');
|
||||||
|
console.log(err);
|
||||||
|
if (configArg.watch) {
|
||||||
|
done.resolve(configArg);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
let handleCoverageData = (configArg) => __awaiter(this, void 0, void 0, function* () {
|
||||||
|
let coverageResult = 0; // the coverage in percent
|
||||||
|
if (configArg.runData.coverageLcovInfo) {
|
||||||
|
coverageResult = yield plugins.smartcov.get.percentageFromLcovString(configArg.runData.coverageLcovInfo, 2);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
plugins.beautylog.warn('Hey... Did your tests import and use your module that you are trying to test?');
|
||||||
|
}
|
||||||
|
if (coverageResult >= configArg.coverageTreshold) {
|
||||||
|
plugins.beautylog.ok(`${coverageResult.toString()}% ` +
|
||||||
|
`coverage exceeds your treshold of ` +
|
||||||
|
`${configArg.coverageTreshold.toString()}%`);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
plugins.beautylog.warn(`${coverageResult.toString()}% ` +
|
||||||
|
`coverage fails your treshold of ` +
|
||||||
|
`${configArg.coverageTreshold.toString()}%`);
|
||||||
|
plugins.beautylog.error('exiting due to coverage failure');
|
||||||
|
if (!configArg.watch) {
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return configArg;
|
||||||
|
});
|
||||||
|
/**
|
||||||
|
* run this module
|
||||||
|
* @param configArg some config for how to run this module
|
||||||
|
*/
|
||||||
|
exports.run = function (configArg) {
|
||||||
|
let done = q.defer();
|
||||||
|
let config = configArg;
|
||||||
|
if (config.test === true) {
|
||||||
|
plugins.beautylog.ora.text('now starting tests');
|
||||||
|
plugins.beautylog.ora.end();
|
||||||
|
plugins.beautylog.log('ready for tapbuffer:');
|
||||||
|
if (configArg.testConfig.coverage) {
|
||||||
|
tap(config)
|
||||||
|
.then(handleCoverageData)
|
||||||
|
.then(() => {
|
||||||
|
done.resolve(config);
|
||||||
|
})
|
||||||
|
.catch(err => {
|
||||||
|
console.log(err);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
tap(config)
|
||||||
|
.then(() => {
|
||||||
|
done.resolve(config);
|
||||||
|
})
|
||||||
|
.catch(err => {
|
||||||
|
console.log(err);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
plugins.beautylog.ora.end();
|
||||||
|
done.resolve(config);
|
||||||
|
}
|
||||||
|
return done.promise;
|
||||||
|
};
|
8
dist/mod_test/mod.plugins.d.ts
vendored
Normal file
8
dist/mod_test/mod.plugins.d.ts
vendored
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
export * from '../npmts.plugins';
|
||||||
|
import * as gulpFunction from 'gulp-function';
|
||||||
|
import * as gulpSourcemaps from 'gulp-sourcemaps';
|
||||||
|
import * as gulpTypeScript from 'gulp-typescript';
|
||||||
|
import * as smartcov from 'smartcov';
|
||||||
|
import * as smartgulp from 'smartgulp';
|
||||||
|
import * as tapbuffer from 'tapbuffer';
|
||||||
|
export { gulpFunction, gulpSourcemaps, gulpTypeScript, smartcov, smartgulp, tapbuffer };
|
18
dist/mod_test/mod.plugins.js
vendored
Normal file
18
dist/mod_test/mod.plugins.js
vendored
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
"use strict";
|
||||||
|
function __export(m) {
|
||||||
|
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
||||||
|
}
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
__export(require("../npmts.plugins"));
|
||||||
|
const gulpFunction = require("gulp-function");
|
||||||
|
exports.gulpFunction = gulpFunction;
|
||||||
|
const gulpSourcemaps = require("gulp-sourcemaps");
|
||||||
|
exports.gulpSourcemaps = gulpSourcemaps;
|
||||||
|
const gulpTypeScript = require("gulp-typescript");
|
||||||
|
exports.gulpTypeScript = gulpTypeScript;
|
||||||
|
const smartcov = require("smartcov");
|
||||||
|
exports.smartcov = smartcov;
|
||||||
|
const smartgulp = require("smartgulp");
|
||||||
|
exports.smartgulp = smartgulp;
|
||||||
|
const tapbuffer = require("tapbuffer");
|
||||||
|
exports.tapbuffer = tapbuffer;
|
4
dist/npmts.cli.d.ts
vendored
4
dist/npmts.cli.d.ts
vendored
@ -1,3 +1 @@
|
|||||||
/// <reference types="q" />
|
export declare let run: () => Promise<{}>;
|
||||||
import * as q from 'q';
|
|
||||||
export declare let run: () => q.Promise<{}>;
|
|
||||||
|
104
dist/npmts.cli.js
vendored
104
dist/npmts.cli.js
vendored
@ -1,34 +1,76 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
const q = require("q");
|
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
||||||
|
return new (P || (P = Promise))(function (resolve, reject) {
|
||||||
|
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
||||||
|
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
||||||
|
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
|
||||||
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
||||||
|
});
|
||||||
|
};
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
const q = require("smartq");
|
||||||
const plugins = require("./npmts.plugins");
|
const plugins = require("./npmts.plugins");
|
||||||
const paths = require("./npmts.paths");
|
const paths = require("./npmts.paths");
|
||||||
const NpmtsConfig = require("./npmts.config");
|
const NpmtsConfig = require("./npmts.config");
|
||||||
const NpmtsMods = require("./npmts.mods");
|
const NpmtsMods = require("./npmts.mods");
|
||||||
const NpmtsWatch = require("./npmts.watch");
|
const NpmtsWatch = require("./npmts.watch");
|
||||||
const NpmtsShip = require("./npmts.ship");
|
const NpmtsShip = require("./npmts.ship");
|
||||||
const npmts_log_1 = require("./npmts.log");
|
/**
|
||||||
exports.run = () => {
|
* smartanalytics
|
||||||
let done = q.defer();
|
* this data is fully anonymized (no Ips or any other personal information is tracked).
|
||||||
let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
|
* It just keeps track which of our tools are really used...
|
||||||
let npmtsCli = new plugins.smartcli.Smartcli();
|
* ... so we know where to spend our limited resources for improving them.
|
||||||
npmtsCli.standardTask()
|
* Since yarn is out and there is heavy caching going on,
|
||||||
.then((argvArg) => {
|
* pure download stats are just not reliable enough for us anymore
|
||||||
plugins.beautylog.figletSync('NPMTS');
|
* Feel free to dig into the smartanalytics package, if you are interested in how it works.
|
||||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
|
* It is just an https call to our own Lossless Analytics API.
|
||||||
return NpmtsConfig.run(argvArg);
|
* Our privacy policy can be found here: https://lossless.gmbh/privacy.html
|
||||||
|
*/
|
||||||
|
let npmtsAnalytics = new plugins.smartanalytics.Analytics({
|
||||||
|
apiEndPoint: 'https://pubapi.lossless.one/analytics',
|
||||||
|
projectId: 'gitzone',
|
||||||
|
appName: 'npmts'
|
||||||
|
});
|
||||||
|
process.nextTick(() => __awaiter(this, void 0, void 0, function* () {
|
||||||
|
// make the analytics call
|
||||||
|
npmtsAnalytics
|
||||||
|
.recordEvent('npmToolExecution', {
|
||||||
|
executionMode: (yield NpmtsConfig.configPromise).mode,
|
||||||
|
tsOptions: (yield NpmtsConfig.configPromise).tsOptions,
|
||||||
|
watch: (yield NpmtsConfig.configPromise).watch,
|
||||||
|
coverageTreshold: (yield NpmtsConfig.configPromise).coverageTreshold
|
||||||
})
|
})
|
||||||
.then((configArg) => {
|
.catch(err => {
|
||||||
|
plugins.beautylog.warn('Lossless Analytics API not available...');
|
||||||
|
});
|
||||||
|
}));
|
||||||
|
exports.run = () => __awaiter(this, void 0, void 0, function* () {
|
||||||
let done = q.defer();
|
let done = q.defer();
|
||||||
npmts_log_1.npmtsOra.start('loading additional modules...');
|
plugins.beautylog.figletSync('NPMTS');
|
||||||
NpmtsMods.mod00.load()
|
let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
|
||||||
.then((mod00) => {
|
// check for updates
|
||||||
return mod00.run(configArg);
|
yield plugins.smartupdate.standardHandler.check('npmts', npmtsProjectInfo.version, 'http://gitzone.gitlab.io/npmts/changelog.html');
|
||||||
|
plugins.beautylog.log('---------------------------------------------');
|
||||||
|
let npmtsCli = new plugins.smartcli.Smartcli();
|
||||||
|
// build
|
||||||
|
npmtsCli
|
||||||
|
.addCommand('build')
|
||||||
|
.subscribe((argvArg) => __awaiter(this, void 0, void 0, function* () {
|
||||||
|
let done = q.defer();
|
||||||
|
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
|
||||||
|
const configArg = yield NpmtsConfig.run(argvArg);
|
||||||
|
plugins.beautylog.ora.start('loading additional modules...');
|
||||||
|
NpmtsMods.modCompile
|
||||||
|
.load()
|
||||||
|
.then(modCompile => {
|
||||||
|
return modCompile.run(configArg);
|
||||||
})
|
})
|
||||||
.then(configArg => {
|
.then(configArg => {
|
||||||
let done = q.defer();
|
let done = q.defer();
|
||||||
NpmtsMods.mod01.load()
|
NpmtsMods.modDocs
|
||||||
.then(mod01 => {
|
.load()
|
||||||
return mod01.run(configArg);
|
.then(modDocs => {
|
||||||
|
return modDocs.run(configArg);
|
||||||
})
|
})
|
||||||
.then(configArg => {
|
.then(configArg => {
|
||||||
done.resolve(configArg);
|
done.resolve(configArg);
|
||||||
@ -37,9 +79,10 @@ exports.run = () => {
|
|||||||
})
|
})
|
||||||
.then(configArg => {
|
.then(configArg => {
|
||||||
let done = q.defer();
|
let done = q.defer();
|
||||||
NpmtsMods.mod02.load()
|
NpmtsMods.modTest
|
||||||
.then(mod02 => {
|
.load()
|
||||||
return mod02.run(configArg);
|
.then(modTest => {
|
||||||
|
return modTest.run(configArg);
|
||||||
})
|
})
|
||||||
.then(configArg => {
|
.then(configArg => {
|
||||||
done.resolve(configArg);
|
done.resolve(configArg);
|
||||||
@ -49,11 +92,18 @@ exports.run = () => {
|
|||||||
.then(NpmtsWatch.run)
|
.then(NpmtsWatch.run)
|
||||||
.then(NpmtsShip.run);
|
.then(NpmtsShip.run);
|
||||||
return done.promise;
|
return done.promise;
|
||||||
})
|
}), err => {
|
||||||
.catch((err) => { if (err instanceof Error) {
|
if (err instanceof Error) {
|
||||||
console.log(err);
|
console.log(err);
|
||||||
} });
|
}
|
||||||
|
});
|
||||||
|
// standard task
|
||||||
|
npmtsCli.standardTask().subscribe((argvArg) => __awaiter(this, void 0, void 0, function* () {
|
||||||
|
yield npmtsCli.trigger('build');
|
||||||
|
}));
|
||||||
|
// cli metadata
|
||||||
npmtsCli.addVersion(npmtsProjectInfo.version);
|
npmtsCli.addVersion(npmtsProjectInfo.version);
|
||||||
|
// start parsing
|
||||||
npmtsCli.startParse();
|
npmtsCli.startParse();
|
||||||
return done.promise;
|
return yield done.promise;
|
||||||
};
|
});
|
||||||
|
21
dist/npmts.config.d.ts
vendored
21
dist/npmts.config.d.ts
vendored
@ -1,15 +1,26 @@
|
|||||||
/// <reference types="q" />
|
import { ITapbufferConfig } from 'tapbuffer';
|
||||||
import * as q from 'q';
|
/**
|
||||||
export declare type npmtsMode = 'default' | 'custom';
|
* specifies the different modes available
|
||||||
|
* default -> uses default options no matterm what
|
||||||
|
* merge -> uses merged default + custom options
|
||||||
|
* custom -> only uses specified options
|
||||||
|
*/
|
||||||
|
export declare type npmtsMode = 'default' | 'custom' | 'merge';
|
||||||
export interface INpmtsConfig {
|
export interface INpmtsConfig {
|
||||||
argv: any;
|
argv: any;
|
||||||
coverageTreshold: number;
|
coverageTreshold: number;
|
||||||
docs: boolean;
|
checkDependencies: boolean;
|
||||||
mode: npmtsMode;
|
mode: npmtsMode;
|
||||||
test: boolean;
|
test: boolean;
|
||||||
testTs: any;
|
testTs: any;
|
||||||
|
testConfig: ITapbufferConfig;
|
||||||
ts: any;
|
ts: any;
|
||||||
tsOptions: any;
|
tsOptions: any;
|
||||||
watch: boolean;
|
watch: boolean;
|
||||||
|
runData: {
|
||||||
|
coverageLcovInfo?: string;
|
||||||
|
coverageResult?: number;
|
||||||
|
};
|
||||||
}
|
}
|
||||||
export declare var run: (argvArg: any) => q.Promise<{}>;
|
export declare let run: (argvArg: any) => Promise<INpmtsConfig>;
|
||||||
|
export declare let configPromise: Promise<INpmtsConfig>;
|
||||||
|
39
dist/npmts.config.js
vendored
39
dist/npmts.config.js
vendored
@ -1,24 +1,28 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
const plugins = require("./npmts.plugins");
|
const plugins = require("./npmts.plugins");
|
||||||
const paths = require("./npmts.paths");
|
const paths = require("./npmts.paths");
|
||||||
const q = require("q");
|
const smartq = require("smartq");
|
||||||
const npmts_log_1 = require("./npmts.log");
|
|
||||||
;
|
|
||||||
exports.run = function (argvArg) {
|
exports.run = function (argvArg) {
|
||||||
let done = q.defer();
|
let done = smartq.defer();
|
||||||
let defaultConfig = {
|
let defaultConfig = {
|
||||||
argv: undefined,
|
argv: undefined,
|
||||||
coverageTreshold: 70,
|
coverageTreshold: 70,
|
||||||
docs: true,
|
checkDependencies: true,
|
||||||
mode: 'default',
|
mode: 'default',
|
||||||
test: true,
|
test: true,
|
||||||
testTs: {},
|
testTs: {},
|
||||||
|
testConfig: {
|
||||||
|
parallel: true,
|
||||||
|
coverage: true
|
||||||
|
},
|
||||||
ts: {},
|
ts: {},
|
||||||
tsOptions: {},
|
tsOptions: {},
|
||||||
watch: false
|
watch: false,
|
||||||
|
runData: {}
|
||||||
};
|
};
|
||||||
// mix with configfile
|
// mix with configfile
|
||||||
npmts_log_1.npmtsOra.text('running npmextra');
|
plugins.beautylog.ora.text('running npmextra');
|
||||||
let localNpmextra = new plugins.npmextra.Npmextra(paths.cwd);
|
let localNpmextra = new plugins.npmextra.Npmextra(paths.cwd);
|
||||||
let config = localNpmextra.dataFor('npmts', defaultConfig);
|
let config = localNpmextra.dataFor('npmts', defaultConfig);
|
||||||
// add argv
|
// add argv
|
||||||
@ -27,16 +31,16 @@ exports.run = function (argvArg) {
|
|||||||
switch (config.mode) {
|
switch (config.mode) {
|
||||||
case 'default':
|
case 'default':
|
||||||
case 'custom':
|
case 'custom':
|
||||||
|
case 'merge':
|
||||||
plugins.beautylog.ok('mode is ' + config.mode);
|
plugins.beautylog.ok('mode is ' + config.mode);
|
||||||
done.resolve(config);
|
done.resolve(config);
|
||||||
break;
|
break;
|
||||||
default:
|
default:
|
||||||
plugins.beautylog.error(`mode not recognised!`);
|
plugins.beautylog.error(`mode not recognised! Can be default or custom`);
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
;
|
|
||||||
// handle default mode
|
// handle default mode
|
||||||
if (config.mode === 'default') {
|
if (config.mode === 'default' || config.mode === 'merge') {
|
||||||
config.ts = {
|
config.ts = {
|
||||||
'./ts/**/*.ts': './dist/'
|
'./ts/**/*.ts': './dist/'
|
||||||
};
|
};
|
||||||
@ -44,21 +48,24 @@ exports.run = function (argvArg) {
|
|||||||
'./test/**/*.ts': './test/'
|
'./test/**/*.ts': './test/'
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
;
|
|
||||||
// mix with commandline
|
// mix with commandline
|
||||||
if (config.argv.notest) {
|
if (config.argv.notest) {
|
||||||
config.test = false;
|
config.test = false;
|
||||||
}
|
}
|
||||||
;
|
if (config.argv.nocoverage) {
|
||||||
if (config.argv.nodocs) {
|
config.testConfig.coverage = false;
|
||||||
config.docs = false;
|
}
|
||||||
|
if (config.argv.nochecks) {
|
||||||
|
config.checkDependencies = false;
|
||||||
}
|
}
|
||||||
;
|
|
||||||
if (config.argv.watch) {
|
if (config.argv.watch) {
|
||||||
config.watch = true;
|
config.watch = true;
|
||||||
}
|
}
|
||||||
;
|
|
||||||
plugins.beautylog.ok('build options are ready!');
|
plugins.beautylog.ok('build options are ready!');
|
||||||
done.resolve(config);
|
done.resolve(config);
|
||||||
|
configDeferred.resolve(config);
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
// config deferred usage
|
||||||
|
let configDeferred = smartq.defer();
|
||||||
|
exports.configPromise = configDeferred.promise;
|
||||||
|
2
dist/npmts.log.d.ts
vendored
2
dist/npmts.log.d.ts
vendored
@ -1,2 +0,0 @@
|
|||||||
import { Ora } from 'beautylog';
|
|
||||||
export declare let npmtsOra: Ora;
|
|
3
dist/npmts.log.js
vendored
3
dist/npmts.log.js
vendored
@ -1,3 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
const beautylog_1 = require("beautylog");
|
|
||||||
exports.npmtsOra = new beautylog_1.Ora('setting up TaskChain', 'cyan');
|
|
14
dist/npmts.mods.d.ts
vendored
14
dist/npmts.mods.d.ts
vendored
@ -1,7 +1,7 @@
|
|||||||
import { LazyModule } from 'smartsystem';
|
import * as plugins from './npmts.plugins';
|
||||||
import * as _mod00 from './mod00/index';
|
import * as _modCompile from './mod_compile/index';
|
||||||
import * as _mod01 from './mod01/index';
|
import * as _modDocs from './mod_docs/index';
|
||||||
import * as _mod02 from './mod02/index';
|
import * as _modTest from './mod_test/index';
|
||||||
export declare let mod00: LazyModule<typeof _mod00>;
|
export declare let modCompile: plugins.smartsystem.LazyModule<typeof _modCompile>;
|
||||||
export declare let mod01: LazyModule<typeof _mod01>;
|
export declare let modDocs: plugins.smartsystem.LazyModule<typeof _modDocs>;
|
||||||
export declare let mod02: LazyModule<typeof _mod02>;
|
export declare let modTest: plugins.smartsystem.LazyModule<typeof _modTest>;
|
||||||
|
7
dist/npmts.mods.js
vendored
7
dist/npmts.mods.js
vendored
@ -1,5 +1,6 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
const smartsystem_1 = require("smartsystem");
|
const smartsystem_1 = require("smartsystem");
|
||||||
exports.mod00 = new smartsystem_1.LazyModule('./mod00/index', __dirname);
|
exports.modCompile = new smartsystem_1.LazyModule('./mod_compile/index', __dirname);
|
||||||
exports.mod01 = new smartsystem_1.LazyModule('./mod01/index', __dirname);
|
exports.modDocs = new smartsystem_1.LazyModule('./mod_docs/index', __dirname);
|
||||||
exports.mod02 = new smartsystem_1.LazyModule('./mod02/index', __dirname);
|
exports.modTest = new smartsystem_1.LazyModule('./mod_test/index', __dirname);
|
||||||
|
1
dist/npmts.paths.js
vendored
1
dist/npmts.paths.js
vendored
@ -1,4 +1,5 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
const plugins = require("./npmts.plugins");
|
const plugins = require("./npmts.plugins");
|
||||||
// NPMTS Paths
|
// NPMTS Paths
|
||||||
exports.npmtsPackageRoot = plugins.path.join(__dirname, '../');
|
exports.npmtsPackageRoot = plugins.path.join(__dirname, '../');
|
||||||
|
11
dist/npmts.plugins.d.ts
vendored
11
dist/npmts.plugins.d.ts
vendored
@ -1,18 +1,17 @@
|
|||||||
import 'typings-global';
|
|
||||||
import * as beautylog from 'beautylog';
|
import * as beautylog from 'beautylog';
|
||||||
declare let depcheck: any;
|
declare let depcheck: any;
|
||||||
import * as lodash from 'lodash';
|
import * as lodash from 'lodash';
|
||||||
import * as npmextra from 'npmextra';
|
import * as npmextra from 'npmextra';
|
||||||
import * as projectinfo from 'projectinfo';
|
import * as projectinfo from 'projectinfo';
|
||||||
import * as path from 'path';
|
import * as path from 'path';
|
||||||
import * as smartcli from 'smartcli';
|
import * as smartanalytics from 'smartanalytics';
|
||||||
import * as smartcov from 'smartcov';
|
import * as smartcli from '@pushrocks/smartcli';
|
||||||
import * as smartenv from 'smartenv';
|
import * as smarterror from 'smarterror';
|
||||||
import * as smartfile from 'smartfile';
|
import * as smartfile from 'smartfile';
|
||||||
import * as smartpath from 'smartpath';
|
import * as smartpath from 'smartpath';
|
||||||
import * as smartstream from 'smartstream';
|
import * as smartstream from 'smartstream';
|
||||||
import * as smartstring from 'smartstring';
|
import * as smartstring from 'smartstring';
|
||||||
import * as smartsystem from 'smartsystem';
|
import * as smartsystem from 'smartsystem';
|
||||||
|
import * as smartupdate from 'smartupdate';
|
||||||
import * as through2 from 'through2';
|
import * as through2 from 'through2';
|
||||||
export declare let sourceMapSupport: any;
|
export { beautylog, depcheck, lodash, npmextra, projectinfo, path, smartanalytics, smartcli, smarterror, smartfile, smartpath, smartstream, smartstring, smartsystem, smartupdate, through2 };
|
||||||
export { beautylog, depcheck, lodash, npmextra, projectinfo, path, smartcli, smartcov, smartenv, smartfile, smartpath, smartstream, smartstring, smartsystem, through2 };
|
|
||||||
|
15
dist/npmts.plugins.js
vendored
15
dist/npmts.plugins.js
vendored
@ -1,5 +1,5 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
require("typings-global");
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
const beautylog = require("beautylog");
|
const beautylog = require("beautylog");
|
||||||
exports.beautylog = beautylog;
|
exports.beautylog = beautylog;
|
||||||
let depcheck = require('depcheck');
|
let depcheck = require('depcheck');
|
||||||
@ -12,12 +12,12 @@ const projectinfo = require("projectinfo");
|
|||||||
exports.projectinfo = projectinfo;
|
exports.projectinfo = projectinfo;
|
||||||
const path = require("path");
|
const path = require("path");
|
||||||
exports.path = path;
|
exports.path = path;
|
||||||
const smartcli = require("smartcli");
|
const smartanalytics = require("smartanalytics");
|
||||||
|
exports.smartanalytics = smartanalytics;
|
||||||
|
const smartcli = require("@pushrocks/smartcli");
|
||||||
exports.smartcli = smartcli;
|
exports.smartcli = smartcli;
|
||||||
const smartcov = require("smartcov");
|
const smarterror = require("smarterror");
|
||||||
exports.smartcov = smartcov;
|
exports.smarterror = smarterror;
|
||||||
const smartenv = require("smartenv");
|
|
||||||
exports.smartenv = smartenv;
|
|
||||||
const smartfile = require("smartfile");
|
const smartfile = require("smartfile");
|
||||||
exports.smartfile = smartfile;
|
exports.smartfile = smartfile;
|
||||||
const smartpath = require("smartpath");
|
const smartpath = require("smartpath");
|
||||||
@ -28,6 +28,7 @@ const smartstring = require("smartstring");
|
|||||||
exports.smartstring = smartstring;
|
exports.smartstring = smartstring;
|
||||||
const smartsystem = require("smartsystem");
|
const smartsystem = require("smartsystem");
|
||||||
exports.smartsystem = smartsystem;
|
exports.smartsystem = smartsystem;
|
||||||
|
const smartupdate = require("smartupdate");
|
||||||
|
exports.smartupdate = smartupdate;
|
||||||
const through2 = require("through2");
|
const through2 = require("through2");
|
||||||
exports.through2 = through2;
|
exports.through2 = through2;
|
||||||
exports.sourceMapSupport = require('source-map-support').install(); // display errors correctly during testing
|
|
||||||
|
3
dist/npmts.ship.js
vendored
3
dist/npmts.ship.js
vendored
@ -1,5 +1,6 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
const q = require("q");
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
const q = require("smartq");
|
||||||
const plugins = require("./npmts.plugins");
|
const plugins = require("./npmts.plugins");
|
||||||
exports.run = (configArg) => {
|
exports.run = (configArg) => {
|
||||||
let done = q.defer();
|
let done = q.defer();
|
||||||
|
4
dist/npmts.watch.d.ts
vendored
4
dist/npmts.watch.d.ts
vendored
@ -1,4 +1,2 @@
|
|||||||
/// <reference types="q" />
|
|
||||||
import * as q from 'q';
|
|
||||||
import { INpmtsConfig } from './npmts.config';
|
import { INpmtsConfig } from './npmts.config';
|
||||||
export declare let run: (configArg: INpmtsConfig) => q.Promise<{}>;
|
export declare let run: (configArg: INpmtsConfig) => Promise<{}>;
|
||||||
|
5
dist/npmts.watch.js
vendored
5
dist/npmts.watch.js
vendored
@ -1,5 +1,6 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
const q = require("q");
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
const q = require("smartq");
|
||||||
const smartchok = require("smartchok");
|
const smartchok = require("smartchok");
|
||||||
const plugins = require("./npmts.plugins");
|
const plugins = require("./npmts.plugins");
|
||||||
const cli = require("./npmts.cli");
|
const cli = require("./npmts.cli");
|
||||||
@ -15,7 +16,7 @@ exports.run = (configArg) => {
|
|||||||
pathsToWatch.push(key);
|
pathsToWatch.push(key);
|
||||||
}
|
}
|
||||||
npmtsSmartchok = new smartchok.Smartchok(pathsToWatch);
|
npmtsSmartchok = new smartchok.Smartchok(pathsToWatch);
|
||||||
npmtsSmartchok.getObservableFor('change').then((changeObservableArg) => {
|
npmtsSmartchok.getObservableFor('change').then(changeObservableArg => {
|
||||||
plugins.beautylog.info('now watching...');
|
plugins.beautylog.info('now watching...');
|
||||||
changeObservableArg.subscribe(() => {
|
changeObservableArg.subscribe(() => {
|
||||||
cli.run();
|
cli.run();
|
||||||
|
9
docs/00footer.md
Normal file
9
docs/00footer.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
[Legal Info](https://lossless.gmbh)
|
||||||
|
[Privacy Policy](https://lossless.gmbh/privacy.html)
|
||||||
|
///
|
||||||
|
[Git.Zone](https://git.zone)
|
||||||
|
<span>tools for a seamless dev workflow</span>
|
||||||
|
|
||||||
|
[Lossless GmbH](https://push.rocks)
|
||||||
|
<span>the company behind git.zone and npmts</span>
|
||||||
|
///
|
10
docs/changelog.md
Normal file
10
docs/changelog.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 2017-07-30: Version 7.x.x -> 8.x.x
|
||||||
|
|
||||||
|
Testfiles in ./test/ can now import files directly from the ts dir:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
// ./test/test.ts
|
||||||
|
import * as myModule from '../ts/index
|
||||||
|
```
|
@ -1,56 +1,65 @@
|
|||||||
# Configuration of NPMTS
|
---
|
||||||
npmts can be configured to your needs:
|
name: config
|
||||||
|
---
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
|
||||||
|
npmts can be configured to your needs.
|
||||||
|
|
||||||
### npmextra.json
|
### npmextra.json
|
||||||
|
|
||||||
the npmts section in npmextra.json can be used to configure npmts.
|
the npmts section in npmextra.json can be used to configure npmts.
|
||||||
|
|
||||||
**Default**
|
**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.
|
> 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
|
```json
|
||||||
{
|
{
|
||||||
"npmts":{
|
"npmts": {
|
||||||
"mode":"default"
|
"mode": "default"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**Custom settings**
|
**Custom settings**
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"mode":"custom",
|
"mode": "custom",
|
||||||
"docs":false,
|
"test": true,
|
||||||
"test":true,
|
"npmts": {
|
||||||
"npmts":{
|
"ts": {
|
||||||
"ts":{
|
"./customdir/*.ts": "./"
|
||||||
"./customdir/*.ts":"./"
|
|
||||||
},
|
},
|
||||||
"tsOptions":{
|
"tsOptions": {
|
||||||
"declaration":false,
|
"declaration": false,
|
||||||
"target":"ES6"
|
"target": "ES6"
|
||||||
},
|
},
|
||||||
"cli":true
|
"cli": true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
| key | default value | description |
|
| key | default value | description |
|
||||||
| --- | --- | --- |
|
| -------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
|
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify, "merge" will merge default options with whatever you specify on your own |
|
||||||
| `"docs"` | `true` | create docs for your module |
|
|
||||||
| `"test"` | `true` | test your module |
|
| `"test"` | `true` | test your module |
|
||||||
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
|
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
|
||||||
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
|
| `"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. |
|
| `"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. |
|
||||||
|
| `"testConfig"` | `{ parallel: true, coverage: true }` | allows you to control test behaviour. `"parallel"` controls wether testfiles are run sequentially or in parallel, and `"coverage` wether to create coverage reports |
|
||||||
|
|
||||||
### TypeScript
|
### TypeScript
|
||||||
|
|
||||||
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
||||||
`./dist/*.js` and `./test/test.js`
|
`./dist/*.js` and `./test/test.js`
|
||||||
|
|
||||||
Use commonjs module system for wiring up files.
|
Use commonjs module system for wiring up files.
|
||||||
|
|
||||||
### Declaration files
|
### Declaration files
|
||||||
|
|
||||||
**npmts** also creates declaration files like `./dist/index.d.ts` by default.
|
**npmts** also creates declaration files like `./dist/index.d.ts` by default.
|
||||||
You can reference it in your package.json like this.
|
You can reference it in your package.json like this.
|
||||||
|
|
||||||
@ -63,18 +72,17 @@ This is in line with the latest TypeScript best practices.
|
|||||||
You can then import plugins via the TypeScript `import` Syntax
|
You can then import plugins via the TypeScript `import` Syntax
|
||||||
and tsc will pick up the declaration file automatically.
|
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:
|
## Some notes:
|
||||||
|
|
||||||
#### Typings for third party modules that do not bundle declaration files
|
#### 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.
|
NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
|
||||||
|
|
||||||
#### Instrumentalize Code
|
#### Instrumentalize Code
|
||||||
|
|
||||||
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
||||||
|
|
||||||
#### Tests
|
#### Tests
|
||||||
|
|
||||||
Any errors will be shown with reference to their originating source in TypeScript
|
Any errors will be shown with reference to their originating source in TypeScript
|
||||||
thanks to autogenerated source maps.
|
thanks to autogenerated source maps.
|
@ -1,8 +1,13 @@
|
|||||||
# Default task execution of npmts
|
---
|
||||||
|
name: Default Behaviour
|
||||||
|
---
|
||||||
|
|
||||||
|
# Default Behaviour
|
||||||
|
|
||||||
|
when you don't configure it otherwise.
|
||||||
|
|
||||||
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
|
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. **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. **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. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
|
||||||
1. **Documentation:** Create TypeDoc Documentation from TypeScript files
|
1. **Test:** transpile TypeScript of module to ES5 for tests (so it can be instrumentalized) and pipe it to tapbuffer. All this happens in memory.
|
||||||
1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
|
|
||||||
|
@ -1,13 +1,23 @@
|
|||||||
# Examples for npmts
|
---
|
||||||
|
name: Examples
|
||||||
|
---
|
||||||
|
|
||||||
## Example Usage in modules:
|
# Examples
|
||||||
* [gulp-browser](https://www.npmjs.com/package/gulp-browser)
|
|
||||||
|
|
||||||
> We will add more options over time.
|
modules that use npmts in theis development workflow
|
||||||
|
|
||||||
## Tips and tricks:
|
| Module Name | Description |
|
||||||
|
| ---------------------------------------------------------- | --------------------------- |
|
||||||
|
| [gitzone](https://www.npmjs.com/package/gitzone) | fast npm module prototyping |
|
||||||
|
| [gulp-browser](https://www.npmjs.com/package/gulp-browser) | browserify for gulp |
|
||||||
|
| [npmdocker](https://www.npmjs.com/package/npmdocker) | dockerized npm development |
|
||||||
|
| [smartcli](https://www.npmjs.com/package/smartcli) | easy cli tool creation |
|
||||||
|
|
||||||
* 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.
|
> There are tons more... We will add them here over time.
|
||||||
* 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
|
### Tips and tricks:
|
||||||
* Use [npmdocker](https://www.npmjs.com/package/npmdocker) for running tests consistently with docker.
|
|
||||||
|
- 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:npmci](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.
|
||||||
|
40
docs/getstarted.md
Normal file
40
docs/getstarted.md
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
---
|
||||||
|
name: Get Started
|
||||||
|
description: learn how to quickly write npm TypeScript modules
|
||||||
|
---
|
||||||
|
|
||||||
|
# Get Started with NPMTS
|
||||||
|
|
||||||
|
and learn how to quickly write npm TypeScript modules
|
||||||
|
|
||||||
|
## Step1: Install the tools
|
||||||
|
|
||||||
|
To use npmts install it using npm or yarn:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm install -g npmts # install with npm
|
||||||
|
yarn global add npmts # install with yarn
|
||||||
|
```
|
||||||
|
|
||||||
|
For the purpose of getting started quickly please also install **gitzone**.
|
||||||
|
It'll proovide awesome scaffolding for new npmts maintained modules and also updates them later on.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm install -g gitzone # install with npm
|
||||||
|
yarn global add gitzone # install with yarn
|
||||||
|
```
|
||||||
|
|
||||||
|
You can make sure npmts and gitzone are installed correctly by typing `npmts -v && gitzone -v`.
|
||||||
|
|
||||||
|
## Scaffold a new module
|
||||||
|
|
||||||
|
To scaffold a new module type
|
||||||
|
|
||||||
|
```shell
|
||||||
|
gitzone template npm
|
||||||
|
```
|
||||||
|
|
||||||
|
This will run you through a series of question to get gitzone to know the specifics of your module.
|
||||||
|
Enter all information accordingly.
|
||||||
|
|
||||||
|
## Run NPMTS for the first time
|
@ -1,42 +1,52 @@
|
|||||||
|
---
|
||||||
|
name: Index
|
||||||
|
description: best practice npm TypeScript modules
|
||||||
|
---
|
||||||
|
|
||||||
# npmts
|
# npmts
|
||||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
|
||||||
|
best practice npm TypeScript modules
|
||||||
|
|
||||||
## Availabililty
|
## Availabililty
|
||||||
[](https://www.npmjs.com/package/npmts)
|
|
||||||
[](https://gitlab.com/pushrocks/npmts)
|
[](https://www.npmjs.com/package/npmts)
|
||||||
[](https://github.com/pushrocks/npmts)
|
[](https://GitLab.com/gitzone/npmts)
|
||||||
[](https://pushrocks.gitlab.io/npmts/gitbook)
|
[](https://github.com/gitzone/npmts)
|
||||||
|
[](https://gitzone.gitlab.io/npmts/)
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
|
||||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
[](https://GitLab.com/gitzone/npmts/commits/master)
|
||||||
[](https://david-dm.org/pushrocks/npmts)
|
[](https://GitLab.com/gitzone/npmts/commits/master)
|
||||||
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
[](https://www.npmjs.com/package/npmts)
|
||||||
[](https://www.bithound.io/github/pushrocks/npmts)
|
[](https://david-dm.org/gitzonetools/npmts)
|
||||||
|
[](https://www.bithound.io/github/gitzonetools/npmts/master/dependencies/npm)
|
||||||
|
[](https://www.bithound.io/github/gitzonetools/npmts)
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
[](http://standardjs.com/)
|
[](http://standardjs.com/)
|
||||||
|
|
||||||
## Introduction
|
## Quick Demo
|
||||||
|
|
||||||
|
[](https://asciinema.org/a/9c3assmh21i49qhe5lmi48sze?speed=2&t=0)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
||||||
|
|
||||||
npmts will
|
npmts will
|
||||||
|
|
||||||
1. check your dependencies and package.json
|
1. check your dependencies and package.json (unused, missing, updates, security)
|
||||||
1. transpile your code with tsc,
|
1. transpile your code with tsc,
|
||||||
1. document your code with typedoc,
|
1. test your code with tap (supports the fancy stuff like Promises, Generators, async/await, sourcemaps, parallel test execution in child processes)
|
||||||
1. test your code with mocha
|
1. create coverage with istanbul (supports tracing of the originating TypeScript)
|
||||||
1. create coverage with istanbul
|
|
||||||
|
For more information on how tests are run check out the [tapbuffer module](https://www.npmjs.com/package/tapbuffer).
|
||||||
|
|
||||||
This works on your machine and in CI. There is a prebuild docker image available that includes npmts to make CI a breeze:
|
This works on your machine and in CI. There is a prebuild 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/)
|
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||||
|
|
||||||
For further information read the docs:
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
* [1. Intro](https://pushrocks.gitlab.io/npmts/gitbook/index.md)
|
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||||
* [2. Install](https://pushrocks.gitlab.io/npmts/gitbook/install.md)
|
|
||||||
* [3. Default Behaviour](https://pushrocks.gitlab.io/npmts/gitbook/default.md)
|
|
||||||
* [4. Configuration](https://pushrocks.gitlab.io/npmts/gitbook/config.md)
|
|
||||||
* [5. Examples](https://pushrocks.gitlab.io/npmts/gitbook/examples.md)
|
|
||||||
* [6. Info](https://pushrocks.gitlab.io/npmts/gitbook/info.md)
|
|
||||||
|
|
||||||
[](https://push.rocks)
|
[](https:/git.zone)
|
||||||
|
14
docs/info.md
14
docs/info.md
@ -1,14 +0,0 @@
|
|||||||
# 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
|
|
@ -1,8 +1,9 @@
|
|||||||
# Install npmts
|
# 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.
|
Get started with TypeScript awesomeness.
|
||||||
If not it installs npmts locally in the right version during npm install.
|
|
||||||
|
> \*_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
|
```sh
|
||||||
npm install npmts -g # installs npmts globally
|
npm install npmts -g # installs npmts globally
|
||||||
|
27
docs/structure.md
Normal file
27
docs/structure.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
---
|
||||||
|
name: npmts project structure
|
||||||
|
description: how npmts projects are structured
|
||||||
|
---
|
||||||
|
|
||||||
|
# npmts - Project Structure
|
||||||
|
|
||||||
|
**locally**
|
||||||
|
|
||||||
|
```text
|
||||||
|
projectroot
|
||||||
|
|- .nogit/ # contains files that should not be checked into git - NOgit
|
||||||
|
|- dist/ # contains compiled js files and their corresponding typings - git
|
||||||
|
|- node_modules/ # contains the installed node modules - NOgit
|
||||||
|
|- test/ # contains the test files - git
|
||||||
|
|- ts/ # contains the source TypeScript files - git
|
||||||
|
|
|
||||||
|
|- .gitignore # the normal gitignore file
|
||||||
|
|- .gitlab-ci.yml # the gitlab ci yml file
|
||||||
|
|- npmextra.json # npmextra.json
|
||||||
|
|- package.json # the standard npm module package.json file
|
||||||
|
|- readme.md # the standard project readme
|
||||||
|
|- tslint.json # the standard tslint.json for TypeScript
|
||||||
|
|- yarn.lock # yarn.lock - the standard yarn.lock file
|
||||||
|
```
|
||||||
|
|
||||||
|
**in git**
|
@ -1,8 +0,0 @@
|
|||||||
# 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)
|
|
16
npmextra.json
Normal file
16
npmextra.json
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
{
|
||||||
|
"npmci": {
|
||||||
|
"npmAccessLevel": "public"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
|
"module": {
|
||||||
|
"githost": "gitlab.com",
|
||||||
|
"gitscope": "gitzone",
|
||||||
|
"gitrepo": "tscoverage",
|
||||||
|
"shortDescription": "get coverage information for gitzone projects",
|
||||||
|
"npmPackagename": "@gitzone/tscoverage",
|
||||||
|
"license": "MIT"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
11399
package-lock.json
generated
Normal file
11399
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
99
package.json
99
package.json
@ -1,27 +1,19 @@
|
|||||||
{
|
{
|
||||||
"name": "npmts",
|
"name": "@gitzone/tscoverage",
|
||||||
"version": "5.5.9",
|
"version": "9.0.2",
|
||||||
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
"description": "get coverage information for gitzone projects",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
|
"typings": "dist_ts/index.d.ts",
|
||||||
"bin": {
|
"bin": {
|
||||||
"npmts": "assets/cliNpmts.js"
|
"tscoverage": "cli.js"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npm run compile && npm run prepareTest && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest && npm run checkNoDocs)",
|
"test": "(tstest test/)",
|
||||||
"testShort": "(npm run compile && npm run check)",
|
"build": "(tsbuild --web)"
|
||||||
"prepareTest": "(rm -rf test/)",
|
|
||||||
"compile": "(rm -rf dist/ && tsc)",
|
|
||||||
"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": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://gitlab.com/pushrocks/npmts.git"
|
"url": "git+https://gitlab.com/gitzone/npmts.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"TypeScript",
|
"TypeScript",
|
||||||
@ -30,54 +22,31 @@
|
|||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://gitlab.com/pushrocks/npmts/issues"
|
"url": "https://gitlab.com/gitzone/npmts/issues"
|
||||||
},
|
|
||||||
"homepage": "https://gitlab.com/pushrocks/npmts#readme",
|
|
||||||
"dependencies": {
|
|
||||||
"@types/gulp": "^3.8.32",
|
|
||||||
"@types/gulp-babel": "^6.1.29",
|
|
||||||
"@types/gulp-istanbul": "^0.9.30",
|
|
||||||
"@types/gulp-mocha": "0.0.29",
|
|
||||||
"@types/gulp-sourcemaps": "0.0.29",
|
|
||||||
"@types/minimatch": "^2.0.29",
|
|
||||||
"@types/q": "^0.x.x",
|
|
||||||
"@types/shelljs": "^0.3.33",
|
|
||||||
"@types/through2": "^2.0.32",
|
|
||||||
"babel-preset-es2015": "^6.18.0",
|
|
||||||
"beautylog": "6.0.0",
|
|
||||||
"depcheck": "^0.6.5",
|
|
||||||
"early": "^2.0.35",
|
|
||||||
"gulp": "3.9.1",
|
|
||||||
"gulp-babel": "^6.1.2",
|
|
||||||
"gulp-function": "^2.2.2",
|
|
||||||
"gulp-inject-modules": "^1.0.0",
|
|
||||||
"gulp-istanbul": "^1.1.1",
|
|
||||||
"gulp-mocha": "^3.0.1",
|
|
||||||
"gulp-sourcemaps": "^2.2.0",
|
|
||||||
"gulp-typedoc": "^2.0.0",
|
|
||||||
"lodash": "^4.17.2",
|
|
||||||
"npmextra": "^2.0.3",
|
|
||||||
"projectinfo": "1.0.4",
|
|
||||||
"q": "^1.4.1",
|
|
||||||
"shelljs": "^0.7.5",
|
|
||||||
"smartchok": "^1.0.4",
|
|
||||||
"smartcli": "1.0.15",
|
|
||||||
"smartcov": "1.0.0",
|
|
||||||
"smartenv": "2.0.0",
|
|
||||||
"smartfile": "4.1.0",
|
|
||||||
"smartpath": "3.2.5",
|
|
||||||
"smartstream": "^1.0.5",
|
|
||||||
"smartstring": "^2.0.22",
|
|
||||||
"smartsystem": "^1.0.9",
|
|
||||||
"source-map-support": "^0.4.6",
|
|
||||||
"through2": "^2.0.1",
|
|
||||||
"tsn": "^2.0.13",
|
|
||||||
"typedoc": "^0.5.1",
|
|
||||||
"typescript": "next",
|
|
||||||
"typings-global": "^1.0.14"
|
|
||||||
},
|
},
|
||||||
|
"homepage": "https://gitlab.com/gitzone/npmts#readme",
|
||||||
|
"dependencies": {},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/should": "^8.1.30",
|
"@gitzone/tsbuild": "^2.1.24",
|
||||||
"should": "^11.1.1"
|
"@gitzone/tsbundle": "^1.0.69",
|
||||||
}
|
"@gitzone/tstest": "^1.0.33",
|
||||||
|
"@gitzone/tswatch": "^1.0.46",
|
||||||
|
"@pushrocks/tapbundle": "^3.2.1",
|
||||||
|
"@types/node": "^10.0.3",
|
||||||
|
"tslint": "^6.1.2",
|
||||||
|
"tslint-config-prettier": "^1.18.0"
|
||||||
|
},
|
||||||
|
"private": true,
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
39
readme.md
Normal file
39
readme.md
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
# @gitzone/tscoverage
|
||||||
|
get coverage information for gitzone projects
|
||||||
|
|
||||||
|
## Availabililty and Links
|
||||||
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tscoverage)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/gitzone/tscoverage)
|
||||||
|
* [github.com (source mirror)](https://github.com/gitzone/tscoverage)
|
||||||
|
* [docs (typedoc)](https://gitzone.gitlab.io/tscoverage/)
|
||||||
|
|
||||||
|
## Status for master
|
||||||
|
|
||||||
|
Status Category | Status Badge
|
||||||
|
-- | --
|
||||||
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
|
npm | [](https://lossless.cloud)
|
||||||
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
tscoverage will run tests while computing coverage for your gitzone project.
|
||||||
|
|
||||||
|
## Contribution
|
||||||
|
|
||||||
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||||
|
|
||||||
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
|
[](https://maintainedby.lossless.com)
|
7
test/test.ts
Normal file
7
test/test.ts
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
import { tap, expect } from '@pushrocks/tapbundle';
|
||||||
|
|
||||||
|
tap.test('should run a test', async () => {
|
||||||
|
console.log('hi there');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
15
ts/index.ts
15
ts/index.ts
@ -1,14 +1 @@
|
|||||||
/* ================================================== *
|
console.log('tscoverage');
|
||||||
**** NPMTS ****
|
|
||||||
Fabulous TypeScript development
|
|
||||||
* ================================================== */
|
|
||||||
|
|
||||||
import * as early from 'early'
|
|
||||||
early.start('NPMTS')
|
|
||||||
import * as plugins from './npmts.plugins'
|
|
||||||
import * as cli from './npmts.cli'
|
|
||||||
early.stop()
|
|
||||||
.then(() => {
|
|
||||||
let loaded = plugins // to make sure plugins get actually loaded
|
|
||||||
cli.run()
|
|
||||||
})
|
|
||||||
|
@ -1,27 +0,0 @@
|
|||||||
/* ------------------------------------------
|
|
||||||
* This module compiles TypeScript files
|
|
||||||
* -------------------------------------------- */
|
|
||||||
import * as q from 'q'
|
|
||||||
|
|
||||||
import { npmtsOra } from '../npmts.log'
|
|
||||||
import { INpmtsConfig } from '../npmts.config'
|
|
||||||
|
|
||||||
import * as plugins from './mod00.plugins'
|
|
||||||
|
|
||||||
import * as NpmtsAssets from './mod00.assets'
|
|
||||||
import * as NpmtsCheck from './mod00.check'
|
|
||||||
import * as NpmtsClean from './mod00.clean'
|
|
||||||
import * as NpmtsCompile from './mod00.compile'
|
|
||||||
|
|
||||||
export let run = function(configArg: INpmtsConfig): q.Promise<INpmtsConfig> {
|
|
||||||
let done = q.defer<INpmtsConfig>()
|
|
||||||
npmtsOra.text('starting TypeScript Compilation')
|
|
||||||
NpmtsClean.run(configArg)
|
|
||||||
.then(NpmtsCheck.run)
|
|
||||||
.then(NpmtsCompile.run)
|
|
||||||
.then(NpmtsAssets.run)
|
|
||||||
.then(function(){
|
|
||||||
done.resolve(configArg)
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
}
|
|
@ -1,25 +0,0 @@
|
|||||||
import * as q from 'q'
|
|
||||||
|
|
||||||
import paths = require('../npmts.paths')
|
|
||||||
import { npmtsOra } from '../npmts.log'
|
|
||||||
|
|
||||||
import plugins = require('./mod00.plugins')
|
|
||||||
import { projectInfo } from '../mod00/mod00.check'
|
|
||||||
|
|
||||||
export var run = function(configArg){
|
|
||||||
let done = q.defer()
|
|
||||||
let config = configArg
|
|
||||||
npmtsOra.text('now looking at ' + 'required assets'.yellow)
|
|
||||||
if (config.cli === true) {
|
|
||||||
let mainJsPath = projectInfo.packageJson.main
|
|
||||||
let cliJsString: string = plugins.smartfile.fs.toStringSync(plugins.path.join(paths.npmtsAssetsDir,'cli.js'))
|
|
||||||
cliJsString = cliJsString.replace('{{pathToIndex}}',mainJsPath)
|
|
||||||
plugins.smartfile.memory.toFsSync(cliJsString, 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
|
|
||||||
}
|
|
@ -1,127 +0,0 @@
|
|||||||
import * as q from 'q'
|
|
||||||
import { ProjectinfoNpm } from 'projectinfo'
|
|
||||||
|
|
||||||
import * as paths from '../npmts.paths'
|
|
||||||
import { npmtsOra } from '../npmts.log'
|
|
||||||
|
|
||||||
import * as plugins from './mod00.plugins'
|
|
||||||
|
|
||||||
export let projectInfo: ProjectinfoNpm
|
|
||||||
|
|
||||||
let checkProjectTypings = (configArg) => {
|
|
||||||
let done = q.defer()
|
|
||||||
npmtsOra.text('Check Module: Check Project Typings...')
|
|
||||||
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 = q.defer()
|
|
||||||
npmtsOra.text('Check Module: Check Dependencies...')
|
|
||||||
let depcheckOptionsMerged = plugins.lodash.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}"`)
|
|
||||||
}
|
|
||||||
for (let item in unused.missing) {
|
|
||||||
plugins.beautylog.error(`missing dependency "${item}" in package.json`)
|
|
||||||
}
|
|
||||||
if (unused.missing.length > 0) {
|
|
||||||
plugins.beautylog.info('exiting due to missing dependencies in package.json')
|
|
||||||
process.exit(1)
|
|
||||||
}
|
|
||||||
for (let item in unused.invalidFiles) {
|
|
||||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`)
|
|
||||||
};
|
|
||||||
for (let item in unused.invalidDirs) {
|
|
||||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
|
|
||||||
}
|
|
||||||
done.resolve(configArg)
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
let checkDevDependencies = (configArg) => {
|
|
||||||
let done = q.defer()
|
|
||||||
npmtsOra.text('Check Module: Check devDependencies...')
|
|
||||||
let depcheckOptionsMerged = plugins.lodash.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 in 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 in unused.invalidFiles) {
|
|
||||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`)
|
|
||||||
}
|
|
||||||
for (let item in unused.invalidDirs) {
|
|
||||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
|
|
||||||
}
|
|
||||||
done.resolve(configArg)
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
let checkNodeVersion = (configArg) => {
|
|
||||||
let done = q.defer()
|
|
||||||
npmtsOra.text('checking node version')
|
|
||||||
done.resolve(configArg)
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
export let run = (configArg) => {
|
|
||||||
let done = q.defer()
|
|
||||||
npmtsOra.text('Check Module: ...')
|
|
||||||
checkProjectTypings(configArg)
|
|
||||||
.then(checkDependencies)
|
|
||||||
.then(checkDevDependencies)
|
|
||||||
.then(checkNodeVersion)
|
|
||||||
.then(done.resolve)
|
|
||||||
.catch((err) => { console.log(err) })
|
|
||||||
return done.promise
|
|
||||||
}
|
|
@ -1,47 +0,0 @@
|
|||||||
import * as q from 'q'
|
|
||||||
import paths = require('../npmts.paths')
|
|
||||||
|
|
||||||
import { npmtsOra } from '../npmts.log'
|
|
||||||
|
|
||||||
import plugins = require('./mod00.plugins')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* removes the dist directory which will be entirely rebuild
|
|
||||||
*/
|
|
||||||
let removeDist = function () {
|
|
||||||
npmtsOra.text('cleaning dist folder')
|
|
||||||
return plugins.smartfile.fs.remove(paths.distDir)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* remove .d.ts files from testDirctory
|
|
||||||
*/
|
|
||||||
let removeTestDeclarations = function () {
|
|
||||||
let done = q.defer()
|
|
||||||
plugins.smartfile.fs.listFileTree('./test/', '**/*.d.ts').then(fileArray => {
|
|
||||||
let fileArrayToRemove = plugins.smartpath.transform.toAbsolute(fileArray, process.cwd() + '//test/')
|
|
||||||
plugins.smartfile.fs.removeManySync(fileArrayToRemove)
|
|
||||||
done.resolve()
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* remove old pages
|
|
||||||
*/
|
|
||||||
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 = q.defer()
|
|
||||||
removeDist()
|
|
||||||
.then(removeTestDeclarations)
|
|
||||||
.then(removePages)
|
|
||||||
.then(function () {
|
|
||||||
plugins.beautylog.ok('Cleaned up from previous builds!')
|
|
||||||
done.resolve(configArg)
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
}
|
|
@ -1,23 +0,0 @@
|
|||||||
import * as q from 'q'
|
|
||||||
|
|
||||||
import * as paths from '../npmts.paths'
|
|
||||||
import { npmtsOra } from '../npmts.log'
|
|
||||||
|
|
||||||
import * as plugins from './mod00.plugins'
|
|
||||||
|
|
||||||
export let run = function (configArg) {
|
|
||||||
let done = q.defer()
|
|
||||||
let config = configArg
|
|
||||||
npmtsOra.text('now compiling ' + 'TypeScript'.yellow)
|
|
||||||
plugins.tsn.compileGlobStringObject(config.ts,config.tsOptions,paths.cwd)
|
|
||||||
.then(() => {
|
|
||||||
plugins.beautylog.ok('compiled main TypeScript!')
|
|
||||||
plugins.beautylog.log('now compiling tests!')
|
|
||||||
return plugins.tsn.compileGlobStringObject(config.testTs,config.tsOptions,paths.cwd)
|
|
||||||
})
|
|
||||||
.then(function () {
|
|
||||||
plugins.beautylog.ok('compiled all TypeScript!')
|
|
||||||
done.resolve(config)
|
|
||||||
}).catch(err => { console.log(err) })
|
|
||||||
return done.promise
|
|
||||||
}
|
|
@ -1,13 +0,0 @@
|
|||||||
export * from '../npmts.plugins'
|
|
||||||
|
|
||||||
import * as tsn from 'tsn'
|
|
||||||
import * as shelljs from 'shelljs'
|
|
||||||
import * as smartchok from 'smartchok'
|
|
||||||
import * as smartstream from 'smartstream'
|
|
||||||
|
|
||||||
export {
|
|
||||||
tsn,
|
|
||||||
shelljs,
|
|
||||||
smartchok,
|
|
||||||
smartstream
|
|
||||||
}
|
|
@ -1,63 +0,0 @@
|
|||||||
/* ------------------------------------------
|
|
||||||
* This module creates TypeScript documentation
|
|
||||||
* -------------------------------------------- */
|
|
||||||
import * as q from 'q'
|
|
||||||
|
|
||||||
import * as paths from '../npmts.paths'
|
|
||||||
import { npmtsOra } from '../npmts.log'
|
|
||||||
import { INpmtsConfig } from '../npmts.config'
|
|
||||||
|
|
||||||
import * as plugins from './mod01.plugins'
|
|
||||||
|
|
||||||
|
|
||||||
import { projectInfo } from '../mod00/mod00.check'
|
|
||||||
|
|
||||||
let genTypeDoc = function (configArg: INpmtsConfig) {
|
|
||||||
let done = q.defer()
|
|
||||||
npmtsOra.text('now generating ' + 'TypeDoc documentation'.yellow)
|
|
||||||
plugins.beautylog.log('TypeDoc Output:')
|
|
||||||
let localSmartstream = new plugins.smartstream.Smartstream([
|
|
||||||
plugins.gulp.src(plugins.path.join(paths.tsDir, '**/*.ts')),
|
|
||||||
plugins.gulpTypedoc({
|
|
||||||
// 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",
|
|
||||||
version: true
|
|
||||||
})
|
|
||||||
])
|
|
||||||
localSmartstream.run().then(
|
|
||||||
() => {
|
|
||||||
plugins.beautylog.ok('TypeDoc documentation generated!')
|
|
||||||
done.resolve(configArg)
|
|
||||||
},
|
|
||||||
(err) => {
|
|
||||||
plugins.beautylog.warn('TypeDoc documentation generation failed!')
|
|
||||||
console.log(err)
|
|
||||||
done.resolve(configArg)
|
|
||||||
}
|
|
||||||
)
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
export let run = function (configArg: INpmtsConfig) {
|
|
||||||
let done = q.defer<INpmtsConfig>()
|
|
||||||
if (configArg.docs) {
|
|
||||||
genTypeDoc(configArg)
|
|
||||||
.then(() => {
|
|
||||||
done.resolve(configArg)
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
done.resolve(configArg)
|
|
||||||
};
|
|
||||||
return done.promise
|
|
||||||
}
|
|
@ -1,9 +0,0 @@
|
|||||||
export * from '../npmts.plugins'
|
|
||||||
|
|
||||||
import * as gulp from 'gulp'
|
|
||||||
let gulpTypedoc = require('gulp-typedoc')
|
|
||||||
|
|
||||||
export {
|
|
||||||
gulp,
|
|
||||||
gulpTypedoc
|
|
||||||
}
|
|
@ -1,123 +0,0 @@
|
|||||||
/* ------------------------------------------
|
|
||||||
* This module tests the compiled TypeScript files
|
|
||||||
* -------------------------------------------- */
|
|
||||||
import plugins = require('./mod02.plugins')
|
|
||||||
import paths = require('../npmts.paths')
|
|
||||||
|
|
||||||
import * as q from 'q'
|
|
||||||
|
|
||||||
import { npmtsOra } from '../npmts.log'
|
|
||||||
import { INpmtsConfig } from '../npmts.config'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* runs mocha
|
|
||||||
* @returns INpmtsConfig
|
|
||||||
*/
|
|
||||||
let mocha = function (configArg: INpmtsConfig) {
|
|
||||||
npmtsOra.text('Instrumentalizing and testing transpiled JS')
|
|
||||||
npmtsOra.end() // end npmtsOra for tests.
|
|
||||||
let done = q.defer()
|
|
||||||
|
|
||||||
let coverageSmartstream = new plugins.smartstream.Smartstream([
|
|
||||||
plugins.gulp.src([plugins.path.join(paths.cwd, './dist/**/*.js')]),
|
|
||||||
plugins.gulpSourcemaps.init(),
|
|
||||||
plugins.gulpBabel({
|
|
||||||
presets: [
|
|
||||||
require.resolve('babel-preset-es2015')
|
|
||||||
]
|
|
||||||
}),
|
|
||||||
plugins.gulpIstanbul({
|
|
||||||
}),
|
|
||||||
plugins.gulpSourcemaps.write(),
|
|
||||||
plugins.gulpInjectModules(),
|
|
||||||
plugins.through2.obj(
|
|
||||||
(file, enc, cb) => {
|
|
||||||
cb()
|
|
||||||
},
|
|
||||||
(cb) => {
|
|
||||||
cb()
|
|
||||||
}
|
|
||||||
)
|
|
||||||
])
|
|
||||||
|
|
||||||
let localSmartstream = new plugins.smartstream.Smartstream([
|
|
||||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')]),
|
|
||||||
plugins.gulpBabel({
|
|
||||||
presets: [
|
|
||||||
require.resolve('babel-preset-es2015')
|
|
||||||
]
|
|
||||||
}),
|
|
||||||
plugins.gulpInjectModules(),
|
|
||||||
plugins.gulpMocha(),
|
|
||||||
plugins.gulpIstanbul.writeReports({
|
|
||||||
dir: plugins.path.join(paths.cwd, './coverage'),
|
|
||||||
reporters: ['lcovonly', 'json', 'text', 'text-summary']
|
|
||||||
})
|
|
||||||
])
|
|
||||||
coverageSmartstream.run()
|
|
||||||
.then(
|
|
||||||
() => {
|
|
||||||
plugins.beautylog.info('code is now transpiled to ES5, instrumented with istanbul, and injected for mocha!')
|
|
||||||
return localSmartstream.run()
|
|
||||||
.then(() => { done.resolve(configArg) }, (err) => {
|
|
||||||
plugins.beautylog.error('Tests failed!')
|
|
||||||
console.log(err)
|
|
||||||
if (configArg.watch) {
|
|
||||||
done.resolve(configArg)
|
|
||||||
} else {
|
|
||||||
process.exit(1)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
},
|
|
||||||
(err) => {
|
|
||||||
console.log(err)
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
let coverage = function (configArg: INpmtsConfig) {
|
|
||||||
let done = q.defer()
|
|
||||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, 'lcov.info'), 2)
|
|
||||||
.then(function (percentageArg) {
|
|
||||||
if (percentageArg >= configArg.coverageTreshold) {
|
|
||||||
plugins.beautylog.ok(
|
|
||||||
`${percentageArg.toString()}% `
|
|
||||||
+ `coverage exceeds your treshold of `
|
|
||||||
+ `${configArg.coverageTreshold.toString()}%`
|
|
||||||
)
|
|
||||||
} else {
|
|
||||||
plugins.beautylog.warn(
|
|
||||||
`${percentageArg.toString()}% `
|
|
||||||
+ `coverage fails your treshold of `
|
|
||||||
+ `${configArg.coverageTreshold.toString()}%`
|
|
||||||
)
|
|
||||||
plugins.beautylog.error('exiting due to coverage failure')
|
|
||||||
if (!configArg.watch) { process.exit(1) }
|
|
||||||
}
|
|
||||||
done.resolve(configArg)
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
export let run = function (configArg: INpmtsConfig) {
|
|
||||||
let done = q.defer<INpmtsConfig>()
|
|
||||||
let config = configArg
|
|
||||||
if (config.test === true) {
|
|
||||||
npmtsOra.text('now starting tests')
|
|
||||||
plugins.beautylog.log(
|
|
||||||
'------------------------------------------------------\n' +
|
|
||||||
'*************************** TESTS: ***************************\n' +
|
|
||||||
'--------------------------------------------------------------'
|
|
||||||
)
|
|
||||||
|
|
||||||
mocha(config)
|
|
||||||
.then(coverage)
|
|
||||||
.then(() => {
|
|
||||||
done.resolve(config)
|
|
||||||
}).catch(err => { console.log(err) })
|
|
||||||
} else {
|
|
||||||
npmtsOra.end()
|
|
||||||
done.resolve(config)
|
|
||||||
}
|
|
||||||
return done.promise
|
|
||||||
}
|
|
@ -1,19 +0,0 @@
|
|||||||
export * from '../npmts.plugins'
|
|
||||||
|
|
||||||
import * as gulp from 'gulp'
|
|
||||||
import * as gulpBabel from 'gulp-babel'
|
|
||||||
import * as gulpIstanbul from 'gulp-istanbul'
|
|
||||||
import * as gulpFunction from 'gulp-function'
|
|
||||||
let gulpInjectModules = require('gulp-inject-modules')
|
|
||||||
import * as gulpMocha from 'gulp-mocha'
|
|
||||||
import * as gulpSourcemaps from 'gulp-sourcemaps'
|
|
||||||
|
|
||||||
export {
|
|
||||||
gulp,
|
|
||||||
gulpBabel,
|
|
||||||
gulpIstanbul,
|
|
||||||
gulpFunction,
|
|
||||||
gulpInjectModules,
|
|
||||||
gulpMocha,
|
|
||||||
gulpSourcemaps
|
|
||||||
}
|
|
@ -1,60 +0,0 @@
|
|||||||
import * as q from 'q'
|
|
||||||
|
|
||||||
import * as plugins from './npmts.plugins'
|
|
||||||
import * as paths from './npmts.paths'
|
|
||||||
import * as NpmtsConfig from './npmts.config'
|
|
||||||
import * as NpmtsMods from './npmts.mods'
|
|
||||||
import * as NpmtsWatch from './npmts.watch'
|
|
||||||
import * as NpmtsShip from './npmts.ship'
|
|
||||||
|
|
||||||
import { npmtsOra } from './npmts.log'
|
|
||||||
|
|
||||||
export let run = () => {
|
|
||||||
let done = q.defer()
|
|
||||||
let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot)
|
|
||||||
let npmtsCli = new plugins.smartcli.Smartcli()
|
|
||||||
npmtsCli.standardTask()
|
|
||||||
.then((argvArg) => {
|
|
||||||
plugins.beautylog.figletSync('NPMTS')
|
|
||||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version)
|
|
||||||
return NpmtsConfig.run(argvArg)
|
|
||||||
})
|
|
||||||
.then((configArg: NpmtsConfig.INpmtsConfig) => {
|
|
||||||
let done = q.defer()
|
|
||||||
npmtsOra.start('loading additional modules...')
|
|
||||||
NpmtsMods.mod00.load()
|
|
||||||
.then((mod00) => {
|
|
||||||
return mod00.run(configArg)
|
|
||||||
})
|
|
||||||
.then(configArg => {
|
|
||||||
let done = q.defer<NpmtsConfig.INpmtsConfig>()
|
|
||||||
NpmtsMods.mod01.load()
|
|
||||||
.then(mod01 => {
|
|
||||||
return mod01.run(configArg)
|
|
||||||
})
|
|
||||||
.then(configArg => {
|
|
||||||
done.resolve(configArg)
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
})
|
|
||||||
.then(configArg => {
|
|
||||||
let done = q.defer<NpmtsConfig.INpmtsConfig>()
|
|
||||||
NpmtsMods.mod02.load()
|
|
||||||
.then(mod02 => {
|
|
||||||
return mod02.run(configArg)
|
|
||||||
})
|
|
||||||
.then(configArg => {
|
|
||||||
done.resolve(configArg)
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
})
|
|
||||||
.then(NpmtsWatch.run)
|
|
||||||
.then(NpmtsShip.run)
|
|
||||||
|
|
||||||
return done.promise
|
|
||||||
})
|
|
||||||
.catch((err) => { if (err instanceof Error) { console.log(err) } } )
|
|
||||||
npmtsCli.addVersion(npmtsProjectInfo.version)
|
|
||||||
npmtsCli.startParse()
|
|
||||||
return done.promise
|
|
||||||
}
|
|
@ -1,85 +0,0 @@
|
|||||||
import plugins = require('./npmts.plugins')
|
|
||||||
import paths = require('./npmts.paths')
|
|
||||||
|
|
||||||
import * as q from 'q'
|
|
||||||
|
|
||||||
import { npmtsOra } from './npmts.log'
|
|
||||||
|
|
||||||
export type npmtsMode = 'default' | 'custom'
|
|
||||||
|
|
||||||
export interface INpmtsConfig {
|
|
||||||
argv: any,
|
|
||||||
coverageTreshold: number,
|
|
||||||
docs: boolean,
|
|
||||||
mode: npmtsMode,
|
|
||||||
test: boolean,
|
|
||||||
testTs: any,
|
|
||||||
ts: any,
|
|
||||||
tsOptions: any,
|
|
||||||
watch: boolean
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
export var run = function (argvArg) {
|
|
||||||
let done = q.defer()
|
|
||||||
let defaultConfig: INpmtsConfig = {
|
|
||||||
argv: undefined,
|
|
||||||
coverageTreshold: 70,
|
|
||||||
docs: true,
|
|
||||||
mode: 'default',
|
|
||||||
test: true,
|
|
||||||
testTs: {},
|
|
||||||
ts: {},
|
|
||||||
tsOptions: {},
|
|
||||||
watch: false
|
|
||||||
}
|
|
||||||
|
|
||||||
// mix with configfile
|
|
||||||
npmtsOra.text('running npmextra')
|
|
||||||
|
|
||||||
let localNpmextra = new plugins.npmextra.Npmextra(paths.cwd)
|
|
||||||
let config: INpmtsConfig = localNpmextra.dataFor<INpmtsConfig>(
|
|
||||||
'npmts',
|
|
||||||
defaultConfig
|
|
||||||
)
|
|
||||||
|
|
||||||
// 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.ts = {
|
|
||||||
'./ts/**/*.ts': './dist/'
|
|
||||||
}
|
|
||||||
config.testTs = {
|
|
||||||
'./test/**/*.ts': './test/'
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// mix with commandline
|
|
||||||
if (config.argv.notest) {
|
|
||||||
config.test = false
|
|
||||||
};
|
|
||||||
if (config.argv.nodocs) {
|
|
||||||
config.docs = false
|
|
||||||
};
|
|
||||||
if (config.argv.watch) {
|
|
||||||
config.watch = true
|
|
||||||
};
|
|
||||||
|
|
||||||
plugins.beautylog.ok('build options are ready!')
|
|
||||||
done.resolve(config)
|
|
||||||
return done.promise
|
|
||||||
}
|
|
@ -1,2 +0,0 @@
|
|||||||
import {Ora} from 'beautylog'
|
|
||||||
export let npmtsOra = new Ora('setting up TaskChain','cyan')
|
|
@ -1,11 +0,0 @@
|
|||||||
import * as plugins from './npmts.plugins'
|
|
||||||
|
|
||||||
import { LazyModule } from 'smartsystem'
|
|
||||||
|
|
||||||
import * as _mod00 from './mod00/index'
|
|
||||||
import * as _mod01 from './mod01/index'
|
|
||||||
import * as _mod02 from './mod02/index'
|
|
||||||
|
|
||||||
export let mod00 = new LazyModule<typeof _mod00>('./mod00/index',__dirname)
|
|
||||||
export let mod01 = new LazyModule<typeof _mod01>('./mod01/index',__dirname)
|
|
||||||
export let mod02 = new LazyModule<typeof _mod02>('./mod02/index',__dirname)
|
|
@ -1,24 +0,0 @@
|
|||||||
import plugins = require('./npmts.plugins')
|
|
||||||
|
|
||||||
// NPMTS Paths
|
|
||||||
export let npmtsPackageRoot = plugins.path.join(__dirname,'../')
|
|
||||||
|
|
||||||
// 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 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
|
|
||||||
export let indexTS = plugins.path.join(cwd,'ts/index.ts')
|
|
||||||
export let testTS = plugins.path.join(cwd,'ts/test.ts')
|
|
@ -1,36 +0,0 @@
|
|||||||
import 'typings-global'
|
|
||||||
import * as beautylog from 'beautylog'
|
|
||||||
let depcheck = require('depcheck')
|
|
||||||
|
|
||||||
import * as lodash from 'lodash'
|
|
||||||
import * as npmextra from 'npmextra'
|
|
||||||
import * as projectinfo from 'projectinfo'
|
|
||||||
import * as path from 'path'
|
|
||||||
import * as smartcli from 'smartcli'
|
|
||||||
import * as smartcov from 'smartcov'
|
|
||||||
import * as smartenv from 'smartenv'
|
|
||||||
import * as smartfile from 'smartfile'
|
|
||||||
import * as smartpath from 'smartpath'
|
|
||||||
import * as smartstream from 'smartstream'
|
|
||||||
import * as smartstring from 'smartstring'
|
|
||||||
import * as smartsystem from 'smartsystem'
|
|
||||||
import * as through2 from 'through2'
|
|
||||||
export let sourceMapSupport = require('source-map-support').install() // display errors correctly during testing
|
|
||||||
|
|
||||||
export {
|
|
||||||
beautylog,
|
|
||||||
depcheck,
|
|
||||||
lodash,
|
|
||||||
npmextra,
|
|
||||||
projectinfo,
|
|
||||||
path,
|
|
||||||
smartcli,
|
|
||||||
smartcov,
|
|
||||||
smartenv,
|
|
||||||
smartfile,
|
|
||||||
smartpath,
|
|
||||||
smartstream,
|
|
||||||
smartstring,
|
|
||||||
smartsystem,
|
|
||||||
through2
|
|
||||||
}
|
|
@ -1,30 +0,0 @@
|
|||||||
import * as q from 'q'
|
|
||||||
|
|
||||||
import * as plugins from './npmts.plugins'
|
|
||||||
|
|
||||||
import { INpmtsConfig } from './npmts.config'
|
|
||||||
|
|
||||||
export let run = (configArg: INpmtsConfig) => {
|
|
||||||
let done = q.defer()
|
|
||||||
let shipString = '' +
|
|
||||||
'\n' +
|
|
||||||
'\n' +
|
|
||||||
' # # ( )\n' +
|
|
||||||
' ___#_#___|__\n' +
|
|
||||||
' _ |____________| _\n' +
|
|
||||||
' _=====| | | | | |==== _\n' +
|
|
||||||
' =====| |.---------------------------. | |====\n' +
|
|
||||||
" <--------------------' . . . . . . . . '--------------/\n" +
|
|
||||||
' \\ /\n' +
|
|
||||||
' \\___________________________________________________________/\n' +
|
|
||||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
|
||||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
|
||||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n'
|
|
||||||
if (process.env.CI) {
|
|
||||||
console.log(shipString)
|
|
||||||
plugins.beautylog.success('READY TO SHIP!')
|
|
||||||
} else {
|
|
||||||
plugins.beautylog.success('Done!')
|
|
||||||
}
|
|
||||||
done.resolve(configArg)
|
|
||||||
}
|
|
@ -1,34 +0,0 @@
|
|||||||
import * as q from 'q'
|
|
||||||
import * as smartchok from 'smartchok'
|
|
||||||
|
|
||||||
import * as plugins from './npmts.plugins'
|
|
||||||
import * as cli from './npmts.cli'
|
|
||||||
|
|
||||||
import { INpmtsConfig } from './npmts.config'
|
|
||||||
|
|
||||||
let npmtsSmartchok: smartchok.Smartchok = null
|
|
||||||
export let run = (configArg: INpmtsConfig) => {
|
|
||||||
let done = q.defer()
|
|
||||||
if (configArg.watch && npmtsSmartchok === null) {
|
|
||||||
let pathsToWatch: string[] = []
|
|
||||||
for (let key in configArg.ts) {
|
|
||||||
pathsToWatch.push(key)
|
|
||||||
}
|
|
||||||
for (let key in configArg.testTs) {
|
|
||||||
pathsToWatch.push(key)
|
|
||||||
}
|
|
||||||
npmtsSmartchok = new smartchok.Smartchok(pathsToWatch)
|
|
||||||
npmtsSmartchok.getObservableFor('change').then((changeObservableArg) => {
|
|
||||||
plugins.beautylog.info('now watching...')
|
|
||||||
changeObservableArg.subscribe(() => {
|
|
||||||
cli.run()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
npmtsSmartchok.start()
|
|
||||||
done.resolve(configArg)
|
|
||||||
} else {
|
|
||||||
plugins.beautylog.info('not watching')
|
|
||||||
done.resolve(configArg)
|
|
||||||
}
|
|
||||||
return done.promise
|
|
||||||
}
|
|
16
tslint.json
16
tslint.json
@ -1,3 +1,17 @@
|
|||||||
{
|
{
|
||||||
"extends": "tslint-config-standard"
|
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||||
|
"rules": {
|
||||||
|
"semicolon": [true, "always"],
|
||||||
|
"no-console": false,
|
||||||
|
"ordered-imports": false,
|
||||||
|
"object-literal-sort-keys": false,
|
||||||
|
"member-ordering": {
|
||||||
|
"options":{
|
||||||
|
"order": [
|
||||||
|
"static-method"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultSeverity": "warning"
|
||||||
}
|
}
|
Loading…
x
Reference in New Issue
Block a user