Compare commits

...

45 Commits

Author SHA1 Message Date
372d2605bb 5.3.25 2016-07-19 20:31:56 +02:00
2ecf6c00b8 fix assets management 2016-07-19 20:31:49 +02:00
2f3d8cecd3 improve README 2016-07-19 00:28:18 +02:00
54bbab232e 5.3.24 2016-07-19 00:25:37 +02:00
380407b5e8 improve README 2016-07-19 00:25:31 +02:00
2a5583946c 5.3.23 2016-07-18 19:06:04 +02:00
80e36a34ee now using initial cwd for writing coverage reports 2016-07-18 19:06:00 +02:00
1f90f4abff 5.3.22 2016-07-17 17:13:53 +02:00
3c7f5f1e2d now using npmextra 2016-07-17 17:13:47 +02:00
8104609306 5.3.21 2016-07-16 23:33:14 +02:00
a3077f7800 improve README 2016-07-16 23:33:10 +02:00
c947121243 5.3.20 2016-07-16 20:54:57 +02:00
4b3f0649fa now much faster due to skipping html coverage report 2016-07-16 20:54:52 +02:00
523c62530f 5.3.19 2016-07-16 20:14:47 +02:00
aa57617fc7 another fix 2016-07-16 20:14:43 +02:00
ef89a33dfc 5.3.18 2016-07-16 19:23:37 +02:00
474a730a09 another fix 2016-07-16 19:23:34 +02:00
e3b029c240 5.3.17 2016-07-16 19:08:23 +02:00
290824190d fix dependency 2016-07-16 19:08:20 +02:00
923d78caab 5.3.16 2016-07-16 19:05:17 +02:00
6587b74a23 now using better babel config 2016-07-16 19:05:12 +02:00
aa0a35f258 5.3.15 2016-07-15 19:27:56 +02:00
09b8809ede fix test 2016-07-15 19:27:53 +02:00
e25566490b 5.3.14 2016-07-15 18:18:14 +02:00
3ed7473066 fix istanbul 2016-07-15 18:18:11 +02:00
1202a68b01 5.3.13 2016-07-15 12:22:29 +02:00
c67d43e16d prevent typedoc from causing build fail 2016-07-15 12:22:19 +02:00
df74769533 5.3.12 2016-07-15 11:52:00 +02:00
5aef714497 now fully ES6 2016-07-15 11:51:55 +02:00
24701afcb2 now using typedoc 2016-07-15 00:38:41 +02:00
cbfbd4ee67 restructure 2016-07-14 13:21:07 +02:00
6df449394d 5.3.11 2016-07-14 13:08:48 +02:00
27b6119bbb improve README 2016-07-14 13:08:43 +02:00
b22abef889 5.3.10 2016-07-14 13:04:11 +02:00
4d8a7a4202 Merge branch 'master' of gitlab.com:pushrocks/npmts 2016-07-14 13:03:54 +02:00
72bc08e973 5.3.9 2016-07-14 13:03:09 +02:00
430f636ae4 now using EsDoc, closes #2 2016-07-14 13:02:58 +02:00
bbc8f13ecf update docker link in README 2016-07-11 15:50:39 +02:00
a01f07f62c improve README 2016-07-11 14:46:31 +02:00
36316e63b2 5.3.9 2016-07-11 14:42:43 +02:00
5c5e88c226 further improve README 2016-07-11 14:42:36 +02:00
af968f65df update README 2016-07-11 13:46:44 +02:00
f0cc2f4cd6 5.3.8 2016-07-08 04:00:56 +02:00
f167226830 update sourcemap handling 2016-07-08 04:00:52 +02:00
3e49b365b6 small fix 2016-07-01 05:58:51 +02:00
24 changed files with 272 additions and 270 deletions

View File

@ -45,17 +45,3 @@ trigger:
- tags - tags
tags: tags:
- docker - docker
pages:
stage: page
script:
- npmci test lts
- mkdir .public
- cp -r test/assets/docs/ .public
- cp -r test/assets/coverage/ .public
- mv .public public
artifacts:
paths:
- public
only:
- tags

