Compare commits
294 Commits
Author | SHA1 | Date | |
---|---|---|---|
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 | |||
3dae49b8a1 | |||
1d431792a5 | |||
9542140b93 | |||
e1487c39cb | |||
d4c69071e4 | |||
186460d437 | |||
30c2db9ed1 | |||
3e5ab24b90 | |||
6d63b620f1 | |||
a9270cda03 | |||
2a0a5cea8c | |||
b2d8cb53f3 | |||
875efe413a | |||
8fd24c6e31 | |||
18a1087478 | |||
cd2f401180 | |||
41b1fe85d6 | |||
8372c1437c | |||
aedf9f3115 | |||
25320bdf5c | |||
33c83de1fb | |||
07a56fcaca | |||
7bc986251f | |||
cdde7da5f9 | |||
82c00fe444 | |||
93682e9ec4 | |||
d339da7e11 | |||
8b51992959 | |||
cb3bfaf438 | |||
91b7317b80 | |||
400b193210 | |||
7f6a6434d2 | |||
a1414877a1 | |||
a4927f9c17 | |||
264c3d95fd | |||
fd06aa04f4 | |||
a576872471 | |||
333b59c37e | |||
054b7dca2b |
3
.gitignore
vendored
3
.gitignore
vendored
@ -1,4 +1,7 @@
|
||||
.nogit/
|
||||
node_modules/
|
||||
test/
|
||||
pages/
|
||||
public/
|
||||
npm-debug/
|
||||
.DS_Store
|
@ -1,56 +1,92 @@
|
||||
# gitzone standard
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .yarn/
|
||||
key: "$CI_BUILD_STAGE"
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- trigger
|
||||
- pages
|
||||
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
tags:
|
||||
- docker
|
||||
|
||||
snyk:
|
||||
stage: security
|
||||
script:
|
||||
- npmci command yarn global add snyk
|
||||
- npmci command yarn install --ignore-scripts
|
||||
- npmci command snyk test
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testLEGACY:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test legacy
|
||||
- npmci node install legacy
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
testLTS:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test lts
|
||||
- npmci node install lts
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- docker
|
||||
|
||||
testSTABLE:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test stable
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci publish
|
||||
- npmci npm prepare
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- docker
|
||||
|
||||
trigger:
|
||||
stage: trigger
|
||||
script:
|
||||
- npmci trigger
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- docker
|
||||
|
||||
pages:
|
||||
image: hosttoday/ht-docker-node:npmpage
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
stage: pages
|
||||
script:
|
||||
- npmci command yarn global add npmpage
|
||||
- npmci command npmpage
|
||||
tags:
|
||||
- docker
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
|
@ -1,4 +1,3 @@
|
||||
.idea/
|
||||
compile/
|
||||
coverage/
|
||||
test/
|
||||
|
90
.snyk
Normal file
90
.snyk
Normal file
@ -0,0 +1,90 @@
|
||||
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
|
||||
version: v1.10.2
|
||||
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
|
||||
ignore:
|
||||
'npm:debug:20170905':
|
||||
- node-pre-gyp > tar-pack > debug:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
smartchok > chokidar > fsevents > node-pre-gyp > tar-pack > debug:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:12:05.487Z'
|
||||
'npm:tough-cookie:20170905':
|
||||
- node-pre-gyp > request > tough-cookie:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
smartchok > chokidar > fsevents > node-pre-gyp > request > tough-cookie:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:12:05.487Z'
|
||||
'npm:hoek:20180212':
|
||||
- boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- cryptiles > boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- hawk > cryptiles > boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- node-pre-gyp > hawk > cryptiles > boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- smartchok > chokidar > fsevents > node-pre-gyp > hawk > cryptiles > boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- node-pre-gyp > request > hawk > cryptiles > boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- smartchok > chokidar > fsevents > node-pre-gyp > request > hawk > cryptiles > boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- hawk > boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- node-pre-gyp > hawk > boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- smartchok > chokidar > fsevents > node-pre-gyp > hawk > boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- node-pre-gyp > request > hawk > boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- smartchok > chokidar > fsevents > node-pre-gyp > request > hawk > boom > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- hawk > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- node-pre-gyp > hawk > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- smartchok > chokidar > fsevents > node-pre-gyp > hawk > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- node-pre-gyp > request > hawk > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- smartchok > chokidar > fsevents > node-pre-gyp > request > hawk > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- hawk > sntp > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- node-pre-gyp > hawk > sntp > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- smartchok > chokidar > fsevents > node-pre-gyp > hawk > sntp > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- node-pre-gyp > request > hawk > sntp > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
- smartchok > chokidar > fsevents > node-pre-gyp > request > hawk > sntp > hoek:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
'npm:shelljs:20140723':
|
||||
- tapbuffer > smartshell > shelljs:
|
||||
reason: None given
|
||||
expires: '2018-05-08T23:10:17.169Z'
|
||||
patch: {}
|
15
.travis.yml
15
.travis.yml
@ -1,15 +0,0 @@
|
||||
language: node_js
|
||||
node_js:
|
||||
- 4.3.1
|
||||
- stable
|
||||
deploy:
|
||||
provider: npm
|
||||
email: npm@lossless.digital
|
||||
api_key:
|
||||
secure: k075QdAcmEdmAoVaP5vclLnZmhbZB39v85VIUMWAKXbIAU+liHrYZRlIEYfAaIUrf6sha+zAo/U/vjAN7c5ArB7J/HjCLJ3lsi2fWtaSRlYQrYX9/EhU0S+YZjRE8Jrn4hGTcce6I2mANBnEzvzlXrlKaqVvSqOqTO9nJ5aDBCGa5XT3EwlHKkRlAlL3ZOLrRg38R343E8ifZBsbn9G0e+RgDt0sic3WD8NME9lpsQ/99UZKH00duHbhF9nme5Sjdh86y01hvsaBf+CLR4gfS2IntnrCSrZbETFrsOBUyMnJZDQ3qlrjcEaiTkpJ4iSIqr+ftwGMMD6S1MxCTPqkp64UIeMz2Tg41HqoaeIg7z8cF0APv6M9ZAdWhsU43GqsMe70dK900JZpQAkQxMf/6NpPpGfZug6TwqLYSIRzvjvNrhYfuyoGfXdAxrM3SJMkIq6rwE+T/y36kZaC3CrQRyNZypNz0vW1M9HLjJUi2vO0U/CDn8tvi1p6ChrDXDfV3H2UIAMHFlAF+GrT7dMWwD+p+d8mc9gpAFEF9zMqAIJamPhwboJxoHjKQrqrq5czNm75ETL77AzfnU6CfQlG5dTIFnGId8y0ZxXvtpBruDoyC1+ZF23MYZmb+ipxQZM2oLCjNLeL3aEePc/JlSm6Gn8w3sIkZTG261F0XZxdApw=
|
||||
on:
|
||||
tags: true
|
||||
repo: pushrocks/npmts
|
||||
env:
|
||||
global:
|
||||
secure: kPKBMnEKoC+K5dXpl11NhuK3LSp0c0fRO60Akj3QeQBjUWnVAcF0Ht30c31y0lnJaMEzXhmUIKdR7RQnlmw5be4TYGINzY7FD3Dcv7o+HO1ZQrkpMWSu46jF6ZJer9moGjZ8e0rX8wZyB9SqsXYlwWRzqvxfOVxQfTvU3BEnJKHbhq+R5JMJ8dwLBPNTJKMWKq85KNsjo3ap0BjxdBUoRLzvrn31VOPH30BkvmLGc5YiIz5QmITll/T2wmQKYTNT2qDlEJ729B8pYa3eNlCNi89AxsLDGCmEoJAVrPsyw5g+gAyBqZ1GRULy83UJbELUq7cse3MRLMSwCAm4f0INRAuqcyiKYJ4+LHd0NwKrFQ/dQ0pvyBTbbEjNemXaakkWH7S6F03UvF+u+tiQ7C97XH0CRsseGlm36zCkAClEhtWVWA4U0Q5c6zqRAAOYOI0xquXalRKPTJe7fCYewp2eqmlp8drt8MxancyKI/ynXNoR5vGFzDTSRoPjTlaYQPmbiH4+Nd5+6Qoj94PEIqghebIPDQo3C7vWts4WGccux5b2q524UgB63hjJQA6+GQOo1q4RibouS6WScn8/tW/ZOEP+sNhDfkeiZUIjye+Q3PyzonGHefgSQ8wBbsc8LOX0cKUcEFWr14nhdQ9ZeW+hrSSF04TbM4zGJPGcKhmT2UU=
|
@ -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
|
2
LICENSE
2
LICENSE
@ -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
|
||||
|
146
README.md
146
README.md
@ -1,146 +0,0 @@
|
||||
# npmts
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
|
||||
## Status
|
||||
[](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/)
|
||||
|
||||
## What is NPMTS?
|
||||
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
|
||||
By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works.
|
||||
|
||||
There is a docker image available that includes npmts to make CI a breeze:
|
||||
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||
|
||||
### Install
|
||||
First install npmts globally, then install the npmts-g locally.
|
||||
|
||||
> **npmts-g* checks if the global version of npmts suffices the modules requirements.
|
||||
If not it installs npmts locally in the right version during npm install.
|
||||
|
||||
```sh
|
||||
npm install npmts -g # installs npmts globally
|
||||
npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency
|
||||
```
|
||||
|
||||
Then add it to your package.json's script section to trigger a build:
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"test": "(npmts)"
|
||||
}
|
||||
```
|
||||
|
||||
### Default task execution order
|
||||
|
||||
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
|
||||
1. **Clean:** Clean up from any previous builds (old js files)
|
||||
1. **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies
|
||||
1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
|
||||
1. **Documentation:** Create TypeDoc Documentation from TypeScript files
|
||||
1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
|
||||
|
||||
### 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.
|
||||
|
||||
## 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.
|
||||
|
||||
## 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)
|
10
appveyor.yml
10
appveyor.yml
@ -1,10 +0,0 @@
|
||||
environment:
|
||||
nodejs_version: "4"
|
||||
install:
|
||||
- ps: Install-Product node $env:nodejs_version
|
||||
- npm install
|
||||
test_script:
|
||||
- node --version
|
||||
- npm --version
|
||||
- npm test
|
||||
build: off
|
@ -1,2 +1,3 @@
|
||||
#!/usr/bin/env node
|
||||
var index = require("./index.js");
|
||||
process.env.CLI_CALL = 'true'
|
||||
var index = require("../{{pathToIndex}}");
|
2
assets/cliNpmts.js
Normal file
2
assets/cliNpmts.js
Normal file
@ -0,0 +1,2 @@
|
||||
#!/usr/bin/env node
|
||||
var index = require("../dist/index.js");
|
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 {};
|
||||
|
34
dist/index.js
vendored
34
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");
|
||||
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();
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const early = require("early");
|
||||
early.start('NPMTS');
|
||||
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"));
|
2
dist/mod_test/index.d.ts
vendored
Normal file
2
dist/mod_test/index.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
import { INpmtsConfig } from '../npmts.config';
|
||||
export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;
|
128
dist/mod_test/index.js
vendored
Normal file
128
dist/mod_test/index.js
vendored
Normal file
@ -0,0 +1,128 @@
|
||||
"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;
|
||||
});
|
||||
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;
|
||||
};
|
3
dist/npmts.check.d.ts
vendored
3
dist/npmts.check.d.ts
vendored
@ -1,3 +0,0 @@
|
||||
/// <reference types="q" />
|
||||
import * as plugins from "./npmts.plugins";
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
128
dist/npmts.check.js
vendored
128
dist/npmts.check.js
vendored
@ -1,128 +0,0 @@
|
||||
"use strict";
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
var checkProjectTypings = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var cwdProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.cwd);
|
||||
if (typeof cwdProjectInfo.packageJson.typings == "undefined") {
|
||||
plugins.beautylog.error("please add typings field to package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
;
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
var depcheckOptions = {
|
||||
ignoreBinPackage: false,
|
||||
parsers: {
|
||||
'*.ts': plugins.depcheck.parser.typescript,
|
||||
},
|
||||
detectors: [
|
||||
plugins.depcheck.detector.requireCallExpression,
|
||||
plugins.depcheck.detector.importDeclaration
|
||||
],
|
||||
specials: [
|
||||
plugins.depcheck.special.eslint,
|
||||
plugins.depcheck.special.webpack
|
||||
],
|
||||
};
|
||||
var checkDependencies = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [
|
||||
'test',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [
|
||||
"@types/*",
|
||||
"babel-preset-*"
|
||||
]
|
||||
});
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
|
||||
for (var _i = 0, _a = unused.dependencies; _i < _a.length; _i++) {
|
||||
var item = _a[_i];
|
||||
plugins.beautylog.warn("Watch out: unused dependency " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
|
||||
var item = _c[_b];
|
||||
plugins.beautylog.error("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||
var item = _e[_d];
|
||||
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
|
||||
var item = _g[_f];
|
||||
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
||||
}
|
||||
;
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
var checkDevDependencies = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [
|
||||
'ts',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [
|
||||
"@types/*",
|
||||
"babel-preset-*"
|
||||
]
|
||||
});
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
|
||||
for (var _i = 0, _a = unused.devDependencies; _i < _a.length; _i++) {
|
||||
var item = _a[_i];
|
||||
plugins.beautylog.log("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
|
||||
var item = _c[_b];
|
||||
plugins.beautylog.error("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||
var item = _e[_d];
|
||||
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
|
||||
var item = _g[_f];
|
||||
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
||||
}
|
||||
;
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
var checkNodeVersion = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text("running project checks..."),
|
||||
checkProjectTypings(configArg)
|
||||
.then(checkDependencies)
|
||||
.then(checkDevDependencies)
|
||||
.then(checkNodeVersion)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
4
dist/npmts.clean.d.ts
vendored
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<{}>;
|
105
dist/npmts.cli.js
vendored
Normal file
105
dist/npmts.cli.js
vendored
Normal file
@ -0,0 +1,105 @@
|
||||
"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();
|
||||
npmtsCli
|
||||
.standardTask()
|
||||
.then(argvArg => {
|
||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
|
||||
return NpmtsConfig.run(argvArg);
|
||||
})
|
||||
.then((configArg) => {
|
||||
let done = q.defer();
|
||||
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;
|
||||
})
|
||||
.catch(err => {
|
||||
if (err instanceof Error) {
|
||||
console.log(err);
|
||||
}
|
||||
});
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version);
|
||||
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<{}>;
|
1
dist/npmts.compile.helpers.d.ts
vendored
1
dist/npmts.compile.helpers.d.ts
vendored
@ -1 +0,0 @@
|
||||
export declare let checkOutputPath: (tsArrayArg: any, keyArg: any) => boolean;
|
16
dist/npmts.compile.helpers.js
vendored
16
dist/npmts.compile.helpers.js
vendored
@ -1,16 +0,0 @@
|
||||
"use strict";
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var outputPathIsDir = function (tsArrayArg, keyArg) {
|
||||
return plugins.smartpath.check.isDir(plugins.path.join(paths.cwd, tsArrayArg[keyArg]));
|
||||
};
|
||||
exports.checkOutputPath = function (tsArrayArg, keyArg) {
|
||||
if (!outputPathIsDir(tsArrayArg, keyArg)) {
|
||||
plugins.beautylog.warn("Skipping " + keyArg + " because " + tsArrayArg[keyArg] + " it is no directory!");
|
||||
return false;
|
||||
}
|
||||
else {
|
||||
return true;
|
||||
}
|
||||
;
|
||||
};
|
63
dist/npmts.compile.js
vendored
63
dist/npmts.compile.js
vendored
@ -1,63 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var helpers = require("./npmts.compile.helpers");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
var promiseArray = [];
|
||||
var compileTs = function (tsFileArrayArg, tsOptionsArg) {
|
||||
if (tsOptionsArg === void 0) { tsOptionsArg = {}; }
|
||||
var done = plugins.Q.defer();
|
||||
var compilerOptionsDefault = {
|
||||
declaration: true,
|
||||
module: "CommonJS",
|
||||
target: "ES6"
|
||||
};
|
||||
/**
|
||||
* merges default ts options with those found in npmts.json
|
||||
*/
|
||||
var compilerOptions = function (keyArg) {
|
||||
var tsOptionsCombined = plugins.lodashObject.merge(compilerOptionsDefault, tsOptionsArg);
|
||||
var compilerOptions = {
|
||||
declaration: tsOptionsCombined.declaration,
|
||||
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
||||
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target]
|
||||
};
|
||||
return compilerOptions;
|
||||
};
|
||||
var _loop_1 = function(keyArg) {
|
||||
plugins.beautylog.info("TypeScript assignment: transpile from " + keyArg.blue + " to " + tsFileArrayArg[keyArg].blue);
|
||||
if (helpers.checkOutputPath(tsFileArrayArg, keyArg)) {
|
||||
var filesReadPromise = plugins.smartfile.fs.listFileTree(process.cwd(), keyArg)
|
||||
.then(function (filesToConvertArg) {
|
||||
var filesToConvertAbsolute = plugins.smartpath.transform.toAbsolute(filesToConvertArg, process.cwd());
|
||||
var destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg], process.cwd());
|
||||
var filesCompiledPromise = plugins.tsn.compile(filesToConvertAbsolute, destDir, compilerOptions(keyArg));
|
||||
promiseArray.push(filesCompiledPromise);
|
||||
});
|
||||
promiseArray.push(filesReadPromise);
|
||||
}
|
||||
};
|
||||
for (var keyArg in tsFileArrayArg) {
|
||||
_loop_1(keyArg);
|
||||
}
|
||||
;
|
||||
plugins.Q.all(promiseArray)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
npmts_promisechain_1.npmtsOra.text("now compiling " + "TypeScript".yellow);
|
||||
compileTs(config.ts, config.tsOptions)
|
||||
.then(function () {
|
||||
plugins.beautylog.ok("compiled main TypeScript!");
|
||||
plugins.beautylog.log("now compiling tests!");
|
||||
return compileTs(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<{}>;
|
||||
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 npmtsConfig {
|
||||
argv: any;
|
||||
coverageTreshold: number;
|
||||
docs: boolean;
|
||||
mode: npmtsMode;
|
||||
test: boolean;
|
||||
testTs: any;
|
||||
ts: any;
|
||||
tsOptions: any;
|
||||
}
|
||||
export declare var run: (argvArg: any) => plugins.Q.Promise<{}>;
|
65
dist/npmts.options.js
vendored
65
dist/npmts.options.js
vendored
@ -1,65 +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;
|
||||
|
28
dist/npmts.paths.js
vendored
28
dist/npmts.paths.js
vendored
@ -1,20 +1,20 @@
|
||||
"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, "../");
|
||||
exports.npmtsPackageRoot = plugins.path.join(__dirname, '../');
|
||||
// Project paths
|
||||
exports.cwd = process.cwd();
|
||||
// Directories
|
||||
exports.tsDir = plugins.path.join(exports.cwd, "ts/");
|
||||
exports.distDir = plugins.path.join(exports.cwd, "dist/");
|
||||
exports.testDir = plugins.path.join(exports.cwd, "test/");
|
||||
exports.typingsDir = plugins.path.join(exports.cwd, "ts/typings/");
|
||||
exports.coverageDir = plugins.path.join(exports.cwd, "coverage/");
|
||||
exports.tsDir = plugins.path.join(exports.cwd, 'ts/');
|
||||
exports.distDir = plugins.path.join(exports.cwd, 'dist/');
|
||||
exports.testDir = plugins.path.join(exports.cwd, 'test/');
|
||||
exports.typingsDir = plugins.path.join(exports.cwd, 'ts/typings/');
|
||||
exports.coverageDir = plugins.path.join(exports.cwd, 'coverage/');
|
||||
// Pages
|
||||
exports.pagesDir = plugins.path.join(exports.cwd, "pages/");
|
||||
exports.pagesApiDir = plugins.path.join(exports.pagesDir, "/api");
|
||||
exports.npmtsAssetsDir = plugins.path.join(__dirname, "../assets/");
|
||||
//Files
|
||||
exports.indexTS = plugins.path.join(exports.cwd, "ts/index.ts");
|
||||
exports.testTS = plugins.path.join(exports.cwd, "ts/test.ts");
|
||||
exports.pagesDir = plugins.path.join(exports.cwd, 'pages/');
|
||||
exports.pagesApiDir = plugins.path.join(exports.pagesDir, '/api');
|
||||
exports.npmtsAssetsDir = plugins.path.join(__dirname, '../assets/');
|
||||
// Files
|
||||
exports.indexTS = plugins.path.join(exports.cwd, 'ts/index.ts');
|
||||
exports.testTS = plugins.path.join(exports.cwd, 'ts/test.ts');
|
||||
|
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 lodashObject = require('lodash');
|
||||
export import npmextra = require("npmextra");
|
||||
export import projectinfo = require("projectinfo");
|
||||
export import path = require("path");
|
||||
export import Q = require("q");
|
||||
export import shelljs = require("shelljs");
|
||||
export import smartcli = require("smartcli");
|
||||
export import smartcov = require("smartcov");
|
||||
export import smartenv = require("smartenv");
|
||||
export import smartfile = require("smartfile");
|
||||
export import smartpath = require("smartpath");
|
||||
export import smartstring = require("smartstring");
|
||||
export declare let sourceMapSupport: any;
|
||||
export import tsn = require("tsn");
|
||||
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 '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.lodashObject = 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(); // this is required to 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("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<{}>;
|
47
dist/npmts.promisechain.js
vendored
47
dist/npmts.promisechain.js
vendored
@ -1,47 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
exports.npmtsOra = new plugins.beautylog.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<{}>;
|
79
dist/npmts.tests.js
vendored
79
dist/npmts.tests.js
vendored
@ -1,79 +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();
|
||||
var stream = 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<{}>;
|
41
dist/npmts.typedoc.js
vendored
41
dist/npmts.typedoc.js
vendored
@ -1,41 +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 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: "my-project",
|
||||
//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>
|
||||
///
|
@ -1,19 +0,0 @@
|
||||
{
|
||||
"structure": {
|
||||
"readme": "index.md"
|
||||
},
|
||||
"plugins": [
|
||||
"disqus",
|
||||
"tonic",
|
||||
"edit-link"
|
||||
],
|
||||
"pluginsConfig": {
|
||||
"edit-link": {
|
||||
"base": "https://gitlab.com/pushrocks/npmts/edit/master/",
|
||||
"label": "Edit on GitLab"
|
||||
},
|
||||
"disqus": {
|
||||
"shortName": "mojoio-docs"
|
||||
}
|
||||
}
|
||||
}
|
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
|
182
docs/index.md
182
docs/index.md
@ -1,146 +1,52 @@
|
||||
# npmts
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
---
|
||||
name: Index
|
||||
description: best practice npm TypeScript modules
|
||||
---
|
||||
|
||||
## Status
|
||||
[](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)
|
||||
# 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/)
|
||||
|
||||
## What is NPMTS?
|
||||
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
|
||||
By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works.
|
||||
## Quick Demo
|
||||
|
||||
There is a docker image available that includes npmts to make CI a breeze:
|
||||
[](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/)
|
||||
|
||||
### Install
|
||||
First install npmts globally, then install the npmts-g locally.
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
|
||||
> **npmts-g* checks if the global version of npmts suffices the modules requirements.
|
||||
If not it installs npmts locally in the right version during npm install.
|
||||
|
||||
```sh
|
||||
npm install npmts -g # installs npmts globally
|
||||
npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency
|
||||
```
|
||||
|
||||
Then add it to your package.json's script section to trigger a build:
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"test": "(npmts)"
|
||||
}
|
||||
```
|
||||
|
||||
### Default task execution order
|
||||
|
||||
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
|
||||
1. **Clean:** Clean up from any previous builds (old js files)
|
||||
1. **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies
|
||||
1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
|
||||
1. **Documentation:** Create TypeDoc Documentation from TypeScript files
|
||||
1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
|
||||
|
||||
### 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.
|
||||
|
||||
## 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.
|
||||
|
||||
## 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)
|
||||
[](https:/git.zone)
|
||||
|
19
docs/install.md
Normal file
19
docs/install.md
Normal file
@ -0,0 +1,19 @@
|
||||
# Install npmts
|
||||
|
||||
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
|
||||
npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency
|
||||
```
|
||||
|
||||
Then add it to your package.json's script section to trigger a build:
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"test": "(npmts)"
|
||||
}
|
||||
```
|
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**
|
5
npmextra.json
Normal file
5
npmextra.json
Normal file
@ -0,0 +1,5 @@
|
||||
{
|
||||
"npmci": {
|
||||
"npmAccessLevel": "public"
|
||||
}
|
||||
}
|
89
package.json
89
package.json
@ -1,69 +1,70 @@
|
||||
{
|
||||
"name": "npmts",
|
||||
"version": "5.4.17",
|
||||
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
||||
"name": "@gitzone/npmts",
|
||||
"version": "8.0.30",
|
||||
"description": "best practice npm TypeScript modules",
|
||||
"main": "dist/index.js",
|
||||
"bin": {
|
||||
"npmts": "dist/cli.js"
|
||||
"npmts": "assets/cliNpmts.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/ )",
|
||||
"test": "(npm run compile && npm run prepareTest && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest && npm run checkNoDocs)",
|
||||
"testShort": "(npm run compile && npm run check)",
|
||||
"prepareTest": "(rm -rf test/)",
|
||||
"compile": "(rm -rf dist/ && tsc)",
|
||||
"setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
|
||||
"typedoc": "(typedoc --out ./pages/api --target ES6 ./ts/)",
|
||||
"npmpage": "(npmpage)",
|
||||
"check": "(cd test && npm install && node ../dist/index.js)",
|
||||
"check": "(cd test && yarn install && node ../dist/index.js)",
|
||||
"checkVersion": "(cd test/ && node ../dist/index.js -v)",
|
||||
"checkNoTest": "(cd test && node ../dist/index.js --notest)",
|
||||
"checkNoDocs": "(cd test && node ../dist/index.js --nodocs)"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"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",
|
||||
"homepage": "https://gitlab.com/gitzone/npmts#readme",
|
||||
"dependencies": {
|
||||
"@types/gulp": "^3.8.30",
|
||||
"@types/minimatch": "^2.0.28",
|
||||
"@types/q": "^0.x.x",
|
||||
"@types/shelljs": "^0.3.29",
|
||||
"babel-preset-es2015": "^6.13.2",
|
||||
"beautylog": "5.0.20",
|
||||
"depcheck": "^0.6.4",
|
||||
"early": "^2.0.25",
|
||||
"gulp": "3.9.1",
|
||||
"gulp-babel": "^6.1.2",
|
||||
"gulp-function": "^1.3.6",
|
||||
"gulp-inject-modules": "^1.0.0",
|
||||
"gulp-istanbul": "^1.1.0",
|
||||
"gulp-mocha": "^3.0.1",
|
||||
"gulp-sourcemaps": "^1.6.0",
|
||||
"gulp-typedoc": "^2.0.0",
|
||||
"lodash": "^4.15.0",
|
||||
"npmextra": "^1.0.9",
|
||||
"projectinfo": "1.0.3",
|
||||
"q": "^1.4.1",
|
||||
"shelljs": "^0.7.3",
|
||||
"smartcli": "1.0.4",
|
||||
"smartcov": "1.0.0",
|
||||
"smartenv": "1.2.5",
|
||||
"smartfile": "4.0.13",
|
||||
"smartpath": "3.2.2",
|
||||
"smartstring": "^2.0.17",
|
||||
"source-map-support": "^0.4.2",
|
||||
"tsn": "^1.0.12",
|
||||
"typedoc": "^0.4.5",
|
||||
"typescript": "next",
|
||||
"typings-global": "*"
|
||||
"@types/gulp-sourcemaps": "0.0.32",
|
||||
"@types/minimatch": "^3.0.1",
|
||||
"@types/through2": "^2.0.33",
|
||||
"beautylog": "^6.1.10",
|
||||
"depcheck": "^0.6.9",
|
||||
"early": "^2.1.1",
|
||||
"gulp-function": "^2.2.9",
|
||||
"gulp-sourcemaps": "^2.6.1",
|
||||
"gulp-typescript": "^4.0.2",
|
||||
"lodash": "^4.17.4",
|
||||
"npmextra": "^2.0.9",
|
||||
"projectinfo": "^3.0.4",
|
||||
"smartanalytics": "^2.0.9",
|
||||
"smartchok": "1.0.14",
|
||||
"smartcli": "^2.0.9",
|
||||
"smartcov": "^1.0.2",
|
||||
"smarterror": "^1.0.3",
|
||||
"smartfile": "^4.2.26",
|
||||
"smartgulp": "^1.0.6",
|
||||
"smartpath": "^3.2.8",
|
||||
"smartq": "^1.1.8",
|
||||
"smartstream": "^1.0.10",
|
||||
"smartstring": "^2.0.28",
|
||||
"smartsystem": "^2.0.2",
|
||||
"smartupdate": "^1.0.13",
|
||||
"tapbuffer": "^1.0.31",
|
||||
"through2": "^2.0.3",
|
||||
"tsn": "^2.0.15",
|
||||
"typescript": "^2.8.1"
|
||||
},
|
||||
"devDependencies": {}
|
||||
"devDependencies": {
|
||||
"@types/node": "^9.6.2"
|
||||
}
|
||||
}
|
||||
|
55
readme.md
Normal file
55
readme.md
Normal file
@ -0,0 +1,55 @@
|
||||
# npmts
|
||||
|
||||
best practice npm TypeScript modules
|
||||
|
||||
## Availabililty
|
||||
|
||||
[](https://www.npmjs.com/package/@gitzone/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://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).
|
||||
|
||||
For more information about how to best write tap tests check out the [tapbundle module's linked docs](https://www.npmjs.com/package/tapbundle).
|
||||
|
||||
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/)
|
||||
|
||||
## Changelog
|
||||
|
||||
For breaking changes please see the [changelog](https://gitzone.gitlab.io/npmts/changelog.html).
|
||||
|
||||
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.html)
|
||||
|
||||
[](https://push.rocks)
|
37
ts/index.ts
37
ts/index.ts
@ -1,30 +1,13 @@
|
||||
import "typings-global";
|
||||
|
||||
/* ================================================== *
|
||||
Starting NPMTS main process.
|
||||
**** NPMTS ****
|
||||
Fabulous TypeScript development
|
||||
* ================================================== */
|
||||
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();
|
||||
});
|
||||
import * as early from 'early';
|
||||
early.start('NPMTS');
|
||||
import * as plugins from './npmts.plugins';
|
||||
import * as cli from './npmts.cli';
|
||||
early.stop().then(() => {
|
||||
let loaded = plugins; // to make sure plugins get actually loaded
|
||||
cli.run();
|
||||
});
|
||||
|
27
ts/mod_compile/index.ts
Normal file
27
ts/mod_compile/index.ts
Normal file
@ -0,0 +1,27 @@
|
||||
/* ------------------------------------------
|
||||
* This module compiles the module's TypeScript files
|
||||
* Note: Test files are only compiled in memory
|
||||
* -------------------------------------------- */
|
||||
import * as q from 'smartq';
|
||||
|
||||
import { INpmtsConfig } from '../npmts.config';
|
||||
|
||||
import * as plugins from './mod.plugins';
|
||||
|
||||
import * as NpmtsAssets from './mod.assets';
|
||||
import * as NpmtsCheck from './mod.check';
|
||||
import * as NpmtsClean from './mod.clean';
|
||||
import * as NpmtsCompile from './mod.compile';
|
||||
|
||||
export let run = function(configArg: INpmtsConfig): Promise<INpmtsConfig> {
|
||||
let done = q.defer<INpmtsConfig>();
|
||||
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;
|
||||
};
|
26
ts/mod_compile/mod.assets.ts
Normal file
26
ts/mod_compile/mod.assets.ts
Normal file
@ -0,0 +1,26 @@
|
||||
import * as q from 'smartq';
|
||||
|
||||
import paths = require('../npmts.paths');
|
||||
|
||||
import plugins = require('./mod.plugins');
|
||||
import { projectInfo } from '../mod_compile/mod.check';
|
||||
|
||||
export let 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 = projectInfo.packageJson.main;
|
||||
let cliJsString: string = plugins.smartfile.fs.toStringSync(
|
||||
plugins.path.join(paths.npmtsAssetsDir, 'cli.js')
|
||||
);
|
||||
cliJsString = cliJsString.replace('{{pathToIndex}}', mainJsPath);
|
||||
plugins.smartfile.memory.toFsSync(cliJsString, plugins.path.join(paths.distDir, 'cli.js'));
|
||||
plugins.beautylog.ok('installed CLI assets!');
|
||||
done.resolve(config);
|
||||
} else {
|
||||
plugins.beautylog.ok('No additional assets required!');
|
||||
done.resolve(config);
|
||||
}
|
||||
return done.promise;
|
||||
};
|
139
ts/mod_compile/mod.check.ts
Normal file
139
ts/mod_compile/mod.check.ts
Normal file
@ -0,0 +1,139 @@
|
||||
import * as q from 'smartq';
|
||||
import { ProjectinfoNpm } from 'projectinfo';
|
||||
|
||||
// interfaces
|
||||
import { INpmtsConfig } from '../npmts.config';
|
||||
|
||||
import * as paths from '../npmts.paths';
|
||||
|
||||
import * as plugins from './mod.plugins';
|
||||
|
||||
export let projectInfo: ProjectinfoNpm;
|
||||
|
||||
let checkProjectTypings = (configArg: INpmtsConfig) => {
|
||||
let done = q.defer<INpmtsConfig>();
|
||||
plugins.beautylog.ora.text('Check Module: Check Project Typings...');
|
||||
projectInfo = new ProjectinfoNpm(paths.cwd);
|
||||
if (typeof projectInfo.packageJson.typings === 'undefined') {
|
||||
plugins.beautylog.error(`please add typings field to package.json`);
|
||||
process.exit(1);
|
||||
}
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
const depcheckOptions = {
|
||||
ignoreBinPackage: false, // ignore the packages with bin entry
|
||||
parsers: {
|
||||
// the target parsers
|
||||
'*.ts': plugins.depcheck.parser.typescript
|
||||
},
|
||||
detectors: [
|
||||
// the target detectors
|
||||
plugins.depcheck.detector.requireCallExpression,
|
||||
plugins.depcheck.detector.importDeclaration
|
||||
],
|
||||
specials: [
|
||||
// the target special parsers
|
||||
plugins.depcheck.special.eslint,
|
||||
plugins.depcheck.special.webpack
|
||||
]
|
||||
};
|
||||
|
||||
let checkDependencies = (configArg: INpmtsConfig) => {
|
||||
let done = q.defer<INpmtsConfig>();
|
||||
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: INpmtsConfig) => {
|
||||
let done = q.defer<INpmtsConfig>();
|
||||
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: INpmtsConfig) => {
|
||||
let done = q.defer<INpmtsConfig>();
|
||||
plugins.beautylog.ora.text('checking node version');
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
export let run = async (configArg: INpmtsConfig) => {
|
||||
plugins.beautylog.ora.text('Check Module: ...');
|
||||
|
||||
if (configArg.checkDependencies) {
|
||||
configArg = await checkProjectTypings(configArg);
|
||||
configArg = await checkDependencies(configArg);
|
||||
configArg = await checkDevDependencies(configArg);
|
||||
configArg = await checkNodeVersion(configArg);
|
||||
return configArg;
|
||||
} else {
|
||||
configArg = await checkProjectTypings(configArg);
|
||||
return configArg;
|
||||
}
|
||||
};
|
32
ts/mod_compile/mod.clean.ts
Normal file
32
ts/mod_compile/mod.clean.ts
Normal file
@ -0,0 +1,32 @@
|
||||
import * as q from 'smartq';
|
||||
import paths = require('../npmts.paths');
|
||||
|
||||
import 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);
|
||||
};
|
||||
|
||||
export let 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;
|
||||
};
|
21
ts/mod_compile/mod.compile.ts
Normal file
21
ts/mod_compile/mod.compile.ts
Normal file
@ -0,0 +1,21 @@
|
||||
import * as q from 'smartq';
|
||||
|
||||
import * as paths from '../npmts.paths';
|
||||
|
||||
import * as plugins from './mod.plugins';
|
||||
|
||||
export let 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;
|
||||
};
|
7
ts/mod_compile/mod.plugins.ts
Normal file
7
ts/mod_compile/mod.plugins.ts
Normal file
@ -0,0 +1,7 @@
|
||||
export * from '../npmts.plugins';
|
||||
|
||||
import * as tsn from 'tsn';
|
||||
import * as smartchok from 'smartchok';
|
||||
import * as smartstream from 'smartstream';
|
||||
|
||||
export { tsn, smartchok, smartstream };
|
15
ts/mod_docs/index.ts
Normal file
15
ts/mod_docs/index.ts
Normal file
@ -0,0 +1,15 @@
|
||||
/* ------------------------------------------
|
||||
* This module creates TypeScript documentation
|
||||
* -------------------------------------------- */
|
||||
import * as q from 'smartq';
|
||||
|
||||
import * as paths from '../npmts.paths';
|
||||
import { INpmtsConfig } from '../npmts.config';
|
||||
|
||||
import * as plugins from './mod.plugins';
|
||||
|
||||
export let run = function(configArg: INpmtsConfig) {
|
||||
let done = q.defer<INpmtsConfig>();
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
1
ts/mod_docs/mod.plugins.ts
Normal file
1
ts/mod_docs/mod.plugins.ts
Normal file
@ -0,0 +1 @@
|
||||
export * from '../npmts.plugins';
|
141
ts/mod_test/index.ts
Normal file
141
ts/mod_test/index.ts
Normal file
@ -0,0 +1,141 @@
|
||||
/* ------------------------------------------
|
||||
* This module tests the compiled TypeScript files
|
||||
* -------------------------------------------- */
|
||||
import plugins = require('./mod.plugins');
|
||||
import paths = require('../npmts.paths');
|
||||
|
||||
import * as q from 'smartq';
|
||||
|
||||
// interfaces
|
||||
import { INpmtsConfig } from '../npmts.config';
|
||||
import { Smartfile } from 'smartfile';
|
||||
|
||||
let testTypeScriptConfig = {
|
||||
target: 'ES5',
|
||||
emitDecoratorMetadata: true,
|
||||
experimentalDecorators: true,
|
||||
lib: ['DOM', 'ESNext']
|
||||
};
|
||||
|
||||
/**
|
||||
* runs mocha
|
||||
* @returns INpmtsConfig
|
||||
*/
|
||||
let tap = function(configArg: INpmtsConfig) {
|
||||
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(
|
||||
async () => {
|
||||
configArg.runData.coverageLcovInfo = await 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 = async (configArg: INpmtsConfig) => {
|
||||
let coverageResult: number = 0; // the coverage in percent
|
||||
if (configArg.runData.coverageLcovInfo) {
|
||||
coverageResult = await 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;
|
||||
};
|
||||
|
||||
export let run = function(configArg: INpmtsConfig) {
|
||||
let done = q.defer<INpmtsConfig>();
|
||||
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;
|
||||
};
|
10
ts/mod_test/mod.plugins.ts
Normal file
10
ts/mod_test/mod.plugins.ts
Normal file
@ -0,0 +1,10 @@
|
||||
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 };
|
@ -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,117 +0,0 @@
|
||||
import * as plugins from "./npmts.plugins";
|
||||
import * as paths from "./npmts.paths";
|
||||
import { npmtsOra } from "./npmts.promisechain";
|
||||
|
||||
let checkProjectTypings = (configArg) => {
|
||||
let done = plugins.Q.defer();
|
||||
let cwdProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.cwd);
|
||||
if(typeof cwdProjectInfo.packageJson.typings == "undefined"){
|
||||
plugins.beautylog.error(`please add typings field to package.json`);
|
||||
process.exit(1);
|
||||
};
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
const depcheckOptions = {
|
||||
ignoreBinPackage: false, // ignore the packages with bin entry
|
||||
parsers: { // the target parsers
|
||||
'*.ts': plugins.depcheck.parser.typescript,
|
||||
},
|
||||
detectors: [ // the target detectors
|
||||
plugins.depcheck.detector.requireCallExpression,
|
||||
plugins.depcheck.detector.importDeclaration
|
||||
],
|
||||
specials: [ // the target special parsers
|
||||
plugins.depcheck.special.eslint,
|
||||
plugins.depcheck.special.webpack
|
||||
],
|
||||
};
|
||||
|
||||
let checkDependencies = (configArg) => {
|
||||
let done = plugins.Q.defer();
|
||||
let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [ // folder with these names will be ignored
|
||||
'test',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [ // ignore dependencies that matches these globs
|
||||
"@types/*",
|
||||
"babel-preset-*"
|
||||
]
|
||||
})
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
||||
for (let item of unused.dependencies) {
|
||||
plugins.beautylog.warn(`Watch out: unused dependency ${item.red}`);
|
||||
};
|
||||
for (let item of unused.missing) {
|
||||
plugins.beautylog.error(`unused devDependency ${item.red}`);
|
||||
};
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
for (let item of unused.invalidFiles) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
||||
};
|
||||
for (let item of unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
|
||||
};
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
let checkDevDependencies = (configArg) => {
|
||||
let done = plugins.Q.defer();
|
||||
let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [ // folder with these names will be ignored
|
||||
'ts',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [ // ignore dependencies that matches these globs
|
||||
"@types/*",
|
||||
"babel-preset-*"
|
||||
]
|
||||
})
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
||||
for (let item of unused.devDependencies) {
|
||||
plugins.beautylog.log(`unused devDependency ${item.red}`);
|
||||
};
|
||||
for (let item of unused.missing) {
|
||||
plugins.beautylog.error(`unused devDependency ${item.red}`);
|
||||
};
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
for (let item of unused.invalidFiles) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
||||
};
|
||||
for (let item of unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
|
||||
};
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
let checkNodeVersion = (configArg) => {
|
||||
let done = plugins.Q.defer();
|
||||
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
}
|
||||
|
||||
export let run = (configArg) => {
|
||||
let done = plugins.Q.defer();
|
||||
npmtsOra.text("running project checks..."),
|
||||
checkProjectTypings(configArg)
|
||||
.then(checkDependencies)
|
||||
.then(checkDevDependencies)
|
||||
.then(checkNodeVersion)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
}
|
@ -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;
|
||||
};
|
105
ts/npmts.cli.ts
Normal file
105
ts/npmts.cli.ts
Normal file
@ -0,0 +1,105 @@
|
||||
import * as q from 'smartq';
|
||||
|
||||
import * as plugins from './npmts.plugins';
|
||||
import * as paths from './npmts.paths';
|
||||
import * as NpmtsConfig from './npmts.config';
|
||||
import * as NpmtsMods from './npmts.mods';
|
||||
import * as NpmtsWatch from './npmts.watch';
|
||||
import * as NpmtsShip from './npmts.ship';
|
||||
|
||||
/**
|
||||
* 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(async () => {
|
||||
// make the analytics call
|
||||
npmtsAnalytics
|
||||
.recordEvent('npmToolExecution', {
|
||||
executionMode: (await NpmtsConfig.configPromise).mode,
|
||||
tsOptions: (await NpmtsConfig.configPromise).tsOptions,
|
||||
watch: (await NpmtsConfig.configPromise).watch,
|
||||
coverageTreshold: (await NpmtsConfig.configPromise).coverageTreshold
|
||||
})
|
||||
.catch(err => {
|
||||
plugins.beautylog.warn('Lossless Analytics API not available...');
|
||||
});
|
||||
});
|
||||
|
||||
export let run = async () => {
|
||||
let done = q.defer();
|
||||
|
||||
plugins.beautylog.figletSync('NPMTS');
|
||||
let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
|
||||
// check for updates
|
||||
await plugins.smartupdate.standardHandler.check(
|
||||
'npmts',
|
||||
npmtsProjectInfo.version,
|
||||
'http://gitzone.gitlab.io/npmts/changelog.html'
|
||||
);
|
||||
plugins.beautylog.log('---------------------------------------------');
|
||||
let npmtsCli = new plugins.smartcli.Smartcli();
|
||||
npmtsCli
|
||||
.standardTask()
|
||||
.then(argvArg => {
|
||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
|
||||
return NpmtsConfig.run(argvArg);
|
||||
})
|
||||
.then((configArg: NpmtsConfig.INpmtsConfig) => {
|
||||
let done = q.defer();
|
||||
plugins.beautylog.ora.start('loading additional modules...');
|
||||
NpmtsMods.modCompile
|
||||
.load()
|
||||
.then(modCompile => {
|
||||
return modCompile.run(configArg);
|
||||
})
|
||||
.then(configArg => {
|
||||
let done = q.defer<NpmtsConfig.INpmtsConfig>();
|
||||
NpmtsMods.modDocs
|
||||
.load()
|
||||
.then(modDocs => {
|
||||
return modDocs.run(configArg);
|
||||
})
|
||||
.then(configArg => {
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
})
|
||||
.then(configArg => {
|
||||
let done = q.defer<NpmtsConfig.INpmtsConfig>();
|
||||
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;
|
||||
})
|
||||
.catch(err => {
|
||||
if (err instanceof Error) {
|
||||
console.log(err);
|
||||
}
|
||||
});
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version);
|
||||
npmtsCli.startParse();
|
||||
return await done.promise;
|
||||
};
|
@ -1,15 +0,0 @@
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
|
||||
let outputPathIsDir = function (tsArrayArg,keyArg) {
|
||||
return plugins.smartpath.check.isDir(plugins.path.join(paths.cwd, tsArrayArg[keyArg]));
|
||||
};
|
||||
|
||||
export let checkOutputPath = function(tsArrayArg,keyArg){
|
||||
if(!outputPathIsDir(tsArrayArg,keyArg)) {
|
||||
plugins.beautylog.warn("Skipping " + keyArg + " because " + tsArrayArg[keyArg] + " it is no directory!")
|
||||
return false
|
||||
} else {
|
||||
return true;
|
||||
};
|
||||
}
|
@ -1,68 +0,0 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
import helpers = require("./npmts.compile.helpers");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
|
||||
let promiseArray = [];
|
||||
let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => {
|
||||
let done = plugins.Q.defer();
|
||||
|
||||
let compilerOptionsDefault = {
|
||||
declaration: true,
|
||||
module: "CommonJS",
|
||||
target: "ES6"
|
||||
};
|
||||
|
||||
/**
|
||||
* merges default ts options with those found in npmts.json
|
||||
*/
|
||||
let compilerOptions = function (keyArg:string) {
|
||||
let tsOptionsCombined = plugins.lodashObject.merge(compilerOptionsDefault, tsOptionsArg);
|
||||
let compilerOptions:plugins.tsn.CompilerOptions = {
|
||||
declaration: tsOptionsCombined.declaration,
|
||||
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
||||
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target]
|
||||
};
|
||||
return compilerOptions;
|
||||
};
|
||||
for (let keyArg in tsFileArrayArg) {
|
||||
plugins.beautylog.info(`TypeScript assignment: transpile from ${keyArg.blue} to ${tsFileArrayArg[keyArg].blue}`);
|
||||
if (helpers.checkOutputPath(tsFileArrayArg,keyArg)) {
|
||||
let filesReadPromise = plugins.smartfile.fs.listFileTree(process.cwd(),keyArg)
|
||||
.then((filesToConvertArg) => {
|
||||
let filesToConvertAbsolute = plugins.smartpath.transform.toAbsolute(filesToConvertArg,process.cwd());
|
||||
let destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg],process.cwd());
|
||||
let filesCompiledPromise = plugins.tsn.compile(
|
||||
filesToConvertAbsolute,
|
||||
destDir,
|
||||
compilerOptions(keyArg)
|
||||
);
|
||||
promiseArray.push(filesCompiledPromise);
|
||||
});
|
||||
promiseArray.push(filesReadPromise);
|
||||
}
|
||||
};
|
||||
plugins.Q.all(promiseArray)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
}
|
||||
|
||||
|
||||
export let run = function (configArg) {
|
||||
let done = plugins.Q.defer();
|
||||
let config = configArg;
|
||||
npmtsOra.text("now compiling " + "TypeScript".yellow);
|
||||
|
||||
compileTs(config.ts,config.tsOptions)
|
||||
.then(() => {
|
||||
plugins.beautylog.ok("compiled main TypeScript!");
|
||||
plugins.beautylog.log("now compiling tests!");
|
||||
return compileTs(config.testTs);
|
||||
})
|
||||
.then(function () {
|
||||
plugins.beautylog.ok("compiled all TypeScript!");
|
||||
done.resolve(config);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
110
ts/npmts.config.ts
Normal file
110
ts/npmts.config.ts
Normal file
@ -0,0 +1,110 @@
|
||||
import plugins = require('./npmts.plugins');
|
||||
import paths = require('./npmts.paths');
|
||||
|
||||
import * as smartq from 'smartq';
|
||||
|
||||
// interfaces
|
||||
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 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 let run = function(argvArg) {
|
||||
let done = smartq.defer();
|
||||
let defaultConfig: INpmtsConfig = {
|
||||
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: INpmtsConfig = localNpmextra.dataFor<INpmtsConfig>('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<INpmtsConfig>();
|
||||
export let configPromise = configDeferred.promise;
|
11
ts/npmts.mods.ts
Normal file
11
ts/npmts.mods.ts
Normal file
@ -0,0 +1,11 @@
|
||||
import * as plugins from './npmts.plugins';
|
||||
|
||||
import { LazyModule } from 'smartsystem';
|
||||
|
||||
import * as _modCompile from './mod_compile/index';
|
||||
import * as _modDocs from './mod_docs/index';
|
||||
import * as _modTest from './mod_test/index';
|
||||
|
||||
export let modCompile = new LazyModule<typeof _modCompile>('./mod_compile/index', __dirname);
|
||||
export let modDocs = new LazyModule<typeof _modDocs>('./mod_docs/index', __dirname);
|
||||
export let modTest = new LazyModule<typeof _modTest>('./mod_test/index', __dirname);
|
@ -1,81 +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 npmtsConfig {
|
||||
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:npmtsConfig = {
|
||||
argv:undefined,
|
||||
coverageTreshold: 70,
|
||||
docs: true,
|
||||
mode:"default",
|
||||
test:true,
|
||||
testTs:{},
|
||||
ts:{},
|
||||
tsOptions: {}
|
||||
};
|
||||
|
||||
|
||||
// mix with configfile
|
||||
npmtsOra.text("looking for npmextra.json");
|
||||
let config:npmtsConfig = plugins.npmextra.dataFor({
|
||||
toolName:"npmts",
|
||||
defaultSettings:defaultConfig,
|
||||
cwd:paths.cwd
|
||||
});
|
||||
|
||||
// add argv
|
||||
config.argv = argvArg;
|
||||
|
||||
// check mode
|
||||
switch (config.mode){
|
||||
case "default":
|
||||
case "custom":
|
||||
plugins.beautylog.ok("mode is " + config.mode);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error(`mode not recognised!`);
|
||||
process.exit(1);
|
||||
};
|
||||
|
||||
//handle default mode
|
||||
if (config.mode == "default"){
|
||||
config.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,26 +1,24 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import plugins = require('./npmts.plugins');
|
||||
|
||||
// NPMTS Paths
|
||||
export let npmtsPackageRoot = plugins.path.join(__dirname,"../");
|
||||
|
||||
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/");
|
||||
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 pagesDir = plugins.path.join(cwd, 'pages/');
|
||||
export let pagesApiDir = plugins.path.join(pagesDir, '/api');
|
||||
|
||||
export let npmtsAssetsDir = plugins.path.join(__dirname,"../assets/");
|
||||
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");
|
||||
// Files
|
||||
export let indexTS = plugins.path.join(cwd, 'ts/index.ts');
|
||||
export let testTS = plugins.path.join(cwd, 'ts/test.ts');
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user