Compare commits
123 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 |
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,4 +1,4 @@
|
||||
node_modules/
|
||||
test/
|
||||
docs/
|
||||
pages/
|
||||
.DS_Store
|
@ -1,10 +1,10 @@
|
||||
image: hosttoday/ht-docker-node:npmts
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
|
||||
stages:
|
||||
- test
|
||||
- release
|
||||
- trigger
|
||||
- page
|
||||
- pages
|
||||
|
||||
testLEGACY:
|
||||
stage: test
|
||||
@ -45,17 +45,15 @@ trigger:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
|
||||
|
||||
pages:
|
||||
stage: page
|
||||
image: hosttoday/ht-docker-node:npmpage
|
||||
stage: pages
|
||||
script:
|
||||
- npmci test lts
|
||||
- mkdir .public
|
||||
- cp -r test/assets/docs/ .public
|
||||
- cp -r test/assets/coverage/ .public
|
||||
- mv .public public
|
||||
- npmci command npmpage --host gitlab
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
only:
|
||||
- tags
|
15
.travis.yml
15
.travis.yml
@ -1,15 +0,0 @@
|
||||
language: node_js
|
||||
node_js:
|
||||
- 4.3.1
|
||||
- stable
|
||||
deploy:
|
||||
provider: npm
|
||||
email: npm@lossless.digital
|
||||
api_key:
|
||||
secure: k075QdAcmEdmAoVaP5vclLnZmhbZB39v85VIUMWAKXbIAU+liHrYZRlIEYfAaIUrf6sha+zAo/U/vjAN7c5ArB7J/HjCLJ3lsi2fWtaSRlYQrYX9/EhU0S+YZjRE8Jrn4hGTcce6I2mANBnEzvzlXrlKaqVvSqOqTO9nJ5aDBCGa5XT3EwlHKkRlAlL3ZOLrRg38R343E8ifZBsbn9G0e+RgDt0sic3WD8NME9lpsQ/99UZKH00duHbhF9nme5Sjdh86y01hvsaBf+CLR4gfS2IntnrCSrZbETFrsOBUyMnJZDQ3qlrjcEaiTkpJ4iSIqr+ftwGMMD6S1MxCTPqkp64UIeMz2Tg41HqoaeIg7z8cF0APv6M9ZAdWhsU43GqsMe70dK900JZpQAkQxMf/6NpPpGfZug6TwqLYSIRzvjvNrhYfuyoGfXdAxrM3SJMkIq6rwE+T/y36kZaC3CrQRyNZypNz0vW1M9HLjJUi2vO0U/CDn8tvi1p6ChrDXDfV3H2UIAMHFlAF+GrT7dMWwD+p+d8mc9gpAFEF9zMqAIJamPhwboJxoHjKQrqrq5czNm75ETL77AzfnU6CfQlG5dTIFnGId8y0ZxXvtpBruDoyC1+ZF23MYZmb+ipxQZM2oLCjNLeL3aEePc/JlSm6Gn8w3sIkZTG261F0XZxdApw=
|
||||
on:
|
||||
tags: true
|
||||
repo: pushrocks/npmts
|
||||
env:
|
||||
global:
|
||||
secure: kPKBMnEKoC+K5dXpl11NhuK3LSp0c0fRO60Akj3QeQBjUWnVAcF0Ht30c31y0lnJaMEzXhmUIKdR7RQnlmw5be4TYGINzY7FD3Dcv7o+HO1ZQrkpMWSu46jF6ZJer9moGjZ8e0rX8wZyB9SqsXYlwWRzqvxfOVxQfTvU3BEnJKHbhq+R5JMJ8dwLBPNTJKMWKq85KNsjo3ap0BjxdBUoRLzvrn31VOPH30BkvmLGc5YiIz5QmITll/T2wmQKYTNT2qDlEJ729B8pYa3eNlCNi89AxsLDGCmEoJAVrPsyw5g+gAyBqZ1GRULy83UJbELUq7cse3MRLMSwCAm4f0INRAuqcyiKYJ4+LHd0NwKrFQ/dQ0pvyBTbbEjNemXaakkWH7S6F03UvF+u+tiQ7C97XH0CRsseGlm36zCkAClEhtWVWA4U0Q5c6zqRAAOYOI0xquXalRKPTJe7fCYewp2eqmlp8drt8MxancyKI/ynXNoR5vGFzDTSRoPjTlaYQPmbiH4+Nd5+6Qoj94PEIqghebIPDQo3C7vWts4WGccux5b2q524UgB63hjJQA6+GQOo1q4RibouS6WScn8/tW/ZOEP+sNhDfkeiZUIjye+Q3PyzonGHefgSQ8wBbsc8LOX0cKUcEFWr14nhdQ9ZeW+hrSSF04TbM4zGJPGcKhmT2UU=
|
155
README.md
155
README.md
@ -1,141 +1,36 @@
|
||||
# npmts
|
||||
Write npm modules with TypeScript without hassle.
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
|
||||
## Status
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://gitlab.com/pushrocks/npmts)
|
||||
[](https://github.com/pushrocks/npmts)
|
||||
[](https://pushrocks.gitlab.io/npmts/docs)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://ci.appveyor.com/project/philkunz/npmts/branch/master)
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://david-dm.org/pushrocks/npmts)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||
[](https://codecov.io/github/pushrocks/npmts?branch=master)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](http://standardjs.com/)
|
||||
|
||||
## What is NPMTS?
|
||||
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
|
||||
By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works.
|
||||
## Introduction
|
||||
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
||||
|
||||
There is a docker image available that includes npmts to make CI a breeze:
|
||||
[hosttoday/ht-docker-npmg on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-npmg/)
|
||||
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
|
||||
|
||||
### Install
|
||||
First install npmts globally, then install the npmts checker:
|
||||
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/)
|
||||
|
||||
```sh
|
||||
npm install npmts -g # installs npmts globally
|
||||
npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency
|
||||
```
|
||||
For further information read the docs.
|
||||
|
||||
Then add it to your package.json's script section to trigger a build:
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"test": "npmts"
|
||||
}
|
||||
```
|
||||
|
||||
### Default task execution order
|
||||
|
||||
1. Check config in ./npmts.json
|
||||
1. Clean up from any previous builds (old js files)
|
||||
1. Install typings
|
||||
1. Transpile TypeScript with **inline sourcemaps** and **declaration files**
|
||||
1. Create JsDoc Documentation
|
||||
1. Instrumentalize created JavaScript files with istanbul
|
||||
1. Run Tests
|
||||
1. Create Coverage report
|
||||
|
||||
#### npmts.json
|
||||
the npmts.json is the main config file. You can use it to customize the behaviour of NPMTS.
|
||||
|
||||
```json
|
||||
{
|
||||
"mode":"default",
|
||||
"codecov":{
|
||||
"publish":true,
|
||||
"token":"sometoken"
|
||||
},
|
||||
"ts":{
|
||||
"./customdir/*.ts":"./"
|
||||
},
|
||||
"docs": {
|
||||
"publish":true,
|
||||
"destination":"github"
|
||||
},
|
||||
"tsOptions":{
|
||||
"declaration":false,
|
||||
"target":"ES6"
|
||||
},
|
||||
"typings":[
|
||||
"./ts/typings.json",
|
||||
"./subts1/typings.json",
|
||||
"./subts2/typings.json",
|
||||
"./customdir/typings.json"
|
||||
],
|
||||
"typingsInclude":"auto",
|
||||
"cli":true
|
||||
}
|
||||
```
|
||||
|
||||
| key | default value | description |
|
||||
| --- | --- | --- |
|
||||
| `"codecov"` | `true` | if true, coverage data will be uploaded to codecov when running on travis |
|
||||
| `"docs"` | `{"publish":"false"}` | `{"publish":true, destination:"github"}` lets you control what happens with your module documentation |
|
||||
| `"mode"` | `"default"` | "default" will do some defualt stuff, "custom" only does what you specify |
|
||||
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
|
||||
| `"typings"` | `["./ts/typings.json"]` | allows you to specify multiple locations for typings.json to install. This is needed for modules that do not yet bundle typings |
|
||||
| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
|
||||
|
||||
#### Typings
|
||||
**npmts** looks for `./ts/typings.json` by default and installs any defined typings to `.ts/typings/`.
|
||||
|
||||
> Note: You can reference the typings files in any of your TypeScript code with a
|
||||
`/// <reference path="/some/path/main.d.ts">`
|
||||
We are currently working on a "typingsInclude" option, that will autoload any typings during compilation.
|
||||
tsconfig is NOT supported, since it would render this module useless
|
||||
|
||||
#### TypeScript
|
||||
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
||||
`./dist/*.js` and `./test/test.js`
|
||||
|
||||
Use commonjs module system for wiring up files.
|
||||
|
||||
#### Declaration files
|
||||
**npmts** also creates an `./dist/index.d.ts` declaration file by default.
|
||||
You can reference it in your package.json like this.
|
||||
|
||||
```json
|
||||
"main": "dist/index.js",
|
||||
"typings": ".dist/index.d.ts",
|
||||
```
|
||||
|
||||
This is in line with the latest TypeScript best practices.
|
||||
You can then import plugins via the TypeScript `import` Syntax
|
||||
and tsc will pick up the declaration file automatically.
|
||||
|
||||
> Note: If you don't want declaration files, set tsOptions.declaration to false in npmts.json
|
||||
|
||||
#### Instrumentalize Code
|
||||
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
||||
|
||||
#### Tests
|
||||
When Typings have been installed, TypeScript + Declaration files have been transpiled and the resulting JS has been instrumentalized,
|
||||
npmts looks for `.test/test.ts` which will be transpiled to test.js and run with mocha.
|
||||
|
||||
Any errors will be shown with reference to their originating source in TypeScript
|
||||
thanks to autogenerated source maps.
|
||||
|
||||
## Example Usage in modules:
|
||||
* [gulp-typings](https://www.npmjs.com/package/gulp-typings)
|
||||
* [gulp-browser](https://www.npmjs.com/package/gulp-typings)
|
||||
|
||||
> We will add more options over time.
|
||||
|
||||
## 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/npmtspage) to create a webpage from coverage reports and JsDocs for the module
|
||||
* Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds
|
||||
|
||||
## About the authors:
|
||||
[](https://lossless.com/)
|
||||
|
||||
[](https://paypal.me/lossless)
|
||||
[](https://push.rocks)
|
||||
|
10
appveyor.yml
10
appveyor.yml
@ -1,10 +0,0 @@
|
||||
environment:
|
||||
nodejs_version: "4"
|
||||
install:
|
||||
- ps: Install-Product node $env:nodejs_version
|
||||
- npm install
|
||||
test_script:
|
||||
- node --version
|
||||
- npm --version
|
||||
- npm test
|
||||
build: off
|
2
dist/index.d.ts
vendored
2
dist/index.d.ts
vendored
@ -1 +1 @@
|
||||
import "typings-global";
|
||||
import 'typings-global';
|
||||
|
16
dist/index.js
vendored
16
dist/index.js
vendored
@ -1,21 +1,21 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
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");
|
||||
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);
|
||||
plugins.beautylog.figletSync('NPMTS');
|
||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
|
||||
try {
|
||||
npmts_promisechain_1.promisechain(argvArg);
|
||||
}
|
||||
|
4
dist/npmts.assets.d.ts
vendored
4
dist/npmts.assets.d.ts
vendored
@ -1,4 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare var run: (configArg: any) => plugins.Q.Promise<{}>;
|
||||
|
17
dist/npmts.assets.js
vendored
17
dist/npmts.assets.js
vendored
@ -1,18 +1,19 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
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.copy(plugins.path.join(paths.npmtsAssetsDir, "cli.js"), paths.distDir);
|
||||
plugins.beautylog.ok("installed CLI assets!");
|
||||
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
4
dist/npmts.clean.d.ts
vendored
@ -1,4 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
||||
|
28
dist/npmts.clean.js
vendored
28
dist/npmts.clean.js
vendored
@ -1,29 +1,23 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
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".yellow + " folder");
|
||||
npmts_promisechain_1.npmtsOra.text('cleaning dist folder');
|
||||
return plugins.smartfile.fs.remove(paths.distDir);
|
||||
};
|
||||
var removeTypings = function () {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text("cleaning " + "typings".yellow + " folder");
|
||||
if (false) {
|
||||
}
|
||||
else {
|
||||
done.resolve();
|
||||
}
|
||||
return done.promise;
|
||||
var removePages = function () {
|
||||
npmts_promisechain_1.npmtsOra.text('cleaning pages folder');
|
||||
return plugins.smartfile.fs.remove(paths.pagesDir);
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
npmts_promisechain_1.npmtsOra.text("cleaning up from previous builds...");
|
||||
npmts_promisechain_1.npmtsOra.text('cleaning up from previous builds...');
|
||||
var done = plugins.Q.defer();
|
||||
removeDist()
|
||||
.then(removeTypings)
|
||||
.then(removePages)
|
||||
.then(function () {
|
||||
plugins.beautylog.ok("Cleaned up from previous builds!");
|
||||
plugins.beautylog.ok('Cleaned up from previous builds!');
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
|
1
dist/npmts.cli.d.ts
vendored
1
dist/npmts.cli.d.ts
vendored
@ -1 +0,0 @@
|
||||
import "typings-global";
|
2
dist/npmts.cli.js
vendored
2
dist/npmts.cli.js
vendored
@ -1,2 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
4
dist/npmts.compile.d.ts
vendored
4
dist/npmts.compile.d.ts
vendored
@ -1,4 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
||||
|
6
dist/npmts.compile.helpers.js
vendored
6
dist/npmts.compile.helpers.js
vendored
@ -1,12 +1,12 @@
|
||||
"use strict";
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
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!");
|
||||
plugins.beautylog.warn('Skipping ' + keyArg + ' because ' + tsArrayArg[keyArg] + ' it is no directory!');
|
||||
return false;
|
||||
}
|
||||
else {
|
||||
|
35
dist/npmts.compile.js
vendored
35
dist/npmts.compile.js
vendored
@ -1,22 +1,29 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var helpers = require("./npmts.compile.helpers");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
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 tsOptionsDefault = {
|
||||
var compilerOptionsDefault = {
|
||||
declaration: true,
|
||||
target: "ES5",
|
||||
module: "commonjs"
|
||||
module: 'CommonJS',
|
||||
target: 'ES6'
|
||||
};
|
||||
/**
|
||||
* merges default ts options with those found in npmts.json
|
||||
*/
|
||||
var tsOptions = function (keyArg) {
|
||||
return plugins.lodashObject.assign(tsOptionsDefault, tsOptionsArg);
|
||||
var compilerOptions = function (keyArg) {
|
||||
var tsOptionsCombined = plugins.lodashObject.merge(compilerOptionsDefault, tsOptionsArg);
|
||||
var compilerOptions = {
|
||||
declaration: tsOptionsCombined.declaration,
|
||||
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
||||
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target],
|
||||
exclude: 'node_modules/**/*'
|
||||
};
|
||||
return compilerOptions;
|
||||
};
|
||||
var _loop_1 = function(keyArg) {
|
||||
plugins.beautylog.info("TypeScript assignment: transpile from " + keyArg.blue + " to " + tsFileArrayArg[keyArg].blue);
|
||||
@ -25,7 +32,7 @@ var compileTs = function (tsFileArrayArg, tsOptionsArg) {
|
||||
.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);
|
||||
var filesCompiledPromise = plugins.tsn.compile(filesToConvertAbsolute, destDir, compilerOptions(keyArg));
|
||||
promiseArray.push(filesCompiledPromise);
|
||||
});
|
||||
promiseArray.push(filesReadPromise);
|
||||
@ -42,15 +49,15 @@ var compileTs = function (tsFileArrayArg, tsOptionsArg) {
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
npmts_promisechain_1.npmtsOra.text("now compiling " + "TypeScript".yellow);
|
||||
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!");
|
||||
plugins.beautylog.ok('compiled main TypeScript!');
|
||||
plugins.beautylog.log('now compiling tests!');
|
||||
return compileTs(config.testTs);
|
||||
})
|
||||
.then(function () {
|
||||
plugins.beautylog.ok("compiled all TypeScript!");
|
||||
plugins.beautylog.ok('compiled all TypeScript!');
|
||||
done.resolve(config);
|
||||
});
|
||||
return done.promise;
|
||||
|
4
dist/npmts.configfile.d.ts
vendored
4
dist/npmts.configfile.d.ts
vendored
@ -1,4 +0,0 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
export declare var run: (argvArg: any) => plugins.Q.Promise<{}>;
|
34
dist/npmts.configfile.js
vendored
34
dist/npmts.configfile.js
vendored
@ -1,34 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
exports.run = function (argvArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = {};
|
||||
var configPath = plugins.path.join(paths.cwd, "npmts.json");
|
||||
if (argvArg.notest) {
|
||||
config.notest = true;
|
||||
}
|
||||
if (plugins.smartfile.fs.fileExistsSync(configPath)) {
|
||||
plugins.beautylog.info("npmts.json".blue + " config file found!");
|
||||
config = plugins.lodashObject.assign(config, plugins.smartfile.fs.toObjectSync(configPath));
|
||||
switch (config.mode) {
|
||||
case "default":
|
||||
case "custom":
|
||||
plugins.beautylog.ok("mode is " + config.mode.yellow);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
|
||||
process.exit(1);
|
||||
}
|
||||
;
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
|
||||
config.mode = "default";
|
||||
done.resolve(config);
|
||||
}
|
||||
;
|
||||
return done.promise;
|
||||
};
|
28
dist/npmts.jsdoc.js
vendored
28
dist/npmts.jsdoc.js
vendored
@ -1,28 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
var genJsdoc = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text("now generating " + "JsDoc documentation".yellow);
|
||||
plugins.gulp.src([
|
||||
plugins.path.join(paths.cwd, "README.md"),
|
||||
plugins.path.join(paths.distDir, "**/*.js")
|
||||
])
|
||||
.pipe(plugins.g.jsdoc3({
|
||||
opts: {
|
||||
destination: paths.docsDir
|
||||
}
|
||||
}, function () {
|
||||
plugins.beautylog.ok("JsDoc documentation has been generated!");
|
||||
done.resolve(configArg);
|
||||
}));
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
genJsdoc(configArg)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
18
dist/npmts.options.d.ts
vendored
18
dist/npmts.options.d.ts
vendored
@ -1,5 +1,15 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
export declare let isCi: () => any;
|
||||
export declare var run: (configArg: any) => plugins.Q.Promise<{}>;
|
||||
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,35 +1,64 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
exports.isCi = function () {
|
||||
return plugins.smartci.check.isCi();
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
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;
|
||||
npmts_promisechain_1.npmtsOra.text("now determining build options...");
|
||||
//handle default mode
|
||||
if (config.mode == "default") {
|
||||
config.typings = [
|
||||
"./ts/typings.json"
|
||||
];
|
||||
var defaultConfig = {
|
||||
argv: undefined,
|
||||
coverageTreshold: 70,
|
||||
docs: true,
|
||||
mode: 'default',
|
||||
test: true,
|
||||
testTs: {},
|
||||
ts: {},
|
||||
tsOptions: {}
|
||||
};
|
||||
// mix with configfile
|
||||
npmts_promisechain_1.npmtsOra.text('looking for npmextra.json');
|
||||
var config = plugins.npmextra.dataFor({
|
||||
toolName: 'npmts',
|
||||
defaultSettings: defaultConfig,
|
||||
cwd: paths.cwd
|
||||
});
|
||||
// add argv
|
||||
config.argv = argvArg;
|
||||
// check mode
|
||||
switch (config.mode) {
|
||||
case 'default':
|
||||
case 'custom':
|
||||
plugins.beautylog.ok('mode is ' + config.mode);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error("mode not recognised!");
|
||||
process.exit(1);
|
||||
}
|
||||
;
|
||||
// handle default mode
|
||||
if (config.mode === 'default') {
|
||||
config.ts = (_a = {},
|
||||
_a["./ts/**/*.ts"] = "./dist/",
|
||||
_a['./ts/**/*.ts'] = './dist/',
|
||||
_a
|
||||
);
|
||||
config.testTs = (_b = {},
|
||||
_b["./test/test.ts"] = "./test/",
|
||||
_b['./test/test.ts'] = './test/',
|
||||
_b
|
||||
);
|
||||
config.test = ["./index.js"];
|
||||
}
|
||||
//check if config.tsOptions is available
|
||||
config.tsOptions ? void (0) : config.tsOptions = {};
|
||||
config.coverageTreshold ? void (0) : config.coverageTreshold = 70;
|
||||
// handle docs
|
||||
config.docs ? void (0) : config.docs = {};
|
||||
plugins.beautylog.ok("build options are ready!");
|
||||
;
|
||||
// mix with commandline
|
||||
if (config.argv.notest) {
|
||||
config.test = false;
|
||||
}
|
||||
;
|
||||
if (config.argv.nodocs) {
|
||||
config.docs = false;
|
||||
}
|
||||
;
|
||||
plugins.beautylog.ok('build options are ready!');
|
||||
done.resolve(config);
|
||||
return done.promise;
|
||||
var _a, _b;
|
||||
|
5
dist/npmts.paths.d.ts
vendored
5
dist/npmts.paths.d.ts
vendored
@ -1,12 +1,13 @@
|
||||
import "typings-global";
|
||||
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 docsDir: 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;
|
||||
|
34
dist/npmts.paths.js
vendored
34
dist/npmts.paths.js
vendored
@ -1,18 +1,20 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
//Npmts Paths
|
||||
exports.npmtsPackageRoot = plugins.path.join(__dirname, "../");
|
||||
//Project paths
|
||||
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.docsDir = plugins.path.join(exports.cwd, "docs/");
|
||||
exports.testDir = plugins.path.join(exports.cwd, "test/");
|
||||
exports.typingsDir = plugins.path.join(exports.cwd, "ts/typings/");
|
||||
exports.coverageDir = plugins.path.join(exports.cwd, "coverage/");
|
||||
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");
|
||||
// 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');
|
||||
|
42
dist/npmts.plugins.d.ts
vendored
42
dist/npmts.plugins.d.ts
vendored
@ -1,25 +1,27 @@
|
||||
import "typings-global";
|
||||
export import beautylog = require("beautylog");
|
||||
export declare let gulp: any;
|
||||
import 'typings-global';
|
||||
export import beautylog = require('beautylog');
|
||||
export declare let depcheck: any;
|
||||
export import gulp = require('gulp');
|
||||
export declare let g: {
|
||||
gFunction: any;
|
||||
babel: any;
|
||||
istanbul: any;
|
||||
jsdoc3: any;
|
||||
gFunction: any;
|
||||
injectModules: any;
|
||||
mocha: any;
|
||||
replace: any;
|
||||
sourcemaps: any;
|
||||
typedoc: any;
|
||||
};
|
||||
export declare let lodashObject: any;
|
||||
export declare let merge2: any;
|
||||
export import projectinfo = require("projectinfo");
|
||||
export import path = require("path");
|
||||
export import Q = require("q");
|
||||
export import shelljs = require("shelljs");
|
||||
export declare let smartci: any;
|
||||
export import smartcli = require("smartcli");
|
||||
export declare let smartcov: any;
|
||||
export import smartenv = require("smartenv");
|
||||
export import smartfile = require("smartfile");
|
||||
export import smartpath = require("smartpath");
|
||||
export import smartstring = require("smartstring");
|
||||
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");
|
||||
export import tsn = require('tsn');
|
||||
|
48
dist/npmts.plugins.js
vendored
48
dist/npmts.plugins.js
vendored
@ -1,26 +1,28 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
exports.beautylog = require("beautylog");
|
||||
exports.gulp = require("gulp");
|
||||
require('typings-global');
|
||||
exports.beautylog = require('beautylog');
|
||||
exports.depcheck = require('depcheck');
|
||||
exports.gulp = require('gulp');
|
||||
exports.g = {
|
||||
gFunction: require("gulp-function"),
|
||||
istanbul: require("gulp-istanbul"),
|
||||
jsdoc3: require("gulp-jsdoc3"),
|
||||
mocha: require("gulp-mocha"),
|
||||
replace: require("gulp-replace")
|
||||
babel: require('gulp-babel'),
|
||||
istanbul: require('gulp-istanbul'),
|
||||
gFunction: require('gulp-function'),
|
||||
injectModules: require('gulp-inject-modules'),
|
||||
mocha: require('gulp-mocha'),
|
||||
sourcemaps: require('gulp-sourcemaps'),
|
||||
typedoc: require('gulp-typedoc')
|
||||
};
|
||||
exports.lodashObject = require('lodash/fp/object');
|
||||
exports.merge2 = require("merge2");
|
||||
exports.projectinfo = require("projectinfo");
|
||||
exports.path = require("path");
|
||||
exports.Q = require("q");
|
||||
exports.shelljs = require("shelljs");
|
||||
exports.smartci = require("smartci");
|
||||
exports.smartcli = require("smartcli");
|
||||
exports.smartcov = require("smartcov");
|
||||
exports.smartenv = require("smartenv");
|
||||
exports.smartfile = require("smartfile");
|
||||
exports.smartpath = require("smartpath");
|
||||
exports.smartstring = require("smartstring");
|
||||
exports.sourceMapSupport = require("source-map-support").install(); // this is required to display errors correctly during testing
|
||||
exports.tsn = require("tsn");
|
||||
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
6
dist/npmts.promisechain.d.ts
vendored
@ -1,6 +1,6 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import { Ora } from "beautylog";
|
||||
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<{}>;
|
||||
|
57
dist/npmts.promisechain.js
vendored
57
dist/npmts.promisechain.js
vendored
@ -1,45 +1,46 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
exports.npmtsOra = new plugins.beautylog.Ora("setting up TaskChain", "cyan");
|
||||
var NpmtsAssets = require("./npmts.assets");
|
||||
var NpmtsClean = require("./npmts.clean");
|
||||
var NpmtsCompile = require("./npmts.compile");
|
||||
var NpmtsConfigFile = require("./npmts.configfile");
|
||||
var NpmtsJsdoc = require("./npmts.jsdoc");
|
||||
var NpmtsOptions = require("./npmts.options");
|
||||
var NpmtsTests = require("./npmts.tests");
|
||||
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();
|
||||
NpmtsConfigFile.run(argvArg)
|
||||
.then(NpmtsOptions.run)
|
||||
NpmtsOptions.run(argvArg)
|
||||
.then(NpmtsClean.run)
|
||||
.then(NpmtsCheck.run)
|
||||
.then(NpmtsCompile.run)
|
||||
.then(NpmtsAssets.run)
|
||||
.then(NpmtsJsdoc.run)
|
||||
.then(NpmtsTypeDoc.run)
|
||||
.then(NpmtsTests.run)
|
||||
.then(function (configArg) {
|
||||
var shipString = "" +
|
||||
"\n" +
|
||||
"\n" +
|
||||
" # # ( )\n" +
|
||||
" ___#_#___|__\n" +
|
||||
" _ |____________| _\n" +
|
||||
" _=====| | | | | |==== _\n" +
|
||||
" =====| |.---------------------------. | |====\n" +
|
||||
var shipString = '' +
|
||||
'\n' +
|
||||
'\n' +
|
||||
' # # ( )\n' +
|
||||
' ___#_#___|__\n' +
|
||||
' _ |____________| _\n' +
|
||||
' _=====| | | | | |==== _\n' +
|
||||
' =====| |.---------------------------. | |====\n' +
|
||||
" <--------------------' . . . . . . . . '--------------/\n" +
|
||||
" \\ /\n" +
|
||||
" \\___________________________________________________________/\n" +
|
||||
" wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n" +
|
||||
" wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n" +
|
||||
" wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n";
|
||||
' \\ /\n' +
|
||||
' \\___________________________________________________________/\n' +
|
||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n';
|
||||
if (process.env.CI) {
|
||||
console.log(shipString);
|
||||
plugins.beautylog.success("READY TO SHIP!");
|
||||
plugins.beautylog.success('READY TO SHIP!');
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.success("Done!");
|
||||
plugins.beautylog.success('Done!');
|
||||
}
|
||||
done.resolve();
|
||||
});
|
||||
|
4
dist/npmts.tests.d.ts
vendored
4
dist/npmts.tests.d.ts
vendored
@ -1,4 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import 'typings-global';
|
||||
import plugins = require('./npmts.plugins');
|
||||
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
||||
|
89
dist/npmts.tests.js
vendored
89
dist/npmts.tests.js
vendored
@ -1,52 +1,60 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var plugins = require("./npmts.plugins");
|
||||
var paths = require("./npmts.paths");
|
||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||
/**
|
||||
*
|
||||
* @returns {*}
|
||||
*/
|
||||
var istanbul = function (configArg) {
|
||||
npmts_promisechain_1.npmtsOra.text("Instrumentalizing transpiled JS...");
|
||||
var done = plugins.Q.defer();
|
||||
var stream = plugins.gulp.src([plugins.path.join(paths.cwd, "dist/*.js")])
|
||||
.pipe(plugins.g.istanbul()) // Covering files
|
||||
.pipe(plugins.g.istanbul.hookRequire()) // Force `require` to return covered files
|
||||
.pipe(plugins.g.gFunction(function () {
|
||||
plugins.beautylog.ok("JS has been instrumentalized to get test code coverage!");
|
||||
done.resolve(configArg);
|
||||
}, "atEnd"));
|
||||
return done.promise;
|
||||
};
|
||||
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) {
|
||||
var done = plugins.Q.defer();
|
||||
npmts_promisechain_1.npmtsOra.text('Instrumentalizing and testing transpiled JS');
|
||||
npmts_promisechain_1.npmtsOra.end(); // end npmtsOra for tests.
|
||||
var stream = plugins.gulp.src(["./test/test.js"])
|
||||
.pipe(plugins.g.mocha())
|
||||
.pipe(plugins.g.istanbul.writeReports()) // Creating the reports after tests ran
|
||||
.pipe(plugins.g.gFunction(function () {
|
||||
plugins.beautylog.ok("Tests have passed!");
|
||||
done.resolve(configArg);
|
||||
}, "atEnd"));
|
||||
var done = plugins.Q.defer();
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'dist/*.js')])
|
||||
.pipe(plugins.g.sourcemaps.init())
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve('babel-preset-es2015')
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.istanbul({}))
|
||||
.pipe(plugins.g.sourcemaps.write())
|
||||
.pipe(plugins.g.injectModules())
|
||||
.on('finish', function () {
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')])
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve('babel-preset-es2015')
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.injectModules())
|
||||
.pipe(plugins.g.mocha())
|
||||
.pipe(plugins.g.istanbul.writeReports({
|
||||
dir: plugins.path.join(paths.cwd, './coverage'),
|
||||
reporters: ['lcovonly', 'json', 'text', 'text-summary']
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(function () {
|
||||
plugins.beautylog.ok('Tested!');
|
||||
done.resolve(configArg);
|
||||
}, 'atEnd'));
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
var coverage = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, "lcov.info"))
|
||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, 'lcov.info'), 2)
|
||||
.then(function (percentageArg) {
|
||||
if (percentageArg >= configArg.coverageTreshold) {
|
||||
plugins.beautylog.ok("your coverage of " + percentageArg.toString().blue + "% ".blue + "exceeds your treshold of " +
|
||||
configArg.coverageTreshold.toString().blue + "%".blue);
|
||||
plugins.beautylog.ok((percentageArg.toString() + "% ")
|
||||
+ "coverage exceeds your treshold of "
|
||||
+ (configArg.coverageTreshold.toString() + "%"));
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.warn("your coverage of " + percentageArg + "% " + "fails your treshold of " +
|
||||
configArg.coverageTreshold + "%");
|
||||
plugins.beautylog.error("exiting due to coverage failure");
|
||||
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);
|
||||
@ -56,13 +64,12 @@ var coverage = function (configArg) {
|
||||
exports.run = function (configArg) {
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
if (config.notest != true) {
|
||||
npmts_promisechain_1.npmtsOra.text("now starting tests");
|
||||
plugins.beautylog.log("-------------------------------------------------------\n" +
|
||||
"*************************** TESTS: ***************************\n" +
|
||||
"--------------------------------------------------------------");
|
||||
istanbul(config)
|
||||
.then(mocha)
|
||||
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);
|
||||
|
@ -1,4 +1,4 @@
|
||||
/// <reference types="q" />
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
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)
|
1192
npm-debug.log
1192
npm-debug.log
File diff suppressed because it is too large
Load Diff
61
package.json
61
package.json
@ -1,19 +1,21 @@
|
||||
{
|
||||
"name": "npmts",
|
||||
"version": "5.3.6",
|
||||
"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": "(npm run compile && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest)",
|
||||
"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/)",
|
||||
"check": "(cd test && node ../dist/index.js)",
|
||||
"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)",
|
||||
"install": "(mkdir test/)"
|
||||
"checkNoDocs": "(cd test && node ../dist/index.js --nodocs)"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@ -30,35 +32,38 @@
|
||||
},
|
||||
"homepage": "https://gitlab.com/pushrocks/npmts#readme",
|
||||
"dependencies": {
|
||||
"@types/minimatch": "^2.0.22-alpha",
|
||||
"@types/q": "0.0.21-alpha",
|
||||
"@types/shelljs": "^0.3.21-alpha",
|
||||
"beautylog": "5.0.12",
|
||||
"early": "^2.0.13",
|
||||
"@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-babel": "^6.1.2",
|
||||
"gulp-function": "^1.3.6",
|
||||
"gulp-if": "^2.0.1",
|
||||
"gulp-istanbul": "^1.0.0",
|
||||
"gulp-jsdoc3": "^0.3.0",
|
||||
"gulp-mocha": "^2.2.0",
|
||||
"gulp-replace": "^0.5.4",
|
||||
"lodash": "^4.13.1",
|
||||
"merge2": "1.0.2",
|
||||
"gulp-inject-modules": "^1.0.0",
|
||||
"gulp-istanbul": "^1.1.1",
|
||||
"gulp-mocha": "^3.0.1",
|
||||
"gulp-sourcemaps": "^1.6.0",
|
||||
"gulp-typedoc": "^2.0.0",
|
||||
"lodash": "^4.15.0",
|
||||
"npmextra": "^1.0.9",
|
||||
"projectinfo": "1.0.3",
|
||||
"q": "^1.4.1",
|
||||
"shelljs": "^0.7.0",
|
||||
"smartci": "0.0.1",
|
||||
"smartcli": "1.0.4",
|
||||
"smartcov": "0.0.6",
|
||||
"shelljs": "^0.7.4",
|
||||
"smartcli": "1.0.5",
|
||||
"smartcov": "1.0.0",
|
||||
"smartenv": "1.2.5",
|
||||
"smartfile": "4.0.10",
|
||||
"smartfile": "4.0.15",
|
||||
"smartpath": "3.2.2",
|
||||
"smartstring": "^2.0.10",
|
||||
"source-map-support": "^0.4.1",
|
||||
"tsn": "^1.0.3",
|
||||
"typescript": "^2.0.0-dev.20160630",
|
||||
"typings-global": "*"
|
||||
"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": {}
|
||||
}
|
||||
|
36
ts/index.ts
36
ts/index.ts
@ -1,30 +1,28 @@
|
||||
import "typings-global";
|
||||
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";
|
||||
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();
|
||||
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);
|
||||
plugins.beautylog.figletSync('NPMTS')
|
||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version)
|
||||
try {
|
||||
promisechain(argvArg);
|
||||
promisechain(argvArg)
|
||||
} catch (err) {
|
||||
console.log(err)
|
||||
}
|
||||
catch(err){
|
||||
console.log(err);
|
||||
}
|
||||
});
|
||||
})
|
||||
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version);
|
||||
npmtsCli.startParse();
|
||||
});
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version)
|
||||
npmtsCli.startParse()
|
||||
})
|
||||
|
@ -1,18 +1,22 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
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.copy(plugins.path.join(paths.npmtsAssetsDir,"cli.js"),paths.distDir);
|
||||
plugins.beautylog.ok("installed CLI assets!");
|
||||
done.resolve(config);
|
||||
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 {
|
||||
done.resolve(config);
|
||||
plugins.beautylog.ok('No additional assets required!')
|
||||
done.resolve(config)
|
||||
}
|
||||
return done.promise;
|
||||
};
|
||||
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
|
||||
}
|
@ -1,33 +1,26 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
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".yellow + " folder");
|
||||
return plugins.smartfile.fs.remove(paths.distDir);
|
||||
};
|
||||
npmtsOra.text('cleaning dist folder')
|
||||
return plugins.smartfile.fs.remove(paths.distDir)
|
||||
}
|
||||
|
||||
let removeTypings = function(){
|
||||
let done = plugins.Q.defer();
|
||||
npmtsOra.text("cleaning " + "typings".yellow + " folder");
|
||||
if(false){
|
||||
//plugins.smartfile.fsaction.remove(paths.typingsDir)
|
||||
// .then(done.resolve);
|
||||
} else {
|
||||
done.resolve();
|
||||
}
|
||||
return done.promise;
|
||||
};
|
||||
let removePages = function(){
|
||||
npmtsOra.text('cleaning pages folder')
|
||||
return plugins.smartfile.fs.remove(paths.pagesDir)
|
||||
}
|
||||
|
||||
export let run = function(configArg){
|
||||
npmtsOra.text("cleaning up from previous builds...");
|
||||
let done = plugins.Q.defer();
|
||||
npmtsOra.text('cleaning up from previous builds...')
|
||||
let done = plugins.Q.defer()
|
||||
removeDist()
|
||||
.then(removeTypings)
|
||||
.then(removePages)
|
||||
.then(function(){
|
||||
plugins.beautylog.ok("Cleaned up from previous builds!");
|
||||
done.resolve(configArg);
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
plugins.beautylog.ok('Cleaned up from previous builds!')
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
@ -1 +0,0 @@
|
||||
import "typings-global";
|
@ -1,15 +1,15 @@
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
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]));
|
||||
};
|
||||
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!")
|
||||
if (!outputPathIsDir(tsArrayArg,keyArg)) {
|
||||
plugins.beautylog.warn('Skipping ' + keyArg + ' because ' + tsArrayArg[keyArg] + ' it is no directory!')
|
||||
return false
|
||||
} else {
|
||||
return true;
|
||||
return true
|
||||
};
|
||||
}
|
||||
}
|
||||
|
@ -1,61 +1,68 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
import helpers = require("./npmts.compile.helpers");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import helpers = require('./npmts.compile.helpers')
|
||||
import {npmtsOra} from './npmts.promisechain'
|
||||
|
||||
let promiseArray = [];
|
||||
let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => {
|
||||
let done = plugins.Q.defer();
|
||||
let promiseArray = []
|
||||
let compileTs = (tsFileArrayArg: string[],tsOptionsArg = {}) => {
|
||||
let done = plugins.Q.defer()
|
||||
|
||||
let tsOptionsDefault = {
|
||||
let compilerOptionsDefault = {
|
||||
declaration: true,
|
||||
target: "ES5",
|
||||
module: "commonjs"
|
||||
};
|
||||
|
||||
module: 'CommonJS',
|
||||
target: 'ES6'
|
||||
}
|
||||
|
||||
/**
|
||||
* merges default ts options with those found in npmts.json
|
||||
*/
|
||||
let tsOptions = function (keyArg:string) {
|
||||
return plugins.lodashObject.assign(tsOptionsDefault, tsOptionsArg)
|
||||
};
|
||||
let compilerOptions = function (keyArg: string) {
|
||||
let tsOptionsCombined = plugins.lodashObject.merge(compilerOptionsDefault, tsOptionsArg)
|
||||
let compilerOptions: plugins.tsn.CompilerOptions = {
|
||||
declaration: tsOptionsCombined.declaration,
|
||||
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
||||
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target],
|
||||
exclude: 'node_modules/**/*'
|
||||
}
|
||||
return compilerOptions
|
||||
}
|
||||
for (let keyArg in tsFileArrayArg) {
|
||||
plugins.beautylog.info(`TypeScript assignment: transpile from ${keyArg.blue} to ${tsFileArrayArg[keyArg].blue}`);
|
||||
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 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
|
||||
);
|
||||
promiseArray.push(filesCompiledPromise);
|
||||
});
|
||||
promiseArray.push(filesReadPromise);
|
||||
destDir,
|
||||
compilerOptions(keyArg)
|
||||
)
|
||||
promiseArray.push(filesCompiledPromise)
|
||||
})
|
||||
promiseArray.push(filesReadPromise)
|
||||
}
|
||||
};
|
||||
plugins.Q.all(promiseArray)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
.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);
|
||||
|
||||
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);
|
||||
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;
|
||||
};
|
||||
plugins.beautylog.ok('compiled all TypeScript!')
|
||||
done.resolve(config)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
@ -1,33 +0,0 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
export var run = function(argvArg){
|
||||
var done = plugins.Q.defer();
|
||||
var config:any = {};
|
||||
var configPath = plugins.path.join(paths.cwd,"npmts.json");
|
||||
if(argvArg.notest){
|
||||
config.notest = true;
|
||||
}
|
||||
if(plugins.smartfile.fs.fileExistsSync(configPath)){
|
||||
plugins.beautylog.info("npmts.json".blue + " config file found!");
|
||||
config = plugins.lodashObject.assign(
|
||||
config,
|
||||
plugins.smartfile.fs.toObjectSync(configPath)
|
||||
);
|
||||
switch (config.mode){
|
||||
case "default":
|
||||
case "custom":
|
||||
plugins.beautylog.ok("mode is " + config.mode.yellow);
|
||||
done.resolve(config);
|
||||
break;
|
||||
default:
|
||||
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
|
||||
process.exit(1);
|
||||
};
|
||||
} else {
|
||||
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
|
||||
config.mode = "default";
|
||||
done.resolve(config);
|
||||
};
|
||||
return done.promise;
|
||||
};
|
@ -1,30 +0,0 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
|
||||
let genJsdoc = function(configArg){
|
||||
let done = plugins.Q.defer();
|
||||
npmtsOra.text("now generating " + "JsDoc documentation".yellow);
|
||||
plugins.gulp.src([
|
||||
plugins.path.join(paths.cwd,"README.md"),
|
||||
plugins.path.join(paths.distDir,"**/*.js")
|
||||
])
|
||||
.pipe(plugins.g.jsdoc3({
|
||||
opts: {
|
||||
destination: paths.docsDir
|
||||
}
|
||||
}, function(){
|
||||
plugins.beautylog.ok("JsDoc documentation has been generated!");
|
||||
done.resolve(configArg)
|
||||
}));
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
|
||||
export let run = function(configArg){
|
||||
let done = plugins.Q.defer();
|
||||
genJsdoc(configArg)
|
||||
.then(done.resolve);
|
||||
return done.promise;
|
||||
};
|
@ -1,42 +1,77 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
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 let isCi = function(){
|
||||
return plugins.smartci.check.isCi();
|
||||
};
|
||||
|
||||
export var run = function(configArg){
|
||||
var done = plugins.Q.defer();
|
||||
var config = configArg;
|
||||
|
||||
npmtsOra.text("now determining build options...");
|
||||
|
||||
//handle default mode
|
||||
if (config.mode == "default"){
|
||||
config.typings = [
|
||||
"./ts/typings.json"
|
||||
];
|
||||
config.ts = {
|
||||
["./ts/**/*.ts"]: "./dist/"
|
||||
};
|
||||
config.testTs = {
|
||||
["./test/test.ts"]: "./test/"
|
||||
};
|
||||
config.test = ["./index.js"];
|
||||
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: {}
|
||||
}
|
||||
|
||||
//check if config.tsOptions is available
|
||||
config.tsOptions ? void(0) : config.tsOptions = {};
|
||||
|
||||
|
||||
// mix with configfile
|
||||
npmtsOra.text('looking for npmextra.json')
|
||||
let config: INpmtsConfig = plugins.npmextra.dataFor({
|
||||
toolName: 'npmts',
|
||||
defaultSettings: defaultConfig,
|
||||
cwd: paths.cwd
|
||||
})
|
||||
|
||||
config.coverageTreshold ? void(0) : config.coverageTreshold = 70;
|
||||
// add argv
|
||||
config.argv = argvArg
|
||||
|
||||
// handle docs
|
||||
config.docs ? void(0) : config.docs = {};
|
||||
// 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)
|
||||
};
|
||||
|
||||
plugins.beautylog.ok("build options are ready!");
|
||||
done.resolve(config);
|
||||
return done.promise;
|
||||
};
|
||||
// handle default mode
|
||||
if (config.mode === 'default') {
|
||||
config.ts = {
|
||||
['./ts/**/*.ts']: './dist/'
|
||||
}
|
||||
config.testTs = {
|
||||
['./test/test.ts']: './test/'
|
||||
}
|
||||
};
|
||||
|
||||
// mix with commandline
|
||||
if (config.argv.notest) {
|
||||
config.test = false
|
||||
};
|
||||
if (config.argv.nodocs) {
|
||||
config.docs = false
|
||||
};
|
||||
|
||||
plugins.beautylog.ok('build options are ready!')
|
||||
done.resolve(config)
|
||||
return done.promise
|
||||
}
|
||||
|
@ -1,23 +1,25 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
|
||||
//Npmts Paths
|
||||
export let npmtsPackageRoot = plugins.path.join(__dirname,"../");
|
||||
// NPMTS Paths
|
||||
export let npmtsPackageRoot = plugins.path.join(__dirname,'../')
|
||||
|
||||
// Project paths
|
||||
export let cwd = process.cwd()
|
||||
|
||||
//Project paths
|
||||
export let cwd = process.cwd();
|
||||
// Directories
|
||||
export let tsDir = plugins.path.join(cwd,'ts/')
|
||||
export let distDir = plugins.path.join(cwd,'dist/')
|
||||
export let testDir = plugins.path.join(cwd,'test/')
|
||||
export let typingsDir = plugins.path.join(cwd,'ts/typings/')
|
||||
export let coverageDir = plugins.path.join(cwd,'coverage/')
|
||||
|
||||
//Directories
|
||||
export let tsDir = plugins.path.join(cwd,"ts/");
|
||||
export let distDir = plugins.path.join(cwd,"dist/");
|
||||
export let docsDir = plugins.path.join(cwd,"docs/");
|
||||
export let testDir = plugins.path.join(cwd,"test/");
|
||||
export let typingsDir = plugins.path.join(cwd,"ts/typings/");
|
||||
export let coverageDir = plugins.path.join(cwd,"coverage/");
|
||||
// Pages
|
||||
export let pagesDir = plugins.path.join(cwd,'pages/')
|
||||
export let pagesApiDir = plugins.path.join(pagesDir,'/api')
|
||||
|
||||
export let npmtsAssetsDir = plugins.path.join(__dirname,"../assets/");
|
||||
export let npmtsAssetsDir = plugins.path.join(__dirname,'../assets/')
|
||||
|
||||
//Files
|
||||
export let indexTS = plugins.path.join(cwd,"ts/index.ts");
|
||||
export let testTS = plugins.path.join(cwd,"ts/test.ts");
|
||||
// Files
|
||||
export let indexTS = plugins.path.join(cwd,'ts/index.ts')
|
||||
export let testTS = plugins.path.join(cwd,'ts/test.ts')
|
||||
|
@ -1,25 +1,27 @@
|
||||
import "typings-global";
|
||||
export import beautylog = require("beautylog");
|
||||
export let gulp = require("gulp");
|
||||
import 'typings-global'
|
||||
export import beautylog = require('beautylog')
|
||||
export let depcheck = require('depcheck')
|
||||
export import gulp = require('gulp')
|
||||
export let g = {
|
||||
gFunction: require("gulp-function"),
|
||||
istanbul: require("gulp-istanbul"),
|
||||
jsdoc3: require("gulp-jsdoc3"),
|
||||
mocha: require("gulp-mocha"),
|
||||
replace: require("gulp-replace")
|
||||
};
|
||||
export let lodashObject = require('lodash/fp/object');
|
||||
export let merge2 = require("merge2");
|
||||
export import projectinfo = require("projectinfo");
|
||||
export import path = require("path");
|
||||
export import Q = require("q");
|
||||
export import shelljs = require("shelljs");
|
||||
export let smartci = require("smartci");
|
||||
export import smartcli = require("smartcli");
|
||||
export let smartcov = require("smartcov");
|
||||
export import smartenv = require("smartenv");
|
||||
export import smartfile = require("smartfile");
|
||||
export import smartpath = require("smartpath");
|
||||
export import smartstring = require("smartstring");
|
||||
export let sourceMapSupport = require("source-map-support").install(); // this is required to display errors correctly during testing
|
||||
export import tsn = require("tsn");
|
||||
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,49 +1,49 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import {Ora} from "beautylog"
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import {Ora} from 'beautylog'
|
||||
|
||||
export let npmtsOra = new plugins.beautylog.Ora("setting up TaskChain","cyan");
|
||||
export let npmtsOra = new Ora('setting up TaskChain','cyan')
|
||||
|
||||
import NpmtsAssets = require("./npmts.assets");
|
||||
import NpmtsClean = require("./npmts.clean");
|
||||
import NpmtsCompile = require("./npmts.compile");
|
||||
import NpmtsConfigFile = require("./npmts.configfile");
|
||||
import NpmtsJsdoc = require("./npmts.jsdoc");
|
||||
import NpmtsOptions = require("./npmts.options");
|
||||
import NpmtsTests = require("./npmts.tests");
|
||||
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();
|
||||
NpmtsConfigFile.run(argvArg)
|
||||
.then(NpmtsOptions.run)
|
||||
let done = plugins.Q.defer()
|
||||
npmtsOra.start()
|
||||
NpmtsOptions.run(argvArg)
|
||||
.then(NpmtsClean.run)
|
||||
.then(NpmtsCheck.run)
|
||||
.then(NpmtsCompile.run)
|
||||
.then(NpmtsAssets.run)
|
||||
.then(NpmtsJsdoc.run)
|
||||
.then(NpmtsTypeDoc.run)
|
||||
.then(NpmtsTests.run)
|
||||
.then(function(configArg){
|
||||
let shipString = "" +
|
||||
"\n" +
|
||||
"\n" +
|
||||
" # # ( )\n" +
|
||||
" ___#_#___|__\n" +
|
||||
" _ |____________| _\n" +
|
||||
" _=====| | | | | |==== _\n" +
|
||||
" =====| |.---------------------------. | |====\n" +
|
||||
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!");
|
||||
' \\ /\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!");
|
||||
plugins.beautylog.success('Done!')
|
||||
}
|
||||
done.resolve();
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
done.resolve()
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
@ -1,84 +1,94 @@
|
||||
import "typings-global";
|
||||
import plugins = require("./npmts.plugins");
|
||||
import paths = require("./npmts.paths");
|
||||
import {npmtsOra} from "./npmts.promisechain";
|
||||
|
||||
/**
|
||||
*
|
||||
* @returns {*}
|
||||
*/
|
||||
let istanbul = function (configArg) {
|
||||
npmtsOra.text("Instrumentalizing transpiled JS...");
|
||||
let done = plugins.Q.defer();
|
||||
var stream = plugins.gulp.src([plugins.path.join(paths.cwd,"dist/*.js")])
|
||||
.pipe(plugins.g.istanbul()) // Covering files
|
||||
.pipe(plugins.g.istanbul.hookRequire()) // Force `require` to return covered files
|
||||
.pipe(plugins.g.gFunction(function(){
|
||||
plugins.beautylog.ok("JS has been instrumentalized to get test code coverage!");
|
||||
done.resolve(configArg);
|
||||
},"atEnd"));
|
||||
return done.promise;
|
||||
};
|
||||
import 'typings-global'
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
import { npmtsOra } from './npmts.promisechain'
|
||||
|
||||
/**
|
||||
*
|
||||
* @returns {*}
|
||||
*/
|
||||
let mocha = function (configArg) {
|
||||
let done = plugins.Q.defer();
|
||||
npmtsOra.end(); // end npmtsOra for tests.
|
||||
let stream = plugins.gulp.src(["./test/test.js"])
|
||||
.pipe(plugins.g.mocha())
|
||||
.pipe(plugins.g.istanbul.writeReports()) // Creating the reports after tests ran
|
||||
.pipe(plugins.g.gFunction(function(){
|
||||
plugins.beautylog.ok("Tests have passed!");
|
||||
done.resolve(configArg);
|
||||
},"atEnd"));
|
||||
return done.promise;
|
||||
};
|
||||
npmtsOra.text('Instrumentalizing and testing transpiled JS')
|
||||
npmtsOra.end() // end npmtsOra for tests.
|
||||
let done = plugins.Q.defer()
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'dist/*.js')])
|
||||
.pipe(plugins.g.sourcemaps.init())
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve('babel-preset-es2015')
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.istanbul({
|
||||
}))
|
||||
.pipe(plugins.g.sourcemaps.write())
|
||||
.pipe(plugins.g.injectModules())
|
||||
.on('finish', function () {
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')])
|
||||
.pipe(plugins.g.babel({
|
||||
presets: [
|
||||
require.resolve('babel-preset-es2015')
|
||||
]
|
||||
}))
|
||||
.pipe(plugins.g.injectModules())
|
||||
.pipe(plugins.g.mocha())
|
||||
.pipe(plugins.g.istanbul.writeReports({
|
||||
dir: plugins.path.join(paths.cwd, './coverage'),
|
||||
reporters: ['lcovonly', 'json', 'text', 'text-summary']
|
||||
}))
|
||||
.pipe(plugins.g.gFunction(
|
||||
function () {
|
||||
plugins.beautylog.ok('Tested!')
|
||||
done.resolve(configArg)
|
||||
},
|
||||
'atEnd'
|
||||
))
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
let coverage = function(configArg){
|
||||
let done = plugins.Q.defer();
|
||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir,"lcov.info"))
|
||||
.then(function(percentageArg){
|
||||
if (percentageArg >= configArg.coverageTreshold){
|
||||
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(
|
||||
"your coverage of " + percentageArg.toString().blue + "% ".blue + "exceeds your treshold of " +
|
||||
configArg.coverageTreshold.toString().blue + "%".blue
|
||||
);
|
||||
`${percentageArg.toString()}% `
|
||||
+ `coverage exceeds your treshold of `
|
||||
+ `${configArg.coverageTreshold.toString()}%`
|
||||
)
|
||||
} else {
|
||||
plugins.beautylog.warn(
|
||||
"your coverage of " + percentageArg + "% " + "fails your treshold of " +
|
||||
configArg.coverageTreshold + "%"
|
||||
);
|
||||
plugins.beautylog.error("exiting due to coverage failure");
|
||||
process.exit(1);
|
||||
`${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;
|
||||
};
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
|
||||
export let run = function(configArg) {
|
||||
let done = plugins.Q.defer();
|
||||
let config = configArg;
|
||||
if(config.notest != true){
|
||||
npmtsOra.text("now starting tests");
|
||||
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" +
|
||||
"--------------------------------------------------------------"
|
||||
);
|
||||
'-------------------------------------------------------\n' +
|
||||
'*************************** TESTS: ***************************\n' +
|
||||
'--------------------------------------------------------------'
|
||||
)
|
||||
|
||||
istanbul(config)
|
||||
.then(mocha)
|
||||
mocha(config)
|
||||
.then(coverage)
|
||||
.then(() => {
|
||||
done.resolve(config);
|
||||
});
|
||||
done.resolve(config)
|
||||
})
|
||||
} else {
|
||||
npmtsOra.end();
|
||||
done.resolve(config);
|
||||
npmtsOra.end()
|
||||
done.resolve(config)
|
||||
}
|
||||
return done.promise;
|
||||
};
|
||||
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
|
||||
}
|
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