Compare commits
297 Commits
Author | SHA1 | Date | |
---|---|---|---|
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 | |||
33209773c8 | |||
625cadea5e | |||
de05001f3e | |||
5aa10261e5 | |||
070574c8d7 | |||
a304f34f31 | |||
26b5db3782 | |||
dadad3fa96 | |||
2ab35db571 | |||
4a17953298 | |||
8c633b3c30 | |||
e100a6e026 | |||
3e7148c938 | |||
3554e2543d | |||
44a86542ec | |||
b63d2edd29 | |||
a4e0112767 | |||
b40837b6a7 | |||
7ecb565de9 | |||
41a38aeb56 | |||
0be87e2f45 | |||
2edcb3947e | |||
51753df662 | |||
36c002581a | |||
db1cfe4746 | |||
2c254a2ecf | |||
425bc6150a | |||
b2aaa51882 | |||
8ee6623984 | |||
91ec17c51d | |||
646dbdaa3a | |||
4550fcd375 | |||
4d1b992193 | |||
cf2d482798 | |||
43853e4d71 | |||
6a650b9f1b | |||
c76cc6baf7 | |||
659fa9ba95 | |||
97c47ed696 | |||
b69bd24cec | |||
3317168d12 | |||
433fad502d | |||
f583b05f73 | |||
3f50311487 | |||
ee16740d0b | |||
63c73536a2 | |||
2f7ebfc47a | |||
372d2605bb | |||
2ecf6c00b8 | |||
2f3d8cecd3 | |||
54bbab232e | |||
380407b5e8 | |||
2a5583946c | |||
80e36a34ee | |||
1f90f4abff | |||
3c7f5f1e2d | |||
8104609306 | |||
a3077f7800 | |||
c947121243 | |||
4b3f0649fa | |||
523c62530f | |||
aa57617fc7 | |||
ef89a33dfc | |||
474a730a09 | |||
e3b029c240 | |||
290824190d | |||
923d78caab | |||
6587b74a23 | |||
aa0a35f258 | |||
09b8809ede | |||
e25566490b | |||
3ed7473066 | |||
1202a68b01 | |||
c67d43e16d | |||
df74769533 | |||
5aef714497 | |||
24701afcb2 | |||
cbfbd4ee67 | |||
6df449394d | |||
27b6119bbb | |||
b22abef889 | |||
4d8a7a4202 | |||
72bc08e973 | |||
430f636ae4 | |||
bbc8f13ecf | |||
a01f07f62c | |||
36316e63b2 | |||
5c5e88c226 | |||
af968f65df | |||
f0cc2f4cd6 | |||
f167226830 | |||
3e49b365b6 | |||
c833374fdd | |||
778f057d87 | |||
8f57bf4dd5 | |||
5a9f07002f | |||
ca5ff20107 | |||
a406ff648a | |||
dab1f8514b | |||
b80c1f9090 | |||
fcd2616a3c | |||
1723193d27 | |||
88cd04d0e2 | |||
c4faa56d0d | |||
20ad0d0b38 | |||
5221d3ee84 | |||
1f50f54fe9 | |||
12199a668e | |||
82df431adf | |||
71f0a9d37f | |||
5f16cdd830 | |||
966cb88c82 | |||
7f4d72f0d6 | |||
3df47307a3 | |||
e3b84af278 | |||
a6c4a99d82 | |||
8d506f8220 | |||
bd9ed5feb5 | |||
ec28c660dc | |||
9f4299e52a | |||
73c583409e | |||
f8c86f1871 | |||
67130ec2b6 | |||
48fa9d205a | |||
3070584642 | |||
a71ffb2415 | |||
dc2be85236 | |||
964e1ce9ac | |||
fba6e3d4c5 | |||
7df51bad07 | |||
5c7af1e59f | |||
e72f7fe5c6 | |||
da48b987ba | |||
9eabac7022 | |||
00683fbab1 | |||
3434bbf815 | |||
85ac242627 | |||
9b71872d12 | |||
281595f8c8 | |||
83f03994a9 | |||
01837f8420 | |||
b5735e3721 | |||
0dc45f1414 | |||
9d1c3f7457 | |||
017279730a | |||
0b50b14146 | |||
dfa27c0604 | |||
19e839a282 | |||
647e2ec886 | |||
4e267850bf | |||
a52f6a9e9b | |||
23b0ee1472 | |||
c4d58b047c | |||
403b530a60 | |||
7d6caaafce | |||
8f47b95220 | |||
375d5cdfcc | |||
a3b1391b86 | |||
d2f5a81cfb | |||
2bc2d11a2d | |||
ecf0666103 | |||
ad05144bba | |||
1e77aba991 | |||
bb6c07845c | |||
079b049a10 | |||
94f48afbbd | |||
944e9b227c | |||
b83aaf4abf | |||
51a1dd0b1d | |||
dd9df9f5ee | |||
c109952a22 | |||
b14c79f6ef | |||
66ad3aeeb9 | |||
a6e91c6a7f | |||
f65c09c24e | |||
e8053fa9e1 | |||
759d4031d2 | |||
28e71356ff | |||
962246157c | |||
043f6e8581 | |||
e30dc5d77c | |||
e297be6fc2 | |||
659907d280 | |||
50db40d831 | |||
fbf5dce989 | |||
b6e418a431 | |||
7f69a5eaab | |||
e1f80ee888 | |||
3f261a4fa6 | |||
e75de7590e | |||
94c0663980 | |||
995161dd54 | |||
29c941044f | |||
1dc8b1aeec | |||
a0c83c8f48 | |||
b6e63664bb | |||
88b39213a6 | |||
6dad1c3d85 | |||
7d9b9b2d1d | |||
e3e6a326b5 | |||
3d59f6d393 | |||
07d752449e | |||
ea779add20 | |||
938a7bd872 | |||
45f9674550 | |||
eae983b271 | |||
871990725d | |||
d46bb18893 | |||
d8fb9747cd | |||
53209b18a9 | |||
3e3561f4bb | |||
099b513e0a | |||
cf15c428c1 | |||
3bd876a201 | |||
af62f20614 | |||
69eba08b27 | |||
6635265f4b | |||
ebdda5f969 | |||
f3a24154b4 | |||
2980b6b5f3 | |||
570046ff67 | |||
112ce2d0d6 | |||
791eaefe3c | |||
a3af90844a | |||
e389f78256 | |||
9e8fc76623 | |||
bf20ad9e61 | |||
58043d0fa2 | |||
5b0814520a | |||
848d40eeac | |||
73f5a0b055 | |||
f2a169ac7d | |||
3cdd22044e | |||
60d200135e | |||
e8238dc907 | |||
007e7539c8 | |||
e3c2c56548 | |||
f0954b19e0 | |||
48a9d19b8e | |||
7d39683972 | |||
01e9f386a6 | |||
2f4fb28b5d | |||
50b14e60c6 | |||
4753a4ff82 | |||
fe9ea47208 | |||
c8f29dc146 | |||
e7e228c900 | |||
b76cb1376d | |||
eed1a65415 | |||
040100b73f | |||
3ce49c7e97 | |||
55d7018891 | |||
d98d035902 | |||
217af24d25 | |||
11c43f59d9 | |||
14c36dd894 | |||
9f74fab2b2 | |||
8efa67a4ff | |||
f7304f59a5 | |||
070385867e | |||
e429eb8ae0 | |||
6045174edb | |||
08dcdb2c9f | |||
44aa92c83c | |||
e43541cf90 | |||
414e845b80 | |||
c18eb85ec8 | |||
3ae3598c96 | |||
26eca7aa65 |
13
.gitignore
vendored
13
.gitignore
vendored
@ -1,13 +1,4 @@
|
||||
.idea/
|
||||
.c9/
|
||||
node_modules/
|
||||
test/**/node_modules/
|
||||
test/assets/docs/
|
||||
test/**/typings/
|
||||
test/**/coverage/
|
||||
ts/*.js
|
||||
ts/*.js.map
|
||||
ts/typings/
|
||||
docs/
|
||||
|
||||
test/
|
||||
pages/
|
||||
.DS_Store
|
59
.gitlab-ci.yml
Normal file
59
.gitlab-ci.yml
Normal file
@ -0,0 +1,59 @@
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
|
||||
stages:
|
||||
- test
|
||||
- release
|
||||
- trigger
|
||||
- pages
|
||||
|
||||
testLEGACY:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test legacy
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
testLTS:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test lts
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testSTABLE:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test stable
|
||||
tags:
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
|
||||
trigger:
|
||||
stage: trigger
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
|
||||
pages:
|
||||
image: hosttoday/ht-docker-node:npmpage
|
||||
stage: pages
|
||||
script:
|
||||
- npmci command npmpage --host gitlab
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
@ -1,6 +1,7 @@
|
||||
.idea/
|
||||
support
|
||||
compile
|
||||
compile/
|
||||
coverage/
|
||||
test/
|
||||
docs/
|
||||
examples
|
||||
.gitignore
|
12
.travis.yml
12
.travis.yml
@ -1,12 +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
|
7
CHANGELOG
Normal file
7
CHANGELOG
Normal file
@ -0,0 +1,7 @@
|
||||
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
|
4
CONTRIBUTING.md
Normal file
4
CONTRIBUTING.md
Normal file
@ -0,0 +1,4 @@
|
||||
# Contribution Guide
|
||||
|
||||
This module is developed on the fabulous GitLab.com:
|
||||
https://gitlab.com/pushrocks/npmts
|
@ -1 +0,0 @@
|
||||
# README-dev
|
113
README.md
113
README.md
@ -1,97 +1,36 @@
|
||||
# npmts
|
||||
Write npm modules with TypeScript without hassle.
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
|
||||
## Status
|
||||
[](https://travis-ci.org/pushrocks/npmts)
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://gitlab.com/pushrocks/npmts)
|
||||
[](https://github.com/pushrocks/npmts)
|
||||
[](https://pushrocks.gitlab.io/npmts/docs)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://david-dm.org/pushrocks/npmts)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||
[](https://coveralls.io/github/pushrocks/npmts?branch=master)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](http://standardjs.com/)
|
||||
|
||||
## How to use npmts
|
||||
## Introduction
|
||||
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
||||
|
||||
### Install
|
||||
First install npmts as dev dependency:
|
||||
npmts will
|
||||
|
||||
1. check your dependencies and package.json
|
||||
1. transpile your code with tsc,
|
||||
1. document your code with typedoc,
|
||||
1. test your code with mocha
|
||||
1. create coverage with istanbul
|
||||
|
||||
```sh
|
||||
npm install npmts --save-dev
|
||||
```
|
||||
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/)
|
||||
|
||||
Then use it in package.json's script section to trigger a build:
|
||||
For further information read the docs.
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"test": "npmts"
|
||||
}
|
||||
```
|
||||
|
||||
### Default behaviour
|
||||
|
||||
**Execution order of tasks**
|
||||
|
||||
1. Install typings
|
||||
2. Transpile TypeScript with inline sourcemaps
|
||||
3. Create Declaration Files
|
||||
4. Instrumentalize created JavaScript files with istanbul
|
||||
5. Run Tests
|
||||
6. Create Coverage report
|
||||
7. Upload Coverage reports to travis (must be activated, only triggers on travis)
|
||||
|
||||
|
||||
#### Typings
|
||||
**npmts** looks for `./ts/typings.json` by default and installs any defined typings to `.ts/typings/`.
|
||||
You can then reference the ./ts/typings/main.d.ts file in your TypeScript code.
|
||||
|
||||
#### TypeScript
|
||||
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
||||
`./dist/*.js` and `./test/test.js`
|
||||
|
||||
Use commonjs module system for wiring up files.
|
||||
|
||||
#### Declaration files
|
||||
**npmts** also creates an `index.d.ts` declaration file by default.
|
||||
You can reference it in your package.json like this:
|
||||
|
||||
```json
|
||||
"main": "index.js",
|
||||
"typings": "./index.d.ts",
|
||||
```
|
||||
|
||||
#### Instrumentalize Code
|
||||
npmts instrumentalizes the created JavaScript code to create a coverage report.
|
||||
|
||||
#### Tests
|
||||
When Typings have been installed, TypeScript + Declaration files have been transpiled and the resulting JS has been instrumentalized,
|
||||
npmts runs `.test/test.js` with mocha.
|
||||
|
||||
Any errors will be shown with reference to their originating source in TypeScript.
|
||||
|
||||
When requiring the module from other TypeScript files,
|
||||
the TypeScript Compiler will use the declaration file to resolve typings.
|
||||
|
||||
|
||||
|
||||
### Custom behaviour
|
||||
Custom behaviour can be achieved through a config file at the root of your package.
|
||||
The file must be named **npmts.json**
|
||||
|
||||
```json
|
||||
{
|
||||
"mode":"custom",
|
||||
"ts":{
|
||||
"./customdir/custom.ts":"./customcompiled.js"
|
||||
},
|
||||
"typings":[
|
||||
"./customdir"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
* **mode** can be "default" or "custom"
|
||||
* **ts** You can list as many TypeScript files as you like. The key represents the source TypeScript file, the value the output file.
|
||||
* **typings** is an array of all direcories that have a typings.json present. Uses the new typings tool from npm.
|
||||
|
||||
|
||||
## Readme for Devs
|
||||
There is a [README-dev.md](README-dev.md) in the repo.
|
||||
This is only of interest for you when looking to contribute to, improve or build upon this package.
|
||||
[](https://push.rocks)
|
||||
|
2
assets/cli.js
Normal file
2
assets/cli.js
Normal file
@ -0,0 +1,2 @@
|
||||
#!/usr/bin/env node
|
||||
var index = require("./index.js");
|
@ -1 +0,0 @@
|
||||
#!/usr/bin/env node
|
@ -1,39 +0,0 @@
|
||||
// import gulp
|
||||
var plugins = {
|
||||
beautylog: require("beautylog"),
|
||||
gulp: require("gulp"),
|
||||
g:{
|
||||
typescript: require("gulp-typescript"),
|
||||
header: require("gulp-header")
|
||||
},
|
||||
mergeStream: require("merge2"),
|
||||
path: require("path")
|
||||
};
|
||||
|
||||
paths = {
|
||||
packageBase: plugins.path.resolve(
|
||||
plugins.path.join(__dirname,"../")
|
||||
)
|
||||
};
|
||||
|
||||
plugins.beautylog.log('now compiling NPMTS');
|
||||
|
||||
plugins.gulp.task('indexTS', function() {
|
||||
var stream = plugins.gulp.src([
|
||||
plugins.path.join(paths.packageBase,'ts/**/*.ts'),
|
||||
"!" + plugins.path.join(paths.packageBase,'ts/typings/**/*.d.ts')
|
||||
])
|
||||
.pipe(plugins.g.typescript({
|
||||
target:"ES5",
|
||||
module:"commonjs"
|
||||
}))
|
||||
.pipe(plugins.g.header('#!/usr/bin/env node\n\n'))
|
||||
.pipe(plugins.gulp.dest(plugins.path.join(paths.packageBase, 'dist/')));
|
||||
return stream;
|
||||
});
|
||||
|
||||
plugins.gulp.task('default',['indexTS'], function() {
|
||||
plugins.beautylog.success('Typescript compiled');
|
||||
});
|
||||
|
||||
plugins.gulp.start.apply(plugins.gulp, ['default']);
|
3
dist/cli.js
vendored
3
dist/cli.js
vendored
@ -1,3 +1,2 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var index = require("./index.js");
|
1
dist/index.d.ts
vendored
Normal file
1
dist/index.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
||||
import 'typings-global';
|
36
dist/index.js
vendored
36
dist/index.js
vendored
@ -1,8 +1,28 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
console.log("**** starting NPMTS ****");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var promisechain = require("./npmts.promisechain");
|
||||
plugins.beautylog.figletSync("NPMTS");
|
||||
promisechain.run();
|
||||
"use strict";
|
||||
require('typings-global');
|
||||
/* ================================================== *
|
||||
Starting NPMTS main process.
|
||||
* ================================================== */
|
||||
var early = require('early');
|
||||
early.start('NPMTS');
|
||||
var plugins = require('./npmts.plugins');
|
||||
var paths = require('./npmts.paths');
|
||||
var npmts_promisechain_1 = require('./npmts.promisechain');
|
||||
early.stop()
|
||||
.then(function () {
|
||||
var npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
|
||||
var npmtsCli = new plugins.smartcli.Smartcli();
|
||||
npmtsCli.standardTask()
|
||||
.then(function (argvArg) {
|
||||
plugins.beautylog.figletSync('NPMTS');
|
||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
|
||||
try {
|
||||
npmts_promisechain_1.promisechain(argvArg);
|
||||
}
|
||||
catch (err) {
|
||||
console.log(err);
|
||||
}
|
||||
});
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version);
|
||||
npmtsCli.startParse();
|
||||
});
|
||||
|
4
dist/npmts.assets.d.ts
vendored
Normal file
4
dist/npmts.assets.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare var run: (configArg: any) => plugins.Q.Promise<{}>;
|
20
dist/npmts.assets.js
vendored
Normal file
20
dist/npmts.assets.js
vendored
Normal file
@ -0,0 +1,20 @@
|
||||
"use strict";
|
||||
require('typings-global');
|
||||
var plugins = require('./npmts.plugins');
|
||||
var paths = require('./npmts.paths');
|
||||
var npmts_promisechain_1 = require('./npmts.promisechain');
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
npmts_promisechain_1.npmtsOra.text('now looking at ' + 'required assets'.yellow);
|
||||
if (config.cli === true) {
|
||||
plugins.smartfile.fs.copySync(plugins.path.join(paths.npmtsAssetsDir, 'cli.js'), plugins.path.join(paths.distDir, 'cli.js'));
|
||||
plugins.beautylog.ok('installed CLI assets!');
|
||||
done.resolve(config);
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.ok('No additional assets required!');
|
||||
done.resolve(config);
|
||||
}
|
||||
return done.promise;
|
||||
};
|
5
dist/npmts.check.d.ts
vendored
Normal file
5
dist/npmts.check.d.ts
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
/// <reference types="q" />
|
||||
import * as plugins from './npmts.plugins';
|
||||
import { ProjectinfoNpm } from 'projectinfo';
|
||||
export declare let projectInfo: ProjectinfoNpm;
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
127
dist/npmts.check.js
vendored
Normal file
127
dist/npmts.check.js
vendored
Normal file
@ -0,0 +1,127 @@
|
||||
"use strict";
|
||||
var plugins = require('./npmts.plugins');
|
||||
var paths = require('./npmts.paths');
|
||||
var npmts_promisechain_1 = require('./npmts.promisechain');
|
||||
var projectinfo_1 = require('projectinfo');
|
||||
var checkProjectTypings = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
exports.projectInfo = new projectinfo_1.ProjectinfoNpm(paths.cwd);
|
||||
if (typeof exports.projectInfo.packageJson.typings === 'undefined') {
|
||||
plugins.beautylog.error("please add typings field to package.json");
|
||||
process.exit(1);
|
||||
}
|
||||
;
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
var depcheckOptions = {
|
||||
ignoreBinPackage: false,
|
||||
parsers: {
|
||||
'*.ts': plugins.depcheck.parser.typescript
|
||||
},
|
||||
detectors: [
|
||||
plugins.depcheck.detector.requireCallExpression,
|
||||
plugins.depcheck.detector.importDeclaration
|
||||
],
|
||||
specials: [
|
||||
plugins.depcheck.special.eslint,
|
||||
plugins.depcheck.special.webpack
|
||||
]
|
||||
};
|
||||
var checkDependencies = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [
|
||||
'test',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [
|
||||
'@types/*',
|
||||
'babel-preset-*'
|
||||
]
|
||||
});
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
|
||||
for (var _i = 0, _a = unused.dependencies; _i < _a.length; _i++) {
|
||||
var item = _a[_i];
|
||||
plugins.beautylog.warn("Watch out: unused dependency " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
|
||||
var item = _c[_b];
|
||||
plugins.beautylog.error("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info('exiting due to missing dependencies in package.json');
|
||||
process.exit(1);
|
||||
}
|
||||
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||
var item = _e[_d];
|
||||
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
|
||||
var item = _g[_f];
|
||||
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
||||
}
|
||||
;
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
var checkDevDependencies = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [
|
||||
'ts',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [
|
||||
'@types/*',
|
||||
'babel-preset-*'
|
||||
]
|
||||
});
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
|
||||
for (var _i = 0, _a = unused.devDependencies; _i < _a.length; _i++) {
|
||||
var item = _a[_i];
|
||||
plugins.beautylog.log("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
|
||||
var item = _c[_b];
|
||||
plugins.beautylog.error("unused devDependency " + item.red);
|
||||
}
|
||||
;
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info('exiting due to missing dependencies in package.json');
|
||||
process.exit(1);
|
||||
}
|
||||
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||
var item = _e[_d];
|
||||
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||
}
|
||||
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
|
||||
var item = _g[_f];
|
||||
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
||||
}
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
var checkNodeVersion = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text('running project checks...');
|
||||
checkProjectTypings(configArg)
|
||||
.then(checkDependencies)
|
||||
.then(checkDevDependencies)
|
||||
.then(checkNodeVersion)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
4
dist/npmts.clean.d.ts
vendored
Normal file
4
dist/npmts.clean.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
24
dist/npmts.clean.js
vendored
Normal file
24
dist/npmts.clean.js
vendored
Normal file
@ -0,0 +1,24 @@
|
||||
"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;
|
||||
};
|
3
dist/npmts.cli.js
vendored
3
dist/npmts.cli.js
vendored
@ -1,3 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./typings/main.d.ts" />
|
4
dist/npmts.compile.d.ts
vendored
Normal file
4
dist/npmts.compile.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
1
dist/npmts.compile.helpers.d.ts
vendored
Normal file
1
dist/npmts.compile.helpers.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
||||
export declare let checkOutputPath: (tsArrayArg: any, keyArg: any) => boolean;
|
16
dist/npmts.compile.helpers.js
vendored
Normal file
16
dist/npmts.compile.helpers.js
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
"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;
|
||||
}
|
||||
;
|
||||
};
|
143
dist/npmts.compile.js
vendored
143
dist/npmts.compile.js
vendored
@ -1,91 +1,64 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
"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],
|
||||
exclude: 'node_modules/**/*'
|
||||
};
|
||||
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;
|
||||
plugins.beautylog.log("now running custom tasks");
|
||||
var moduleStream = plugins.merge2({ end: false });
|
||||
/* -------------------------------------------------
|
||||
* ----------- first install typings ---------------
|
||||
* ----------------------------------------------- */
|
||||
var typingsDone = plugins.Q.defer();
|
||||
var typingsCounter = 0;
|
||||
var typingsCounterAdvance = function () {
|
||||
typingsCounter++;
|
||||
if (typeof config.typings[typingsCounter] != "undefined") {
|
||||
installTypings();
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.success("custom typings installed successfully");
|
||||
typingsDone.resolve();
|
||||
}
|
||||
};
|
||||
var installTypings = function () {
|
||||
plugins.beautylog.log("now installing " + "typings.json".yellow + " from " + config.typings[typingsCounter].blue);
|
||||
plugins.typings.install({ production: false, cwd: plugins.path.join(paths.cwd, config.typings[typingsCounter]) })
|
||||
.then(function () {
|
||||
typingsCounterAdvance();
|
||||
}, function () {
|
||||
plugins.beautylog.error("something went wrong: Check if path is correct: " + config.typings[typingsCounter].blue);
|
||||
typingsCounterAdvance();
|
||||
});
|
||||
};
|
||||
installTypings();
|
||||
/* -------------------------------------------------
|
||||
* ----------- second compile TS -------------------
|
||||
* ----------------------------------------------- */
|
||||
typingsDone.promise.then(function () {
|
||||
for (var key in config.ts) {
|
||||
plugins.beautylog.log("now compiling" + key.blue);
|
||||
var outputPathIsDir;
|
||||
try {
|
||||
if (plugins.fs.statSync(plugins.path.join(paths.cwd, config.ts[key])).isDirectory()) {
|
||||
outputPathIsDir = true;
|
||||
}
|
||||
}
|
||||
catch (err) {
|
||||
outputPathIsDir = false;
|
||||
}
|
||||
//do some evaluation of the environment
|
||||
var outputNameSpecified = (!outputPathIsDir
|
||||
&& (plugins.path.extname(config.ts[key]) == ".js"));
|
||||
var outputName = (function () {
|
||||
if (outputNameSpecified) {
|
||||
return plugins.path.basename(config.ts[key]);
|
||||
}
|
||||
else {
|
||||
return undefined;
|
||||
}
|
||||
})();
|
||||
var outputDir = (function () {
|
||||
if (outputNameSpecified) {
|
||||
return plugins.path.dirname(plugins.path.join(paths.cwd, config.ts[key]));
|
||||
}
|
||||
else {
|
||||
return plugins.path.join(paths.cwd, config.ts[key]);
|
||||
}
|
||||
})();
|
||||
var stream = plugins.gulp.src([plugins.path.join(paths.cwd, key), "!**/typings/**"])
|
||||
.pipe(plugins.g.sourcemaps.init()) // This means sourcemaps will be generated
|
||||
.pipe(plugins.g.typescript({
|
||||
out: outputName,
|
||||
target: "ES5",
|
||||
module: "commonjs"
|
||||
}))
|
||||
.pipe(plugins.g.sourcemaps.write()) // Now the sourcemaps are added to the .js file
|
||||
.pipe(plugins.gulp.dest(outputDir));
|
||||
moduleStream.add(stream);
|
||||
}
|
||||
moduleStream.on("queueDrain", function () {
|
||||
plugins.beautylog.success("custom TypeScript installed successfully");
|
||||
moduleStream.on("finish", function () {
|
||||
done.resolve(config);
|
||||
});
|
||||
moduleStream.end();
|
||||
});
|
||||
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;
|
||||
};
|
||||
|
31
dist/npmts.configfile.js
vendored
31
dist/npmts.configfile.js
vendored
@ -1,31 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
exports.run = function () {
|
||||
var done = plugins.Q.defer();
|
||||
var config = {};
|
||||
var configPath = plugins.path.join(paths.cwd, "npmts.json");
|
||||
if (plugins.smartfile.checks.fileExistsSync(configPath)) {
|
||||
plugins.beautylog.info("npmts.json".blue + " config file found!");
|
||||
config = plugins.smartfile.readFileToObject(configPath);
|
||||
switch (config.mode) {
|
||||
case "default":
|
||||
case "custom":
|
||||
plugins.beautylog.log("mode is " + config.mode.yellow);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
|
||||
}
|
||||
;
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
|
||||
config.mode = "default";
|
||||
done.resolve(config);
|
||||
}
|
||||
;
|
||||
return done.promise;
|
||||
};
|
64
dist/npmts.jsdoc.js
vendored
64
dist/npmts.jsdoc.js
vendored
@ -1,64 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var genJsdoc = function () {
|
||||
var done = plugins.Q.defer();
|
||||
plugins.beautylog.log("now generating " + "JsDoc documentation".blue);
|
||||
plugins.gulp.src([
|
||||
plugins.path.join(paths.cwd, "README.md"),
|
||||
plugins.path.join(paths.distDir, "**/*.js")
|
||||
])
|
||||
.pipe(plugins.g.jsdoc3({
|
||||
opts: {
|
||||
destination: paths.docsDir
|
||||
}
|
||||
}, done.resolve));
|
||||
return done.promise;
|
||||
};
|
||||
var publishDocs = function () {
|
||||
var done = plugins.Q.defer();
|
||||
try {
|
||||
var gitUrl = plugins.projectinfo.npm(paths.cwd, {
|
||||
gitAccessToken: process.env.GITHUB_TOKEN
|
||||
}).git.httpsUrl;
|
||||
var deployScript = ""
|
||||
+ "cd " + paths.docsDir + " "
|
||||
+ "&& git init "
|
||||
+ "&& git config user.name \"TRAVIS CI\" "
|
||||
+ "&& git config user.email \"travis@shipzone.io\" "
|
||||
+ "&& git add . "
|
||||
+ "&& git commit -m \"Deploy to GitHub Pages\" "
|
||||
+ "&& git push --force --quiet "
|
||||
+ "\"" + gitUrl + "\" "
|
||||
+ "master:gh-pages "
|
||||
+ "> /dev/null 2>&1";
|
||||
}
|
||||
catch (err) {
|
||||
console.log(err);
|
||||
}
|
||||
if (plugins.smartenv.getEnv().isTravis) {
|
||||
plugins.beautylog.log("now publishing docs to GitHub");
|
||||
if (!plugins.shelljs.which('git')) {
|
||||
plugins.beautylog.error('Git is not installed');
|
||||
plugins.shelljs.exit(1);
|
||||
}
|
||||
else if (plugins.shelljs.exec(deployScript).code !== 0) {
|
||||
plugins.beautylog.error('Error: Git failed');
|
||||
plugins.shelljs.exit(1);
|
||||
}
|
||||
done.resolve();
|
||||
}
|
||||
else {
|
||||
done.resolve();
|
||||
}
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function () {
|
||||
var done = plugins.Q.defer();
|
||||
genJsdoc()
|
||||
.then(publishDocs)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
15
dist/npmts.options.d.ts
vendored
Normal file
15
dist/npmts.options.d.ts
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare type npmtsMode = 'default' | 'custom';
|
||||
export interface INpmtsConfig {
|
||||
argv: any;
|
||||
coverageTreshold: number;
|
||||
docs: boolean;
|
||||
mode: npmtsMode;
|
||||
test: boolean;
|
||||
testTs: any;
|
||||
ts: any;
|
||||
tsOptions: any;
|
||||
}
|
||||
export declare var run: (argvArg: any) => plugins.Q.Promise<{}>;
|
75
dist/npmts.options.js
vendored
75
dist/npmts.options.js
vendored
@ -1,28 +1,65 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var plugins = require("./npmts.plugins");
|
||||
exports.run = function (configArg) {
|
||||
"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 config = configArg;
|
||||
if (typeof config.coveralls === "undefined") {
|
||||
config.coveralls = false;
|
||||
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);
|
||||
}
|
||||
if (config.mode == "default") {
|
||||
config.typings = [
|
||||
"./ts/"
|
||||
];
|
||||
;
|
||||
// handle default mode
|
||||
if (config.mode === 'default') {
|
||||
config.ts = (_a = {},
|
||||
_a["./ts/**/*.ts"] = "./dist/",
|
||||
_a["./test/test.ts"] = "./test/",
|
||||
_a['./ts/**/*.ts'] = './dist/',
|
||||
_a
|
||||
);
|
||||
config.test = ["./index.js"];
|
||||
done.resolve(config);
|
||||
config.testTs = (_b = {},
|
||||
_b['./test/test.ts'] = './test/',
|
||||
_b
|
||||
);
|
||||
}
|
||||
else {
|
||||
done.resolve(config);
|
||||
;
|
||||
// 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;
|
||||
var _a, _b;
|
||||
};
|
||||
|
13
dist/npmts.paths.d.ts
vendored
Normal file
13
dist/npmts.paths.d.ts
vendored
Normal file
@ -0,0 +1,13 @@
|
||||
import 'typings-global';
|
||||
export declare let npmtsPackageRoot: string;
|
||||
export declare let cwd: string;
|
||||
export declare let tsDir: string;
|
||||
export declare let distDir: string;
|
||||
export declare let testDir: string;
|
||||
export declare let typingsDir: string;
|
||||
export declare let coverageDir: string;
|
||||
export declare let pagesDir: string;
|
||||
export declare let pagesApiDir: string;
|
||||
export declare let npmtsAssetsDir: string;
|
||||
export declare let indexTS: string;
|
||||
export declare let testTS: string;
|
35
dist/npmts.paths.js
vendored
35
dist/npmts.paths.js
vendored
@ -1,15 +1,20 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = {};
|
||||
paths.cwd = plugins.smartcli.get.cwd().path;
|
||||
//Directories
|
||||
paths.tsDir = plugins.path.join(paths.cwd, "ts/");
|
||||
paths.distDir = plugins.path.join(paths.cwd, "dist/");
|
||||
paths.docsDir = plugins.path.join(paths.cwd, "docs/");
|
||||
paths.testDir = plugins.path.join(paths.cwd, "test/");
|
||||
//Files
|
||||
paths.indexTS = plugins.path.join(paths.cwd, "ts/index.ts");
|
||||
paths.testTS = plugins.path.join(paths.cwd, "ts/test.ts");
|
||||
module.exports = paths;
|
||||
"use strict";
|
||||
require('typings-global');
|
||||
var plugins = require('./npmts.plugins');
|
||||
// NPMTS Paths
|
||||
exports.npmtsPackageRoot = plugins.path.join(__dirname, '../');
|
||||
// Project paths
|
||||
exports.cwd = process.cwd();
|
||||
// Directories
|
||||
exports.tsDir = plugins.path.join(exports.cwd, 'ts/');
|
||||
exports.distDir = plugins.path.join(exports.cwd, 'dist/');
|
||||
exports.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');
|
||||
|
27
dist/npmts.plugins.d.ts
vendored
Normal file
27
dist/npmts.plugins.d.ts
vendored
Normal file
@ -0,0 +1,27 @@
|
||||
import 'typings-global';
|
||||
export import beautylog = require('beautylog');
|
||||
export declare let depcheck: any;
|
||||
export import gulp = require('gulp');
|
||||
export declare let g: {
|
||||
babel: any;
|
||||
istanbul: any;
|
||||
gFunction: any;
|
||||
injectModules: any;
|
||||
mocha: any;
|
||||
sourcemaps: any;
|
||||
typedoc: any;
|
||||
};
|
||||
export import lodashObject = require('lodash');
|
||||
export import npmextra = require('npmextra');
|
||||
export import projectinfo = require('projectinfo');
|
||||
export import path = require('path');
|
||||
export import Q = require('q');
|
||||
export import shelljs = require('shelljs');
|
||||
export import smartcli = require('smartcli');
|
||||
export import smartcov = require('smartcov');
|
||||
export import smartenv = require('smartenv');
|
||||
export import smartfile = require('smartfile');
|
||||
export import smartpath = require('smartpath');
|
||||
export import smartstring = require('smartstring');
|
||||
export declare let sourceMapSupport: any;
|
||||
export import tsn = require('tsn');
|
54
dist/npmts.plugins.js
vendored
54
dist/npmts.plugins.js
vendored
@ -1,28 +1,28 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var plugins = {
|
||||
beautylog: require("beautylog"),
|
||||
fs: require("fs-extra"),
|
||||
gulp: require("gulp"),
|
||||
g: {
|
||||
coveralls: require("gulp-coveralls"),
|
||||
gFunction: require("gulp-function"),
|
||||
istanbul: require("gulp-istanbul"),
|
||||
jsdoc3: require("gulp-jsdoc3"),
|
||||
mocha: require("gulp-mocha"),
|
||||
sourcemaps: require("gulp-sourcemaps"),
|
||||
typescript: require("gulp-typescript")
|
||||
},
|
||||
merge2: require("merge2"),
|
||||
projectinfo: require("projectinfo"),
|
||||
sourceMapSupport: require("source-map-support").install(),
|
||||
path: require("path"),
|
||||
Q: require("q"),
|
||||
shelljs: require("shelljs"),
|
||||
smartcli: require("smartcli"),
|
||||
smartenv: require("smartenv"),
|
||||
smartfile: require("smartfile"),
|
||||
typings: require("typings")
|
||||
"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')
|
||||
};
|
||||
module.exports = plugins;
|
||||
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(); // display errors correctly during testing
|
||||
exports.tsn = require('tsn');
|
||||
|
6
dist/npmts.promisechain.d.ts
vendored
Normal file
6
dist/npmts.promisechain.d.ts
vendored
Normal file
@ -0,0 +1,6 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
import { Ora } from 'beautylog';
|
||||
export declare let npmtsOra: Ora;
|
||||
export declare let promisechain: (argvArg: any) => plugins.Q.Promise<{}>;
|
61
dist/npmts.promisechain.js
vendored
61
dist/npmts.promisechain.js
vendored
@ -1,17 +1,48 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var NpmtsConfigFile = require("./npmts.configfile");
|
||||
var NpmtsOptions = require("./npmts.options");
|
||||
var NpmtsCompile = require("./npmts.compile");
|
||||
var NpmtsJsdoc = require("./npmts.jsdoc");
|
||||
var NpmtsTests = require("./npmts.tests");
|
||||
exports.run = function () {
|
||||
var promisechain;
|
||||
NpmtsConfigFile.run()
|
||||
.then(NpmtsOptions.run)
|
||||
"use strict";
|
||||
require('typings-global');
|
||||
var plugins = require('./npmts.plugins');
|
||||
var beautylog_1 = require('beautylog');
|
||||
exports.npmtsOra = new beautylog_1.Ora('setting up TaskChain', 'cyan');
|
||||
var NpmtsAssets = require('./npmts.assets');
|
||||
var NpmtsCheck = require('./npmts.check');
|
||||
var NpmtsClean = require('./npmts.clean');
|
||||
var NpmtsCompile = require('./npmts.compile');
|
||||
var NpmtsTypeDoc = require('./npmts.typedoc');
|
||||
var NpmtsOptions = require('./npmts.options');
|
||||
var NpmtsTests = require('./npmts.tests');
|
||||
exports.promisechain = function (argvArg) {
|
||||
var done = plugins.Q.defer();
|
||||
exports.npmtsOra.start();
|
||||
NpmtsOptions.run(argvArg)
|
||||
.then(NpmtsClean.run)
|
||||
.then(NpmtsCheck.run)
|
||||
.then(NpmtsCompile.run)
|
||||
.then(NpmtsJsdoc.run)
|
||||
.then(NpmtsTests.run);
|
||||
return promisechain;
|
||||
.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;
|
||||
};
|
||||
|
4
dist/npmts.tests.d.ts
vendored
Normal file
4
dist/npmts.tests.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
114
dist/npmts.tests.js
vendored
114
dist/npmts.tests.js
vendored
@ -1,41 +1,83 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
exports.run = function (configArg) {
|
||||
"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 config = configArg;
|
||||
var istanbul = function () {
|
||||
var stream = plugins.gulp.src([plugins.path.join(paths.cwd, "dist/*.js")])
|
||||
.pipe(plugins.g.istanbul())
|
||||
.pipe(plugins.g.istanbul.hookRequire());
|
||||
return stream;
|
||||
};
|
||||
var mocha = function () {
|
||||
var stream = plugins.gulp.src(["./test/test.js"])
|
||||
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())
|
||||
.pipe(plugins.g.istanbul.enforceThresholds({ thresholds: { global: 30 } }));
|
||||
return stream;
|
||||
};
|
||||
var coveralls = function () {
|
||||
plugins.beautylog.log("now uploading coverage data to coveralls");
|
||||
var stream = plugins.gulp.src([plugins.path.join(paths.cwd, "./coverage/lcov.info")])
|
||||
.pipe(plugins.g.coveralls());
|
||||
return stream;
|
||||
};
|
||||
istanbul().on("finish", function () {
|
||||
mocha().on("finish", function () {
|
||||
if (plugins.smartenv.getEnv().isTravis && config.coveralls) {
|
||||
coveralls().on("finish", function () {
|
||||
done.resolve(config);
|
||||
});
|
||||
}
|
||||
else {
|
||||
done.resolve(config);
|
||||
}
|
||||
});
|
||||
.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
Normal file
4
dist/npmts.typedoc.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
43
dist/npmts.typedoc.js
vendored
Normal file
43
dist/npmts.typedoc.js
vendored
Normal file
@ -0,0 +1,43 @@
|
||||
"use strict";
|
||||
require('typings-global');
|
||||
var plugins = require('./npmts.plugins');
|
||||
var paths = require('./npmts.paths');
|
||||
var npmts_promisechain_1 = require('./npmts.promisechain');
|
||||
var npmts_check_1 = require('./npmts.check');
|
||||
var genTypeDoc = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text('now generating ' + 'TypeDoc documentation'.yellow);
|
||||
plugins.beautylog.log('TypeDoc Output:');
|
||||
plugins.gulp.src(plugins.path.join(paths.tsDir, '**/*.ts'))
|
||||
.pipe(plugins.g.typedoc({
|
||||
// TypeScript options (see typescript docs)
|
||||
module: 'commonjs',
|
||||
target: 'es6',
|
||||
includeDeclarations: true,
|
||||
// Output options (see typedoc docs)
|
||||
out: paths.pagesApiDir,
|
||||
json: plugins.path.join(paths.pagesApiDir, 'file.json'),
|
||||
// TypeDoc options (see typedoc docs)
|
||||
name: npmts_check_1.projectInfo.name,
|
||||
readme: plugins.path.join(paths.cwd, 'README.md'),
|
||||
// theme: "default",
|
||||
ignoreCompilerErrors: true,
|
||||
version: true
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(done.resolve, 'atEnd'));
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
if (configArg.docs) {
|
||||
genTypeDoc(configArg)
|
||||
.then(function () {
|
||||
done.resolve(configArg);
|
||||
});
|
||||
}
|
||||
else {
|
||||
done.resolve(configArg);
|
||||
}
|
||||
;
|
||||
return done.promise;
|
||||
};
|
15
docs/book.json
Normal file
15
docs/book.json
Normal file
@ -0,0 +1,15 @@
|
||||
{
|
||||
"structure": {
|
||||
"readme": "index.md"
|
||||
},
|
||||
"plugins": [
|
||||
"tonic",
|
||||
"edit-link"
|
||||
],
|
||||
"pluginsConfig": {
|
||||
"edit-link": {
|
||||
"base": "https://gitlab.com/pushrocks/npmts/edit/master/docs/",
|
||||
"label": "Edit on GitLab"
|
||||
}
|
||||
}
|
||||
}
|
80
docs/config.md
Normal file
80
docs/config.md
Normal file
@ -0,0 +1,80 @@
|
||||
# Configuration of NPMTS
|
||||
npmts can be configured to your needs:
|
||||
|
||||
### npmextra.json
|
||||
the npmts section in npmextra.json can be used to configure npmts.
|
||||
|
||||
**Default**
|
||||
>Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
|
||||
with default behaviour.
|
||||
|
||||
```json
|
||||
{
|
||||
"npmts":{
|
||||
"mode":"default"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Custom settings**
|
||||
```json
|
||||
{
|
||||
"mode":"custom",
|
||||
"docs":false,
|
||||
"test":true,
|
||||
"npmts":{
|
||||
"ts":{
|
||||
"./customdir/*.ts":"./"
|
||||
},
|
||||
"tsOptions":{
|
||||
"declaration":false,
|
||||
"target":"ES6"
|
||||
},
|
||||
"cli":true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
| key | default value | description |
|
||||
| --- | --- | --- |
|
||||
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
|
||||
| `"docs"` | `true` | create docs for your module |
|
||||
| `"test"` | `true` | test your module |
|
||||
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
|
||||
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
|
||||
| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
|
||||
|
||||
### TypeScript
|
||||
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
||||
`./dist/*.js` and `./test/test.js`
|
||||
|
||||
Use commonjs module system for wiring up files.
|
||||
|
||||
### Declaration files
|
||||
**npmts** also creates declaration files like `./dist/index.d.ts` by default.
|
||||
You can reference it in your package.json like this.
|
||||
|
||||
```json
|
||||
"main": "dist/index.js",
|
||||
"typings": ".dist/index.d.ts",
|
||||
```
|
||||
|
||||
This is in line with the latest TypeScript best practices.
|
||||
You can then import plugins via the TypeScript `import` Syntax
|
||||
and tsc will pick up the declaration file automatically.
|
||||
|
||||
### TypeDoc
|
||||
By default TypeDoc will create docs for your module in `./pages/api/` directory.
|
||||
> Note: Use [npmpage](https://www.npmjs.com/package/npmpage) to build a website for the module.
|
||||
It also allows you to integrate api docs with a gitbook located in `./docs/`
|
||||
|
||||
## Some notes:
|
||||
#### Typings for third party modules that do not bundle declaration files
|
||||
NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
|
||||
|
||||
#### Instrumentalize Code
|
||||
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
||||
|
||||
#### Tests
|
||||
Any errors will be shown with reference to their originating source in TypeScript
|
||||
thanks to autogenerated source maps.
|
8
docs/default.md
Normal file
8
docs/default.md
Normal file
@ -0,0 +1,8 @@
|
||||
# Default task execution of npmts
|
||||
|
||||
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
|
||||
1. **Clean:** Clean up from any previous builds (old js files)
|
||||
1. **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies
|
||||
1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
|
||||
1. **Documentation:** Create TypeDoc Documentation from TypeScript files
|
||||
1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
|
13
docs/examples.md
Normal file
13
docs/examples.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Examples for npmts
|
||||
|
||||
## Example Usage in modules:
|
||||
* [gulp-browser](https://www.npmjs.com/package/gulp-browser)
|
||||
|
||||
> We will add more options over time.
|
||||
|
||||
## Tips and tricks:
|
||||
|
||||
* Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available.
|
||||
* Use [npmpage](https://www.npmjs.com/package/npmpage) to create a webpage from coverage reports and TypeDoc for the module
|
||||
* Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds
|
||||
* Use [npmdocker](https://www.npmjs.com/package/npmdocker) for running tests consistently with docker.
|
36
docs/index.md
Normal file
36
docs/index.md
Normal file
@ -0,0 +1,36 @@
|
||||
# npmts
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://gitlab.com/pushrocks/npmts)
|
||||
[](https://github.com/pushrocks/npmts)
|
||||
[](https://pushrocks.gitlab.io/npmts/docs)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://david-dm.org/pushrocks/npmts)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](http://standardjs.com/)
|
||||
|
||||
## Introduction
|
||||
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
||||
|
||||
npmts will
|
||||
|
||||
1. check your dependencies and package.json
|
||||
1. transpile your code with tsc,
|
||||
1. document your code with typedoc,
|
||||
1. test your code with mocha
|
||||
1. create coverage with istanbul
|
||||
|
||||
This works on your machine and in CI. There is a prebuild docker image available that includes npmts to make CI a breeze:
|
||||
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||
|
||||
For further information read the docs.
|
||||
|
||||
[](https://push.rocks)
|
14
docs/info.md
Normal file
14
docs/info.md
Normal file
@ -0,0 +1,14 @@
|
||||
# Info
|
||||
|
||||
## Future Scope:
|
||||
* automatically manage badges in README
|
||||
* manage tslint to enforce code best practices
|
||||
* tear down any differences between local and CI environments by using brand new npmdocker
|
||||
|
||||
## About the authors:
|
||||
[](https://lossless.com/)
|
||||
|
||||
[](https://paypal.me/lossless)
|
||||
|
||||
## Legal Info
|
||||
https://lossless.gmbh
|
18
docs/install.md
Normal file
18
docs/install.md
Normal file
@ -0,0 +1,18 @@
|
||||
# Install npmts
|
||||
First install npmts globally, then install the npmts-g locally.
|
||||
|
||||
> **npmts-g* checks if the global version of npmts suffices the modules requirements.
|
||||
If not it installs npmts locally in the right version during npm install.
|
||||
|
||||
```sh
|
||||
npm install npmts -g # installs npmts globally
|
||||
npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency
|
||||
```
|
||||
|
||||
Then add it to your package.json's script section to trigger a build:
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"test": "(npmts)"
|
||||
}
|
||||
```
|
8
docs/summary.md
Normal file
8
docs/summary.md
Normal file
@ -0,0 +1,8 @@
|
||||
# Summary
|
||||
|
||||
* [1. Intro](index.md)
|
||||
* [2. Install](install.md)
|
||||
* [3. Default Behaviour](default.md)
|
||||
* [4. Configuration](config.md)
|
||||
* [5. Examples](examples.md)
|
||||
* [6. Info](info.md)
|
74
package.json
74
package.json
@ -1,18 +1,25 @@
|
||||
{
|
||||
"name": "npmts",
|
||||
"version": "3.2.1",
|
||||
"description": "write npm modules with TypeScript",
|
||||
"version": "5.4.30",
|
||||
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
||||
"main": "dist/index.js",
|
||||
"bin": {
|
||||
"npmts": "dist/cli.js"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "(cd compile && node compile.js) && (cd test/assets && node ../../dist/index.js)",
|
||||
"release": "(git add -A && git commit -m 'update' && git push origin master && npm version patch && npm publish)"
|
||||
"test": "(npm run compile && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest && npm run checkNoDocs)",
|
||||
"compile": "(rm -rf test/ && rm -r dist/ && mkdir dist/ && tsc && cp assets/cli.js dist/ )",
|
||||
"setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
|
||||
"typedoc": "(typedoc --out ./pages/api --target ES6 ./ts/)",
|
||||
"npmpage": "(npmpage)",
|
||||
"check": "(cd test && npm install && node ../dist/index.js)",
|
||||
"checkVersion": "(cd test/ && node ../dist/index.js -v)",
|
||||
"checkNoTest": "(cd test && node ../dist/index.js --notest)",
|
||||
"checkNoDocs": "(cd test && node ../dist/index.js --nodocs)"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/pushrocks/npmts.git"
|
||||
"url": "git+https://gitlab.com/pushrocks/npmts.git"
|
||||
},
|
||||
"keywords": [
|
||||
"TypeScript",
|
||||
@ -21,35 +28,42 @@
|
||||
"author": "Lossless Digital UG (haftungsbeschraenkt)",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/pushrocks/npmts/issues"
|
||||
"url": "https://gitlab.com/pushrocks/npmts/issues"
|
||||
},
|
||||
"homepage": "https://github.com/pushrocks/npmts#readme",
|
||||
"homepage": "https://gitlab.com/pushrocks/npmts#readme",
|
||||
"dependencies": {
|
||||
"beautylog": "3.1.2",
|
||||
"fs-extra": "^0.26.5",
|
||||
"@types/gulp": "^3.8.31",
|
||||
"@types/minimatch": "^2.0.28",
|
||||
"@types/q": "^0.x.x",
|
||||
"@types/shelljs": "^0.3.30",
|
||||
"babel-preset-es2015": "^6.14.0",
|
||||
"beautylog": "5.0.22",
|
||||
"depcheck": "^0.6.4",
|
||||
"early": "^2.0.26",
|
||||
"gulp": "3.9.1",
|
||||
"gulp-concat": "^2.6.0",
|
||||
"gulp-coveralls": "^0.1.4",
|
||||
"gulp-function": "^1.1.1",
|
||||
"gulp-header": "^1.7.1",
|
||||
"gulp-if": "^2.0.0",
|
||||
"gulp-istanbul": "^0.10.3",
|
||||
"gulp-jsdoc3": "^0.2.0",
|
||||
"gulp-mocha": "^2.2.0",
|
||||
"gulp-babel": "^6.1.2",
|
||||
"gulp-function": "^1.3.6",
|
||||
"gulp-inject-modules": "^1.0.0",
|
||||
"gulp-istanbul": "^1.1.1",
|
||||
"gulp-mocha": "^3.0.1",
|
||||
"gulp-sourcemaps": "^1.6.0",
|
||||
"gulp-typescript": "2.11.0",
|
||||
"gulp-typings": "1.1.0",
|
||||
"merge2": "1.0.1",
|
||||
"projectinfo": "1.0.1",
|
||||
"gulp-typedoc": "^2.0.0",
|
||||
"lodash": "^4.15.0",
|
||||
"npmextra": "^1.0.9",
|
||||
"projectinfo": "1.0.3",
|
||||
"q": "^1.4.1",
|
||||
"shelljs": "^0.6.0",
|
||||
"smartcli": "0.0.11",
|
||||
"smartenv": "1.1.0",
|
||||
"smartfile": "0.0.11",
|
||||
"source-map-support": "^0.4.0",
|
||||
"typings": "^0.6.8"
|
||||
"shelljs": "^0.7.4",
|
||||
"smartcli": "1.0.5",
|
||||
"smartcov": "1.0.0",
|
||||
"smartenv": "1.2.5",
|
||||
"smartfile": "4.0.15",
|
||||
"smartpath": "3.2.2",
|
||||
"smartstring": "^2.0.17",
|
||||
"source-map-support": "^0.4.2",
|
||||
"tsn": "^1.0.12",
|
||||
"typedoc": "^0.4.5",
|
||||
"typescript": "next",
|
||||
"typings-global": "^1.0.14"
|
||||
},
|
||||
"devDependencies": {
|
||||
"gulp-header": "^1.7.1"
|
||||
}
|
||||
"devDependencies": {}
|
||||
}
|
||||
|
@ -1,2 +0,0 @@
|
||||
var hello = "hello";
|
||||
//# sourceMappingURL=custom.js.map
|
@ -1 +0,0 @@
|
||||
{"version":3,"file":"custom.js","sourceRoot":"","sources":["custom.ts"],"names":[],"mappings":"AAAA,IAAI,KAAK,GAAG,OAAO,CAAC"}
|
@ -1 +0,0 @@
|
||||
var hello = "hello";
|
@ -1,2 +0,0 @@
|
||||
var something = "something";
|
||||
//# sourceMappingURL=tsfile1.js.map
|
@ -1 +0,0 @@
|
||||
{"version":3,"file":"tsfile1.js","sourceRoot":"","sources":["tsfile1.ts"],"names":[],"mappings":"AAAA,IAAI,SAAS,GAAG,WAAW,CAAC"}
|
@ -1 +0,0 @@
|
||||
var something = "something";
|
@ -1,7 +0,0 @@
|
||||
{
|
||||
"ambientDependencies": {
|
||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
|
||||
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
|
||||
}
|
||||
}
|
9
test/assets/dist/index.js
vendored
9
test/assets/dist/index.js
vendored
@ -1,9 +0,0 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var testplugin = {
|
||||
logSomething: function () {
|
||||
console.log("only function executed");
|
||||
}
|
||||
};
|
||||
module.exports = testplugin;
|
||||
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLDRDQUE0QztBQUM1QyxJQUFJLFVBQVUsR0FBRztJQUNiLFlBQVksRUFBRTtRQUNWLE9BQU8sQ0FBQyxHQUFHLENBQUMsd0JBQXdCLENBQUMsQ0FBQztJQUMxQyxDQUFDO0NBQ0osQ0FBQztBQUNGLE1BQU0sQ0FBQyxPQUFPLEdBQUcsVUFBVSxDQUFDIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9tYWluLmQudHNcIiAvPlxudmFyIHRlc3RwbHVnaW4gPSB7XG4gICAgbG9nU29tZXRoaW5nOiBmdW5jdGlvbigpe1xuICAgICAgICBjb25zb2xlLmxvZyhcIm9ubHkgZnVuY3Rpb24gZXhlY3V0ZWRcIik7XG4gICAgfVxufTtcbm1vZHVsZS5leHBvcnRzID0gdGVzdHBsdWdpbjsiXSwic291cmNlUm9vdCI6Ii9zb3VyY2UvIn0=
|
@ -1,13 +0,0 @@
|
||||
{
|
||||
"mode":"default",
|
||||
"ts":{
|
||||
"./customdir/*.ts":"./"
|
||||
},
|
||||
"typings":[
|
||||
"./ts",
|
||||
"./subts1/",
|
||||
"./subts2/",
|
||||
"./customdir"
|
||||
],
|
||||
"coveralls":true
|
||||
}
|
@ -1,16 +0,0 @@
|
||||
{
|
||||
"name": "testpackage",
|
||||
"version": "2.0.0",
|
||||
"description": "",
|
||||
"main": "index.js",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/sometest/somerepo.git"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "(npmts)"
|
||||
},
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"dependencies": {}
|
||||
}
|
@ -1,7 +0,0 @@
|
||||
{
|
||||
"ambientDependencies": {
|
||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
|
||||
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
|
||||
}
|
||||
}
|
BIN
test/assets/test/.DS_Store
vendored
BIN
test/assets/test/.DS_Store
vendored
Binary file not shown.
2
test/assets/test/test.d.ts
vendored
2
test/assets/test/test.d.ts
vendored
@ -1,2 +0,0 @@
|
||||
/// <reference path="../ts/typings/main.d.ts" />
|
||||
declare var testplugin: any;
|
@ -1,12 +0,0 @@
|
||||
/// <reference path="../ts/typings/main.d.ts" />
|
||||
console.log("**** starting test ****");
|
||||
var testplugin = require("../dist/index.js");
|
||||
describe("testplugins", function () {
|
||||
describe(".logSomething", function () {
|
||||
it("should log something", function () {
|
||||
testplugin.logSomething();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsZ0RBQWdEO0FBQ2hELE9BQU8sQ0FBQyxHQUFHLENBQUMseUJBQXlCLENBQUMsQ0FBQztBQUN2QyxJQUFJLFVBQVUsR0FBRyxPQUFPLENBQUMsa0JBQWtCLENBQUMsQ0FBQztBQUM3QyxRQUFRLENBQUMsYUFBYSxFQUFDO0lBQ25CLFFBQVEsQ0FBQyxlQUFlLEVBQUM7UUFDckIsRUFBRSxDQUFDLHNCQUFzQixFQUFDO1lBQ3RCLFVBQVUsQ0FBQyxZQUFZLEVBQUUsQ0FBQTtRQUM3QixDQUFDLENBQUMsQ0FBQztJQUNQLENBQUMsQ0FBQyxDQUFDO0FBQ1AsQ0FBQyxDQUFDLENBQUMiLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8vLyA8cmVmZXJlbmNlIHBhdGg9XCIuLi90cy90eXBpbmdzL21haW4uZC50c1wiIC8+XG5jb25zb2xlLmxvZyhcIioqKiogc3RhcnRpbmcgdGVzdCAqKioqXCIpO1xudmFyIHRlc3RwbHVnaW4gPSByZXF1aXJlKFwiLi4vZGlzdC9pbmRleC5qc1wiKTtcbmRlc2NyaWJlKFwidGVzdHBsdWdpbnNcIixmdW5jdGlvbigpe1xuICAgIGRlc2NyaWJlKFwiLmxvZ1NvbWV0aGluZ1wiLGZ1bmN0aW9uKCl7XG4gICAgICAgIGl0KFwic2hvdWxkIGxvZyBzb21ldGhpbmdcIixmdW5jdGlvbigpe1xuICAgICAgICAgICAgdGVzdHBsdWdpbi5sb2dTb21ldGhpbmcoKVxuICAgICAgICB9KTtcbiAgICB9KTtcbn0pOyJdLCJzb3VyY2VSb290IjoiL3NvdXJjZS8ifQ==
|
@ -1 +0,0 @@
|
||||
{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;AACvC,IAAI,UAAU,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC7C,QAAQ,CAAC,aAAa,EAAC;IACnB,QAAQ,CAAC,eAAe,EAAC;QACrB,EAAE,CAAC,sBAAsB,EAAC;YACtB,UAAU,CAAC,YAAY,EAAE,CAAA;QAC7B,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
@ -1,10 +0,0 @@
|
||||
/// <reference path="../ts/typings/main.d.ts" />
|
||||
console.log("**** starting test ****");
|
||||
var testplugin = require("../dist/index.js");
|
||||
describe("testplugins",function(){
|
||||
describe(".logSomething",function(){
|
||||
it("should log something",function(){
|
||||
testplugin.logSomething()
|
||||
});
|
||||
});
|
||||
});
|
@ -1,8 +0,0 @@
|
||||
{
|
||||
"ambientDependencies": {
|
||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
|
||||
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
|
||||
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
|
||||
}
|
||||
}
|
@ -1,8 +0,0 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var testplugin = {
|
||||
logSomething: function () {
|
||||
console.log("only function executed");
|
||||
}
|
||||
};
|
||||
module.exports = testplugin;
|
||||
//# sourceMappingURL=index.js.map
|
@ -1 +0,0 @@
|
||||
{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,IAAI,UAAU,GAAG;IACb,YAAY,EAAE;QACV,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;IAC1C,CAAC;CACJ,CAAC;AACF,MAAM,CAAC,OAAO,GAAG,UAAU,CAAC"}
|
@ -1,7 +0,0 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var testplugin = {
|
||||
logSomething: function(){
|
||||
console.log("only function executed");
|
||||
}
|
||||
};
|
||||
module.exports = testplugin;
|
@ -1,8 +0,0 @@
|
||||
{
|
||||
"ambientDependencies": {
|
||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
|
||||
"mocha": "github:Bartvds/tsd-deftools/typings/DefinitelyTyped/mocha/mocha.d.ts",
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
|
||||
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
|
||||
}
|
||||
}
|
34
ts/index.ts
34
ts/index.ts
@ -1,6 +1,28 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
console.log("**** starting NPMTS ****");
|
||||
import plugins = require("./npmts.plugins");
|
||||
import promisechain = require("./npmts.promisechain");
|
||||
plugins.beautylog.figletSync("NPMTS");
|
||||
promisechain.run();
|
||||
import 'typings-global'
|
||||
|
||||
/* ================================================== *
|
||||
Starting NPMTS main process.
|
||||
* ================================================== */
|
||||
import * as early from 'early'
|
||||
early.start('NPMTS')
|
||||
import * as plugins from './npmts.plugins'
|
||||
import * as paths from './npmts.paths'
|
||||
import {promisechain} from './npmts.promisechain'
|
||||
early.stop()
|
||||
.then(() => {
|
||||
let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot)
|
||||
let npmtsCli = new plugins.smartcli.Smartcli()
|
||||
npmtsCli.standardTask()
|
||||
.then((argvArg) => {
|
||||
plugins.beautylog.figletSync('NPMTS')
|
||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version)
|
||||
try {
|
||||
promisechain(argvArg)
|
||||
} catch (err) {
|
||||
console.log(err)
|
||||
}
|
||||
})
|
||||
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version)
|
||||
npmtsCli.startParse()
|
||||
})
|
||||
|
22
ts/npmts.assets.ts
Normal file
22
ts/npmts.assets.ts
Normal file
@ -0,0 +1,22 @@
|
||||
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
|
||||
}
|
120
ts/npmts.check.ts
Normal file
120
ts/npmts.check.ts
Normal file
@ -0,0 +1,120 @@
|
||||
import * as plugins from './npmts.plugins'
|
||||
import * as paths from './npmts.paths'
|
||||
import { npmtsOra } from './npmts.promisechain'
|
||||
|
||||
import {ProjectinfoNpm} from 'projectinfo'
|
||||
|
||||
export let projectInfo: ProjectinfoNpm
|
||||
|
||||
let checkProjectTypings = (configArg) => {
|
||||
let done = plugins.Q.defer()
|
||||
projectInfo = new ProjectinfoNpm(paths.cwd)
|
||||
if (typeof projectInfo.packageJson.typings === 'undefined') {
|
||||
plugins.beautylog.error(`please add typings field to package.json`)
|
||||
process.exit(1)
|
||||
};
|
||||
done.resolve(configArg)
|
||||
return done.promise
|
||||
}
|
||||
|
||||
const depcheckOptions = {
|
||||
ignoreBinPackage: false, // ignore the packages with bin entry
|
||||
parsers: { // the target parsers
|
||||
'*.ts': plugins.depcheck.parser.typescript
|
||||
},
|
||||
detectors: [ // the target detectors
|
||||
plugins.depcheck.detector.requireCallExpression,
|
||||
plugins.depcheck.detector.importDeclaration
|
||||
],
|
||||
specials: [ // the target special parsers
|
||||
plugins.depcheck.special.eslint,
|
||||
plugins.depcheck.special.webpack
|
||||
]
|
||||
}
|
||||
|
||||
let checkDependencies = (configArg) => {
|
||||
let done = plugins.Q.defer()
|
||||
let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [ // folder with these names will be ignored
|
||||
'test',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [ // ignore dependencies that matches these globs
|
||||
'@types/*',
|
||||
'babel-preset-*'
|
||||
]
|
||||
})
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
||||
for (let item of unused.dependencies) {
|
||||
plugins.beautylog.warn(`Watch out: unused dependency ${item.red}`)
|
||||
};
|
||||
for (let item of unused.missing) {
|
||||
plugins.beautylog.error(`unused devDependency ${item.red}`)
|
||||
};
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info('exiting due to missing dependencies in package.json')
|
||||
process.exit(1)
|
||||
}
|
||||
for (let item of unused.invalidFiles) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`)
|
||||
};
|
||||
for (let item of unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
|
||||
};
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
let checkDevDependencies = (configArg) => {
|
||||
let done = plugins.Q.defer()
|
||||
let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||
ignoreDirs: [ // folder with these names will be ignored
|
||||
'ts',
|
||||
'dist',
|
||||
'bower_components'
|
||||
],
|
||||
ignoreMatches: [ // ignore dependencies that matches these globs
|
||||
'@types/*',
|
||||
'babel-preset-*'
|
||||
]
|
||||
})
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
||||
for (let item of unused.devDependencies) {
|
||||
plugins.beautylog.log(`unused devDependency ${item.red}`)
|
||||
};
|
||||
for (let item of unused.missing) {
|
||||
plugins.beautylog.error(`unused devDependency ${item.red}`)
|
||||
};
|
||||
if (unused.missing.length > 0) {
|
||||
plugins.beautylog.info('exiting due to missing dependencies in package.json')
|
||||
process.exit(1)
|
||||
}
|
||||
for (let item of unused.invalidFiles) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`)
|
||||
}
|
||||
for (let item of unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
|
||||
}
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
let checkNodeVersion = (configArg) => {
|
||||
let done = plugins.Q.defer()
|
||||
done.resolve(configArg)
|
||||
return done.promise
|
||||
}
|
||||
|
||||
export let run = (configArg) => {
|
||||
let done = plugins.Q.defer()
|
||||
npmtsOra.text('running project checks...')
|
||||
checkProjectTypings(configArg)
|
||||
.then(checkDependencies)
|
||||
.then(checkDevDependencies)
|
||||
.then(checkNodeVersion)
|
||||
.then(done.resolve)
|
||||
return done.promise
|
||||
}
|
26
ts/npmts.clean.ts
Normal file
26
ts/npmts.clean.ts
Normal file
@ -0,0 +1,26 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import {npmtsOra} from './npmts.promisechain'
|
||||
|
||||
let removeDist = function(){
|
||||
npmtsOra.text('cleaning dist folder')
|
||||
return plugins.smartfile.fs.remove(paths.distDir)
|
||||
}
|
||||
|
||||
let removePages = function(){
|
||||
npmtsOra.text('cleaning pages folder')
|
||||
return plugins.smartfile.fs.remove(paths.pagesDir)
|
||||
}
|
||||
|
||||
export let run = function(configArg){
|
||||
npmtsOra.text('cleaning up from previous builds...')
|
||||
let done = plugins.Q.defer()
|
||||
removeDist()
|
||||
.then(removePages)
|
||||
.then(function(){
|
||||
plugins.beautylog.ok('Cleaned up from previous builds!')
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
}
|
@ -1 +0,0 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
15
ts/npmts.compile.helpers.ts
Normal file
15
ts/npmts.compile.helpers.ts
Normal file
@ -0,0 +1,15 @@
|
||||
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,92 +1,68 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
export var run = function(configArg){
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
plugins.beautylog.log("now running custom tasks");
|
||||
var moduleStream = plugins.merge2({end: false});
|
||||
/* -------------------------------------------------
|
||||
* ----------- first install typings ---------------
|
||||
* ----------------------------------------------- */
|
||||
var typingsDone = plugins.Q.defer();
|
||||
var typingsCounter:number = 0;
|
||||
var typingsCounterAdvance = function(){
|
||||
typingsCounter++;
|
||||
if(typeof config.typings[typingsCounter] != "undefined"){
|
||||
installTypings();
|
||||
} else {
|
||||
plugins.beautylog.success("custom typings installed successfully");
|
||||
typingsDone.resolve();
|
||||
}
|
||||
};
|
||||
var installTypings = function() {
|
||||
plugins.beautylog.log("now installing " + "typings.json".yellow + " from " + config.typings[typingsCounter].blue);
|
||||
plugins.typings.install({production: false, cwd: plugins.path.join(paths.cwd,config.typings[typingsCounter])})
|
||||
.then(function(){
|
||||
typingsCounterAdvance();
|
||||
},function(){
|
||||
plugins.beautylog.error("something went wrong: Check if path is correct: " + config.typings[typingsCounter].blue);
|
||||
typingsCounterAdvance();
|
||||
});
|
||||
};
|
||||
installTypings();
|
||||
/* -------------------------------------------------
|
||||
* ----------- second compile TS -------------------
|
||||
* ----------------------------------------------- */
|
||||
typingsDone.promise.then(function(){
|
||||
for (var key in config.ts) {
|
||||
plugins.beautylog.log("now compiling" + key.blue);
|
||||
var outputPathIsDir:boolean;
|
||||
try {
|
||||
if(plugins.fs.statSync(plugins.path.join(paths.cwd,config.ts[key])).isDirectory()){
|
||||
outputPathIsDir = true;
|
||||
}
|
||||
}
|
||||
catch(err) {
|
||||
outputPathIsDir = false;
|
||||
}
|
||||
//do some evaluation of the environment
|
||||
var outputNameSpecified:boolean = (
|
||||
!outputPathIsDir
|
||||
&& (plugins.path.extname(config.ts[key]) == ".js")
|
||||
);
|
||||
var outputName = (function(){
|
||||
if(outputNameSpecified){
|
||||
return plugins.path.basename(config.ts[key])
|
||||
} else {
|
||||
return undefined
|
||||
}
|
||||
})();
|
||||
var outputDir = (function(){
|
||||
if(outputNameSpecified){
|
||||
return plugins.path.dirname(
|
||||
plugins.path.join(paths.cwd,config.ts[key])
|
||||
)
|
||||
} else {
|
||||
return plugins.path.join(paths.cwd,config.ts[key])
|
||||
}
|
||||
})();
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import helpers = require('./npmts.compile.helpers')
|
||||
import {npmtsOra} from './npmts.promisechain'
|
||||
|
||||
var stream = plugins.gulp.src([plugins.path.join(paths.cwd,key),"!**/typings/**"])
|
||||
.pipe(plugins.g.sourcemaps.init()) // This means sourcemaps will be generated
|
||||
.pipe(plugins.g.typescript({
|
||||
out: outputName,
|
||||
target: "ES5",
|
||||
module: "commonjs"
|
||||
}))
|
||||
.pipe(plugins.g.sourcemaps.write()) // Now the sourcemaps are added to the .js file
|
||||
//.pipe(plugins.g.header('#!/usr/bin/env node\n\n'))
|
||||
.pipe(plugins.gulp.dest(outputDir));
|
||||
moduleStream.add(stream);
|
||||
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],
|
||||
exclude: 'node_modules/**/*'
|
||||
}
|
||||
moduleStream.on("queueDrain",function(){
|
||||
plugins.beautylog.success("custom TypeScript installed successfully");
|
||||
moduleStream.on("finish",function(){
|
||||
done.resolve(config);
|
||||
});
|
||||
moduleStream.end();
|
||||
});
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
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
|
||||
}
|
||||
|
@ -1,26 +0,0 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
export var run = function(){
|
||||
var done = plugins.Q.defer();
|
||||
var config:any = {};
|
||||
var configPath = plugins.path.join(paths.cwd,"npmts.json");
|
||||
if(plugins.smartfile.checks.fileExistsSync(configPath)){
|
||||
plugins.beautylog.info("npmts.json".blue + " config file found!");
|
||||
config = plugins.smartfile.readFileToObject(configPath);
|
||||
switch (config.mode){
|
||||
case "default":
|
||||
case "custom":
|
||||
plugins.beautylog.log("mode is " + config.mode.yellow);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
|
||||
};
|
||||
} else {
|
||||
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
|
||||
config.mode = "default";
|
||||
done.resolve(config);
|
||||
};
|
||||
return done.promise;
|
||||
};
|
@ -1,69 +0,0 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
|
||||
var genJsdoc = function(){
|
||||
var done = plugins.Q.defer();
|
||||
plugins.beautylog.log("now generating " + "JsDoc documentation".blue);
|
||||
plugins.gulp.src([
|
||||
plugins.path.join(paths.cwd,"README.md"),
|
||||
plugins.path.join(paths.distDir,"**/*.js")
|
||||
])
|
||||
.pipe(plugins.g.jsdoc3({
|
||||
opts: {
|
||||
destination: paths.docsDir
|
||||
}
|
||||
}, done.resolve));
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
var publishDocs = function(){
|
||||
var done = plugins.Q.defer();
|
||||
try {
|
||||
var gitUrl = plugins.projectinfo.npm(
|
||||
paths.cwd,
|
||||
{
|
||||
gitAccessToken:process.env.GITHUB_TOKEN
|
||||
}
|
||||
).git.httpsUrl;
|
||||
|
||||
var deployScript = ""
|
||||
+ "cd " + paths.docsDir + " "
|
||||
+ "&& git init "
|
||||
+ "&& git config user.name \"TRAVIS CI\" "
|
||||
+ "&& git config user.email \"travis@shipzone.io\" "
|
||||
+ "&& git add . "
|
||||
+ "&& git commit -m \"Deploy to GitHub Pages\" "
|
||||
+ "&& git push --force --quiet "
|
||||
+ "\"" + gitUrl + "\" "
|
||||
+ "master:gh-pages "
|
||||
+ "> /dev/null 2>&1";
|
||||
}
|
||||
catch (err){
|
||||
console.log(err);
|
||||
}
|
||||
|
||||
if(plugins.smartenv.getEnv().isTravis){
|
||||
plugins.beautylog.log("now publishing docs to GitHub")
|
||||
if (!plugins.shelljs.which('git')) {
|
||||
plugins.beautylog.error('Git is not installed');
|
||||
plugins.shelljs.exit(1);
|
||||
} else if (plugins.shelljs.exec(deployScript).code !== 0) {
|
||||
plugins.beautylog.error('Error: Git failed');
|
||||
plugins.shelljs.exit(1);
|
||||
}
|
||||
done.resolve();
|
||||
} else {
|
||||
done.resolve();
|
||||
}
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
|
||||
export var run = function(){
|
||||
var done = plugins.Q.defer();
|
||||
genJsdoc()
|
||||
.then(publishDocs)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
@ -1,23 +1,77 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
import plugins = require("./npmts.plugins");
|
||||
export var run = function(configArg){
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
if (typeof config.coveralls === "undefined"){
|
||||
config.coveralls = false;
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import { npmtsOra } from './npmts.promisechain'
|
||||
|
||||
export type npmtsMode = 'default' | 'custom'
|
||||
|
||||
export interface INpmtsConfig {
|
||||
argv: any,
|
||||
coverageTreshold: number,
|
||||
docs: boolean,
|
||||
mode: npmtsMode,
|
||||
test: boolean,
|
||||
testTs: any,
|
||||
ts: any,
|
||||
tsOptions: any
|
||||
|
||||
};
|
||||
|
||||
export var run = function (argvArg) {
|
||||
let done = plugins.Q.defer()
|
||||
let defaultConfig: INpmtsConfig = {
|
||||
argv: undefined,
|
||||
coverageTreshold: 70,
|
||||
docs: true,
|
||||
mode: 'default',
|
||||
test: true,
|
||||
testTs: {},
|
||||
ts: {},
|
||||
tsOptions: {}
|
||||
}
|
||||
if (config.mode == "default"){
|
||||
config.typings = [
|
||||
"./ts/"
|
||||
];
|
||||
|
||||
// mix with configfile
|
||||
npmtsOra.text('looking for npmextra.json')
|
||||
let config: INpmtsConfig = 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/",
|
||||
["./test/test.ts"]: "./test/"
|
||||
};
|
||||
config.test = ["./index.js"];
|
||||
done.resolve(config);
|
||||
} else {
|
||||
done.resolve(config);
|
||||
}
|
||||
return done.promise;
|
||||
};
|
||||
['./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,16 +1,25 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
import plugins = require("./npmts.plugins");
|
||||
var paths:any = {};
|
||||
paths.cwd = plugins.smartcli.get.cwd().path;
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
|
||||
//Directories
|
||||
paths.tsDir = plugins.path.join(paths.cwd,"ts/");
|
||||
paths.distDir = plugins.path.join(paths.cwd,"dist/");
|
||||
paths.docsDir = plugins.path.join(paths.cwd,"docs/");
|
||||
paths.testDir = plugins.path.join(paths.cwd,"test/");
|
||||
// NPMTS Paths
|
||||
export let npmtsPackageRoot = plugins.path.join(__dirname,'../')
|
||||
|
||||
//Files
|
||||
paths.indexTS = plugins.path.join(paths.cwd,"ts/index.ts");
|
||||
paths.testTS = plugins.path.join(paths.cwd,"ts/test.ts");
|
||||
// Project paths
|
||||
export let cwd = process.cwd()
|
||||
|
||||
export = paths;
|
||||
// Directories
|
||||
export let tsDir = plugins.path.join(cwd,'ts/')
|
||||
export let distDir = plugins.path.join(cwd,'dist/')
|
||||
export let testDir = plugins.path.join(cwd,'test/')
|
||||
export let typingsDir = plugins.path.join(cwd,'ts/typings/')
|
||||
export let coverageDir = plugins.path.join(cwd,'coverage/')
|
||||
|
||||
// Pages
|
||||
export let pagesDir = plugins.path.join(cwd,'pages/')
|
||||
export let pagesApiDir = plugins.path.join(pagesDir,'/api')
|
||||
|
||||
export let npmtsAssetsDir = plugins.path.join(__dirname,'../assets/')
|
||||
|
||||
// Files
|
||||
export let indexTS = plugins.path.join(cwd,'ts/index.ts')
|
||||
export let testTS = plugins.path.join(cwd,'ts/test.ts')
|
||||
|
@ -1,27 +1,27 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
var plugins = {
|
||||
beautylog: require("beautylog"),
|
||||
fs: require("fs-extra"),
|
||||
gulp: require("gulp"),
|
||||
g: {
|
||||
coveralls: require("gulp-coveralls"),
|
||||
gFunction: require("gulp-function"),
|
||||
istanbul: require("gulp-istanbul"),
|
||||
jsdoc3: require("gulp-jsdoc3"),
|
||||
mocha: require("gulp-mocha"),
|
||||
sourcemaps: require("gulp-sourcemaps"),
|
||||
typescript: require("gulp-typescript")
|
||||
|
||||
},
|
||||
merge2: require("merge2"),
|
||||
projectinfo: require("projectinfo"),
|
||||
sourceMapSupport:require("source-map-support").install(),
|
||||
path: require("path"),
|
||||
Q:require("q"),
|
||||
shelljs: require("shelljs"),
|
||||
smartcli: require("smartcli"),
|
||||
smartenv: require("smartenv"),
|
||||
smartfile: require("smartfile"),
|
||||
typings: require("typings")
|
||||
};
|
||||
export = plugins;
|
||||
import 'typings-global'
|
||||
export import beautylog = require('beautylog')
|
||||
export let depcheck = require('depcheck')
|
||||
export import gulp = require('gulp')
|
||||
export let g = {
|
||||
babel: require('gulp-babel'),
|
||||
istanbul: require('gulp-istanbul'),
|
||||
gFunction: require('gulp-function'),
|
||||
injectModules: require('gulp-inject-modules'),
|
||||
mocha: require('gulp-mocha'),
|
||||
sourcemaps: require('gulp-sourcemaps'),
|
||||
typedoc: require('gulp-typedoc')
|
||||
}
|
||||
export import lodashObject = require('lodash')
|
||||
export import npmextra = require('npmextra')
|
||||
export import projectinfo = require('projectinfo')
|
||||
export import path = require('path')
|
||||
export import Q = require('q')
|
||||
export import shelljs = require('shelljs')
|
||||
export import smartcli = require('smartcli')
|
||||
export import smartcov = require('smartcov')
|
||||
export import smartenv = require('smartenv')
|
||||
export import smartfile = require('smartfile')
|
||||
export import smartpath = require('smartpath')
|
||||
export import smartstring = require('smartstring')
|
||||
export let sourceMapSupport = require('source-map-support').install() // display errors correctly during testing
|
||||
export import tsn = require('tsn')
|
||||
|
@ -1,15 +1,49 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
import NpmtsConfigFile = require("./npmts.configfile");
|
||||
import NpmtsOptions = require("./npmts.options");
|
||||
import NpmtsCompile = require("./npmts.compile");
|
||||
import NpmtsJsdoc = require("./npmts.jsdoc");
|
||||
import NpmtsTests = require("./npmts.tests");
|
||||
export var run = function(){
|
||||
var promisechain;
|
||||
NpmtsConfigFile.run()
|
||||
.then(NpmtsOptions.run)
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import {Ora} from 'beautylog'
|
||||
|
||||
export let npmtsOra = new Ora('setting up TaskChain','cyan')
|
||||
|
||||
import NpmtsAssets = require('./npmts.assets')
|
||||
import NpmtsCheck = require('./npmts.check')
|
||||
import NpmtsClean = require('./npmts.clean')
|
||||
import NpmtsCompile = require('./npmts.compile')
|
||||
import NpmtsTypeDoc = require('./npmts.typedoc')
|
||||
import NpmtsOptions = require('./npmts.options')
|
||||
import NpmtsTests = require('./npmts.tests')
|
||||
|
||||
export let promisechain = function(argvArg){
|
||||
let done = plugins.Q.defer()
|
||||
npmtsOra.start()
|
||||
NpmtsOptions.run(argvArg)
|
||||
.then(NpmtsClean.run)
|
||||
.then(NpmtsCheck.run)
|
||||
.then(NpmtsCompile.run)
|
||||
.then(NpmtsJsdoc.run)
|
||||
.then(NpmtsTests.run);
|
||||
return promisechain;
|
||||
};
|
||||
.then(NpmtsAssets.run)
|
||||
.then(NpmtsTypeDoc.run)
|
||||
.then(NpmtsTests.run)
|
||||
.then(function(configArg){
|
||||
let shipString = '' +
|
||||
'\n' +
|
||||
'\n' +
|
||||
' # # ( )\n' +
|
||||
' ___#_#___|__\n' +
|
||||
' _ |____________| _\n' +
|
||||
' _=====| | | | | |==== _\n' +
|
||||
' =====| |.---------------------------. | |====\n' +
|
||||
" <--------------------' . . . . . . . . '--------------/\n" +
|
||||
' \\ /\n' +
|
||||
' \\___________________________________________________________/\n' +
|
||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n'
|
||||
if (process.env.CI) {
|
||||
console.log(shipString)
|
||||
plugins.beautylog.success('READY TO SHIP!')
|
||||
} else {
|
||||
plugins.beautylog.success('Done!')
|
||||
}
|
||||
done.resolve()
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
@ -1,45 +1,94 @@
|
||||
/// <reference path="./typings/main.d.ts" />
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
export var run = function(configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
var istanbul = function () {
|
||||
var stream = plugins.gulp.src([plugins.path.join(paths.cwd,"dist/*.js")])
|
||||
// Covering files
|
||||
.pipe(plugins.g.istanbul())
|
||||
// Force `require` to return covered files
|
||||
.pipe(plugins.g.istanbul.hookRequire());
|
||||
return stream;
|
||||
};
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import { npmtsOra } from './npmts.promisechain'
|
||||
|
||||
var mocha = function () {
|
||||
var stream = plugins.gulp.src(["./test/test.js"])
|
||||
.pipe(plugins.g.mocha())
|
||||
// Creating the reports after tests ran
|
||||
.pipe(plugins.g.istanbul.writeReports())
|
||||
// Enforce a coverage of at least 90%
|
||||
.pipe(plugins.g.istanbul.enforceThresholds({ thresholds: { global: 30 } }));
|
||||
return stream;
|
||||
};
|
||||
|
||||
var coveralls = function(){
|
||||
plugins.beautylog.log("now uploading coverage data to coveralls");
|
||||
var stream = plugins.gulp.src([plugins.path.join(paths.cwd,"./coverage/lcov.info")])
|
||||
.pipe(plugins.g.coveralls());
|
||||
return stream;
|
||||
};
|
||||
|
||||
istanbul().on("finish",function(){
|
||||
mocha().on("finish",function(){
|
||||
if(plugins.smartenv.getEnv().isTravis && config.coveralls){
|
||||
coveralls().on("finish",function(){
|
||||
done.resolve(config);
|
||||
})
|
||||
} else {
|
||||
done.resolve(config);
|
||||
}
|
||||
/**
|
||||
*
|
||||
* @returns {*}
|
||||
*/
|
||||
let mocha = function (configArg) {
|
||||
npmtsOra.text('Instrumentalizing and testing transpiled JS')
|
||||
npmtsOra.end() // end npmtsOra for tests.
|
||||
let done = plugins.Q.defer()
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'dist/*.js')])
|
||||
.pipe(plugins.g.sourcemaps.init())
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve('babel-preset-es2015')
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.istanbul({
|
||||
}))
|
||||
.pipe(plugins.g.sourcemaps.write())
|
||||
.pipe(plugins.g.injectModules())
|
||||
.on('finish', function () {
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')])
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve('babel-preset-es2015')
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.injectModules())
|
||||
.pipe(plugins.g.mocha())
|
||||
.pipe(plugins.g.istanbul.writeReports({
|
||||
dir: plugins.path.join(paths.cwd, './coverage'),
|
||||
reporters: ['lcovonly', 'json', 'text', 'text-summary']
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(
|
||||
function () {
|
||||
plugins.beautylog.ok('Tested!')
|
||||
done.resolve(configArg)
|
||||
},
|
||||
'atEnd'
|
||||
))
|
||||
})
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
return done.promise
|
||||
}
|
||||
|
||||
let coverage = function (configArg) {
|
||||
let done = plugins.Q.defer()
|
||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, 'lcov.info'), 2)
|
||||
.then(function (percentageArg) {
|
||||
if (percentageArg >= configArg.coverageTreshold) {
|
||||
plugins.beautylog.ok(
|
||||
`${percentageArg.toString()}% `
|
||||
+ `coverage exceeds your treshold of `
|
||||
+ `${configArg.coverageTreshold.toString()}%`
|
||||
)
|
||||
} else {
|
||||
plugins.beautylog.warn(
|
||||
`${percentageArg.toString()}% `
|
||||
+ `coverage fails your treshold of `
|
||||
+ `${configArg.coverageTreshold.toString()}%`
|
||||
)
|
||||
plugins.beautylog.error('exiting due to coverage failure')
|
||||
process.exit(1)
|
||||
}
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
export let run = function (configArg) {
|
||||
let done = plugins.Q.defer()
|
||||
let config = configArg
|
||||
if (config.test === true) {
|
||||
npmtsOra.text('now starting tests')
|
||||
plugins.beautylog.log(
|
||||
'-------------------------------------------------------\n' +
|
||||
'*************************** TESTS: ***************************\n' +
|
||||
'--------------------------------------------------------------'
|
||||
)
|
||||
|
||||
mocha(config)
|
||||
.then(coverage)
|
||||
.then(() => {
|
||||
done.resolve(config)
|
||||
})
|
||||
} else {
|
||||
npmtsOra.end()
|
||||
done.resolve(config)
|
||||
}
|
||||
return done.promise
|
||||
}
|
||||
|
45
ts/npmts.typedoc.ts
Normal file
45
ts/npmts.typedoc.ts
Normal file
@ -0,0 +1,45 @@
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import { npmtsOra } from './npmts.promisechain'
|
||||
|
||||
import { projectInfo } from './npmts.check'
|
||||
|
||||
let genTypeDoc = function (configArg) {
|
||||
let done = plugins.Q.defer()
|
||||
npmtsOra.text('now generating ' + 'TypeDoc documentation'.yellow)
|
||||
plugins.beautylog.log('TypeDoc Output:')
|
||||
plugins.gulp.src(plugins.path.join(paths.tsDir, '**/*.ts'))
|
||||
.pipe(plugins.g.typedoc({
|
||||
// TypeScript options (see typescript docs)
|
||||
module: 'commonjs',
|
||||
target: 'es6',
|
||||
includeDeclarations: true,
|
||||
|
||||
// Output options (see typedoc docs)
|
||||
out: paths.pagesApiDir,
|
||||
json: plugins.path.join(paths.pagesApiDir, 'file.json'),
|
||||
|
||||
// TypeDoc options (see typedoc docs)
|
||||
name: projectInfo.name,
|
||||
readme: plugins.path.join(paths.cwd, 'README.md'),
|
||||
// theme: "default",
|
||||
ignoreCompilerErrors: true,
|
||||
version: true
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(done.resolve, 'atEnd'))
|
||||
return done.promise
|
||||
}
|
||||
|
||||
export let run = function (configArg) {
|
||||
let done = plugins.Q.defer()
|
||||
if (configArg.docs) {
|
||||
genTypeDoc(configArg)
|
||||
.then(() => {
|
||||
done.resolve(configArg)
|
||||
})
|
||||
} else {
|
||||
done.resolve(configArg)
|
||||
};
|
||||
return done.promise
|
||||
}
|
@ -1,7 +0,0 @@
|
||||
{
|
||||
"ambientDependencies": {
|
||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
|
||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
|
||||
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
|
||||
}
|
||||
}
|
8
tsconfig.json
Normal file
8
tsconfig.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"declaration": true,
|
||||
"module": "commonjs",
|
||||
"target": "ES5",
|
||||
"outDir": "./dist/"
|
||||
}
|
||||
}
|
3
tslint.json
Normal file
3
tslint.json
Normal file
@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": "tslint-config-standard"
|
||||
}
|
Reference in New Issue
Block a user