Compare commits
276 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 | |||
60bed4cb1f | |||
8831a8d173 | |||
36f540a22e | |||
7e61b49d04 | |||
57aa38af89 | |||
12cf37f01f | |||
44150f4d83 | |||
3fd755691d | |||
00983205ce | |||
a0b1b1847c | |||
be9e98ad0c | |||
84578e8dd0 | |||
6d759706ac | |||
2bd4063d22 | |||
c274590184 | |||
de8992da84 | |||
dc598e1627 | |||
bfcd78b169 | |||
2352456be1 | |||
8e4a4e5766 | |||
4f93ef3fb2 | |||
69742fd6a7 | |||
d7b08034da | |||
349c6cce77 | |||
4770b1e349 | |||
7043a844f0 | |||
5f4a8d3ee5 | |||
0b6fc610e8 | |||
3d78bf268d | |||
36887512ee | |||
fb7025d7ec | |||
8dcdad9e2c | |||
1898db5472 | |||
1f01bee204 | |||
851653a6ae | |||
9229cd79dd | |||
86fb639c82 | |||
d536e6aa8c | |||
c91ff6ef4a | |||
2c88c889bf | |||
d3f8ea0433 | |||
d57b05c6d0 | |||
e1ce5f2d5b | |||
7c960649bc | |||
71588595e6 | |||
b31994f163 | |||
e6284cdde3 | |||
5f15fe1b30 |
22
.gitignore
vendored
22
.gitignore
vendored
@ -1,4 +1,20 @@
|
||||
node_modules/
|
||||
test/
|
||||
.nogit/
|
||||
|
||||
# artifacts
|
||||
coverage/
|
||||
public/
|
||||
pages/
|
||||
.DS_Store
|
||||
|
||||
# installs
|
||||
node_modules/
|
||||
|
||||
# caches
|
||||
.yarn/
|
||||
.cache/
|
||||
.rpt2_cache
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_*/
|
||||
|
||||
# custom
|
114
.gitlab-ci.yml
114
.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:
|
||||
- test
|
||||
- release
|
||||
- trigger
|
||||
- pages
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- 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
|
||||
script:
|
||||
- npmci test legacy
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
allow_failure: true
|
||||
- priv
|
||||
|
||||
testLTS:
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test lts
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testSTABLE:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test stable
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci publish
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- 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:
|
||||
stage: trigger
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
image: hosttoday/ht-docker-node:npmpage
|
||||
stage: pages
|
||||
stage: metadata
|
||||
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:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
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
|
36
README.md
36
README.md
@ -1,36 +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/gitbook)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://david-dm.org/pushrocks/npmts)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](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.
|
||||
|
||||
[](https://push.rocks)
|
@ -1,2 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
var index = require("./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();
|
2
dist/cli.js
vendored
2
dist/cli.js
vendored
@ -1,2 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
var index = require("./index.js");
|
2
dist/index.d.ts
vendored
2
dist/index.d.ts
vendored
@ -1 +1 @@
|
||||
import 'typings-global';
|
||||
export {};
|
||||
|
32
dist/index.js
vendored
32
dist/index.js
vendored
@ -1,28 +1,14 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
/* ================================================== *
|
||||
Starting NPMTS main process.
|
||||
**** NPMTS ****
|
||||
Fabulous TypeScript development
|
||||
* ================================================== */
|
||||
var early = require("early");
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const early = require("early");
|
||||
early.start('NPMTS');
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
early.stop()
|
||||
.then(function () {
|
||||
var npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
|
||||
var npmtsCli = new plugins.smartcli.Smartcli();
|
||||
npmtsCli.standardTask()
|
||||
.then(function (argvArg) {
|
||||
plugins.beautylog.figletSync('NPMTS');
|
||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
|
||||
try {
|
||||
npmts_promisechain_1.promisechain(argvArg);
|
||||
}
|
||||
catch (err) {
|
||||
console.log(err);
|
||||
}
|
||||
});
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version);
|
||||
npmtsCli.startParse();
|
||||
const plugins = require("./npmts.plugins");
|
||||
const cli = require("./npmts.cli");
|
||||
early.stop().then(() => {
|
||||
let loaded = plugins; // to make sure plugins get actually loaded
|
||||
cli.run();
|
||||
});
|
||||
|
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<{}>;
|
24
dist/mod_compile/mod.assets.js
vendored
Normal file
24
dist/mod_compile/mod.assets.js
vendored
Normal file
@ -0,0 +1,24 @@
|
||||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const q = require("smartq");
|
||||
const paths = require("../npmts.paths");
|
||||
const plugins = require("./mod.plugins");
|
||||
const mod_check_1 = require("../mod_compile/mod.check");
|
||||
exports.run = function (configArg) {
|
||||
let done = q.defer();
|
||||
let config = configArg;
|
||||
plugins.beautylog.ora.text('now looking at ' + 'required assets');
|
||||
if (config.cli === true) {
|
||||
let mainJsPath = mod_check_1.projectInfo.packageJson.main;
|
||||
let cliJsString = 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;
|
||||
};
|
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>;
|
136
dist/mod_compile/mod.check.js
vendored
Normal file
136
dist/mod_compile/mod.check.js
vendored
Normal file
@ -0,0 +1,136 @@
|
||||
"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 });
|
||||
const q = require("smartq");
|
||||
const projectinfo_1 = require("projectinfo");
|
||||
const paths = require("../npmts.paths");
|
||||
const plugins = require("./mod.plugins");
|
||||
let checkProjectTypings = (configArg) => {
|
||||
let done = q.defer();
|
||||
plugins.beautylog.ora.text('Check Module: Check Project Typings...');
|
||||
exports.projectInfo = new projectinfo_1.ProjectinfoNpm(paths.cwd);
|
||||
if (typeof exports.projectInfo.packageJson.typings === 'undefined') {
|
||||
plugins.beautylog.error(`please add typings field to package.json`);
|
||||
process.exit(1);
|
||||
}
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
const depcheckOptions = {
|
||||
ignoreBinPackage: false,
|
||||
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();
|
||||
plugins.beautylog.ora.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}`);
|
||||
}
|
||||
for (let item in unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item}`);
|
||||
}
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
let checkDevDependencies = (configArg) => {
|
||||
let done = q.defer();
|
||||
plugins.beautylog.ora.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}`);
|
||||
}
|
||||
for (let item in unused.missing) {
|
||||
plugins.beautylog.error(`missing devDependency ${item}`);
|
||||
}
|
||||
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}`);
|
||||
}
|
||||
for (let item in unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item}`);
|
||||
}
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
let checkNodeVersion = (configArg) => {
|
||||
let done = q.defer();
|
||||
plugins.beautylog.ora.text('checking node version');
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = (configArg) => __awaiter(this, void 0, void 0, function* () {
|
||||
plugins.beautylog.ora.text('Check Module: ...');
|
||||
if (configArg.checkDependencies) {
|
||||
configArg = yield checkProjectTypings(configArg);
|
||||
configArg = yield checkDependencies(configArg);
|
||||
configArg = yield checkDevDependencies(configArg);
|
||||
configArg = yield checkNodeVersion(configArg);
|
||||
return configArg;
|
||||
}
|
||||
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;
|
||||
};
|
5
dist/mod_compile/mod.plugins.d.ts
vendored
Normal file
5
dist/mod_compile/mod.plugins.d.ts
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
export * from '../npmts.plugins';
|
||||
import * as tsn from 'tsn';
|
||||
import * as smartchok from 'smartchok';
|
||||
import * as smartstream from 'smartstream';
|
||||
export { tsn, smartchok, smartstream };
|
12
dist/mod_compile/mod.plugins.js
vendored
Normal file
12
dist/mod_compile/mod.plugins.js
vendored
Normal file
@ -0,0 +1,12 @@
|
||||
"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 tsn = require("tsn");
|
||||
exports.tsn = tsn;
|
||||
const smartchok = require("smartchok");
|
||||
exports.smartchok = smartchok;
|
||||
const smartstream = require("smartstream");
|
||||
exports.smartstream = 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';
|
6
dist/mod_docs/mod.plugins.js
vendored
Normal file
6
dist/mod_docs/mod.plugins.js
vendored
Normal file
@ -0,0 +1,6 @@
|
||||
"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"));
|
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.assets.d.ts
vendored
4
dist/npmts.assets.d.ts
vendored
@ -1,4 +0,0 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare var run: (configArg: any) => plugins.Q.Promise<{}>;
|
20
dist/npmts.assets.js
vendored
20
dist/npmts.assets.js
vendored
@ -1,20 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
npmts_promisechain_1.npmtsOra.text('now looking at ' + 'required assets'.yellow);
|
||||
if (config.cli === true) {
|
||||
plugins.smartfile.fs.copySync(plugins.path.join(paths.npmtsAssetsDir, 'cli.js'), plugins.path.join(paths.distDir, 'cli.js'));
|
||||
plugins.beautylog.ok('installed CLI assets!');
|
||||
done.resolve(config);
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.ok('No additional assets required!');
|
||||
done.resolve(config);
|
||||
}
|
||||
return done.promise;
|
||||
};
|
5
dist/npmts.check.d.ts
vendored
5
dist/npmts.check.d.ts
vendored
@ -1,5 +0,0 @@
|
||||
/// <reference types="q" />
|
||||
import * as plugins from './npmts.plugins';
|
||||
import { ProjectinfoNpm } from 'projectinfo';
|
||||
export declare let projectInfo: ProjectinfoNpm;
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
127
dist/npmts.check.js
vendored
127
dist/npmts.check.js
vendored
@ -1,127 +0,0 @@
|
||||
"use strict";
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
var projectinfo_1 = require("projectinfo");
|
||||
var checkProjectTypings = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
exports.projectInfo = new projectinfo_1.ProjectinfoNpm(paths.cwd);
|
||||
if (typeof exports.projectInfo.packageJson.typings === 'undefined') {
|
||||
plugins.beautylog.error("please add typings field to package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
;
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
var depcheckOptions = {
|
||||
ignoreBinPackage: false,
|
||||
parsers: {
|
||||
'*.ts': plugins.depcheck.parser.typescript
|
||||
},
|
||||
detectors: [
|
||||
plugins.depcheck.detector.requireCallExpression,
|
||||
plugins.depcheck.detector.importDeclaration
|
||||
],
|
||||
specials: [
|
||||
plugins.depcheck.special.eslint,
|
||||
plugins.depcheck.special.webpack
|
||||
]
|
||||
};
|
||||
var checkDependencies = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
|
||||
ignoreDirs: [
|
||||
'test',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [
|
||||
'@types/*',
|
||||
'babel-preset-*'
|
||||
]
|
||||
});
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
|
||||
for (var _i = 0, _a = unused.dependencies; _i < _a.length; _i++) {
|
||||
var item = _a[_i];
|
||||
plugins.beautylog.warn("Watch out: unused dependency " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
|
||||
var item = _c[_b];
|
||||
plugins.beautylog.error("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info('exiting due to missing dependencies in package.json');
|
||||
process.exit(1);
|
||||
}
|
||||
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||
var item = _e[_d];
|
||||
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
|
||||
var item = _g[_f];
|
||||
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
||||
}
|
||||
;
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
var checkDevDependencies = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
|
||||
ignoreDirs: [
|
||||
'ts',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [
|
||||
'@types/*',
|
||||
'babel-preset-*'
|
||||
]
|
||||
});
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
|
||||
for (var _i = 0, _a = unused.devDependencies; _i < _a.length; _i++) {
|
||||
var item = _a[_i];
|
||||
plugins.beautylog.log("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
|
||||
var item = _c[_b];
|
||||
plugins.beautylog.error("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info('exiting due to missing dependencies in package.json');
|
||||
process.exit(1);
|
||||
}
|
||||
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||
var item = _e[_d];
|
||||
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||
}
|
||||
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
|
||||
var item = _g[_f];
|
||||
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
||||
}
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
var checkNodeVersion = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text('running project checks...');
|
||||
checkProjectTypings(configArg)
|
||||
.then(checkDependencies)
|
||||
.then(checkDevDependencies)
|
||||
.then(checkNodeVersion)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
4
dist/npmts.clean.d.ts
vendored
4
dist/npmts.clean.d.ts
vendored
@ -1,4 +0,0 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
24
dist/npmts.clean.js
vendored
24
dist/npmts.clean.js
vendored
@ -1,24 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
var removeDist = function () {
|
||||
npmts_promisechain_1.npmtsOra.text('cleaning dist folder');
|
||||
return plugins.smartfile.fs.remove(paths.distDir);
|
||||
};
|
||||
var removePages = function () {
|
||||
npmts_promisechain_1.npmtsOra.text('cleaning pages folder');
|
||||
return plugins.smartfile.fs.remove(paths.pagesDir);
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
npmts_promisechain_1.npmtsOra.text('cleaning up from previous builds...');
|
||||
var done = plugins.Q.defer();
|
||||
removeDist()
|
||||
.then(removePages)
|
||||
.then(function () {
|
||||
plugins.beautylog.ok('Cleaned up from previous builds!');
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
1
dist/npmts.cli.d.ts
vendored
Normal file
1
dist/npmts.cli.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
||||
export declare let run: () => Promise<{}>;
|
109
dist/npmts.cli.js
vendored
Normal file
109
dist/npmts.cli.js
vendored
Normal file
@ -0,0 +1,109 @@
|
||||
"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 });
|
||||
const q = require("smartq");
|
||||
const plugins = require("./npmts.plugins");
|
||||
const paths = require("./npmts.paths");
|
||||
const NpmtsConfig = require("./npmts.config");
|
||||
const NpmtsMods = require("./npmts.mods");
|
||||
const NpmtsWatch = require("./npmts.watch");
|
||||
const NpmtsShip = require("./npmts.ship");
|
||||
/**
|
||||
* smartanalytics
|
||||
* this data is fully anonymized (no Ips or any other personal information is tracked).
|
||||
* It just keeps track which of our tools are really used...
|
||||
* ... so we know where to spend our limited resources for improving them.
|
||||
* Since yarn is out and there is heavy caching going on,
|
||||
* pure download stats are just not reliable enough for us anymore
|
||||
* Feel free to dig into the smartanalytics package, if you are interested in how it works.
|
||||
* It is just an https call to our own Lossless Analytics API.
|
||||
* 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
|
||||
})
|
||||
.catch(err => {
|
||||
plugins.beautylog.warn('Lossless Analytics API not available...');
|
||||
});
|
||||
}));
|
||||
exports.run = () => __awaiter(this, void 0, void 0, function* () {
|
||||
let done = q.defer();
|
||||
plugins.beautylog.figletSync('NPMTS');
|
||||
let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
|
||||
// check for updates
|
||||
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 => {
|
||||
let done = q.defer();
|
||||
NpmtsMods.modDocs
|
||||
.load()
|
||||
.then(modDocs => {
|
||||
return modDocs.run(configArg);
|
||||
})
|
||||
.then(configArg => {
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
})
|
||||
.then(configArg => {
|
||||
let done = q.defer();
|
||||
NpmtsMods.modTest
|
||||
.load()
|
||||
.then(modTest => {
|
||||
return modTest.run(configArg);
|
||||
})
|
||||
.then(configArg => {
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
})
|
||||
.then(NpmtsWatch.run)
|
||||
.then(NpmtsShip.run);
|
||||
return done.promise;
|
||||
}), err => {
|
||||
if (err instanceof Error) {
|
||||
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);
|
||||
// start parsing
|
||||
npmtsCli.startParse();
|
||||
return yield done.promise;
|
||||
});
|
4
dist/npmts.compile.d.ts
vendored
4
dist/npmts.compile.d.ts
vendored
@ -1,4 +0,0 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
21
dist/npmts.compile.js
vendored
21
dist/npmts.compile.js
vendored
@ -1,21 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
npmts_promisechain_1.npmtsOra.text('now compiling ' + 'TypeScript'.yellow);
|
||||
plugins.tsn.compileGlobStringObject(config.ts, config.tsOptions, paths.cwd)
|
||||
.then(function () {
|
||||
plugins.beautylog.ok('compiled main TypeScript!');
|
||||
plugins.beautylog.log('now compiling tests!');
|
||||
return plugins.tsn.compileGlobStringObject(config.testTs);
|
||||
})
|
||||
.then(function () {
|
||||
plugins.beautylog.ok('compiled all TypeScript!');
|
||||
done.resolve(config);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
26
dist/npmts.config.d.ts
vendored
Normal file
26
dist/npmts.config.d.ts
vendored
Normal file
@ -0,0 +1,26 @@
|
||||
import { ITapbufferConfig } from 'tapbuffer';
|
||||
/**
|
||||
* 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 {
|
||||
argv: any;
|
||||
coverageTreshold: number;
|
||||
checkDependencies: boolean;
|
||||
mode: npmtsMode;
|
||||
test: boolean;
|
||||
testTs: any;
|
||||
testConfig: ITapbufferConfig;
|
||||
ts: any;
|
||||
tsOptions: any;
|
||||
watch: boolean;
|
||||
runData: {
|
||||
coverageLcovInfo?: string;
|
||||
coverageResult?: number;
|
||||
};
|
||||
}
|
||||
export declare let run: (argvArg: any) => Promise<INpmtsConfig>;
|
||||
export declare let configPromise: Promise<INpmtsConfig>;
|
71
dist/npmts.config.js
vendored
Normal file
71
dist/npmts.config.js
vendored
Normal file
@ -0,0 +1,71 @@
|
||||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const plugins = require("./npmts.plugins");
|
||||
const paths = require("./npmts.paths");
|
||||
const smartq = require("smartq");
|
||||
exports.run = function (argvArg) {
|
||||
let done = smartq.defer();
|
||||
let defaultConfig = {
|
||||
argv: undefined,
|
||||
coverageTreshold: 70,
|
||||
checkDependencies: true,
|
||||
mode: 'default',
|
||||
test: true,
|
||||
testTs: {},
|
||||
testConfig: {
|
||||
parallel: true,
|
||||
coverage: true
|
||||
},
|
||||
ts: {},
|
||||
tsOptions: {},
|
||||
watch: false,
|
||||
runData: {}
|
||||
};
|
||||
// mix with configfile
|
||||
plugins.beautylog.ora.text('running npmextra');
|
||||
let localNpmextra = new plugins.npmextra.Npmextra(paths.cwd);
|
||||
let config = localNpmextra.dataFor('npmts', defaultConfig);
|
||||
// add argv
|
||||
config.argv = argvArg;
|
||||
// check mode
|
||||
switch (config.mode) {
|
||||
case 'default':
|
||||
case 'custom':
|
||||
case 'merge':
|
||||
plugins.beautylog.ok('mode is ' + config.mode);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error(`mode not recognised! Can be default or custom`);
|
||||
process.exit(1);
|
||||
}
|
||||
// handle default mode
|
||||
if (config.mode === 'default' || config.mode === 'merge') {
|
||||
config.ts = {
|
||||
'./ts/**/*.ts': './dist/'
|
||||
};
|
||||
config.testTs = {
|
||||
'./test/**/*.ts': './test/'
|
||||
};
|
||||
}
|
||||
// mix with commandline
|
||||
if (config.argv.notest) {
|
||||
config.test = false;
|
||||
}
|
||||
if (config.argv.nocoverage) {
|
||||
config.testConfig.coverage = false;
|
||||
}
|
||||
if (config.argv.nochecks) {
|
||||
config.checkDependencies = false;
|
||||
}
|
||||
if (config.argv.watch) {
|
||||
config.watch = true;
|
||||
}
|
||||
plugins.beautylog.ok('build options are ready!');
|
||||
done.resolve(config);
|
||||
configDeferred.resolve(config);
|
||||
return done.promise;
|
||||
};
|
||||
// config deferred usage
|
||||
let configDeferred = smartq.defer();
|
||||
exports.configPromise = configDeferred.promise;
|
7
dist/npmts.mods.d.ts
vendored
Normal file
7
dist/npmts.mods.d.ts
vendored
Normal file
@ -0,0 +1,7 @@
|
||||
import * as plugins from './npmts.plugins';
|
||||
import * as _modCompile from './mod_compile/index';
|
||||
import * as _modDocs from './mod_docs/index';
|
||||
import * as _modTest from './mod_test/index';
|
||||
export declare let modCompile: plugins.smartsystem.LazyModule<typeof _modCompile>;
|
||||
export declare let modDocs: plugins.smartsystem.LazyModule<typeof _modDocs>;
|
||||
export declare let modTest: plugins.smartsystem.LazyModule<typeof _modTest>;
|
6
dist/npmts.mods.js
vendored
Normal file
6
dist/npmts.mods.js
vendored
Normal file
@ -0,0 +1,6 @@
|
||||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const smartsystem_1 = require("smartsystem");
|
||||
exports.modCompile = new smartsystem_1.LazyModule('./mod_compile/index', __dirname);
|
||||
exports.modDocs = new smartsystem_1.LazyModule('./mod_docs/index', __dirname);
|
||||
exports.modTest = new smartsystem_1.LazyModule('./mod_test/index', __dirname);
|
15
dist/npmts.options.d.ts
vendored
15
dist/npmts.options.d.ts
vendored
@ -1,15 +0,0 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare type npmtsMode = 'default' | 'custom';
|
||||
export interface INpmtsConfig {
|
||||
argv: any;
|
||||
coverageTreshold: number;
|
||||
docs: boolean;
|
||||
mode: npmtsMode;
|
||||
test: boolean;
|
||||
testTs: any;
|
||||
ts: any;
|
||||
tsOptions: any;
|
||||
}
|
||||
export declare var run: (argvArg: any) => plugins.Q.Promise<{}>;
|
63
dist/npmts.options.js
vendored
63
dist/npmts.options.js
vendored
@ -1,63 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
;
|
||||
exports.run = function (argvArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var defaultConfig = {
|
||||
argv: undefined,
|
||||
coverageTreshold: 70,
|
||||
docs: true,
|
||||
mode: 'default',
|
||||
test: true,
|
||||
testTs: {},
|
||||
ts: {},
|
||||
tsOptions: {}
|
||||
};
|
||||
// mix with configfile
|
||||
npmts_promisechain_1.npmtsOra.text('looking for npmextra.json');
|
||||
var config = plugins.npmextra.dataFor({
|
||||
toolName: 'npmts',
|
||||
defaultSettings: defaultConfig,
|
||||
cwd: paths.cwd
|
||||
});
|
||||
// add argv
|
||||
config.argv = argvArg;
|
||||
// check mode
|
||||
switch (config.mode) {
|
||||
case 'default':
|
||||
case 'custom':
|
||||
plugins.beautylog.ok('mode is ' + config.mode);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error("mode not recognised!");
|
||||
process.exit(1);
|
||||
}
|
||||
;
|
||||
// handle default mode
|
||||
if (config.mode === 'default') {
|
||||
config.ts = (_a = {},
|
||||
_a['./ts/**/*.ts'] = './dist/',
|
||||
_a);
|
||||
config.testTs = (_b = {},
|
||||
_b['./test/test.ts'] = './test/',
|
||||
_b);
|
||||
}
|
||||
;
|
||||
// mix with commandline
|
||||
if (config.argv.notest) {
|
||||
config.test = false;
|
||||
}
|
||||
;
|
||||
if (config.argv.nodocs) {
|
||||
config.docs = false;
|
||||
}
|
||||
;
|
||||
plugins.beautylog.ok('build options are ready!');
|
||||
done.resolve(config);
|
||||
return done.promise;
|
||||
var _a, _b;
|
||||
};
|
1
dist/npmts.paths.d.ts
vendored
1
dist/npmts.paths.d.ts
vendored
@ -1,4 +1,3 @@
|
||||
import 'typings-global';
|
||||
export declare let npmtsPackageRoot: string;
|
||||
export declare let cwd: string;
|
||||
export declare let tsDir: string;
|
||||
|
4
dist/npmts.paths.js
vendored
4
dist/npmts.paths.js
vendored
@ -1,6 +1,6 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const plugins = require("./npmts.plugins");
|
||||
// NPMTS Paths
|
||||
exports.npmtsPackageRoot = plugins.path.join(__dirname, '../');
|
||||
// Project paths
|
||||
|
44
dist/npmts.plugins.d.ts
vendored
44
dist/npmts.plugins.d.ts
vendored
@ -1,27 +1,17 @@
|
||||
import 'typings-global';
|
||||
export import beautylog = require('beautylog');
|
||||
export declare let depcheck: any;
|
||||
export import gulp = require('gulp');
|
||||
export declare let g: {
|
||||
babel: any;
|
||||
istanbul: any;
|
||||
gFunction: any;
|
||||
injectModules: any;
|
||||
mocha: any;
|
||||
sourcemaps: any;
|
||||
typedoc: any;
|
||||
};
|
||||
export import lodash = require('lodash');
|
||||
export import npmextra = require('npmextra');
|
||||
export import projectinfo = require('projectinfo');
|
||||
export import path = require('path');
|
||||
export import Q = require('q');
|
||||
export import shelljs = require('shelljs');
|
||||
export import smartcli = require('smartcli');
|
||||
export import smartcov = require('smartcov');
|
||||
export import smartenv = require('smartenv');
|
||||
export import smartfile = require('smartfile');
|
||||
export import smartpath = require('smartpath');
|
||||
export import smartstring = require('smartstring');
|
||||
export declare let sourceMapSupport: any;
|
||||
export import tsn = require('tsn');
|
||||
import * as beautylog from 'beautylog';
|
||||
declare let depcheck: any;
|
||||
import * as lodash from 'lodash';
|
||||
import * as npmextra from 'npmextra';
|
||||
import * as projectinfo from 'projectinfo';
|
||||
import * as path from 'path';
|
||||
import * as smartanalytics from 'smartanalytics';
|
||||
import * as smartcli from '@pushrocks/smartcli';
|
||||
import * as smarterror from 'smarterror';
|
||||
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 smartupdate from 'smartupdate';
|
||||
import * as through2 from 'through2';
|
||||
export { beautylog, depcheck, lodash, npmextra, projectinfo, path, smartanalytics, smartcli, smarterror, smartfile, smartpath, smartstream, smartstring, smartsystem, smartupdate, through2 };
|
||||
|
60
dist/npmts.plugins.js
vendored
60
dist/npmts.plugins.js
vendored
@ -1,28 +1,34 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
exports.beautylog = require("beautylog");
|
||||
exports.depcheck = require('depcheck');
|
||||
exports.gulp = require("gulp");
|
||||
exports.g = {
|
||||
babel: require('gulp-babel'),
|
||||
istanbul: require('gulp-istanbul'),
|
||||
gFunction: require('gulp-function'),
|
||||
injectModules: require('gulp-inject-modules'),
|
||||
mocha: require('gulp-mocha'),
|
||||
sourcemaps: require('gulp-sourcemaps'),
|
||||
typedoc: require('gulp-typedoc')
|
||||
};
|
||||
exports.lodash = require("lodash");
|
||||
exports.npmextra = require("npmextra");
|
||||
exports.projectinfo = require("projectinfo");
|
||||
exports.path = require("path");
|
||||
exports.Q = require("q");
|
||||
exports.shelljs = require("shelljs");
|
||||
exports.smartcli = require("smartcli");
|
||||
exports.smartcov = require("smartcov");
|
||||
exports.smartenv = require("smartenv");
|
||||
exports.smartfile = require("smartfile");
|
||||
exports.smartpath = require("smartpath");
|
||||
exports.smartstring = require("smartstring");
|
||||
exports.sourceMapSupport = require('source-map-support').install(); // display errors correctly during testing
|
||||
exports.tsn = require("tsn");
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const beautylog = require("beautylog");
|
||||
exports.beautylog = beautylog;
|
||||
let depcheck = require('depcheck');
|
||||
exports.depcheck = depcheck;
|
||||
const lodash = require("lodash");
|
||||
exports.lodash = lodash;
|
||||
const npmextra = require("npmextra");
|
||||
exports.npmextra = npmextra;
|
||||
const projectinfo = require("projectinfo");
|
||||
exports.projectinfo = projectinfo;
|
||||
const path = require("path");
|
||||
exports.path = path;
|
||||
const smartanalytics = require("smartanalytics");
|
||||
exports.smartanalytics = smartanalytics;
|
||||
const smartcli = require("@pushrocks/smartcli");
|
||||
exports.smartcli = smartcli;
|
||||
const smarterror = require("smarterror");
|
||||
exports.smarterror = smarterror;
|
||||
const smartfile = require("smartfile");
|
||||
exports.smartfile = smartfile;
|
||||
const smartpath = require("smartpath");
|
||||
exports.smartpath = smartpath;
|
||||
const smartstream = require("smartstream");
|
||||
exports.smartstream = smartstream;
|
||||
const smartstring = require("smartstring");
|
||||
exports.smartstring = smartstring;
|
||||
const smartsystem = require("smartsystem");
|
||||
exports.smartsystem = smartsystem;
|
||||
const smartupdate = require("smartupdate");
|
||||
exports.smartupdate = smartupdate;
|
||||
const through2 = require("through2");
|
||||
exports.through2 = through2;
|
||||
|
6
dist/npmts.promisechain.d.ts
vendored
6
dist/npmts.promisechain.d.ts
vendored
@ -1,6 +0,0 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
import { Ora } from 'beautylog';
|
||||
export declare let npmtsOra: Ora;
|
||||
export declare let promisechain: (argvArg: any) => plugins.Q.Promise<{}>;
|
48
dist/npmts.promisechain.js
vendored
48
dist/npmts.promisechain.js
vendored
@ -1,48 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var beautylog_1 = require("beautylog");
|
||||
exports.npmtsOra = new beautylog_1.Ora('setting up TaskChain', 'cyan');
|
||||
var NpmtsAssets = require("./npmts.assets");
|
||||
var NpmtsCheck = require("./npmts.check");
|
||||
var NpmtsClean = require("./npmts.clean");
|
||||
var NpmtsCompile = require("./npmts.compile");
|
||||
var NpmtsTypeDoc = require("./npmts.typedoc");
|
||||
var NpmtsOptions = require("./npmts.options");
|
||||
var NpmtsTests = require("./npmts.tests");
|
||||
exports.promisechain = function (argvArg) {
|
||||
var done = plugins.Q.defer();
|
||||
exports.npmtsOra.start();
|
||||
NpmtsOptions.run(argvArg)
|
||||
.then(NpmtsClean.run)
|
||||
.then(NpmtsCheck.run)
|
||||
.then(NpmtsCompile.run)
|
||||
.then(NpmtsAssets.run)
|
||||
.then(NpmtsTypeDoc.run)
|
||||
.then(NpmtsTests.run)
|
||||
.then(function (configArg) {
|
||||
var 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();
|
||||
});
|
||||
return done.promise;
|
||||
};
|
2
dist/npmts.ship.d.ts
vendored
Normal file
2
dist/npmts.ship.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
import { INpmtsConfig } from './npmts.config';
|
||||
export declare let run: (configArg: INpmtsConfig) => void;
|
29
dist/npmts.ship.js
vendored
Normal file
29
dist/npmts.ship.js
vendored
Normal file
@ -0,0 +1,29 @@
|
||||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const q = require("smartq");
|
||||
const plugins = require("./npmts.plugins");
|
||||
exports.run = (configArg) => {
|
||||
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);
|
||||
};
|
4
dist/npmts.tests.d.ts
vendored
4
dist/npmts.tests.d.ts
vendored
@ -1,4 +0,0 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
83
dist/npmts.tests.js
vendored
83
dist/npmts.tests.js
vendored
@ -1,83 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
/**
|
||||
*
|
||||
* @returns {*}
|
||||
*/
|
||||
var mocha = function (configArg) {
|
||||
npmts_promisechain_1.npmtsOra.text('Instrumentalizing and testing transpiled JS');
|
||||
npmts_promisechain_1.npmtsOra.end(); // end npmtsOra for tests.
|
||||
var done = plugins.Q.defer();
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'dist/*.js')])
|
||||
.pipe(plugins.g.sourcemaps.init())
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve('babel-preset-es2015')
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.istanbul({}))
|
||||
.pipe(plugins.g.sourcemaps.write())
|
||||
.pipe(plugins.g.injectModules())
|
||||
.on('finish', function () {
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')])
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve('babel-preset-es2015')
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.injectModules())
|
||||
.pipe(plugins.g.mocha())
|
||||
.pipe(plugins.g.istanbul.writeReports({
|
||||
dir: plugins.path.join(paths.cwd, './coverage'),
|
||||
reporters: ['lcovonly', 'json', 'text', 'text-summary']
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(function () {
|
||||
plugins.beautylog.ok('Tested!');
|
||||
done.resolve(configArg);
|
||||
}, 'atEnd'));
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
var coverage = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, 'lcov.info'), 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');
|
||||
process.exit(1);
|
||||
}
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
if (config.test === true) {
|
||||
npmts_promisechain_1.npmtsOra.text('now starting tests');
|
||||
plugins.beautylog.log('-------------------------------------------------------\n' +
|
||||
'*************************** TESTS: ***************************\n' +
|
||||
'--------------------------------------------------------------');
|
||||
mocha(config)
|
||||
.then(coverage)
|
||||
.then(function () {
|
||||
done.resolve(config);
|
||||
});
|
||||
}
|
||||
else {
|
||||
npmts_promisechain_1.npmtsOra.end();
|
||||
done.resolve(config);
|
||||
}
|
||||
return done.promise;
|
||||
};
|
4
dist/npmts.typedoc.d.ts
vendored
4
dist/npmts.typedoc.d.ts
vendored
@ -1,4 +0,0 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
43
dist/npmts.typedoc.js
vendored
43
dist/npmts.typedoc.js
vendored
@ -1,43 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
var npmts_check_1 = require("./npmts.check");
|
||||
var genTypeDoc = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text('now generating ' + 'TypeDoc documentation'.yellow);
|
||||
plugins.beautylog.log('TypeDoc Output:');
|
||||
plugins.gulp.src(plugins.path.join(paths.tsDir, '**/*.ts'))
|
||||
.pipe(plugins.g.typedoc({
|
||||
// TypeScript options (see typescript docs)
|
||||
module: 'commonjs',
|
||||
target: 'es6',
|
||||
includeDeclarations: true,
|
||||
// Output options (see typedoc docs)
|
||||
out: paths.pagesApiDir,
|
||||
json: plugins.path.join(paths.pagesApiDir, 'file.json'),
|
||||
// TypeDoc options (see typedoc docs)
|
||||
name: npmts_check_1.projectInfo.name,
|
||||
readme: plugins.path.join(paths.cwd, 'README.md'),
|
||||
// theme: "default",
|
||||
ignoreCompilerErrors: true,
|
||||
version: true
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(done.resolve, 'atEnd'));
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
if (configArg.docs) {
|
||||
genTypeDoc(configArg)
|
||||
.then(function () {
|
||||
done.resolve(configArg);
|
||||
});
|
||||
}
|
||||
else {
|
||||
done.resolve(configArg);
|
||||
}
|
||||
;
|
||||
return done.promise;
|
||||
};
|
2
dist/npmts.watch.d.ts
vendored
Normal file
2
dist/npmts.watch.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
import { INpmtsConfig } from './npmts.config';
|
||||
export declare let run: (configArg: INpmtsConfig) => Promise<{}>;
|
33
dist/npmts.watch.js
vendored
Normal file
33
dist/npmts.watch.js
vendored
Normal file
@ -0,0 +1,33 @@
|
||||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const q = require("smartq");
|
||||
const smartchok = require("smartchok");
|
||||
const plugins = require("./npmts.plugins");
|
||||
const cli = require("./npmts.cli");
|
||||
let npmtsSmartchok = null;
|
||||
exports.run = (configArg) => {
|
||||
let done = q.defer();
|
||||
if (configArg.watch && npmtsSmartchok === null) {
|
||||
let pathsToWatch = [];
|
||||
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;
|
||||
};
|
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
|
||||
```
|
88
docs/config.md
Normal file
88
docs/config.md
Normal file
@ -0,0 +1,88 @@
|
||||
---
|
||||
name: config
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
npmts can be configured to your needs.
|
||||
|
||||
### npmextra.json
|
||||
|
||||
the npmts section in npmextra.json can be used to configure npmts.
|
||||
|
||||
**Default**
|
||||
|
||||
> Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
|
||||
> with default behaviour.
|
||||
|
||||
```json
|
||||
{
|
||||
"npmts": {
|
||||
"mode": "default"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Custom settings**
|
||||
|
||||
```json
|
||||
{
|
||||
"mode": "custom",
|
||||
"test": true,
|
||||
"npmts": {
|
||||
"ts": {
|
||||
"./customdir/*.ts": "./"
|
||||
},
|
||||
"tsOptions": {
|
||||
"declaration": false,
|
||||
"target": "ES6"
|
||||
},
|
||||
"cli": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
| key | default value | description |
|
||||
| -------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify, "merge" will merge default options with whatever you specify on your own |
|
||||
| `"test"` | `true` | test your module |
|
||||
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
|
||||
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
|
||||
| `"cli"` | `"false"` | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
|
||||
| `"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
|
||||
|
||||
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
||||
`./dist/*.js` and `./test/test.js`
|
||||
|
||||
Use commonjs module system for wiring up files.
|
||||
|
||||
### Declaration files
|
||||
|
||||
**npmts** also creates declaration files like `./dist/index.d.ts` by default.
|
||||
You can reference it in your package.json like this.
|
||||
|
||||
```json
|
||||
"main": "dist/index.js",
|
||||
"typings": ".dist/index.d.ts",
|
||||
```
|
||||
|
||||
This is in line with the latest TypeScript best practices.
|
||||
You can then import plugins via the TypeScript `import` Syntax
|
||||
and tsc will pick up the declaration file automatically.
|
||||
|
||||
## Some notes:
|
||||
|
||||
#### Typings for third party modules that do not bundle declaration files
|
||||
|
||||
NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
|
||||
|
||||
#### Instrumentalize Code
|
||||
|
||||
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
||||
|
||||
#### Tests
|
||||
|
||||
Any errors will be shown with reference to their originating source in TypeScript
|
||||
thanks to autogenerated source maps.
|
13
docs/default.md
Normal file
13
docs/default.md
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
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. **Clean:** Clean up from any previous builds (old js files)
|
||||
1. **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies
|
||||
1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
|
||||
1. **Test:** transpile TypeScript of module to ES5 for tests (so it can be instrumentalized) and pipe it to tapbuffer. All this happens in memory.
|
23
docs/examples.md
Normal file
23
docs/examples.md
Normal file
@ -0,0 +1,23 @@
|
||||
---
|
||||
name: Examples
|
||||
---
|
||||
|
||||
# Examples
|
||||
|
||||
modules that use npmts in theis development workflow
|
||||
|
||||
| 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 |
|
||||
|
||||
> There are tons more... We will add them here over time.
|
||||
|
||||
### Tips and tricks:
|
||||
|
||||
- Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available.
|
||||
- Use [npmpage](https://www.npmjs.com/package/npmpage) to create a webpage from coverage reports and TypeDoc for the module
|
||||
- Use [hosttoday/ht-docker-node: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
|
52
docs/index.md
Normal file
52
docs/index.md
Normal file
@ -0,0 +1,52 @@
|
||||
---
|
||||
name: Index
|
||||
description: best practice npm TypeScript modules
|
||||
---
|
||||
|
||||
# npmts
|
||||
|
||||
best practice npm TypeScript modules
|
||||
|
||||
## Availabililty
|
||||
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://GitLab.com/gitzone/npmts)
|
||||
[](https://github.com/gitzone/npmts)
|
||||
[](https://gitzone.gitlab.io/npmts/)
|
||||
|
||||
## Status for master
|
||||
|
||||
[](https://GitLab.com/gitzone/npmts/commits/master)
|
||||
[](https://GitLab.com/gitzone/npmts/commits/master)
|
||||
[](https://www.npmjs.com/package/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/)
|
||||
[](http://standardjs.com/)
|
||||
|
||||
## 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 will
|
||||
|
||||
1. check your dependencies and package.json (unused, missing, updates, security)
|
||||
1. transpile your code with tsc,
|
||||
1. test your code with tap (supports the fancy stuff like Promises, Generators, async/await, sourcemaps, parallel test execution in child processes)
|
||||
1. create coverage with istanbul (supports tracing of the originating TypeScript)
|
||||
|
||||
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:
|
||||
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
|
||||
[](https:/git.zone)
|
@ -1,8 +1,9 @@
|
||||
# Install npmts
|
||||
First install npmts globally, then install the npmts-g locally.
|
||||
|
||||
> **npmts-g* checks if the global version of npmts suffices the modules requirements.
|
||||
If not it installs npmts locally in the right version during npm install.
|
||||
Get started with TypeScript awesomeness.
|
||||
|
||||
> \*_npmts-g_ checks if the global version of npmts suffices the modules requirements.
|
||||
> If not it installs npmts locally in the right version during npm install.
|
||||
|
||||
```sh
|
||||
npm install npmts -g # installs npmts globally
|
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,15 +0,0 @@
|
||||
{
|
||||
"structure": {
|
||||
"readme": "index.md"
|
||||
},
|
||||
"plugins": [
|
||||
"tonic",
|
||||
"edit-link"
|
||||
],
|
||||
"pluginsConfig": {
|
||||
"edit-link": {
|
||||
"base": "https://gitlab.com/pushrocks/npmts/edit/master/docs/",
|
||||
"label": "Edit on GitLab"
|
||||
}
|
||||
}
|
||||
}
|
@ -1,80 +0,0 @@
|
||||
# Configuration of NPMTS
|
||||
npmts can be configured to your needs:
|
||||
|
||||
### npmextra.json
|
||||
the npmts section in npmextra.json can be used to configure npmts.
|
||||
|
||||
**Default**
|
||||
>Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
|
||||
with default behaviour.
|
||||
|
||||
```json
|
||||
{
|
||||
"npmts":{
|
||||
"mode":"default"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Custom settings**
|
||||
```json
|
||||
{
|
||||
"mode":"custom",
|
||||
"docs":false,
|
||||
"test":true,
|
||||
"npmts":{
|
||||
"ts":{
|
||||
"./customdir/*.ts":"./"
|
||||
},
|
||||
"tsOptions":{
|
||||
"declaration":false,
|
||||
"target":"ES6"
|
||||
},
|
||||
"cli":true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
| key | default value | description |
|
||||
| --- | --- | --- |
|
||||
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
|
||||
| `"docs"` | `true` | create docs for your module |
|
||||
| `"test"` | `true` | test your module |
|
||||
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
|
||||
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
|
||||
| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
|
||||
|
||||
### TypeScript
|
||||
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
||||
`./dist/*.js` and `./test/test.js`
|
||||
|
||||
Use commonjs module system for wiring up files.
|
||||
|
||||
### Declaration files
|
||||
**npmts** also creates declaration files like `./dist/index.d.ts` by default.
|
||||
You can reference it in your package.json like this.
|
||||
|
||||
```json
|
||||
"main": "dist/index.js",
|
||||
"typings": ".dist/index.d.ts",
|
||||
```
|
||||
|
||||
This is in line with the latest TypeScript best practices.
|
||||
You can then import plugins via the TypeScript `import` Syntax
|
||||
and tsc will pick up the declaration file automatically.
|
||||
|
||||
### TypeDoc
|
||||
By default TypeDoc will create docs for your module in `./pages/api/` directory.
|
||||
> Note: Use [npmpage](https://www.npmjs.com/package/npmpage) to build a website for the module.
|
||||
It also allows you to integrate api docs with a gitbook located in `./docs/`
|
||||
|
||||
## Some notes:
|
||||
#### Typings for third party modules that do not bundle declaration files
|
||||
NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
|
||||
|
||||
#### Instrumentalize Code
|
||||
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
||||
|
||||
#### Tests
|
||||
Any errors will be shown with reference to their originating source in TypeScript
|
||||
thanks to autogenerated source maps.
|
@ -1,8 +0,0 @@
|
||||
# Default task execution of npmts
|
||||
|
||||
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
|
||||
1. **Clean:** Clean up from any previous builds (old js files)
|
||||
1. **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies
|
||||
1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
|
||||
1. **Documentation:** Create TypeDoc Documentation from TypeScript files
|
||||
1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
|
@ -1,13 +0,0 @@
|
||||
# Examples for npmts
|
||||
|
||||
## Example Usage in modules:
|
||||
* [gulp-browser](https://www.npmjs.com/package/gulp-browser)
|
||||
|
||||
> We will add more options over time.
|
||||
|
||||
## Tips and tricks:
|
||||
|
||||
* Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available.
|
||||
* Use [npmpage](https://www.npmjs.com/package/npmpage) to create a webpage from coverage reports and TypeDoc for the module
|
||||
* Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds
|
||||
* Use [npmdocker](https://www.npmjs.com/package/npmdocker) for running tests consistently with docker.
|
@ -1,36 +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/docs)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://david-dm.org/pushrocks/npmts)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](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.
|
||||
|
||||
[](https://push.rocks)
|
@ -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 +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)
|
@ -1,6 +1,6 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2016 Push.Rocks
|
||||
Copyright (c) 2016 Lossless GmbH
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
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
87
package.json
87
package.json
@ -1,69 +1,52 @@
|
||||
{
|
||||
"name": "npmts",
|
||||
"version": "5.4.35",
|
||||
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
||||
"main": "dist/index.js",
|
||||
"name": "@gitzone/tscoverage",
|
||||
"version": "9.0.2",
|
||||
"description": "get coverage information for gitzone projects",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"bin": {
|
||||
"npmts": "dist/cli.js"
|
||||
"tscoverage": "cli.js"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "(npm run compile && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest && npm run checkNoDocs)",
|
||||
"compile": "(rm -rf test/ && rm -r dist/ && mkdir dist/ && tsc && cp assets/cli.js dist/ )",
|
||||
"setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
|
||||
"typedoc": "(typedoc --out ./pages/api --target ES6 ./ts/)",
|
||||
"npmpage": "(npmpage)",
|
||||
"check": "(cd test && npm install && node ../dist/index.js)",
|
||||
"checkVersion": "(cd test/ && node ../dist/index.js -v)",
|
||||
"checkNoTest": "(cd test && node ../dist/index.js --notest)",
|
||||
"checkNoDocs": "(cd test && node ../dist/index.js --nodocs)"
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild --web)"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://gitlab.com/pushrocks/npmts.git"
|
||||
"url": "git+https://gitlab.com/gitzone/npmts.git"
|
||||
},
|
||||
"keywords": [
|
||||
"TypeScript",
|
||||
"Declaration"
|
||||
],
|
||||
"author": "Lossless Digital UG (haftungsbeschraenkt)",
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"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.31",
|
||||
"@types/minimatch": "^2.0.28",
|
||||
"@types/q": "^0.x.x",
|
||||
"@types/shelljs": "^0.3.30",
|
||||
"babel-preset-es2015": "^6.14.0",
|
||||
"beautylog": "5.0.23",
|
||||
"depcheck": "^0.6.4",
|
||||
"early": "^2.0.28",
|
||||
"gulp": "3.9.1",
|
||||
"gulp-babel": "^6.1.2",
|
||||
"gulp-function": "^1.3.6",
|
||||
"gulp-inject-modules": "^1.0.0",
|
||||
"gulp-istanbul": "^1.1.1",
|
||||
"gulp-mocha": "^3.0.1",
|
||||
"gulp-sourcemaps": "^1.6.0",
|
||||
"gulp-typedoc": "^2.0.0",
|
||||
"lodash": "^4.15.0",
|
||||
"npmextra": "^1.0.11",
|
||||
"projectinfo": "1.0.3",
|
||||
"q": "^1.4.1",
|
||||
"shelljs": "^0.7.4",
|
||||
"smartcli": "1.0.9",
|
||||
"smartcov": "1.0.0",
|
||||
"smartenv": "1.2.5",
|
||||
"smartfile": "4.0.18",
|
||||
"smartpath": "3.2.2",
|
||||
"smartstring": "^2.0.17",
|
||||
"source-map-support": "^0.4.2",
|
||||
"tsn": "^2.0.3",
|
||||
"typedoc": "^0.4.5",
|
||||
"typescript": "next",
|
||||
"typings-global": "^1.0.14"
|
||||
"homepage": "https://gitlab.com/gitzone/npmts#readme",
|
||||
"dependencies": {},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.24",
|
||||
"@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"
|
||||
},
|
||||
"devDependencies": {}
|
||||
"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();
|
29
ts/index.ts
29
ts/index.ts
@ -1,28 +1 @@
|
||||
import 'typings-global'
|
||||
|
||||
/* ================================================== *
|
||||
Starting NPMTS main process.
|
||||
* ================================================== */
|
||||
import * as early from 'early'
|
||||
early.start('NPMTS')
|
||||
import * as plugins from './npmts.plugins'
|
||||
import * as paths from './npmts.paths'
|
||||
import {promisechain} from './npmts.promisechain'
|
||||
early.stop()
|
||||
.then(() => {
|
||||
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)
|
||||
try {
|
||||
promisechain(argvArg)
|
||||
} catch (err) {
|
||||
console.log(err)
|
||||
}
|
||||
})
|
||||
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version)
|
||||
npmtsCli.startParse()
|
||||
})
|
||||
console.log('tscoverage');
|
||||
|
@ -1,22 +0,0 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import {npmtsOra} from './npmts.promisechain'
|
||||
|
||||
export var run = function(configArg){
|
||||
let done = plugins.Q.defer()
|
||||
let config = configArg
|
||||
npmtsOra.text('now looking at ' + 'required assets'.yellow)
|
||||
if (config.cli === true) {
|
||||
plugins.smartfile.fs.copySync(
|
||||
plugins.path.join(paths.npmtsAssetsDir,'cli.js'),
|
||||
plugins.path.join(paths.distDir,'cli.js')
|
||||
)
|
||||
plugins.beautylog.ok('installed CLI assets!')
|
||||
done.resolve(config)
|
||||
} else {
|
||||
plugins.beautylog.ok('No additional assets required!')
|
||||
done.resolve(config)
|
||||
}
|
||||
return done.promise
|
||||
}
|
@ -1,120 +0,0 @@
|
||||
import * as plugins from './npmts.plugins'
|
||||
import * as paths from './npmts.paths'
|
||||
import { npmtsOra } from './npmts.promisechain'
|
||||
|
||||
import {ProjectinfoNpm} from 'projectinfo'
|
||||
|
||||
export let projectInfo: ProjectinfoNpm
|
||||
|
||||
let checkProjectTypings = (configArg) => {
|
||||
let done = plugins.Q.defer()
|
||||
projectInfo = new ProjectinfoNpm(paths.cwd)
|
||||
if (typeof projectInfo.packageJson.typings === 'undefined') {
|
||||
plugins.beautylog.error(`please add typings field to package.json`)
|
||||
process.exit(1)
|
||||
};
|
||||
done.resolve(configArg)
|
||||
return done.promise
|
||||
}
|
||||
|
||||
const depcheckOptions = {
|
||||
ignoreBinPackage: false, // ignore the packages with bin entry
|
||||
parsers: { // the target parsers
|
||||
'*.ts': plugins.depcheck.parser.typescript
|
||||
},
|
||||
detectors: [ // the target detectors
|
||||
plugins.depcheck.detector.requireCallExpression,
|
||||
plugins.depcheck.detector.importDeclaration
|
||||
],
|
||||
specials: [ // the target special parsers
|
||||
plugins.depcheck.special.eslint,
|
||||
plugins.depcheck.special.webpack
|
||||
]
|
||||
}
|
||||
|
||||
let checkDependencies = (configArg) => {
|
||||
let done = plugins.Q.defer()
|
||||
let depcheckOptionsMerged = plugins.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.red}`)
|
||||
};
|
||||
for (let item of unused.missing) {
|
||||
plugins.beautylog.error(`unused devDependency ${item.red}`)
|
||||
};
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info('exiting due to missing dependencies in package.json')
|
||||
process.exit(1)
|
||||
}
|
||||
for (let item of unused.invalidFiles) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`)
|
||||
};
|
||||
for (let item of unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
|
||||
};
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
let checkDevDependencies = (configArg) => {
|
||||
let done = plugins.Q.defer()
|
||||
let depcheckOptionsMerged = plugins.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 of unused.missing) {
|
||||
plugins.beautylog.error(`unused devDependency ${item.red}`)
|
||||
};
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info('exiting due to missing dependencies in package.json')
|
||||
process.exit(1)
|
||||
}
|
||||
for (let item of unused.invalidFiles) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`)
|
||||
}
|
||||
for (let item of unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
|
||||
}
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
let checkNodeVersion = (configArg) => {
|
||||
let done = plugins.Q.defer()
|
||||
done.resolve(configArg)
|
||||
return done.promise
|
||||
}
|
||||
|
||||
export let run = (configArg) => {
|
||||
let done = plugins.Q.defer()
|
||||
npmtsOra.text('running project checks...')
|
||||
checkProjectTypings(configArg)
|
||||
.then(checkDependencies)
|
||||
.then(checkDevDependencies)
|
||||
.then(checkNodeVersion)
|
||||
.then(done.resolve)
|
||||
return done.promise
|
||||
}
|
@ -1,26 +0,0 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import {npmtsOra} from './npmts.promisechain'
|
||||
|
||||
let removeDist = function(){
|
||||
npmtsOra.text('cleaning dist folder')
|
||||
return plugins.smartfile.fs.remove(paths.distDir)
|
||||
}
|
||||
|
||||
let removePages = function(){
|
||||
npmtsOra.text('cleaning pages folder')
|
||||
return plugins.smartfile.fs.remove(paths.pagesDir)
|
||||
}
|
||||
|
||||
export let run = function(configArg){
|
||||
npmtsOra.text('cleaning up from previous builds...')
|
||||
let done = plugins.Q.defer()
|
||||
removeDist()
|
||||
.then(removePages)
|
||||
.then(function(){
|
||||
plugins.beautylog.ok('Cleaned up from previous builds!')
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
}
|
@ -1,21 +0,0 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import {npmtsOra} from './npmts.promisechain'
|
||||
|
||||
export let run = function (configArg) {
|
||||
let done = plugins.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)
|
||||
})
|
||||
.then(function () {
|
||||
plugins.beautylog.ok('compiled all TypeScript!')
|
||||
done.resolve(config)
|
||||
})
|
||||
return done.promise
|
||||
}
|
@ -1,77 +0,0 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import { npmtsOra } from './npmts.promisechain'
|
||||
|
||||
export type npmtsMode = 'default' | 'custom'
|
||||
|
||||
export interface INpmtsConfig {
|
||||
argv: any,
|
||||
coverageTreshold: number,
|
||||
docs: boolean,
|
||||
mode: npmtsMode,
|
||||
test: boolean,
|
||||
testTs: any,
|
||||
ts: any,
|
||||
tsOptions: any
|
||||
|
||||
};
|
||||
|
||||
export var run = function (argvArg) {
|
||||
let done = plugins.Q.defer()
|
||||
let defaultConfig: INpmtsConfig = {
|
||||
argv: undefined,
|
||||
coverageTreshold: 70,
|
||||
docs: true,
|
||||
mode: 'default',
|
||||
test: true,
|
||||
testTs: {},
|
||||
ts: {},
|
||||
tsOptions: {}
|
||||
}
|
||||
|
||||
// mix with configfile
|
||||
npmtsOra.text('looking for npmextra.json')
|
||||
let config: INpmtsConfig = plugins.npmextra.dataFor<INpmtsConfig>({
|
||||
toolName: 'npmts',
|
||||
defaultSettings: defaultConfig,
|
||||
cwd: paths.cwd
|
||||
})
|
||||
|
||||
// add argv
|
||||
config.argv = argvArg
|
||||
|
||||
// check mode
|
||||
switch (config.mode) {
|
||||
case 'default':
|
||||
case 'custom':
|
||||
plugins.beautylog.ok('mode is ' + config.mode)
|
||||
done.resolve(config)
|
||||
break
|
||||
default:
|
||||
plugins.beautylog.error(`mode not recognised!`)
|
||||
process.exit(1)
|
||||
};
|
||||
|
||||
// handle default mode
|
||||
if (config.mode === 'default') {
|
||||
config.ts = {
|
||||
['./ts/**/*.ts']: './dist/'
|
||||
}
|
||||
config.testTs = {
|
||||
['./test/test.ts']: './test/'
|
||||
}
|
||||
};
|
||||
|
||||
// mix with commandline
|
||||
if (config.argv.notest) {
|
||||
config.test = false
|
||||
};
|
||||
if (config.argv.nodocs) {
|
||||
config.docs = false
|
||||
};
|
||||
|
||||
plugins.beautylog.ok('build options are ready!')
|
||||
done.resolve(config)
|
||||
return done.promise
|
||||
}
|
@ -1,25 +0,0 @@
|
||||
import 'typings-global'
|
||||
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,27 +0,0 @@
|
||||
import 'typings-global'
|
||||
export import beautylog = require('beautylog')
|
||||
export let depcheck = require('depcheck')
|
||||
export import gulp = require('gulp')
|
||||
export let g = {
|
||||
babel: require('gulp-babel'),
|
||||
istanbul: require('gulp-istanbul'),
|
||||
gFunction: require('gulp-function'),
|
||||
injectModules: require('gulp-inject-modules'),
|
||||
mocha: require('gulp-mocha'),
|
||||
sourcemaps: require('gulp-sourcemaps'),
|
||||
typedoc: require('gulp-typedoc')
|
||||
}
|
||||
export import lodash = require('lodash')
|
||||
export import npmextra = require('npmextra')
|
||||
export import projectinfo = require('projectinfo')
|
||||
export import path = require('path')
|
||||
export import Q = require('q')
|
||||
export import shelljs = require('shelljs')
|
||||
export import smartcli = require('smartcli')
|
||||
export import smartcov = require('smartcov')
|
||||
export import smartenv = require('smartenv')
|
||||
export import smartfile = require('smartfile')
|
||||
export import smartpath = require('smartpath')
|
||||
export import smartstring = require('smartstring')
|
||||
export let sourceMapSupport = require('source-map-support').install() // display errors correctly during testing
|
||||
export import tsn = require('tsn')
|
@ -1,49 +0,0 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import {Ora} from 'beautylog'
|
||||
|
||||
export let npmtsOra = new Ora('setting up TaskChain','cyan')
|
||||
|
||||
import NpmtsAssets = require('./npmts.assets')
|
||||
import NpmtsCheck = require('./npmts.check')
|
||||
import NpmtsClean = require('./npmts.clean')
|
||||
import NpmtsCompile = require('./npmts.compile')
|
||||
import NpmtsTypeDoc = require('./npmts.typedoc')
|
||||
import NpmtsOptions = require('./npmts.options')
|
||||
import NpmtsTests = require('./npmts.tests')
|
||||
|
||||
export let promisechain = function(argvArg){
|
||||
let done = plugins.Q.defer()
|
||||
npmtsOra.start()
|
||||
NpmtsOptions.run(argvArg)
|
||||
.then(NpmtsClean.run)
|
||||
.then(NpmtsCheck.run)
|
||||
.then(NpmtsCompile.run)
|
||||
.then(NpmtsAssets.run)
|
||||
.then(NpmtsTypeDoc.run)
|
||||
.then(NpmtsTests.run)
|
||||
.then(function(configArg){
|
||||
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()
|
||||
})
|
||||
return done.promise
|
||||
}
|
@ -1,94 +0,0 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import { npmtsOra } from './npmts.promisechain'
|
||||
|
||||
/**
|
||||
*
|
||||
* @returns {*}
|
||||
*/
|
||||
let mocha = function (configArg) {
|
||||
npmtsOra.text('Instrumentalizing and testing transpiled JS')
|
||||
npmtsOra.end() // end npmtsOra for tests.
|
||||
let done = plugins.Q.defer()
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'dist/*.js')])
|
||||
.pipe(plugins.g.sourcemaps.init())
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve('babel-preset-es2015')
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.istanbul({
|
||||
}))
|
||||
.pipe(plugins.g.sourcemaps.write())
|
||||
.pipe(plugins.g.injectModules())
|
||||
.on('finish', function () {
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')])
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve('babel-preset-es2015')
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.injectModules())
|
||||
.pipe(plugins.g.mocha())
|
||||
.pipe(plugins.g.istanbul.writeReports({
|
||||
dir: plugins.path.join(paths.cwd, './coverage'),
|
||||
reporters: ['lcovonly', 'json', 'text', 'text-summary']
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(
|
||||
function () {
|
||||
plugins.beautylog.ok('Tested!')
|
||||
done.resolve(configArg)
|
||||
},
|
||||
'atEnd'
|
||||
))
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
let coverage = function (configArg) {
|
||||
let done = plugins.Q.defer()
|
||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, 'lcov.info'), 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')
|
||||
process.exit(1)
|
||||
}
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
export let run = function (configArg) {
|
||||
let done = plugins.Q.defer()
|
||||
let config = configArg
|
||||
if (config.test === true) {
|
||||
npmtsOra.text('now starting tests')
|
||||
plugins.beautylog.log(
|
||||
'-------------------------------------------------------\n' +
|
||||
'*************************** TESTS: ***************************\n' +
|
||||
'--------------------------------------------------------------'
|
||||
)
|
||||
|
||||
mocha(config)
|
||||
.then(coverage)
|
||||
.then(() => {
|
||||
done.resolve(config)
|
||||
})
|
||||
} else {
|
||||
npmtsOra.end()
|
||||
done.resolve(config)
|
||||
}
|
||||
return done.promise
|
||||
}
|
@ -1,45 +0,0 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import { npmtsOra } from './npmts.promisechain'
|
||||
|
||||
import { projectInfo } from './npmts.check'
|
||||
|
||||
let genTypeDoc = function (configArg) {
|
||||
let done = plugins.Q.defer()
|
||||
npmtsOra.text('now generating ' + 'TypeDoc documentation'.yellow)
|
||||
plugins.beautylog.log('TypeDoc Output:')
|
||||
plugins.gulp.src(plugins.path.join(paths.tsDir, '**/*.ts'))
|
||||
.pipe(plugins.g.typedoc({
|
||||
// TypeScript options (see typescript docs)
|
||||
module: 'commonjs',
|
||||
target: 'es6',
|
||||
includeDeclarations: true,
|
||||
|
||||
// Output options (see typedoc docs)
|
||||
out: paths.pagesApiDir,
|
||||
json: plugins.path.join(paths.pagesApiDir, 'file.json'),
|
||||
|
||||
// TypeDoc options (see typedoc docs)
|
||||
name: projectInfo.name,
|
||||
readme: plugins.path.join(paths.cwd, 'README.md'),
|
||||
// theme: "default",
|
||||
ignoreCompilerErrors: true,
|
||||
version: true
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(done.resolve, 'atEnd'))
|
||||
return done.promise
|
||||
}
|
||||
|
||||
export let run = function (configArg) {
|
||||
let done = plugins.Q.defer()
|
||||
if (configArg.docs) {
|
||||
genTypeDoc(configArg)
|
||||
.then(() => {
|
||||
done.resolve(configArg)
|
||||
})
|
||||
} else {
|
||||
done.resolve(configArg)
|
||||
};
|
||||
return done.promise
|
||||
}
|
@ -2,7 +2,12 @@
|
||||
"compilerOptions": {
|
||||
"declaration": true,
|
||||
"module": "commonjs",
|
||||
"target": "ES5",
|
||||
"target": "ES6",
|
||||
"outDir": "./dist/"
|
||||
}
|
||||
},
|
||||
"exclude": [
|
||||
"./node_modules",
|
||||
"./test",
|
||||
"./dist"
|
||||
]
|
||||
}
|
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