Compare commits

...

53 Commits

Author SHA1 Message Date
3d78bf268d 5.4.46 2016-10-03 12:45:56 +02:00
36887512ee 5.4.45 2016-10-03 12:38:56 +02:00
fb7025d7ec 5.4.44 2016-10-02 20:35:17 +02:00
8dcdad9e2c some more es6 module syntax 2016-10-02 20:35:13 +02:00
1898db5472 5.4.43 2016-09-29 16:25:29 +02:00
1f01bee204 fix README 2016-09-29 16:25:16 +02:00
851653a6ae 5.4.42 2016-09-29 16:19:59 +02:00
9229cd79dd fix tsn issue 2016-09-29 16:19:49 +02:00
86fb639c82 5.4.41 2016-09-29 00:19:56 +02:00
d536e6aa8c improve test compilation 2016-09-29 00:19:46 +02:00
c91ff6ef4a 5.4.40 2016-09-25 20:28:46 +02:00
2c88c889bf improve README 2016-09-25 20:28:42 +02:00
d3f8ea0433 5.4.39 2016-09-25 20:25:31 +02:00
d57b05c6d0 fix README 2016-09-25 20:25:06 +02:00
e1ce5f2d5b 5.4.38 2016-09-25 20:22:49 +02:00
7c960649bc add smartstream 2016-09-25 20:22:10 +02:00
71588595e6 5.4.37 2016-09-24 16:57:41 +02:00
b31994f163 added new npmextra version 2016-09-24 16:57:30 +02:00
e6284cdde3 5.4.36 2016-09-22 23:23:32 +02:00
5f15fe1b30 added --watch option 2016-09-22 23:23:16 +02:00
3dae49b8a1 5.4.35 2016-09-18 13:08:47 +02:00
1d431792a5 upgrade to newest tsn 2016-09-18 13:08:31 +02:00
9542140b93 clean up 2016-09-15 18:26:33 +02:00
e1487c39cb 5.4.34 2016-09-15 18:25:25 +02:00
d4c69071e4 clean up promise handling for ts compilation 2016-09-15 18:25:09 +02:00
186460d437 5.4.33 2016-09-14 16:18:23 +02:00
30c2db9ed1 update compatibility for npmpage 2016-09-14 16:18:19 +02:00
3e5ab24b90 5.4.32 2016-09-14 16:16:47 +02:00
6d63b620f1 update README 2016-09-14 16:16:39 +02:00
a9270cda03 5.4.31 2016-09-14 13:16:40 +02:00
2a0a5cea8c update tsn dependency and by that support Decorators and runtime type checking through reflect metadata API 2016-09-14 13:16:36 +02:00
b2d8cb53f3 5.4.30 2016-09-06 17:33:31 +02:00
875efe413a some more standard js 2016-09-06 17:33:28 +02:00
8fd24c6e31 5.4.29 2016-09-06 17:22:30 +02:00
18a1087478 copile docs 2016-09-06 17:22:26 +02:00
cd2f401180 now adhering to standard js code style 2016-09-06 17:21:25 +02:00
41b1fe85d6 5.4.27 2016-09-03 18:50:12 +02:00
8372c1437c fixes #8 2016-09-03 18:50:09 +02:00
aedf9f3115 5.4.26 2016-09-02 17:42:45 +02:00
25320bdf5c fix checks 2016-09-02 17:42:41 +02:00
33c83de1fb 5.4.25 2016-09-02 17:12:38 +02:00
07a56fcaca fix @types/node 2016-09-02 17:12:35 +02:00
7bc986251f 5.4.24 2016-09-02 14:11:44 +02:00
cdde7da5f9 remove travis and appveyor 2016-09-02 14:11:27 +02:00
82c00fe444 fix typedoc integration 2016-09-02 14:10:09 +02:00
93682e9ec4 5.4.23 2016-09-01 15:50:01 +02:00
d339da7e11 compile 2016-09-01 15:49:57 +02:00
8b51992959 5.4.22 2016-09-01 15:47:10 +02:00
cb3bfaf438 updated README 2016-09-01 15:46:31 +02:00
91b7317b80 5.4.21 2016-09-01 12:12:09 +02:00
400b193210 integrate push.rocks banding 2016-09-01 12:12:03 +02:00
7f6a6434d2 5.4.20 2016-08-31 16:10:05 +02:00
a1414877a1 update docs 2016-08-31 16:10:01 +02:00
54 changed files with 1090 additions and 1141 deletions

2
.gitignore vendored
View File

@ -1,4 +1,6 @@
node_modules/ node_modules/
test/ test/
pages/ pages/
public/
npm-debug/
.DS_Store .DS_Store

View File

@ -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=

158
README.md
View File