View File

@ -1,9 +1,8 @@
# npmts # npmts
Write npm modules with TypeScript without hassle. Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
## Status ## Status
[![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)
[![Build status](https://ci.appveyor.com/api/projects/status/22fuqa0uv21rcjh4/branch/master?svg=true)](https://ci.appveyor.com/project/philkunz/npmts/branch/master)
[![Dependency Status](https://david-dm.org/pushrocks/npmts.svg)](https://david-dm.org/pushrocks/npmts) [![Dependency Status](https://david-dm.org/pushrocks/npmts.svg)](https://david-dm.org/pushrocks/npmts)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmts/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm) [![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmts/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
[![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)
@ -14,10 +13,13 @@ NPMTS is your friend when it comes to write, test, publish and document NPM modu
By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works. 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: There is a docker image available that includes npmts to make CI a breeze:
[hosttoday/ht-docker-npmg on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-npmg/) [hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
### Install ### Install
First install npmts globally, then install the npmts checker: 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 ```sh
npm install npmts -g # installs npmts globally npm install npmts -g # installs npmts globally
@ -28,77 +30,50 @@ Then add it to your package.json's script section to trigger a build:
```json ```json
"scripts": { "scripts": {
"test": "npmts" "test": "(npmts)"
} }
``` ```
### Default task execution order ### Default task execution order
1. Check config in ./npmts.json 1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
1. Clean up from any previous builds (old js files) 1. **Clean:** Clean up from any previous builds (old js files)
1. Install typings 1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES6
1. Transpile TypeScript with **inline sourcemaps** and **declaration files** 1. **Documentation:** Create TypeDoc Documentation from TypeScript files
1. Create JsDoc Documentation 1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
1. Instrumentalize created JavaScript files with istanbul
1. Run Tests
1. Create Coverage report
#### npmts.json ### npmextra.json
the npmts.json is the main config file. You can use it to customize the behaviour of NPMTS. the npmts section in npmtsextra.json can be used to configure npmts.
```json ```json
{ {
"npmts":{
"mode":"default", "mode":"default",
"codecov":{
"publish":true,
"token":"sometoken"
},
"ts":{ "ts":{
"./customdir/*.ts":"./" "./customdir/*.ts":"./"
}, },
"docs": {
"publish":true,
"destination":"github"
},
"tsOptions":{ "tsOptions":{
"declaration":false, "declaration":false,
"target":"ES6" "target":"ES6"
}, },
"typings":[
"./ts/typings.json",
"./subts1/typings.json",
"./subts2/typings.json",
"./customdir/typings.json"
],
"typingsInclude":"auto",
"cli":true "cli":true
}
} }
``` ```
| key | default value | description | | key | default value | description |
| --- | --- | --- | | --- | --- | --- |
| `"codecov"` | `true` | if true, coverage data will be uploaded to codecov when running on travis | | `"mode"` | `"default"` | "default" will do some default stuff, "custom" only does what you specify |
| `"docs"` | `{"publish":"false"}` | `{"publish":true, destination:"github"}` lets you control what happens with your module documentation |
| `"mode"` | `"default"` | "default" will do some defualt stuff, "custom" only does what you specify |
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc | | `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
| `"typings"` | `["./ts/typings.json"]` | allows you to specify multiple locations for typings.json to install. This is needed for modules that do not yet bundle typings |
| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. | | `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
#### Typings ### TypeScript
**npmts** looks for `./ts/typings.json` by default and installs any defined typings to `.ts/typings/`.
> Note: You can reference the typings files in any of your TypeScript code with a
`/// <reference path="/some/path/main.d.ts">`
We are currently working on a "typingsInclude" option, that will autoload any typings during compilation.
tsconfig is NOT supported, since it would render this module useless
#### TypeScript
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
`./dist/*.js` and `./test/test.js` `./dist/*.js` and `./test/test.js`
Use commonjs module system for wiring up files. Use commonjs module system for wiring up files.
#### Declaration files ### Declaration files
**npmts** also creates an `./dist/index.d.ts` declaration file by default. **npmts** also creates an `./dist/index.d.ts` declaration file by default.
You can reference it in your package.json like this. You can reference it in your package.json like this.
@ -111,29 +86,28 @@ This is in line with the latest TypeScript best practices.
You can then import plugins via the TypeScript `import` Syntax You can then import plugins via the TypeScript `import` Syntax
and tsc will pick up the declaration file automatically. and tsc will pick up the declaration file automatically.
> Note: If you don't want declaration files, set tsOptions.declaration to false in npmts.json ## Some notes:
#### Typings for third party modules that do not bundle declaration files
NPMTS does no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
#### Instrumentalize Code #### Instrumentalize Code
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report. npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
#### Tests #### Tests
When Typings have been installed, TypeScript + Declaration files have been transpiled and the resulting JS has been instrumentalized,
npmts looks for `.test/test.ts` which will be transpiled to test.js and run with mocha.
Any errors will be shown with reference to their originating source in TypeScript Any errors will be shown with reference to their originating source in TypeScript
thanks to autogenerated source maps. thanks to autogenerated source maps.
## Example Usage in modules: ## Example Usage in modules:
* [gulp-typings](https://www.npmjs.com/package/gulp-typings) * [gulp-browser](https://www.npmjs.com/package/gulp-browser)
* [gulp-browser](https://www.npmjs.com/package/gulp-typings)
> We will add more options over time. > We will add more options over time.
## Tips and tricks: ## 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 [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available.
* Use [npmpage](https://www.npmjs.com/package/npmtspage) to create a webpage from coverage reports and JsDocs for the module * Use [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 [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.
## About the authors: ## About the authors:
[![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/) [![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)

View File

@ -8,11 +8,12 @@ exports.run = function (configArg) {
var config = configArg; var 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.copy(plugins.path.join(paths.npmtsAssetsDir, "cli.js"), paths.distDir); 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!");
done.resolve(config); done.resolve(config);
} }
return done.promise; return done.promise;

1
dist/npmts.cli.d.ts vendored
View File

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

2
dist/npmts.cli.js vendored
View File

@ -1,2 +0,0 @@
"use strict";
require("typings-global");

View File

@ -9,7 +9,7 @@ var compileTs = function (tsFileArrayArg, tsOptionsArg) {
var done = plugins.Q.defer(); var done = plugins.Q.defer();
var tsOptionsDefault = { var tsOptionsDefault = {
declaration: true, declaration: true,
target: "ES5", target: "ES6",
module: "commonjs" module: "commonjs"
}; };
/** /**

View File

@ -2,16 +2,23 @@
require("typings-global"); require("typings-global");
var plugins = require("./npmts.plugins"); var plugins = require("./npmts.plugins");
var paths = require("./npmts.paths"); var paths = require("./npmts.paths");
var npmts_promisechain_1 = require("./npmts.promisechain");
exports.run = function (argvArg) { exports.run = function (argvArg) {
var done = plugins.Q.defer(); var done = plugins.Q.defer();
var config = {}; npmts_promisechain_1.npmtsOra.text("looking for npmextra.json");
var configPath = plugins.path.join(paths.cwd, "npmts.json"); var defaultConfig = {
mode: "default",
notest: false
};
if (argvArg.notest) { if (argvArg.notest) {
config.notest = true; defaultConfig.notest = true;
} }
if (plugins.smartfile.fs.fileExistsSync(configPath)) { ;
plugins.beautylog.info("npmts.json".blue + " config file found!"); var config = plugins.npmextra.dataFor({
config = plugins.lodashObject.assign(config, plugins.smartfile.fs.toObjectSync(configPath)); toolName: "npmts",
defaultSettings: defaultConfig,
cwd: paths.cwd
});
switch (config.mode) { switch (config.mode) {
case "default": case "default":
case "custom": case "custom":
@ -23,12 +30,6 @@ exports.run = function (argvArg) {
process.exit(1); process.exit(1);
} }
; ;
}
else {
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
config.mode = "default";
done.resolve(config); done.resolve(config);
}
;
return done.promise; return done.promise;
}; };

28
dist/npmts.jsdoc.js vendored
View File

@ -1,28 +0,0 @@
"use strict";
require("typings-global");
var plugins = require("./npmts.plugins");
var paths = require("./npmts.paths");
var npmts_promisechain_1 = require("./npmts.promisechain");
var genJsdoc = function (configArg) {
var done = plugins.Q.defer();
npmts_promisechain_1.npmtsOra.text("now generating " + "JsDoc documentation".yellow);
plugins.gulp.src([
plugins.path.join(paths.cwd, "README.md"),
plugins.path.join(paths.distDir, "**/*.js")
])
.pipe(plugins.g.jsdoc3({
opts: {
destination: paths.docsDir
}
}, function () {
plugins.beautylog.ok("JsDoc documentation has been generated!");
done.resolve(configArg);
}));
return done.promise;
};
exports.run = function (configArg) {
var done = plugins.Q.defer();
genJsdoc(configArg)
.then(done.resolve);
return done.promise;
};

View File

@ -2,14 +2,17 @@ import "typings-global";
export import beautylog = require("beautylog"); export import beautylog = require("beautylog");
export declare let gulp: any; export declare let gulp: any;
export declare let g: { export declare let g: {
gFunction: any; babel: any;
istanbul: any; istanbul: any;
jsdoc3: any; gFunction: any;
injectModules: any;
mocha: any; mocha: any;
replace: any; replace: any;
sourcemaps: any;
typedoc: any;
}; };
export declare let lodashObject: any; export declare let lodashObject: any;
export declare let merge2: any; export import npmextra = require("npmextra");
export import projectinfo = require("projectinfo"); export import projectinfo = require("projectinfo");
export import path = require("path"); export import path = require("path");
export import Q = require("q"); export import Q = require("q");
@ -22,4 +25,4 @@ export import smartfile = require("smartfile");
export import smartpath = require("smartpath"); export import smartpath = require("smartpath");
export import smartstring = require("smartstring"); export import smartstring = require("smartstring");
export declare let sourceMapSupport: any; export declare let sourceMapSupport: any;
export declare let tsn: any; export import tsn = require("tsn");

11
dist/npmts.plugins.js vendored
View File

@ -3,14 +3,17 @@ require("typings-global");
exports.beautylog = require("beautylog"); exports.beautylog = require("beautylog");
exports.gulp = require("gulp"); exports.gulp = require("gulp");
exports.g = { exports.g = {
gFunction: require("gulp-function"), babel: require("gulp-babel"),
istanbul: require("gulp-istanbul"), istanbul: require("gulp-istanbul"),
jsdoc3: require("gulp-jsdoc3"), gFunction: require("gulp-function"),
injectModules: require("gulp-inject-modules"),
mocha: require("gulp-mocha"), mocha: require("gulp-mocha"),
replace: require("gulp-replace") replace: require("gulp-replace"),
sourcemaps: require("gulp-sourcemaps"),
typedoc: require("gulp-typedoc")
}; };
exports.lodashObject = require('lodash/fp/object'); exports.lodashObject = require('lodash/fp/object');
exports.merge2 = require("merge2"); exports.npmextra = require("npmextra");
exports.projectinfo = require("projectinfo"); exports.projectinfo = require("projectinfo");
exports.path = require("path"); exports.path = require("path");
exports.Q = require("q"); exports.Q = require("q");

View File

@ -6,7 +6,7 @@ var NpmtsAssets = require("./npmts.assets");
var NpmtsClean = require("./npmts.clean"); var NpmtsClean = require("./npmts.clean");
var NpmtsCompile = require("./npmts.compile"); var NpmtsCompile = require("./npmts.compile");
var NpmtsConfigFile = require("./npmts.configfile"); var NpmtsConfigFile = require("./npmts.configfile");
var NpmtsJsdoc = require("./npmts.jsdoc"); var NpmtsTypeDoc = require("./npmts.typedoc");
var NpmtsOptions = require("./npmts.options"); var NpmtsOptions = require("./npmts.options");
var NpmtsTests = require("./npmts.tests"); var NpmtsTests = require("./npmts.tests");
exports.promisechain = function (argvArg) { exports.promisechain = function (argvArg) {
@ -17,7 +17,7 @@ exports.promisechain = function (argvArg) {
.then(NpmtsClean.run) .then(NpmtsClean.run)
.then(NpmtsCompile.run) .then(NpmtsCompile.run)
.then(NpmtsAssets.run) .then(NpmtsAssets.run)
.then(NpmtsJsdoc.run) .then(NpmtsTypeDoc.run)
.then(NpmtsTests.run) .then(NpmtsTests.run)
.then(function (configArg) { .then(function (configArg) {
var shipString = "" + var shipString = "" +

49
dist/npmts.tests.js vendored
View File

@ -7,32 +7,38 @@ var npmts_promisechain_1 = require("./npmts.promisechain");
* *
* @returns {*} * @returns {*}
*/ */
var istanbul = function (configArg) { var mocha = function (configArg) {
npmts_promisechain_1.npmtsOra.text("Instrumentalizing transpiled JS..."); npmts_promisechain_1.npmtsOra.text("Instrumentalizing and testing transpiled JS");
npmts_promisechain_1.npmtsOra.end(); // end npmtsOra for tests.
var done = plugins.Q.defer(); var done = plugins.Q.defer();
var stream = plugins.gulp.src([plugins.path.join(paths.cwd, "dist/*.js")]) var stream = plugins.gulp.src([plugins.path.join(paths.cwd, "dist/*.js")])
.pipe(plugins.g.istanbul()) // Covering files .pipe(plugins.g.sourcemaps.init())
.pipe(plugins.g.istanbul.hookRequire()) // Force `require` to return covered files .pipe(plugins.g.babel({
.pipe(plugins.g.gFunction(function () { presets: [
plugins.beautylog.ok("JS has been instrumentalized to get test code coverage!"); require.resolve("babel-preset-es2015")
done.resolve(configArg); ]
}, "atEnd")); }))
return done.promise; .pipe(plugins.g.istanbul({}))
}; .pipe(plugins.g.sourcemaps.write())
/** .pipe(plugins.g.injectModules())
* .on("finish", function () {
* @returns {*} plugins.gulp.src([plugins.path.join(paths.cwd, "test/test.js")])
*/ .pipe(plugins.g.babel({
var mocha = function (configArg) { presets: [
var done = plugins.Q.defer(); plugins.path.join(paths.npmtsPackageRoot, "node_modules/babel-preset-es2015/index.js")
npmts_promisechain_1.npmtsOra.end(); // end npmtsOra for tests. ]
var stream = plugins.gulp.src(["./test/test.js"]) }))
.pipe(plugins.g.injectModules())
.pipe(plugins.g.mocha()) .pipe(plugins.g.mocha())
.pipe(plugins.g.istanbul.writeReports()) // Creating the reports after tests ran .pipe(plugins.g.istanbul.writeReports({
dir: plugins.path.join(paths.cwd, "./coverage"),
reporters: ['lcovonly', 'json', 'text', 'text-summary']
}))
.pipe(plugins.g.gFunction(function () { .pipe(plugins.g.gFunction(function () {
plugins.beautylog.ok("Tests have passed!"); plugins.beautylog.ok("Tested!");
done.resolve(configArg); done.resolve(configArg);
}, "atEnd")); }, "atEnd"));
});
return done.promise; return done.promise;
}; };
var coverage = function (configArg) { var coverage = function (configArg) {
@ -61,8 +67,7 @@ exports.run = function (configArg) {
plugins.beautylog.log("-------------------------------------------------------\n" + plugins.beautylog.log("-------------------------------------------------------\n" +
"*************************** TESTS: ***************************\n" + "*************************** TESTS: ***************************\n" +
"--------------------------------------------------------------"); "--------------------------------------------------------------");
istanbul(config) mocha(config)
.then(mocha)
.then(coverage) .then(coverage)
.then(function () { .then(function () {
done.resolve(config); done.resolve(config);

35
dist/npmts.typedoc.js vendored Normal file
View File

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

View File

@ -1,7 +1,7 @@
{ {
"name": "npmts", "name": "npmts",
"version": "5.3.7", "version": "5.3.25",
"description": "write npm modules with TypeScript", "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"
@ -29,21 +29,25 @@
}, },
"homepage": "https://gitlab.com/pushrocks/npmts#readme", "homepage": "https://gitlab.com/pushrocks/npmts#readme",
"dependencies": { "dependencies": {
"@types/minimatch": "^2.0.22-alpha", "@types/minimatch": "^2.0.28",
"@types/q": "0.0.21-alpha", "@types/q": "^0.0.27",
"@types/shelljs": "^0.3.21-alpha", "@types/shelljs": "^0.3.27",
"beautylog": "5.0.12", "babel-preset-es2015": "^6.9.0",
"beautylog": "5.0.14",
"early": "^2.0.13", "early": "^2.0.13",
"gulp": "3.9.1", "gulp": "3.9.1",
"gulp-babel": "^6.1.2",
"gulp-concat": "^2.6.0", "gulp-concat": "^2.6.0",
"gulp-function": "^1.3.6", "gulp-function": "^1.3.6",
"gulp-if": "^2.0.1", "gulp-if": "^2.0.1",
"gulp-inject-modules": "^1.0.0",
"gulp-istanbul": "^1.0.0", "gulp-istanbul": "^1.0.0",
"gulp-jsdoc3": "^0.3.0",
"gulp-mocha": "^2.2.0", "gulp-mocha": "^2.2.0",
"gulp-replace": "^0.5.4", "gulp-replace": "^0.5.4",
"gulp-sourcemaps": "^1.6.0",
"gulp-typedoc": "^2.0.0",
"lodash": "^4.13.1", "lodash": "^4.13.1",
"merge2": "1.0.2", "npmextra": "^1.0.7",
"projectinfo": "1.0.3", "projectinfo": "1.0.3",
"q": "^1.4.1", "q": "^1.4.1",
"shelljs": "^0.7.0", "shelljs": "^0.7.0",
@ -53,9 +57,10 @@
"smartenv": "1.2.5", "smartenv": "1.2.5",
"smartfile": "4.0.10", "smartfile": "4.0.10",
"smartpath": "3.2.2", "smartpath": "3.2.2",
"smartstring": "^2.0.10", "smartstring": "^2.0.14",
"source-map-support": "^0.4.1", "source-map-support": "^0.4.2",
"tsn": "^1.0.4", "tsn": "^1.0.7",
"typedoc": "^0.4.4",
"typescript": "^2.0.0-dev.20160630", "typescript": "^2.0.0-dev.20160630",
"typings-global": "*" "typings-global": "*"
}, },

View File

@ -8,10 +8,14 @@ export var run = function(configArg){
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.copy(plugins.path.join(paths.npmtsAssetsDir,"cli.js"),paths.distDir); 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!")
done.resolve(config); done.resolve(config);
} }
return done.promise; return done.promise;

View File

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

View File

@ -10,7 +10,7 @@ let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => {
let tsOptionsDefault = { let tsOptionsDefault = {
declaration: true, declaration: true,
target: "ES5", target: "ES6",
module: "commonjs" module: "commonjs"
}; };

View File

@ -1,19 +1,22 @@
import "typings-global"; 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 var run = function(argvArg){ export var run = function(argvArg){
var done = plugins.Q.defer(); let done = plugins.Q.defer();
var config:any = {}; npmtsOra.text("looking for npmextra.json");
var configPath = plugins.path.join(paths.cwd,"npmts.json"); let defaultConfig = {
mode: "default",
notest:false
};
if(argvArg.notest){ if(argvArg.notest){
config.notest = true; defaultConfig.notest = true;
} };
if(plugins.smartfile.fs.fileExistsSync(configPath)){ let config = plugins.npmextra.dataFor({
plugins.beautylog.info("npmts.json".blue + " config file found!"); toolName:"npmts",
config = plugins.lodashObject.assign( defaultSettings:defaultConfig,
config, cwd:paths.cwd
plugins.smartfile.fs.toObjectSync(configPath) });
);
switch (config.mode){ switch (config.mode){
case "default": case "default":
case "custom": case "custom":
@ -24,10 +27,6 @@ export var run = function(argvArg){
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red); plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
process.exit(1); process.exit(1);
}; };
} else {
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
config.mode = "default";
done.resolve(config); done.resolve(config);
};
return done.promise; return done.promise;
}; };

View File

@ -1,30 +0,0 @@
import "typings-global";
import plugins = require("./npmts.plugins");
import paths = require("./npmts.paths");
import {npmtsOra} from "./npmts.promisechain";
let genJsdoc = function(configArg){
let done = plugins.Q.defer();
npmtsOra.text("now generating " + "JsDoc documentation".yellow);
plugins.gulp.src([
plugins.path.join(paths.cwd,"README.md"),
plugins.path.join(paths.distDir,"**/*.js")
])
.pipe(plugins.g.jsdoc3({
opts: {
destination: paths.docsDir
}
}, function(){
plugins.beautylog.ok("JsDoc documentation has been generated!");
done.resolve(configArg)
}));
return done.promise;
};
export let run = function(configArg){
let done = plugins.Q.defer();
genJsdoc(configArg)
.then(done.resolve);
return done.promise;
};

View File

@ -2,14 +2,17 @@ import "typings-global";
export import beautylog = require("beautylog"); export import beautylog = require("beautylog");
export let gulp = require("gulp"); export let gulp = require("gulp");
export let g = { export let g = {
gFunction: require("gulp-function"), babel: require("gulp-babel"),
istanbul: require("gulp-istanbul"), istanbul: require("gulp-istanbul"),
jsdoc3: require("gulp-jsdoc3"), gFunction: require("gulp-function"),
injectModules: require("gulp-inject-modules"),
mocha: require("gulp-mocha"), mocha: require("gulp-mocha"),
replace: require("gulp-replace") replace: require("gulp-replace"),
sourcemaps: require("gulp-sourcemaps"),
typedoc: require("gulp-typedoc")
}; };
export let lodashObject = require('lodash/fp/object'); export let lodashObject = require('lodash/fp/object');
export let merge2 = require("merge2"); export import npmextra = require("npmextra");
export import projectinfo = require("projectinfo"); export import projectinfo = require("projectinfo");
export import path = require("path"); export import path = require("path");
export import Q = require("q"); export import Q = require("q");
@ -22,4 +25,4 @@ export import smartfile = require("smartfile");
export import smartpath = require("smartpath"); export import smartpath = require("smartpath");
export import smartstring = require("smartstring"); export import smartstring = require("smartstring");
export let sourceMapSupport = require("source-map-support").install(); // this is required to display errors correctly during testing export let sourceMapSupport = require("source-map-support").install(); // this is required to display errors correctly during testing
export let tsn = require("tsn"); export import tsn = require("tsn");

View File

@ -8,7 +8,7 @@ import NpmtsAssets = require("./npmts.assets");
import NpmtsClean = require("./npmts.clean"); import NpmtsClean = require("./npmts.clean");
import NpmtsCompile = require("./npmts.compile"); import NpmtsCompile = require("./npmts.compile");
import NpmtsConfigFile = require("./npmts.configfile"); import NpmtsConfigFile = require("./npmts.configfile");
import NpmtsJsdoc = require("./npmts.jsdoc"); import NpmtsTypeDoc = require("./npmts.typedoc");
import NpmtsOptions = require("./npmts.options"); import NpmtsOptions = require("./npmts.options");
import NpmtsTests = require("./npmts.tests"); import NpmtsTests = require("./npmts.tests");
@ -20,7 +20,7 @@ export let promisechain = function(argvArg){
.then(NpmtsClean.run) .then(NpmtsClean.run)
.then(NpmtsCompile.run) .then(NpmtsCompile.run)
.then(NpmtsAssets.run) .then(NpmtsAssets.run)
.then(NpmtsJsdoc.run) .then(NpmtsTypeDoc.run)
.then(NpmtsTests.run) .then(NpmtsTests.run)
.then(function(configArg){ .then(function(configArg){
let shipString = "" + let shipString = "" +

View File

@ -7,33 +7,39 @@ import {npmtsOra} from "./npmts.promisechain";
* *
* @returns {*} * @returns {*}
*/ */
let istanbul = function (configArg) { let mocha = function (configArg) {
npmtsOra.text("Instrumentalizing transpiled JS..."); npmtsOra.text("Instrumentalizing and testing transpiled JS");
npmtsOra.end(); // end npmtsOra for tests.
let done = plugins.Q.defer(); let done = plugins.Q.defer();
var stream = plugins.gulp.src([plugins.path.join(paths.cwd,"dist/*.js")]) var stream = plugins.gulp.src([plugins.path.join(paths.cwd,"dist/*.js")])
.pipe(plugins.g.istanbul()) // Covering files .pipe(plugins.g.sourcemaps.init())
.pipe(plugins.g.istanbul.hookRequire()) // Force `require` to return covered files .pipe(plugins.g.babel({
.pipe(plugins.g.gFunction(function(){ presets: [
plugins.beautylog.ok("JS has been instrumentalized to get test code coverage!"); require.resolve("babel-preset-es2015")
done.resolve(configArg); ]
},"atEnd")); }))
return done.promise; .pipe(plugins.g.istanbul({
}; }))
.pipe(plugins.g.sourcemaps.write())
/** .pipe(plugins.g.injectModules())
* .on("finish",function(){
* @returns {*} plugins.gulp.src([plugins.path.join(paths.cwd,"test/test.js")])
*/ .pipe(plugins.g.babel({
let mocha = function (configArg) { presets: [
let done = plugins.Q.defer(); plugins.path.join(paths.npmtsPackageRoot,"node_modules/babel-preset-es2015/index.js")
npmtsOra.end(); // end npmtsOra for tests. ]
let stream = plugins.gulp.src(["./test/test.js"]) }))
.pipe(plugins.g.injectModules())
.pipe(plugins.g.mocha()) .pipe(plugins.g.mocha())
.pipe(plugins.g.istanbul.writeReports()) // Creating the reports after tests ran .pipe(plugins.g.istanbul.writeReports({
dir: plugins.path.join(paths.cwd,"./coverage"),
reporters: [ 'lcovonly', 'json', 'text', 'text-summary']
}))
.pipe(plugins.g.gFunction(function(){ .pipe(plugins.g.gFunction(function(){
plugins.beautylog.ok("Tests have passed!"); plugins.beautylog.ok("Tested!");
done.resolve(configArg); done.resolve(configArg);
},"atEnd")); },"atEnd"));
});
return done.promise; return done.promise;
}; };
@ -70,8 +76,7 @@ export let run = function(configArg) {
"--------------------------------------------------------------" "--------------------------------------------------------------"
); );
istanbul(config) mocha(config)
.then(mocha)
.then(coverage) .then(coverage)
.then(() => { .then(() => {
done.resolve(config); done.resolve(config);

40
ts/npmts.typedoc.ts Normal file
View File

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