@ -2,10 +2,10 @@
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6. Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
## Availabililty ## Availabililty
[![npm](https://img.shields.io/badge/npm-npmjs.com-blue.svg)](https://www.npmjs.com/package/npmts) [![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmts)
[![git](https://img.shields.io/badge/git-gitlab.com-blue.svg)](https://gitlab.com/pushrocks/npmts) [![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/npmts)
[![git](https://img.shields.io/badge/git%20mirror-github.com-blue.svg)](https://github.com/pushrocks/npmts) [![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/npmts)
[![docs](https://img.shields.io/badge/docs-gitlab.io-blue.svg)](https://pushrocks.gitlab.io/npmts/docs) [![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/npmts/)
## Status for master ## Status for master
[![build status](https://gitlab.com/pushrocks/npmts/badges/master/build.svg)](https://gitlab.com/pushrocks/npmts/commits/master) [![build status](https://gitlab.com/pushrocks/npmts/badges/master/build.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
@ -15,138 +15,28 @@ Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
[![bitHound Code](https://www.bithound.io/github/pushrocks/npmts/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmts) [![bitHound Code](https://www.bithound.io/github/pushrocks/npmts/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmts)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) [![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) [![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## What is NPMTS? ## Introduction
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript. NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works.
There is a docker image available that includes npmts to make CI a breeze: 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/) [hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
### Install For further information read the docs:
First install npmts globally, then install the npmts-g locally. 1. [Intro](https://pushrocks.gitlab.io/npmts/index.html)
2. [Install](https://pushrocks.gitlab.io/npmts/install.html)
3. [Default Behaviour](https://pushrocks.gitlab.io/npmts/default.html)
4. [Configuration](https://pushrocks.gitlab.io/npmts/config.html)
5. [Examples](https://pushrocks.gitlab.io/npmts/examples.html)
6. [Info](https://pushrocks.gitlab.io/npmts/info.html)
> **npmts-g* checks if the global version of npmts suffices the modules requirements. [![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
If not it installs npmts locally in the right version during npm install.
```sh
npm install npmts -g # installs npmts globally
npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency
```
Then add it to your package.json's script section to trigger a build:
```json
"scripts": {
"test": "(npmts)"
}
```
### Default task execution order
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
1. **Clean:** Clean up from any previous builds (old js files)
1. **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies
1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
1. **Documentation:** Create TypeDoc Documentation from TypeScript files
1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
### npmextra.json
the npmts section in npmextra.json can be used to configure npmts.
**Default**
>Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
with default behaviour.
```json
{
"npmts":{
"mode":"default"
}
}
```
**Custom settings**
```json
{
"mode":"custom",
"docs":false,
"test":true,
"npmts":{
"ts":{
"./customdir/*.ts":"./"
},
"tsOptions":{
"declaration":false,
"target":"ES6"
},
"cli":true
}
}
```
| key | default value | description |
| --- | --- | --- |
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
| `"docs"` | `true` | create docs for your module |
| `"test"` | `true` | test your module |
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
### TypeScript
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
`./dist/*.js` and `./test/test.js`
Use commonjs module system for wiring up files.
### Declaration files
**npmts** also creates declaration files like `./dist/index.d.ts` by default.
You can reference it in your package.json like this.
```json
"main": "dist/index.js",
"typings": ".dist/index.d.ts",
```
This is in line with the latest TypeScript best practices.
You can then import plugins via the TypeScript `import` Syntax
and tsc will pick up the declaration file automatically.
### TypeDoc
By default TypeDoc will create docs for your module in `./pages/api/` directory.
> Note: Use [npmpage](https://www.npmjs.com/package/npmpage) to build a website for the module.
It also allows you to integrate api docs with a gitbook located in `./docs/`
## Some notes:
#### Typings for third party modules that do not bundle declaration files
NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
#### Instrumentalize Code
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
#### Tests
Any errors will be shown with reference to their originating source in TypeScript
thanks to autogenerated source maps.
## Example Usage in modules:
* [gulp-browser](https://www.npmjs.com/package/gulp-browser)
> We will add more options over time.
## Tips and tricks:
* Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available.
* Use [npmpage](https://www.npmjs.com/package/npmpage) to create a webpage from coverage reports and TypeDoc for the module
* Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds
* Use [npmdocker](https://www.npmjs.com/package/npmdocker) for running tests consistently with docker.
## Future Scope:
* automatically manage badges in README
* manage tslint to enforce code best practices
* tear down any differences between local and CI environments by using brand new npmdocker
## About the authors:
[![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)
[![PayPal](https://img.shields.io/badge/Support%20us-PayPal-blue.svg)](https://paypal.me/lossless)

View File

@ -1,10 +0,0 @@
environment:
nodejs_version: "4"
install:
- ps: Install-Product node $env:nodejs_version
- npm install
test_script:
- node --version
- npm --version
- npm test
build: off

1
dist/index.d.ts vendored
View File

@ -1 +0,0 @@
import "typings-global";

35
dist/index.js vendored
View File

@ -1,27 +1,22 @@
"use strict";
require("typings-global");
/* ================================================== * /* ================================================== *
Starting NPMTS main process. **** NPMTS ****
Fabulous TypeScript development
* ================================================== */ * ================================================== */
var early = require("early"); "use strict";
early.start("NPMTS"); const early = require("early");
var plugins = require("./npmts.plugins"); early.start('NPMTS');
var paths = require("./npmts.paths"); const plugins = require("./npmts.plugins");
var npmts_promisechain_1 = require("./npmts.promisechain"); const paths = require("./npmts.paths");
const promisechain = require("./npmts.promisechain");
early.stop() early.stop()
.then(function () { .then(() => {
var npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot); let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
var npmtsCli = new plugins.smartcli.Smartcli(); let npmtsCli = new plugins.smartcli.Smartcli();
npmtsCli.standardTask() npmtsCli.standardTask()
.then(function (argvArg) { .then((argvArg) => {
plugins.beautylog.figletSync("NPMTS"); plugins.beautylog.figletSync('NPMTS');
plugins.beautylog.info("npmts version: " + npmtsProjectInfo.version); plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
try { promisechain.run(argvArg).catch((err) => { console.log(err); });
npmts_promisechain_1.promisechain(argvArg);
}
catch (err) {
console.log(err);
}
}); });
npmtsCli.addVersion(npmtsProjectInfo.version); npmtsCli.addVersion(npmtsProjectInfo.version);
npmtsCli.startParse(); npmtsCli.startParse();

View File

@ -1,4 +1,3 @@
/// <reference types="q" /> /// <reference types="q" />
import "typings-global"; import * as q from 'q';
import plugins = require("./npmts.plugins"); export declare var run: (configArg: any) => q.Promise<{}>;
export declare var run: (configArg: any) => plugins.Q.Promise<{}>;

22
dist/npmts.assets.js vendored
View File

@ -1,19 +1,19 @@
"use strict"; "use strict";
require("typings-global"); const plugins = require("./npmts.plugins");
var plugins = require("./npmts.plugins"); const paths = require("./npmts.paths");
var paths = require("./npmts.paths"); const q = require("q");
var npmts_promisechain_1 = require("./npmts.promisechain"); const npmts_promisechain_1 = require("./npmts.promisechain");
exports.run = function (configArg) { exports.run = function (configArg) {
var done = plugins.Q.defer(); let done = q.defer();
var config = configArg; let config = configArg;
npmts_promisechain_1.npmtsOra.text("now looking at " + "required assets".yellow); npmts_promisechain_1.npmtsOra.text('now looking at ' + 'required assets'.yellow);
if (config.cli == true) { if (config.cli === true) {
plugins.smartfile.fs.copySync(plugins.path.join(paths.npmtsAssetsDir, "cli.js"), plugins.path.join(paths.distDir, "cli.js")); plugins.smartfile.fs.copySync(plugins.path.join(paths.npmtsAssetsDir, 'cli.js'), plugins.path.join(paths.distDir, 'cli.js'));
plugins.beautylog.ok("installed CLI assets!"); plugins.beautylog.ok('installed CLI assets!');
done.resolve(config); done.resolve(config);
} }
else { else {
plugins.beautylog.ok("No additional assets required!"); plugins.beautylog.ok('No additional assets required!');
done.resolve(config); done.resolve(config);
} }
return done.promise; return done.promise;

View File

@ -1,3 +1,5 @@
/// <reference types="q" /> /// <reference types="q" />
import * as plugins from "./npmts.plugins"; import * as q from 'q';
export declare let run: (configArg: any) => plugins.Q.Promise<{}>; import { ProjectinfoNpm } from 'projectinfo';
export declare let projectInfo: ProjectinfoNpm;
export declare let run: (configArg: any) => q.Promise<{}>;

124
dist/npmts.check.js vendored
View File

@ -1,22 +1,25 @@
"use strict"; "use strict";
var plugins = require("./npmts.plugins"); const plugins = require("./npmts.plugins");
var paths = require("./npmts.paths"); const paths = require("./npmts.paths");
var npmts_promisechain_1 = require("./npmts.promisechain"); const q = require("q");
var checkProjectTypings = function (configArg) { const npmts_promisechain_1 = require("./npmts.promisechain");
var done = plugins.Q.defer(); const projectinfo_1 = require("projectinfo");
var cwdProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.cwd); let checkProjectTypings = (configArg) => {
if (typeof cwdProjectInfo.packageJson.typings == "undefined") { let done = q.defer();
plugins.beautylog.error("please add typings field to package.json"); npmts_promisechain_1.npmtsOra.text('Check Module: Check Project Typings...');
exports.projectInfo = new projectinfo_1.ProjectinfoNpm(paths.cwd);
if (typeof exports.projectInfo.packageJson.typings === 'undefined') {
plugins.beautylog.error(`please add typings field to package.json`);
process.exit(1); process.exit(1);
} }
; ;
done.resolve(configArg); done.resolve(configArg);
return done.promise; return done.promise;
}; };
var depcheckOptions = { const depcheckOptions = {
ignoreBinPackage: false, ignoreBinPackage: false,
parsers: { parsers: {
'*.ts': plugins.depcheck.parser.typescript, '*.ts': plugins.depcheck.parser.typescript
}, },
detectors: [ detectors: [
plugins.depcheck.detector.requireCallExpression, plugins.depcheck.detector.requireCallExpression,
@ -25,104 +28,93 @@ var depcheckOptions = {
specials: [ specials: [
plugins.depcheck.special.eslint, plugins.depcheck.special.eslint,
plugins.depcheck.special.webpack plugins.depcheck.special.webpack
], ]
}; };
var checkDependencies = function (configArg) { let checkDependencies = (configArg) => {
var done = plugins.Q.defer(); let done = q.defer();
var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, { npmts_promisechain_1.npmtsOra.text('Check Module: Check Dependencies...');
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
ignoreDirs: [ ignoreDirs: [
'test', 'test',
'dist', 'dist',
'bower_components' 'bower_components'
], ],
ignoreMatches: [ ignoreMatches: [
"@types/*", '@types/*',
"babel-preset-*" 'babel-preset-*'
] ]
}); });
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) { plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
for (var _i = 0, _a = unused.dependencies; _i < _a.length; _i++) { for (let item of unused.dependencies) {
var item = _a[_i]; plugins.beautylog.warn(`Watch out: unused dependency "${item}"`);
plugins.beautylog.warn("Watch out: unused dependency " + item.red);
} }
; for (let item in unused.missing) {
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) { plugins.beautylog.error(`unused devDependency "${item}"`);
var item = _c[_b];
plugins.beautylog.error("unused devDependency " + item.red);
} }
;
if (unused.missing.length > 0) { if (unused.missing.length > 0) {
plugins.beautylog.info("exiting due to missing dependencies in package.json"); plugins.beautylog.info('exiting due to missing dependencies in package.json');
process.exit(1); process.exit(1);
} }
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) { for (let item in unused.invalidFiles) {
var item = _e[_d]; plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
} }
; ;
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) { for (let item in unused.invalidDirs) {
var item = _g[_f]; plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
} }
;
done.resolve(configArg); done.resolve(configArg);
}); });
return done.promise; return done.promise;
}; };
var checkDevDependencies = function (configArg) { let checkDevDependencies = (configArg) => {
var done = plugins.Q.defer(); let done = q.defer();
var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, { npmts_promisechain_1.npmtsOra.text('Check Module: Check devDependencies...');
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
ignoreDirs: [ ignoreDirs: [
'ts', 'ts',
'dist', 'dist',
'bower_components' 'bower_components'
], ],
ignoreMatches: [ ignoreMatches: [
"@types/*", '@types/*',
"babel-preset-*" 'babel-preset-*'
] ]
}); });
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) { plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
for (var _i = 0, _a = unused.devDependencies; _i < _a.length; _i++) { for (let item of unused.devDependencies) {
var item = _a[_i]; plugins.beautylog.log(`unused devDependency ${item.red}`);
plugins.beautylog.log("unused devDependency " + item.red);
} }
; for (let item in unused.missing) {
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) { plugins.beautylog.error(`unused devDependency ${item.red}`);
var item = _c[_b];
plugins.beautylog.error("unused devDependency " + item.red);
} }
;
if (unused.missing.length > 0) { if (unused.missing.length > 0) {
plugins.beautylog.info("exiting due to missing dependencies in package.json"); plugins.beautylog.info('exiting due to missing dependencies in package.json');
process.exit(1); process.exit(1);
} }
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) { for (let item in unused.invalidFiles) {
var item = _e[_d]; plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
} }
; for (let item in unused.invalidDirs) {
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) { plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
var item = _g[_f];
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
} }
;
done.resolve(configArg); done.resolve(configArg);
}); });
return done.promise; return done.promise;
}; };
var checkNodeVersion = function (configArg) { let checkNodeVersion = (configArg) => {
var done = plugins.Q.defer(); let done = q.defer();
npmts_promisechain_1.npmtsOra.text('checking node version');
done.resolve(configArg); done.resolve(configArg);
return done.promise; return done.promise;
}; };
exports.run = function (configArg) { exports.run = (configArg) => {
var done = plugins.Q.defer(); let done = q.defer();
npmts_promisechain_1.npmtsOra.text("running project checks..."), npmts_promisechain_1.npmtsOra.text('Check Module: ...');
checkProjectTypings(configArg) checkProjectTypings(configArg)
.then(checkDependencies) .then(checkDependencies)
.then(checkDevDependencies) .then(checkDevDependencies)
.then(checkNodeVersion) .then(checkNodeVersion)
.then(done.resolve); .then(done.resolve)
.catch((err) => { console.log(err); });
return done.promise; return done.promise;
}; };

View File

@ -1,4 +1,3 @@
/// <reference types="q" /> /// <reference types="q" />
import "typings-global"; import * as q from 'q';
import plugins = require("./npmts.plugins"); export declare let run: (configArg: any) => q.Promise<{}>;
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;

40
dist/npmts.clean.js vendored
View File

@ -1,23 +1,41 @@
"use strict"; "use strict";
require("typings-global"); const plugins = require("./npmts.plugins");
var plugins = require("./npmts.plugins"); const paths = require("./npmts.paths");
var paths = require("./npmts.paths"); const q = require("q");
var npmts_promisechain_1 = require("./npmts.promisechain"); const npmts_promisechain_1 = require("./npmts.promisechain");
var removeDist = function () { /**
npmts_promisechain_1.npmtsOra.text("cleaning dist folder"); * removes the dist directory which will be entirely rebuild
*/
let removeDist = function () {
npmts_promisechain_1.npmtsOra.text('cleaning dist folder');
return plugins.smartfile.fs.remove(paths.distDir); return plugins.smartfile.fs.remove(paths.distDir);
}; };
var removePages = function () { /**
npmts_promisechain_1.npmtsOra.text("cleaning pages folder"); * remove .d.ts files from testDirctory
*/
let removeTestDeclarations = function () {
let done = q.defer();
plugins.smartfile.fs.listFileTree('./test/', '**/*.d.ts').then(fileArray => {
let fileArrayToRemove = plugins.smartpath.transform.toAbsolute(fileArray, process.cwd() + '//test/');
plugins.smartfile.fs.removeManySync(fileArrayToRemove);
done.resolve();
});
};
/**
* remove old pages
*/
let removePages = function () {
npmts_promisechain_1.npmtsOra.text('cleaning pages folder');
return plugins.smartfile.fs.remove(paths.pagesDir); return plugins.smartfile.fs.remove(paths.pagesDir);
}; };
exports.run = function (configArg) { 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(); let done = q.defer();
removeDist() removeDist()
.then(removeTestDeclarations)
.then(removePages) .then(removePages)
.then(function () { .then(function () {
plugins.beautylog.ok("Cleaned up from previous builds!"); plugins.beautylog.ok('Cleaned up from previous builds!');
done.resolve(configArg); done.resolve(configArg);
}); });
return done.promise; return done.promise;

View File

@ -1,4 +1,3 @@
/// <reference types="q" /> /// <reference types="q" />
import "typings-global"; import * as q from 'q';
import plugins = require("./npmts.plugins"); export declare let run: (configArg: any) => q.Promise<{}>;
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;

View File

@ -1 +0,0 @@
export declare let checkOutputPath: (tsArrayArg: any, keyArg: any) => boolean;

View File

@ -1,16 +0,0 @@
"use strict";
var plugins = require("./npmts.plugins");
var paths = require("./npmts.paths");
var outputPathIsDir = function (tsArrayArg, keyArg) {
return plugins.smartpath.check.isDir(plugins.path.join(paths.cwd, tsArrayArg[keyArg]));
};
exports.checkOutputPath = function (tsArrayArg, keyArg) {
if (!outputPathIsDir(tsArrayArg, keyArg)) {
plugins.beautylog.warn("Skipping " + keyArg + " because " + tsArrayArg[keyArg] + " it is no directory!");
return false;
}
else {
return true;
}
;
};

70
dist/npmts.compile.js vendored
View File

@ -1,63 +1,21 @@
"use strict"; "use strict";
require("typings-global"); const plugins = require("./npmts.plugins");
var plugins = require("./npmts.plugins"); const paths = require("./npmts.paths");
var helpers = require("./npmts.compile.helpers"); const q = require("q");
var npmts_promisechain_1 = require("./npmts.promisechain"); const npmts_promisechain_1 = require("./npmts.promisechain");
var promiseArray = [];
var compileTs = function (tsFileArrayArg, tsOptionsArg) {
if (tsOptionsArg === void 0) { tsOptionsArg = {}; }
var done = plugins.Q.defer();
var compilerOptionsDefault = {
declaration: true,
module: "CommonJS",
target: "ES6"
};
/**
* merges default ts options with those found in npmts.json
*/
var compilerOptions = function (keyArg) {
var tsOptionsCombined = plugins.lodashObject.merge(compilerOptionsDefault, tsOptionsArg);
var compilerOptions = {
declaration: tsOptionsCombined.declaration,
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target]
};
return compilerOptions;
};
var _loop_1 = function(keyArg) {
plugins.beautylog.info("TypeScript assignment: transpile from " + keyArg.blue + " to " + tsFileArrayArg[keyArg].blue);
if (helpers.checkOutputPath(tsFileArrayArg, keyArg)) {
var filesReadPromise = plugins.smartfile.fs.listFileTree(process.cwd(), keyArg)
.then(function (filesToConvertArg) {
var filesToConvertAbsolute = plugins.smartpath.transform.toAbsolute(filesToConvertArg, process.cwd());
var destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg], process.cwd());
var filesCompiledPromise = plugins.tsn.compile(filesToConvertAbsolute, destDir, compilerOptions(keyArg));
promiseArray.push(filesCompiledPromise);
});
promiseArray.push(filesReadPromise);
}
};
for (var keyArg in tsFileArrayArg) {
_loop_1(keyArg);
}
;
plugins.Q.all(promiseArray)
.then(done.resolve);
return done.promise;
};
exports.run = function (configArg) { exports.run = function (configArg) {
var done = plugins.Q.defer(); let done = q.defer();
var config = configArg; let 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) plugins.tsn.compileGlobStringObject(config.ts, config.tsOptions, paths.cwd)
.then(function () { .then(() => {
plugins.beautylog.ok("compiled main TypeScript!"); plugins.beautylog.ok('compiled main TypeScript!');
plugins.beautylog.log("now compiling tests!"); plugins.beautylog.log('now compiling tests!');
return compileTs(config.testTs); return plugins.tsn.compileGlobStringObject(config.testTs, config.tsOptions, paths.cwd);
}) })
.then(function () { .then(function () {
plugins.beautylog.ok("compiled all TypeScript!"); plugins.beautylog.ok('compiled all TypeScript!');
done.resolve(config); done.resolve(config);
}); }).catch(err => { console.log(err); });
return done.promise; return done.promise;
}; };

View File

@ -1,8 +1,7 @@
/// <reference types="q" /> /// <reference types="q" />
import "typings-global"; import * as q from 'q';
import plugins = require("./npmts.plugins"); export declare type npmtsMode = 'default' | 'custom';
export declare type npmtsMode = "default" | "custom"; export interface INpmtsConfig {
export interface npmtsConfig {
argv: any; argv: any;
coverageTreshold: number; coverageTreshold: number;
docs: boolean; docs: boolean;
@ -11,5 +10,6 @@ export interface npmtsConfig {
testTs: any; testTs: any;
ts: any; ts: any;
tsOptions: any; tsOptions: any;
watch: boolean;
} }
export declare var run: (argvArg: any) => plugins.Q.Promise<{}>; export declare var run: (argvArg: any) => q.Promise<{}>;

59
dist/npmts.options.js vendored
View File

@ -1,52 +1,48 @@
"use strict"; "use strict";
require("typings-global"); const plugins = require("./npmts.plugins");
var plugins = require("./npmts.plugins"); const paths = require("./npmts.paths");
var paths = require("./npmts.paths"); const q = require("q");
var npmts_promisechain_1 = require("./npmts.promisechain"); const npmts_promisechain_1 = require("./npmts.promisechain");
; ;
exports.run = function (argvArg) { exports.run = function (argvArg) {
var done = plugins.Q.defer(); let done = q.defer();
var defaultConfig = { let defaultConfig = {
argv: undefined, argv: undefined,
coverageTreshold: 70, coverageTreshold: 70,
docs: true, docs: true,
mode: "default", mode: 'default',
test: true, test: true,
testTs: {}, testTs: {},
ts: {}, ts: {},
tsOptions: {} tsOptions: {},
watch: false
}; };
// mix with configfile // mix with configfile
npmts_promisechain_1.npmtsOra.text("looking for npmextra.json"); npmts_promisechain_1.npmtsOra.text('running npmextra');
var config = plugins.npmextra.dataFor({ let localNpmextra = new plugins.npmextra.Npmextra(paths.cwd);
toolName: "npmts", let config = localNpmextra.dataFor('npmts', defaultConfig);
defaultSettings: defaultConfig,
cwd: paths.cwd
});
// add argv // add argv
config.argv = argvArg; config.argv = argvArg;
// check mode // check mode
switch (config.mode) { switch (config.mode) {
case "default": case 'default':
case "custom": case 'custom':
plugins.beautylog.ok("mode is " + config.mode); plugins.beautylog.ok('mode is ' + config.mode);
done.resolve(config); done.resolve(config);
break; break;
default: default:
plugins.beautylog.error("mode not recognised!"); plugins.beautylog.error(`mode not recognised!`);
process.exit(1); process.exit(1);
} }
; ;
//handle default mode // handle default mode
if (config.mode == "default") { if (config.mode === 'default') {
config.ts = (_a = {}, config.ts = {
_a["./ts/**/*.ts"] = "./dist/", './ts/**/*.ts': './dist/'
_a };
); config.testTs = {
config.testTs = (_b = {}, './test/**/*.ts': './test/'
_b["./test/test.ts"] = "./test/", };
_b
);
} }
; ;
// mix with commandline // mix with commandline
@ -58,8 +54,11 @@ exports.run = function (argvArg) {
config.docs = false; config.docs = false;
} }
; ;
plugins.beautylog.ok("build options are ready!"); if (config.argv.watch) {
config.watch = true;
}
;
plugins.beautylog.ok('build options are ready!');
done.resolve(config); done.resolve(config);
return done.promise; return done.promise;
var _a, _b;
}; };

View File

@ -1,4 +1,3 @@
import "typings-global";
export declare let npmtsPackageRoot: string; export declare let npmtsPackageRoot: string;
export declare let cwd: string; export declare let cwd: string;
export declare let tsDir: string; export declare let tsDir: string;

27
dist/npmts.paths.js vendored
View File

@ -1,20 +1,19 @@
"use strict"; "use strict";
require("typings-global"); const plugins = require("./npmts.plugins");
var plugins = require("./npmts.plugins");
// NPMTS Paths // NPMTS Paths
exports.npmtsPackageRoot = plugins.path.join(__dirname, "../"); exports.npmtsPackageRoot = plugins.path.join(__dirname, '../');
// Project paths // Project paths
exports.cwd = process.cwd(); exports.cwd = process.cwd();
// Directories // Directories
exports.tsDir = plugins.path.join(exports.cwd, "ts/"); exports.tsDir = plugins.path.join(exports.cwd, 'ts/');
exports.distDir = plugins.path.join(exports.cwd, "dist/"); exports.distDir = plugins.path.join(exports.cwd, 'dist/');
exports.testDir = plugins.path.join(exports.cwd, "test/"); exports.testDir = plugins.path.join(exports.cwd, 'test/');
exports.typingsDir = plugins.path.join(exports.cwd, "ts/typings/"); exports.typingsDir = plugins.path.join(exports.cwd, 'ts/typings/');
exports.coverageDir = plugins.path.join(exports.cwd, "coverage/"); exports.coverageDir = plugins.path.join(exports.cwd, 'coverage/');
// Pages // Pages
exports.pagesDir = plugins.path.join(exports.cwd, "pages/"); exports.pagesDir = plugins.path.join(exports.cwd, 'pages/');
exports.pagesApiDir = plugins.path.join(exports.pagesDir, "/api"); exports.pagesApiDir = plugins.path.join(exports.pagesDir, '/api');
exports.npmtsAssetsDir = plugins.path.join(__dirname, "../assets/"); exports.npmtsAssetsDir = plugins.path.join(__dirname, '../assets/');
//Files // Files
exports.indexTS = plugins.path.join(exports.cwd, "ts/index.ts"); exports.indexTS = plugins.path.join(exports.cwd, 'ts/index.ts');
exports.testTS = plugins.path.join(exports.cwd, "ts/test.ts"); exports.testTS = plugins.path.join(exports.cwd, 'ts/test.ts');

View File

@ -1,8 +1,8 @@
import "typings-global"; import 'typings-global';
export import beautylog = require("beautylog"); import * as beautylog from 'beautylog';
export declare let depcheck: any; declare let depcheck: any;
export import gulp = require("gulp"); import * as gulp from 'gulp';
export declare let g: { declare let g: {
babel: any; babel: any;
istanbul: any; istanbul: any;
gFunction: any; gFunction: any;
@ -11,17 +11,19 @@ export declare let g: {
sourcemaps: any; sourcemaps: any;
typedoc: any; typedoc: any;
}; };
export import lodashObject = require('lodash'); import * as lodash from 'lodash';
export import npmextra = require("npmextra"); import * as npmextra from 'npmextra';
export import projectinfo = require("projectinfo"); import * as projectinfo from 'projectinfo';
export import path = require("path"); import * as path from 'path';
export import Q = require("q"); import * as shelljs from 'shelljs';
export import shelljs = require("shelljs"); import * as smartchok from 'smartchok';
export import smartcli = require("smartcli"); import * as smartcli from 'smartcli';
export import smartcov = require("smartcov"); import * as smartcov from 'smartcov';
export import smartenv = require("smartenv"); import * as smartenv from 'smartenv';
export import smartfile = require("smartfile"); import * as smartfile from 'smartfile';
export import smartpath = require("smartpath"); import * as smartpath from 'smartpath';
export import smartstring = require("smartstring"); import * as smartstream from 'smartstream';
import * as smartstring from 'smartstring';
export declare let sourceMapSupport: any; export declare let sourceMapSupport: any;
export import tsn = require("tsn"); import * as tsn from 'tsn';
export { beautylog, depcheck, gulp, g, lodash, npmextra, projectinfo, path, shelljs, smartchok, smartcli, smartcov, smartenv, smartfile, smartpath, smartstream, smartstring, tsn };

69
dist/npmts.plugins.js vendored
View File

@ -1,28 +1,47 @@
"use strict"; "use strict";
require("typings-global"); require("typings-global");
exports.beautylog = require("beautylog"); const beautylog = require("beautylog");
exports.depcheck = require("depcheck"); exports.beautylog = beautylog;
exports.gulp = require("gulp"); let depcheck = require('depcheck');
exports.g = { exports.depcheck = depcheck;
babel: require("gulp-babel"), const gulp = require("gulp");
istanbul: require("gulp-istanbul"), exports.gulp = gulp;
gFunction: require("gulp-function"), let g = {
injectModules: require("gulp-inject-modules"), babel: require('gulp-babel'),
mocha: require("gulp-mocha"), istanbul: require('gulp-istanbul'),
sourcemaps: require("gulp-sourcemaps"), gFunction: require('gulp-function'),
typedoc: require("gulp-typedoc") injectModules: require('gulp-inject-modules'),
mocha: require('gulp-mocha'),
sourcemaps: require('gulp-sourcemaps'),
typedoc: require('gulp-typedoc')
}; };
exports.lodashObject = require('lodash'); exports.g = g;
exports.npmextra = require("npmextra"); const lodash = require("lodash");
exports.projectinfo = require("projectinfo"); exports.lodash = lodash;
exports.path = require("path"); const npmextra = require("npmextra");
exports.Q = require("q"); exports.npmextra = npmextra;
exports.shelljs = require("shelljs"); const projectinfo = require("projectinfo");
exports.smartcli = require("smartcli"); exports.projectinfo = projectinfo;
exports.smartcov = require("smartcov"); const path = require("path");
exports.smartenv = require("smartenv"); exports.path = path;
exports.smartfile = require("smartfile"); const shelljs = require("shelljs");
exports.smartpath = require("smartpath"); exports.shelljs = shelljs;
exports.smartstring = require("smartstring"); const smartchok = require("smartchok");
exports.sourceMapSupport = require("source-map-support").install(); // this is required to display errors correctly during testing exports.smartchok = smartchok;
exports.tsn = require("tsn"); const smartcli = require("smartcli");
exports.smartcli = smartcli;
const smartcov = require("smartcov");
exports.smartcov = smartcov;
const smartenv = require("smartenv");
exports.smartenv = smartenv;
const smartfile = require("smartfile");
exports.smartfile = smartfile;
const smartpath = require("smartpath");
exports.smartpath = smartpath;
const smartstream = require("smartstream");
exports.smartstream = smartstream;
const smartstring = require("smartstring");
exports.smartstring = smartstring;
exports.sourceMapSupport = require('source-map-support').install(); // display errors correctly during testing
const tsn = require("tsn");
exports.tsn = tsn;

View File

@ -1,6 +1,5 @@
/// <reference types="q" /> /// <reference types="q" />
import "typings-global"; import { Ora } from 'beautylog';
import plugins = require("./npmts.plugins"); import * as q from 'q';
import { Ora } from "beautylog";
export declare let npmtsOra: Ora; export declare let npmtsOra: Ora;
export declare let promisechain: (argvArg: any) => plugins.Q.Promise<{}>; export declare let run: (argvArg: any) => q.Promise<{}>;

View File

@ -1,16 +1,18 @@
"use strict"; "use strict";
require("typings-global"); const plugins = require("./npmts.plugins");
var plugins = require("./npmts.plugins"); const beautylog_1 = require("beautylog");
exports.npmtsOra = new plugins.beautylog.Ora("setting up TaskChain", "cyan"); const q = require("q");
var NpmtsAssets = require("./npmts.assets"); exports.npmtsOra = new beautylog_1.Ora('setting up TaskChain', 'cyan');
var NpmtsCheck = require("./npmts.check"); const NpmtsAssets = require("./npmts.assets");
var NpmtsClean = require("./npmts.clean"); const NpmtsCheck = require("./npmts.check");
var NpmtsCompile = require("./npmts.compile"); const NpmtsClean = require("./npmts.clean");
var NpmtsTypeDoc = require("./npmts.typedoc"); const NpmtsCompile = require("./npmts.compile");
var NpmtsOptions = require("./npmts.options"); const NpmtsTypeDoc = require("./npmts.typedoc");
var NpmtsTests = require("./npmts.tests"); const NpmtsOptions = require("./npmts.options");
exports.promisechain = function (argvArg) { const NpmtsTests = require("./npmts.tests");
var done = plugins.Q.defer(); const NpmtsWatch = require("./npmts.watch");
exports.run = function (argvArg) {
let done = q.defer();
exports.npmtsOra.start(); exports.npmtsOra.start();
NpmtsOptions.run(argvArg) NpmtsOptions.run(argvArg)
.then(NpmtsClean.run) .then(NpmtsClean.run)
@ -19,29 +21,30 @@ exports.promisechain = function (argvArg) {
.then(NpmtsAssets.run) .then(NpmtsAssets.run)
.then(NpmtsTypeDoc.run) .then(NpmtsTypeDoc.run)
.then(NpmtsTests.run) .then(NpmtsTests.run)
.then(NpmtsWatch.run)
.then(function (configArg) { .then(function (configArg) {
var shipString = "" + let shipString = '' +
"\n" + '\n' +
"\n" + '\n' +
" # # ( )\n" + ' # # ( )\n' +
" ___#_#___|__\n" + ' ___#_#___|__\n' +
" _ |____________| _\n" + ' _ |____________| _\n' +
" _=====| | | | | |==== _\n" + ' _=====| | | | | |==== _\n' +
" =====| |.---------------------------. | |====\n" + ' =====| |.---------------------------. | |====\n' +
" <--------------------' . . . . . . . . '--------------/\n" + " <--------------------' . . . . . . . . '--------------/\n" +
" \\ /\n" + ' \\ /\n' +
" \\___________________________________________________________/\n" + ' \\___________________________________________________________/\n' +
" wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n" + ' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
" wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n" + ' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
" wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n"; ' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n';
if (process.env.CI) { if (process.env.CI) {
console.log(shipString); console.log(shipString);
plugins.beautylog.success("READY TO SHIP!"); plugins.beautylog.success('READY TO SHIP!');
} }
else { else {
plugins.beautylog.success("Done!"); plugins.beautylog.success('Done!');
} }
done.resolve(); done.resolve(configArg);
}); });
return done.promise; return done.promise;
}; };

View File

@ -1,4 +1,4 @@
/// <reference types="q" /> /// <reference types="q" />
import "typings-global"; import * as q from 'q';
import plugins = require("./npmts.plugins"); import { INpmtsConfig } from './npmts.options';
export declare let run: (configArg: any) => plugins.Q.Promise<{}>; export declare let run: (configArg: INpmtsConfig) => q.Promise<{}>;

98
dist/npmts.tests.js vendored
View File

@ -1,73 +1,87 @@
"use strict"; "use strict";
require("typings-global"); const plugins = require("./npmts.plugins");
var plugins = require("./npmts.plugins"); const paths = require("./npmts.paths");
var paths = require("./npmts.paths"); const q = require("q");
var npmts_promisechain_1 = require("./npmts.promisechain"); const npmts_promisechain_1 = require("./npmts.promisechain");
/** /**
* * runs mocha
* @returns {*} * @returns INpmtsConfig
*/ */
var mocha = function (configArg) { let mocha = function (configArg) {
npmts_promisechain_1.npmtsOra.text("Instrumentalizing and testing transpiled JS"); npmts_promisechain_1.npmtsOra.text('Instrumentalizing and testing transpiled JS');
npmts_promisechain_1.npmtsOra.end(); // end npmtsOra for tests. npmts_promisechain_1.npmtsOra.end(); // end npmtsOra for tests.
var done = plugins.Q.defer(); let done = q.defer();
var stream = plugins.gulp.src([plugins.path.join(paths.cwd, "dist/*.js")]) plugins.gulp.src([plugins.path.join(paths.cwd, 'dist/*.js')])
.pipe(plugins.g.sourcemaps.init()) .pipe(plugins.g.sourcemaps.init())
.pipe(plugins.g.babel({ .pipe(plugins.g.babel({
presets: [ presets: [
require.resolve("babel-preset-es2015") require.resolve('babel-preset-es2015')
] ]
})) }))
.pipe(plugins.g.istanbul({})) .pipe(plugins.g.istanbul({}))
.pipe(plugins.g.sourcemaps.write()) .pipe(plugins.g.sourcemaps.write())
.pipe(plugins.g.injectModules()) .pipe(plugins.g.injectModules())
.on("finish", function () { .on('finish', function () {
plugins.gulp.src([plugins.path.join(paths.cwd, "test/test.js")]) let localSmartstream = new plugins.smartstream.Smartstream([
.pipe(plugins.g.babel({ plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')]),
presets: [ plugins.g.babel({
require.resolve("babel-preset-es2015") presets: [
] require.resolve('babel-preset-es2015')
})) ]
.pipe(plugins.g.injectModules()) }),
.pipe(plugins.g.mocha()) plugins.g.injectModules(),
.pipe(plugins.g.istanbul.writeReports({ plugins.g.mocha(),
dir: plugins.path.join(paths.cwd, "./coverage"), plugins.g.istanbul.writeReports({
reporters: ['lcovonly', 'json', 'text', 'text-summary'] 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); localSmartstream.run()
}, "atEnd")); .then(() => { done.resolve(configArg); }, (err) => {
plugins.beautylog.error('Tests failed!');
if (configArg.watch) {
done.resolve(configArg);
}
else {
process.exit(1);
}
});
}); });
return done.promise; return done.promise;
}; };
var coverage = function (configArg) { let coverage = function (configArg) {
var done = plugins.Q.defer(); let done = q.defer();
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, "lcov.info"), 2) plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, 'lcov.info'), 2)
.then(function (percentageArg) { .then(function (percentageArg) {
if (percentageArg >= configArg.coverageTreshold) { if (percentageArg >= configArg.coverageTreshold) {
plugins.beautylog.ok(percentageArg.toString() + "% coverage exceeds your treshold of " + configArg.coverageTreshold.toString() + "%"); plugins.beautylog.ok(`${percentageArg.toString()}% `
+ `coverage exceeds your treshold of `
+ `${configArg.coverageTreshold.toString()}%`);
} }
else { else {
plugins.beautylog.warn(percentageArg.toString() + "% coverage fails your treshold of " + configArg.coverageTreshold.toString() + "%"); plugins.beautylog.warn(`${percentageArg.toString()}% `
plugins.beautylog.error("exiting due to coverage failure"); + `coverage fails your treshold of `
process.exit(1); + `${configArg.coverageTreshold.toString()}%`);
plugins.beautylog.error('exiting due to coverage failure');
if (!configArg.watch) {
process.exit(1);
}
} }
done.resolve(configArg); done.resolve(configArg);
}); });
return done.promise; return done.promise;
}; };
exports.run = function (configArg) { exports.run = function (configArg) {
var done = plugins.Q.defer(); let done = q.defer();
var config = configArg; let config = configArg;
if (config.test === true) { if (config.test === true) {
npmts_promisechain_1.npmtsOra.text("now starting tests"); npmts_promisechain_1.npmtsOra.text('now starting tests');
plugins.beautylog.log("-------------------------------------------------------\n" + plugins.beautylog.log('-------------------------------------------------------\n' +
"*************************** TESTS: ***************************\n" + '*************************** TESTS: ***************************\n' +
"--------------------------------------------------------------"); '--------------------------------------------------------------');
mocha(config) mocha(config)
.then(coverage) .then(coverage)
.then(function () { .then(() => {
done.resolve(config); done.resolve(config);
}); });
} }

View File

@ -1,4 +1,3 @@
/// <reference types="q" /> /// <reference types="q" />
import "typings-global"; import * as q from 'q';
import plugins = require("./npmts.plugins"); export declare let run: (configArg: any) => q.Promise<{}>;
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;

38
dist/npmts.typedoc.js vendored
View File

@ -1,35 +1,37 @@
"use strict"; "use strict";
require("typings-global"); const plugins = require("./npmts.plugins");
var plugins = require("./npmts.plugins"); const paths = require("./npmts.paths");
var paths = require("./npmts.paths"); const npmts_promisechain_1 = require("./npmts.promisechain");
var npmts_promisechain_1 = require("./npmts.promisechain"); const q = require("q");
var genTypeDoc = function (configArg) { const npmts_check_1 = require("./npmts.check");
var done = plugins.Q.defer(); let genTypeDoc = function (configArg) {
npmts_promisechain_1.npmtsOra.text("now generating " + "TypeDoc documentation".yellow); let done = q.defer();
plugins.beautylog.log("TypeDoc Output:"); npmts_promisechain_1.npmtsOra.text('now generating ' + 'TypeDoc documentation'.yellow);
plugins.gulp.src(plugins.path.join(paths.tsDir, "**/*.ts")) plugins.beautylog.log('TypeDoc Output:');
plugins.gulp.src(plugins.path.join(paths.tsDir, '**/*.ts'))
.pipe(plugins.g.typedoc({ .pipe(plugins.g.typedoc({
// TypeScript options (see typescript docs) // TypeScript options (see typescript docs)
module: "commonjs", module: 'commonjs',
target: "es6", target: 'es6',
includeDeclarations: true, includeDeclarations: true,
// Output options (see typedoc docs) // Output options (see typedoc docs)
out: paths.pagesApiDir, out: paths.pagesApiDir,
json: plugins.path.join(paths.pagesApiDir, "file.json"), json: plugins.path.join(paths.pagesApiDir, 'file.json'),
// TypeDoc options (see typedoc docs) // TypeDoc options (see typedoc docs)
name: "my-project", name: npmts_check_1.projectInfo.name,
//theme: "default", readme: plugins.path.join(paths.cwd, 'README.md'),
// theme: "default",
ignoreCompilerErrors: true, ignoreCompilerErrors: true,
version: true, version: true
})) }))
.pipe(plugins.g.gFunction(done.resolve, "atEnd")); .pipe(plugins.g.gFunction(done.resolve, 'atEnd'));
return done.promise; return done.promise;
}; };
exports.run = function (configArg) { exports.run = function (configArg) {
var done = plugins.Q.defer(); let done = q.defer();
if (configArg.docs) { if (configArg.docs) {
genTypeDoc(configArg) genTypeDoc(configArg)
.then(function () { .then(() => {
done.resolve(configArg); done.resolve(configArg);
}); });
} }

4
dist/npmts.watch.d.ts vendored Normal file
View File

@ -0,0 +1,4 @@
/// <reference types="q" />
import * as q from 'q';
import { INpmtsConfig } from './npmts.options';
export declare let run: (configArg: INpmtsConfig) => q.Promise<{}>;

30
dist/npmts.watch.js vendored Normal file
View File

@ -0,0 +1,30 @@
"use strict";
const plugins = require("./npmts.plugins");
const promisechain = require("./npmts.promisechain");
const q = require("q");
let npmtsSmartchok = null;
exports.run = (configArg) => {
let done = q.defer();
if (configArg.watch && npmtsSmartchok === null) {
let pathsToWatch = [];
for (let key in configArg.ts) {
pathsToWatch.push(key);
}
for (let key in configArg.testTs) {
pathsToWatch.push(key);
}
npmtsSmartchok = new plugins.smartchok.Smartchok(pathsToWatch);
npmtsSmartchok.getObservableFor('change').then((changeObservableArg) => {
plugins.beautylog.info('now watching...');
changeObservableArg.subscribe(() => {
promisechain.run(configArg);
});
});
npmtsSmartchok.start();
done.resolve(configArg);
}
else {
done.resolve(configArg);
}
return done.promise;
};

View File

@ -1,15 +0,0 @@
{
"structure": {
"readme": "index.md"
},
"plugins": [
"tonic",
"edit-link"
],
"pluginsConfig": {
"edit-link": {
"base": "https://gitlab.com/pushrocks/npmts/edit/master/docs/",
"label": "Edit on GitLab"
}
}
}

80
docs/config.md Normal file
View 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
View 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
View 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.

View File

@ -2,10 +2,10 @@
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6. Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
## Availabililty ## Availabililty
[![npm](https://img.shields.io/badge/npm-npmjs.com-blue.svg)](https://www.npmjs.com/package/npmts) [![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmts)
[![git](https://img.shields.io/badge/git-gitlab.com-blue.svg)](https://gitlab.com/pushrocks/npmts) [![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/npmts)
[![git](https://img.shields.io/badge/git%20mirror-github.com-blue.svg)](https://github.com/pushrocks/npmts) [![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/npmts)
[![docs](https://img.shields.io/badge/docs-gitlab.io-blue.svg)](https://pushrocks.gitlab.io/npmts/docs) [![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/npmts/gitbook)
## Status for master ## Status for master
[![build status](https://gitlab.com/pushrocks/npmts/badges/master/build.svg)](https://gitlab.com/pushrocks/npmts/commits/master) [![build status](https://gitlab.com/pushrocks/npmts/badges/master/build.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
@ -15,138 +15,28 @@ Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
[![bitHound Code](https://www.bithound.io/github/pushrocks/npmts/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmts) [![bitHound Code](https://www.bithound.io/github/pushrocks/npmts/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmts)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) [![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) [![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## What is NPMTS? ## Introduction
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript. NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works.
There is a docker image available that includes npmts to make CI a breeze: 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/) [hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
### Install For further information read the docs:
First install npmts globally, then install the npmts-g locally. * [1. Intro](https://pushrocks.gitlab.io/npmts/gitbook/index.md)
* [2. Install](https://pushrocks.gitlab.io/npmts/gitbook/install.md)
* [3. Default Behaviour](https://pushrocks.gitlab.io/npmts/gitbook/default.md)
* [4. Configuration](https://pushrocks.gitlab.io/npmts/gitbook/config.md)
* [5. Examples](https://pushrocks.gitlab.io/npmts/gitbook/examples.md)
* [6. Info](https://pushrocks.gitlab.io/npmts/gitbook/info.md)
> **npmts-g* checks if the global version of npmts suffices the modules requirements. [![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
If not it installs npmts locally in the right version during npm install.
```sh
npm install npmts -g # installs npmts globally
npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency
```
Then add it to your package.json's script section to trigger a build:
```json
"scripts": {
"test": "(npmts)"
}
```
### Default task execution order
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
1. **Clean:** Clean up from any previous builds (old js files)
1. **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies
1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
1. **Documentation:** Create TypeDoc Documentation from TypeScript files
1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
### npmextra.json
the npmts section in npmextra.json can be used to configure npmts.
**Default**
>Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
with default behaviour.
```json
{
"npmts":{
"mode":"default"
}
}
```
**Custom settings**
```json
{
"mode":"custom",
"docs":false,
"test":true,
"npmts":{
"ts":{
"./customdir/*.ts":"./"
},
"tsOptions":{
"declaration":false,
"target":"ES6"
},
"cli":true
}
}
```
| key | default value | description |
| --- | --- | --- |
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
| `"docs"` | `true` | create docs for your module |
| `"test"` | `true` | test your module |
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
### TypeScript
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
`./dist/*.js` and `./test/test.js`
Use commonjs module system for wiring up files.
### Declaration files
**npmts** also creates declaration files like `./dist/index.d.ts` by default.
You can reference it in your package.json like this.
```json
"main": "dist/index.js",
"typings": ".dist/index.d.ts",
```
This is in line with the latest TypeScript best practices.
You can then import plugins via the TypeScript `import` Syntax
and tsc will pick up the declaration file automatically.
### TypeDoc
By default TypeDoc will create docs for your module in `./pages/api/` directory.
> Note: Use [npmpage](https://www.npmjs.com/package/npmpage) to build a website for the module.
It also allows you to integrate api docs with a gitbook located in `./docs/`
## Some notes:
#### Typings for third party modules that do not bundle declaration files
NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
#### Instrumentalize Code
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
#### Tests
Any errors will be shown with reference to their originating source in TypeScript
thanks to autogenerated source maps.
## Example Usage in modules:
* [gulp-browser](https://www.npmjs.com/package/gulp-browser)
> We will add more options over time.
## Tips and tricks:
* Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available.
* Use [npmpage](https://www.npmjs.com/package/npmpage) to create a webpage from coverage reports and TypeDoc for the module
* Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds
* Use [npmdocker](https://www.npmjs.com/package/npmdocker) for running tests consistently with docker.
## Future Scope:
* automatically manage badges in README
* manage tslint to enforce code best practices
* tear down any differences between local and CI environments by using brand new npmdocker
## About the authors:
[![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)
[![PayPal](https://img.shields.io/badge/Support%20us-PayPal-blue.svg)](https://paypal.me/lossless)

14
docs/info.md Normal file
View 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:
[![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)
[![PayPal](https://img.shields.io/badge/Support%20us-PayPal-blue.svg)](https://paypal.me/lossless)
## Legal Info
https://lossless.gmbh

18
docs/install.md Normal file
View 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
View 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)

View File

@ -1,14 +1,16 @@
{ {
"name": "npmts", "name": "npmts",
"version": "5.4.19", "version": "5.4.46",
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.", "description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
"main": "dist/index.js", "main": "dist/index.js",
"bin": { "bin": {
"npmts": "dist/cli.js" "npmts": "dist/cli.js"
}, },
"scripts": { "scripts": {
"test": "(npm run compile && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest && npm run checkNoDocs)", "test": "(npm run compile && npm run prepareTest && 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/ )", "testShort": "(npm run compile && npm run check)",
"prepareTest": "(rm -rf test/)",
"compile": "(rm -r dist/ && tsc && cp assets/cli.js dist/ )",
"setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)", "setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
"typedoc": "(typedoc --out ./pages/api --target ES6 ./ts/)", "typedoc": "(typedoc --out ./pages/api --target ES6 ./ts/)",
"npmpage": "(npmpage)", "npmpage": "(npmpage)",
@ -32,38 +34,40 @@
}, },
"homepage": "https://gitlab.com/pushrocks/npmts#readme", "homepage": "https://gitlab.com/pushrocks/npmts#readme",
"dependencies": { "dependencies": {
"@types/gulp": "^3.8.30", "@types/gulp": "^3.8.32",
"@types/minimatch": "^2.0.28", "@types/minimatch": "^2.0.29",
"@types/q": "^0.x.x", "@types/q": "^0.x.x",
"@types/shelljs": "^0.3.29", "@types/shelljs": "^0.3.31",
"babel-preset-es2015": "^6.13.2", "babel-preset-es2015": "^6.16.0",
"beautylog": "5.0.20", "beautylog": "5.0.23",
"depcheck": "^0.6.4", "depcheck": "^0.6.4",
"early": "^2.0.25", "early": "^2.0.35",
"gulp": "3.9.1", "gulp": "3.9.1",
"gulp-babel": "^6.1.2", "gulp-babel": "^6.1.2",
"gulp-function": "^1.3.6", "gulp-function": "^1.3.6",
"gulp-inject-modules": "^1.0.0", "gulp-inject-modules": "^1.0.0",
"gulp-istanbul": "^1.1.0", "gulp-istanbul": "^1.1.1",
"gulp-mocha": "^3.0.1", "gulp-mocha": "^3.0.1",
"gulp-sourcemaps": "^1.6.0", "gulp-sourcemaps": "^1.6.0",
"gulp-typedoc": "^2.0.0", "gulp-typedoc": "^2.0.0",
"lodash": "^4.15.0", "lodash": "^4.16.2",
"npmextra": "^1.0.9", "npmextra": "^2.0.3",
"projectinfo": "1.0.3", "projectinfo": "1.0.3",
"q": "^1.4.1", "q": "^1.4.1",
"shelljs": "^0.7.3", "shelljs": "^0.7.4",
"smartcli": "1.0.4", "smartchok": "^1.0.2",
"smartcli": "1.0.9",
"smartcov": "1.0.0", "smartcov": "1.0.0",
"smartenv": "1.2.5", "smartenv": "1.2.5",
"smartfile": "4.0.13", "smartfile": "4.0.22",
"smartpath": "3.2.2", "smartpath": "3.2.2",
"smartstream": "^1.0.5",
"smartstring": "^2.0.17", "smartstring": "^2.0.17",
"source-map-support": "^0.4.2", "source-map-support": "^0.4.3",
"tsn": "^1.0.12", "tsn": "^2.0.4",
"typedoc": "^0.4.5", "typedoc": "^0.4.5",
"typescript": "next", "typescript": "next",
"typings-global": "*" "typings-global": "^1.0.14"
}, },
"devDependencies": {} "devDependencies": {}
} }

View File

@ -1,30 +1,24 @@
import "typings-global";
/* ================================================== * /* ================================================== *
Starting NPMTS main process. **** NPMTS ****
Fabulous TypeScript development
* ================================================== */ * ================================================== */
import * as early from "early";
early.start("NPMTS"); import * as early from 'early'
import * as plugins from "./npmts.plugins" early.start('NPMTS')
import * as paths from "./npmts.paths"; import * as plugins from './npmts.plugins'
import {promisechain} from "./npmts.promisechain"; import * as paths from './npmts.paths'
import * as promisechain from './npmts.promisechain'
early.stop() early.stop()
.then(() => { .then(() => {
let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot); let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot)
let npmtsCli = new plugins.smartcli.Smartcli()
let npmtsCli = new plugins.smartcli.Smartcli();
npmtsCli.standardTask() npmtsCli.standardTask()
.then((argvArg) => { .then((argvArg) => {
plugins.beautylog.figletSync("NPMTS"); plugins.beautylog.figletSync('NPMTS')
plugins.beautylog.info("npmts version: " + npmtsProjectInfo.version); plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version)
try { promisechain.run(argvArg).catch((err) => { console.log(err) })
promisechain(argvArg); })
}
catch(err){
console.log(err);
}
});
npmtsCli.addVersion(npmtsProjectInfo.version); npmtsCli.addVersion(npmtsProjectInfo.version)
npmtsCli.startParse(); npmtsCli.startParse()
}); })

View File

@ -1,22 +1,23 @@
import "typings-global"; import plugins = require('./npmts.plugins')
import plugins = require("./npmts.plugins"); import paths = require('./npmts.paths')
import paths = require("./npmts.paths");
import {npmtsOra} from "./npmts.promisechain"; import * as q from 'q'
import {npmtsOra} from './npmts.promisechain'
export var run = function(configArg){ export var run = function(configArg){
let done = plugins.Q.defer(); let done = q.defer()
let config = configArg; let config = configArg
npmtsOra.text("now looking at " + "required assets".yellow); npmtsOra.text('now looking at ' + 'required assets'.yellow)
if(config.cli == true){ if (config.cli === true) {
plugins.smartfile.fs.copySync( plugins.smartfile.fs.copySync(
plugins.path.join(paths.npmtsAssetsDir,"cli.js"), plugins.path.join(paths.npmtsAssetsDir,'cli.js'),
plugins.path.join(paths.distDir,"cli.js") plugins.path.join(paths.distDir,'cli.js')
); )
plugins.beautylog.ok("installed CLI assets!"); plugins.beautylog.ok('installed CLI assets!')
done.resolve(config); done.resolve(config)
} else { } else {
plugins.beautylog.ok("No additional assets required!") plugins.beautylog.ok('No additional assets required!')
done.resolve(config); done.resolve(config)
} }
return done.promise; return done.promise
}; }

View File

@ -1,22 +1,29 @@
import * as plugins from "./npmts.plugins"; import * as plugins from './npmts.plugins'
import * as paths from "./npmts.paths"; import * as paths from './npmts.paths'
import { npmtsOra } from "./npmts.promisechain";
import * as q from 'q'
import { npmtsOra } from './npmts.promisechain'
import {ProjectinfoNpm} from 'projectinfo'
export let projectInfo: ProjectinfoNpm
let checkProjectTypings = (configArg) => { let checkProjectTypings = (configArg) => {
let done = plugins.Q.defer(); let done = q.defer()
let cwdProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.cwd); npmtsOra.text('Check Module: Check Project Typings...')
if(typeof cwdProjectInfo.packageJson.typings == "undefined"){ projectInfo = new ProjectinfoNpm(paths.cwd)
plugins.beautylog.error(`please add typings field to package.json`); if (typeof projectInfo.packageJson.typings === 'undefined') {
process.exit(1); plugins.beautylog.error(`please add typings field to package.json`)
process.exit(1)
}; };
done.resolve(configArg); done.resolve(configArg)
return done.promise; return done.promise
}; }
const depcheckOptions = { const depcheckOptions = {
ignoreBinPackage: false, // ignore the packages with bin entry ignoreBinPackage: false, // ignore the packages with bin entry
parsers: { // the target parsers parsers: { // the target parsers
'*.ts': plugins.depcheck.parser.typescript, '*.ts': plugins.depcheck.parser.typescript
}, },
detectors: [ // the target detectors detectors: [ // the target detectors
plugins.depcheck.detector.requireCallExpression, plugins.depcheck.detector.requireCallExpression,
@ -25,93 +32,96 @@ const depcheckOptions = {
specials: [ // the target special parsers specials: [ // the target special parsers
plugins.depcheck.special.eslint, plugins.depcheck.special.eslint,
plugins.depcheck.special.webpack plugins.depcheck.special.webpack
], ]
}; }
let checkDependencies = (configArg) => { let checkDependencies = (configArg) => {
let done = plugins.Q.defer(); let done = q.defer()
let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, { npmtsOra.text('Check Module: Check Dependencies...')
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
ignoreDirs: [ // folder with these names will be ignored ignoreDirs: [ // folder with these names will be ignored
'test', 'test',
'dist', 'dist',
'bower_components' 'bower_components'
], ],
ignoreMatches: [ // ignore dependencies that matches these globs ignoreMatches: [ // ignore dependencies that matches these globs
"@types/*", '@types/*',
"babel-preset-*" 'babel-preset-*'
] ]
}) })
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => { plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
for (let item of unused.dependencies) { for (let item of unused.dependencies) {
plugins.beautylog.warn(`Watch out: unused dependency ${item.red}`); plugins.beautylog.warn(`Watch out: unused dependency "${item}"`)
};
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) { for (let item in unused.missing) {
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`); plugins.beautylog.error(`unused devDependency "${item}"`)
}
if (unused.missing.length > 0) {
plugins.beautylog.info('exiting due to missing dependencies in package.json')
process.exit(1)
}
for (let item in unused.invalidFiles) {
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`)
}; };
for (let item of unused.invalidDirs) { for (let item in unused.invalidDirs) {
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`); plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
}; }
done.resolve(configArg); done.resolve(configArg)
}); })
return done.promise; return done.promise
}; }
let checkDevDependencies = (configArg) => { let checkDevDependencies = (configArg) => {
let done = plugins.Q.defer(); let done = q.defer()
let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, { npmtsOra.text('Check Module: Check devDependencies...')
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
ignoreDirs: [ // folder with these names will be ignored ignoreDirs: [ // folder with these names will be ignored
'ts', 'ts',
'dist', 'dist',
'bower_components' 'bower_components'
], ],
ignoreMatches: [ // ignore dependencies that matches these globs ignoreMatches: [ // ignore dependencies that matches these globs
"@types/*", '@types/*',
"babel-preset-*" 'babel-preset-*'
] ]
}) })
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => { plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
for (let item of unused.devDependencies) { for (let item of unused.devDependencies) {
plugins.beautylog.log(`unused devDependency ${item.red}`); plugins.beautylog.log(`unused devDependency ${item.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) { for (let item in unused.missing) {
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`); plugins.beautylog.error(`unused devDependency ${item.red}`)
}; }
for (let item of unused.invalidDirs) { if (unused.missing.length > 0) {
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`); plugins.beautylog.info('exiting due to missing dependencies in package.json')
}; process.exit(1)
done.resolve(configArg); }
}); for (let item in unused.invalidFiles) {
return done.promise; plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`)
}; }
for (let item in unused.invalidDirs) {
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
}
done.resolve(configArg)
})
return done.promise
}
let checkNodeVersion = (configArg) => { let checkNodeVersion = (configArg) => {
let done = plugins.Q.defer(); let done = q.defer()
npmtsOra.text('checking node version')
done.resolve(configArg); done.resolve(configArg)
return done.promise; return done.promise
} }
export let run = (configArg) => { export let run = (configArg) => {
let done = plugins.Q.defer(); let done = q.defer()
npmtsOra.text("running project checks..."), npmtsOra.text('Check Module: ...')
checkProjectTypings(configArg) checkProjectTypings(configArg)
.then(checkDependencies) .then(checkDependencies)
.then(checkDevDependencies) .then(checkDevDependencies)
.then(checkNodeVersion) .then(checkNodeVersion)
.then(done.resolve); .then(done.resolve)
return done.promise; .catch((err) => { console.log(err) })
return done.promise
} }

View File

@ -1,26 +1,47 @@
import "typings-global"; import plugins = require('./npmts.plugins')
import plugins = require("./npmts.plugins"); import paths = require('./npmts.paths')
import paths = require("./npmts.paths");
import {npmtsOra} from "./npmts.promisechain";
let removeDist = function(){ import * as q from 'q'
npmtsOra.text("cleaning dist folder");
return plugins.smartfile.fs.remove(paths.distDir);
};
let removePages = function(){ import { npmtsOra } from './npmts.promisechain'
npmtsOra.text("cleaning pages folder");
return plugins.smartfile.fs.remove(paths.pagesDir);
};
export let run = function(configArg){ /**
npmtsOra.text("cleaning up from previous builds..."); * removes the dist directory which will be entirely rebuild
let done = plugins.Q.defer(); */
let removeDist = function () {
npmtsOra.text('cleaning dist folder')
return plugins.smartfile.fs.remove(paths.distDir)
}
/**
* remove .d.ts files from testDirctory
*/
let removeTestDeclarations = function () {
let done = q.defer()
plugins.smartfile.fs.listFileTree('./test/', '**/*.d.ts').then(fileArray => {
let fileArrayToRemove = plugins.smartpath.transform.toAbsolute(fileArray, process.cwd() + '//test/')
plugins.smartfile.fs.removeManySync(fileArrayToRemove)
done.resolve()
})
}
/**
* remove old pages
*/
let removePages = function () {
npmtsOra.text('cleaning pages folder')
return plugins.smartfile.fs.remove(paths.pagesDir)
}
export let run = function (configArg) {
npmtsOra.text('cleaning up from previous builds...')
let done = q.defer()
removeDist() removeDist()
.then(removeTestDeclarations)
.then(removePages) .then(removePages)
.then(function(){ .then(function () {
plugins.beautylog.ok("Cleaned up from previous builds!"); plugins.beautylog.ok('Cleaned up from previous builds!')
done.resolve(configArg); done.resolve(configArg)
}); })
return done.promise; return done.promise
}; }

View File

@ -1,15 +0,0 @@
import plugins = require("./npmts.plugins");
import paths = require("./npmts.paths");
let outputPathIsDir = function (tsArrayArg,keyArg) {
return plugins.smartpath.check.isDir(plugins.path.join(paths.cwd, tsArrayArg[keyArg]));
};
export let checkOutputPath = function(tsArrayArg,keyArg){
if(!outputPathIsDir(tsArrayArg,keyArg)) {
plugins.beautylog.warn("Skipping " + keyArg + " because " + tsArrayArg[keyArg] + " it is no directory!")
return false
} else {
return true;
};
}

View File

@ -1,68 +1,23 @@
import "typings-global"; import plugins = require('./npmts.plugins')
import plugins = require("./npmts.plugins"); import paths = require('./npmts.paths')
import paths = require("./npmts.paths");
import helpers = require("./npmts.compile.helpers");
import {npmtsOra} from "./npmts.promisechain";
let promiseArray = []; import * as q from 'q'
let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => {
let done = plugins.Q.defer();
let compilerOptionsDefault = {
declaration: true,
module: "CommonJS",
target: "ES6"
};
/**
* merges default ts options with those found in npmts.json
*/
let compilerOptions = function (keyArg:string) {
let tsOptionsCombined = plugins.lodashObject.merge(compilerOptionsDefault, tsOptionsArg);
let compilerOptions:plugins.tsn.CompilerOptions = {
declaration: tsOptionsCombined.declaration,
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target]
};
return compilerOptions;
};
for (let keyArg in tsFileArrayArg) {
plugins.beautylog.info(`TypeScript assignment: transpile from ${keyArg.blue} to ${tsFileArrayArg[keyArg].blue}`);
if (helpers.checkOutputPath(tsFileArrayArg,keyArg)) {
let filesReadPromise = plugins.smartfile.fs.listFileTree(process.cwd(),keyArg)
.then((filesToConvertArg) => {
let filesToConvertAbsolute = plugins.smartpath.transform.toAbsolute(filesToConvertArg,process.cwd());
let destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg],process.cwd());
let filesCompiledPromise = plugins.tsn.compile(
filesToConvertAbsolute,
destDir,
compilerOptions(keyArg)
);
promiseArray.push(filesCompiledPromise);
});
promiseArray.push(filesReadPromise);
}
};
plugins.Q.all(promiseArray)
.then(done.resolve);
return done.promise;
}
import {npmtsOra} from './npmts.promisechain'
export let run = function (configArg) { export let run = function (configArg) {
let done = plugins.Q.defer(); let done = q.defer()
let config = configArg; let config = configArg
npmtsOra.text("now compiling " + "TypeScript".yellow); npmtsOra.text('now compiling ' + 'TypeScript'.yellow)
plugins.tsn.compileGlobStringObject(config.ts,config.tsOptions,paths.cwd)
compileTs(config.ts,config.tsOptions)
.then(() => { .then(() => {
plugins.beautylog.ok("compiled main TypeScript!"); plugins.beautylog.ok('compiled main TypeScript!')
plugins.beautylog.log("now compiling tests!"); plugins.beautylog.log('now compiling tests!')
return compileTs(config.testTs); return plugins.tsn.compileGlobStringObject(config.testTs,config.tsOptions,paths.cwd)
}) })
.then(function () { .then(function () {
plugins.beautylog.ok("compiled all TypeScript!"); plugins.beautylog.ok('compiled all TypeScript!')
done.resolve(config); done.resolve(config)
}); }).catch(err => { console.log(err) })
return done.promise; return done.promise
}; }

View File

@ -1,81 +1,85 @@
import "typings-global"; import plugins = require('./npmts.plugins')
import plugins = require("./npmts.plugins"); import paths = require('./npmts.paths')
import paths = require("./npmts.paths");
import {npmtsOra} from "./npmts.promisechain";
export type npmtsMode = "default" | "custom" import * as q from 'q'
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,
watch: boolean
export interface npmtsConfig {
argv:any,
coverageTreshold:number,
docs:boolean,
mode: npmtsMode,
test:boolean,
testTs:any,
ts:any,
tsOptions:any
}; };
export var run = function (argvArg) {
export var run = function(argvArg){ let done = q.defer()
let done = plugins.Q.defer(); let defaultConfig: INpmtsConfig = {
let defaultConfig:npmtsConfig = { argv: undefined,
argv:undefined,
coverageTreshold: 70, coverageTreshold: 70,
docs: true, docs: true,
mode:"default", mode: 'default',
test:true, test: true,
testTs:{}, testTs: {},
ts:{}, ts: {},
tsOptions: {} tsOptions: {},
}; watch: false
}
// mix with configfile // mix with configfile
npmtsOra.text("looking for npmextra.json"); npmtsOra.text('running npmextra')
let config:npmtsConfig = plugins.npmextra.dataFor({
toolName:"npmts", let localNpmextra = new plugins.npmextra.Npmextra(paths.cwd)
defaultSettings:defaultConfig, let config: INpmtsConfig = localNpmextra.dataFor<INpmtsConfig>(
cwd:paths.cwd 'npmts',
}); defaultConfig
)
// add argv // add argv
config.argv = argvArg; config.argv = argvArg
// check mode // check mode
switch (config.mode){ switch (config.mode) {
case "default": case 'default':
case "custom": case 'custom':
plugins.beautylog.ok("mode is " + config.mode); plugins.beautylog.ok('mode is ' + config.mode)
done.resolve(config); done.resolve(config)
break; break
default: default:
plugins.beautylog.error(`mode not recognised!`); plugins.beautylog.error(`mode not recognised!`)
process.exit(1); process.exit(1)
}; };
//handle default mode // handle default mode
if (config.mode == "default"){ if (config.mode === 'default') {
config.ts = { config.ts = {
["./ts/**/*.ts"]: "./dist/" './ts/**/*.ts': './dist/'
}; }
config.testTs = { config.testTs = {
["./test/test.ts"]: "./test/" './test/**/*.ts': './test/'
}; }
}; };
// mix with commandline // mix with commandline
if(config.argv.notest){ if (config.argv.notest) {
config.test = false; config.test = false
}; };
if(config.argv.nodocs){ if (config.argv.nodocs) {
config.docs = false; config.docs = false
};
if (config.argv.watch) {
config.watch = true
}; };
plugins.beautylog.ok('build options are ready!')
plugins.beautylog.ok("build options are ready!"); done.resolve(config)
done.resolve(config); return done.promise
return done.promise; }
};

View File

@ -1,26 +1,24 @@
import "typings-global"; import plugins = require('./npmts.plugins')
import plugins = require("./npmts.plugins");
// NPMTS Paths // NPMTS Paths
export let npmtsPackageRoot = plugins.path.join(__dirname,"../"); export let npmtsPackageRoot = plugins.path.join(__dirname,'../')
// Project paths // Project paths
export let cwd = process.cwd(); export let cwd = process.cwd()
// Directories // Directories
export let tsDir = plugins.path.join(cwd,"ts/"); export let tsDir = plugins.path.join(cwd,'ts/')
export let distDir = plugins.path.join(cwd,"dist/"); export let distDir = plugins.path.join(cwd,'dist/')
export let testDir = plugins.path.join(cwd,"test/"); export let testDir = plugins.path.join(cwd,'test/')
export let typingsDir = plugins.path.join(cwd,"ts/typings/"); export let typingsDir = plugins.path.join(cwd,'ts/typings/')
export let coverageDir = plugins.path.join(cwd,"coverage/"); export let coverageDir = plugins.path.join(cwd,'coverage/')
// Pages // Pages
export let pagesDir = plugins.path.join(cwd,"pages/"); export let pagesDir = plugins.path.join(cwd,'pages/')
export let pagesApiDir = plugins.path.join(pagesDir,"/api"); 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 // Files
export let indexTS = plugins.path.join(cwd,"ts/index.ts"); export let indexTS = plugins.path.join(cwd,'ts/index.ts')
export let testTS = plugins.path.join(cwd,"ts/test.ts"); export let testTS = plugins.path.join(cwd,'ts/test.ts')

View File

@ -1,27 +1,49 @@
import "typings-global"; import 'typings-global'
export import beautylog = require("beautylog"); import * as beautylog from 'beautylog'
export let depcheck = require("depcheck"); let depcheck = require('depcheck')
export import gulp = require("gulp"); import * as gulp from 'gulp'
export let g = { let g = {
babel: require("gulp-babel"), babel: require('gulp-babel'),
istanbul: require("gulp-istanbul"), istanbul: require('gulp-istanbul'),
gFunction: require("gulp-function"), gFunction: require('gulp-function'),
injectModules: require("gulp-inject-modules"), injectModules: require('gulp-inject-modules'),
mocha: require("gulp-mocha"), mocha: require('gulp-mocha'),
sourcemaps: require("gulp-sourcemaps"), sourcemaps: require('gulp-sourcemaps'),
typedoc: require("gulp-typedoc") typedoc: require('gulp-typedoc')
}; }
export import lodashObject = require('lodash'); import * as lodash from 'lodash'
export import npmextra = require("npmextra"); import * as npmextra from 'npmextra'
export import projectinfo = require("projectinfo"); import * as projectinfo from 'projectinfo'
export import path = require("path"); import * as path from 'path'
export import Q = require("q"); import * as shelljs from 'shelljs'
export import shelljs = require("shelljs"); import * as smartchok from 'smartchok'
export import smartcli = require("smartcli"); import * as smartcli from 'smartcli'
export import smartcov = require("smartcov"); import * as smartcov from 'smartcov'
export import smartenv = require("smartenv"); import * as smartenv from 'smartenv'
export import smartfile = require("smartfile"); import * as smartfile from 'smartfile'
export import smartpath = require("smartpath"); import * as smartpath from 'smartpath'
export import smartstring = require("smartstring"); import * as smartstream from 'smartstream'
export let sourceMapSupport = require("source-map-support").install(); // this is required to display errors correctly during testing import * as smartstring from 'smartstring'
export import tsn = require("tsn"); export let sourceMapSupport = require('source-map-support').install() // display errors correctly during testing
import * as tsn from 'tsn'
export {
beautylog,
depcheck,
gulp,
g,
lodash,
npmextra,
projectinfo,
path,
shelljs,
smartchok,
smartcli,
smartcov,
smartenv,
smartfile,
smartpath,
smartstream,
smartstring,
tsn
}

View File

@ -1,20 +1,22 @@
import "typings-global"; import plugins = require('./npmts.plugins')
import plugins = require("./npmts.plugins"); import {Ora} from 'beautylog'
import {Ora} from "beautylog"
export let npmtsOra = new plugins.beautylog.Ora("setting up TaskChain","cyan"); import * as q from 'q'
import NpmtsAssets = require("./npmts.assets"); export let npmtsOra = new Ora('setting up TaskChain','cyan')
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){ import * as NpmtsAssets from './npmts.assets'
let done = plugins.Q.defer(); import * as NpmtsCheck from './npmts.check'
npmtsOra.start(); import * as NpmtsClean from './npmts.clean'
import * as NpmtsCompile from './npmts.compile'
import * as NpmtsTypeDoc from './npmts.typedoc'
import * as NpmtsOptions from './npmts.options'
import * as NpmtsTests from './npmts.tests'
import * as NpmtsWatch from './npmts.watch'
export let run = function(argvArg){
let done = q.defer()
npmtsOra.start()
NpmtsOptions.run(argvArg) NpmtsOptions.run(argvArg)
.then(NpmtsClean.run) .then(NpmtsClean.run)
.then(NpmtsCheck.run) .then(NpmtsCheck.run)
@ -22,28 +24,29 @@ export let promisechain = function(argvArg){
.then(NpmtsAssets.run) .then(NpmtsAssets.run)
.then(NpmtsTypeDoc.run) .then(NpmtsTypeDoc.run)
.then(NpmtsTests.run) .then(NpmtsTests.run)
.then(NpmtsWatch.run)
.then(function(configArg){ .then(function(configArg){
let shipString = "" + let shipString = '' +
"\n" + '\n' +
"\n" + '\n' +
" # # ( )\n" + ' # # ( )\n' +
" ___#_#___|__\n" + ' ___#_#___|__\n' +
" _ |____________| _\n" + ' _ |____________| _\n' +
" _=====| | | | | |==== _\n" + ' _=====| | | | | |==== _\n' +
" =====| |.---------------------------. | |====\n" + ' =====| |.---------------------------. | |====\n' +
" <--------------------' . . . . . . . . '--------------/\n" + " <--------------------' . . . . . . . . '--------------/\n" +
" \\ /\n" + ' \\ /\n' +
" \\___________________________________________________________/\n" + ' \\___________________________________________________________/\n' +
" wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n" + ' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
" wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n" + ' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
" wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n" ' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n'
if (process.env.CI){ if (process.env.CI) {
console.log(shipString); console.log(shipString)
plugins.beautylog.success("READY TO SHIP!"); plugins.beautylog.success('READY TO SHIP!')
} else { } else {
plugins.beautylog.success("Done!"); plugins.beautylog.success('Done!')
} }
done.resolve(); done.resolve(configArg)
}); })
return done.promise; return done.promise
}; }

View File

@ -1,87 +1,101 @@
import "typings-global"; import plugins = require('./npmts.plugins')
import plugins = require("./npmts.plugins"); import paths = require('./npmts.paths')
import paths = require("./npmts.paths");
import {npmtsOra} from "./npmts.promisechain"; import * as q from 'q'
import { npmtsOra } from './npmts.promisechain'
import { INpmtsConfig } from './npmts.options'
/** /**
* * runs mocha
* @returns {*} * @returns INpmtsConfig
*/ */
let mocha = function (configArg) { let mocha = function (configArg: INpmtsConfig) {
npmtsOra.text("Instrumentalizing and testing transpiled JS"); npmtsOra.text('Instrumentalizing and testing transpiled JS')
npmtsOra.end(); // end npmtsOra for tests. npmtsOra.end() // end npmtsOra for tests.
let done = plugins.Q.defer(); let done = q.defer()
var stream = plugins.gulp.src([plugins.path.join(paths.cwd,"dist/*.js")]) plugins.gulp.src([plugins.path.join(paths.cwd, 'dist/*.js')])
.pipe(plugins.g.sourcemaps.init()) .pipe(plugins.g.sourcemaps.init())
.pipe(plugins.g.babel({ .pipe(plugins.g.babel({
presets: [ presets: [
require.resolve("babel-preset-es2015") require.resolve('babel-preset-es2015')
] ]
})) }))
.pipe(plugins.g.istanbul({ .pipe(plugins.g.istanbul({
})) }))
.pipe(plugins.g.sourcemaps.write()) .pipe(plugins.g.sourcemaps.write())
.pipe(plugins.g.injectModules()) .pipe(plugins.g.injectModules())
.on("finish",function(){ .on('finish', function () {
plugins.gulp.src([plugins.path.join(paths.cwd,"test/test.js")]) let localSmartstream = new plugins.smartstream.Smartstream([
.pipe(plugins.g.babel({ plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')]),
presets: [ plugins.g.babel({
require.resolve("babel-preset-es2015") presets: [
] require.resolve('babel-preset-es2015')
})) ]
.pipe(plugins.g.injectModules()) }),
.pipe(plugins.g.mocha()) plugins.g.injectModules(),
.pipe(plugins.g.istanbul.writeReports({ plugins.g.mocha(),
dir: plugins.path.join(paths.cwd,"./coverage"), plugins.g.istanbul.writeReports({
reporters: [ 'lcovonly', 'json', 'text', 'text-summary'] 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); localSmartstream.run()
},"atEnd")); .then(() => { done.resolve(configArg) }, (err) => {
}); plugins.beautylog.error('Tests failed!')
return done.promise; if (configArg.watch) {
}; done.resolve(configArg)
} else {
process.exit(1)
}
})
})
return done.promise
}
let coverage = function(configArg){ let coverage = function (configArg: INpmtsConfig) {
let done = plugins.Q.defer(); let done = q.defer()
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir,"lcov.info"),2) plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, 'lcov.info'), 2)
.then(function(percentageArg){ .then(function (percentageArg) {
if (percentageArg >= configArg.coverageTreshold){ if (percentageArg >= configArg.coverageTreshold) {
plugins.beautylog.ok( plugins.beautylog.ok(
`${percentageArg.toString()}% coverage exceeds your treshold of ${configArg.coverageTreshold.toString()}%` `${percentageArg.toString()}% `
); + `coverage exceeds your treshold of `
+ `${configArg.coverageTreshold.toString()}%`
)
} else { } else {
plugins.beautylog.warn( plugins.beautylog.warn(
`${percentageArg.toString()}% coverage fails your treshold of ${configArg.coverageTreshold.toString()}%` `${percentageArg.toString()}% `
); + `coverage fails your treshold of `
plugins.beautylog.error("exiting due to coverage failure"); + `${configArg.coverageTreshold.toString()}%`
process.exit(1); )
plugins.beautylog.error('exiting due to coverage failure')
if (!configArg.watch) { process.exit(1) }
} }
done.resolve(configArg); done.resolve(configArg)
}); })
return done.promise; return done.promise
}; }
export let run = function(configArg) { export let run = function (configArg: INpmtsConfig) {
let done = plugins.Q.defer(); let done = q.defer()
let config = configArg; let config = configArg
if(config.test === true){ if (config.test === true) {
npmtsOra.text("now starting tests"); npmtsOra.text('now starting tests')
plugins.beautylog.log( plugins.beautylog.log(
"-------------------------------------------------------\n" + '-------------------------------------------------------\n' +
"*************************** TESTS: ***************************\n" + '*************************** TESTS: ***************************\n' +
"--------------------------------------------------------------" '--------------------------------------------------------------'
); )
mocha(config) mocha(config)
.then(coverage) .then(coverage)
.then(() => { .then(() => {
done.resolve(config); done.resolve(config)
}); })
} else { } else {
npmtsOra.end(); npmtsOra.end()
done.resolve(config); done.resolve(config)
} }
return done.promise; return done.promise
}; }

View File

@ -1,44 +1,46 @@
import "typings-global"; import plugins = require('./npmts.plugins')
import plugins = require("./npmts.plugins"); import paths = require('./npmts.paths')
import paths = require("./npmts.paths"); import { npmtsOra } from './npmts.promisechain'
import { npmtsOra } from "./npmts.promisechain";
import * as q from 'q'
import { projectInfo } from './npmts.check'
let genTypeDoc = function (configArg) { let genTypeDoc = function (configArg) {
let done = plugins.Q.defer(); let done = q.defer()
npmtsOra.text("now generating " + "TypeDoc documentation".yellow); npmtsOra.text('now generating ' + 'TypeDoc documentation'.yellow)
plugins.beautylog.log("TypeDoc Output:"); plugins.beautylog.log('TypeDoc Output:')
plugins.gulp.src(plugins.path.join(paths.tsDir, "**/*.ts")) plugins.gulp.src(plugins.path.join(paths.tsDir, '**/*.ts'))
.pipe(plugins.g.typedoc({ .pipe(plugins.g.typedoc({
// TypeScript options (see typescript docs) // TypeScript options (see typescript docs)
module: "commonjs", module: 'commonjs',
target: "es6", target: 'es6',
includeDeclarations: true, includeDeclarations: true,
// Output options (see typedoc docs) // Output options (see typedoc docs)
out: paths.pagesApiDir, out: paths.pagesApiDir,
json: plugins.path.join(paths.pagesApiDir, "file.json"), json: plugins.path.join(paths.pagesApiDir, 'file.json'),
// TypeDoc options (see typedoc docs) // TypeDoc options (see typedoc docs)
name: "my-project", name: projectInfo.name,
readme: plugins.path.join(paths.cwd, 'README.md'),
//theme: "default", // theme: "default",
ignoreCompilerErrors: true, ignoreCompilerErrors: true,
version: true, version: true
})) }))
.pipe(plugins.g.gFunction(done.resolve, "atEnd")); .pipe(plugins.g.gFunction(done.resolve, 'atEnd'))
return done.promise; return done.promise
}; }
export let run = function (configArg) { export let run = function (configArg) {
let done = plugins.Q.defer(); let done = q.defer()
if (configArg.docs) { if (configArg.docs) {
genTypeDoc(configArg) genTypeDoc(configArg)
.then(() => { .then(() => {
done.resolve(configArg); done.resolve(configArg)
}); })
} else { } else {
done.resolve(configArg); done.resolve(configArg)
}; };
return done.promise; return done.promise
}; }

32
ts/npmts.watch.ts Normal file
View File

@ -0,0 +1,32 @@
import * as plugins from './npmts.plugins'
import * as promisechain from './npmts.promisechain'
import * as q from 'q'
import { INpmtsConfig } from './npmts.options'
let npmtsSmartchok: plugins.smartchok.Smartchok = null
export let run = (configArg: INpmtsConfig) => {
let done = q.defer()
if (configArg.watch && npmtsSmartchok === null) {
let pathsToWatch: string[] = []
for (let key in configArg.ts) {
pathsToWatch.push(key)
}
for (let key in configArg.testTs) {
pathsToWatch.push(key)
}
npmtsSmartchok = new plugins.smartchok.Smartchok(pathsToWatch)
npmtsSmartchok.getObservableFor('change').then((changeObservableArg) => {
plugins.beautylog.info('now watching...')
changeObservableArg.subscribe(() => {
promisechain.run(configArg)
})
})
npmtsSmartchok.start()
done.resolve(configArg)
} else {
done.resolve(configArg)
}
return done.promise
}

View File

@ -2,7 +2,12 @@
"compilerOptions": { "compilerOptions": {
"declaration": true, "declaration": true,
"module": "commonjs", "module": "commonjs",
"target": "ES5", "target": "ES6",
"outDir": "./dist/" "outDir": "./dist/"
} },
"exclude": [
"./node_modules",
"./test",
"./dist"
]
} }

3
tslint.json Normal file
View File

@ -0,0 +1,3 @@
{
"extends": "tslint-config-standard"
}