Compare commits
29 Commits
Author | SHA1 | Date | |
---|---|---|---|
433fad502d | |||
f583b05f73 | |||
3f50311487 | |||
ee16740d0b | |||
63c73536a2 | |||
2f7ebfc47a | |||
372d2605bb | |||
2ecf6c00b8 | |||
2f3d8cecd3 | |||
54bbab232e | |||
380407b5e8 | |||
2a5583946c | |||
80e36a34ee | |||
1f90f4abff | |||
3c7f5f1e2d | |||
8104609306 | |||
a3077f7800 | |||
c947121243 | |||
4b3f0649fa | |||
523c62530f | |||
aa57617fc7 | |||
ef89a33dfc | |||
474a730a09 | |||
e3b029c240 | |||
290824190d | |||
923d78caab | |||
6587b74a23 | |||
aa0a35f258 | |||
09b8809ede |
57
README.md
57
README.md
@ -1,5 +1,5 @@
|
|||||||
# npmts
|
# npmts
|
||||||
Write npm modules with TypeScript without hassle.
|
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||||
|
|
||||||
## Status
|
## Status
|
||||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||||
@ -36,48 +36,44 @@ Then add it to your package.json's script section to trigger a build:
|
|||||||
|
|
||||||
### 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 EsDoc 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
|
||||||
{
|
{
|
||||||
"mode":"default",
|
"npmts":{
|
||||||
"ts":{
|
"mode":"default",
|
||||||
"./customdir/*.ts":"./"
|
"ts":{
|
||||||
},
|
"./customdir/*.ts":"./"
|
||||||
"tsOptions":{
|
},
|
||||||
"declaration":false,
|
"tsOptions":{
|
||||||
"target":"ES6"
|
"declaration":false,
|
||||||
},
|
"target":"ES6"
|
||||||
"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. |
|
||||||
|
|
||||||
#### TypeScript
|
### 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.
|
||||||
|
|
||||||
@ -90,6 +86,7 @@ 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.
|
||||||
|
|
||||||
|
## Some notes:
|
||||||
#### Typings for third party modules that do not bundle declaration files
|
#### 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.
|
NPMTS does no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
|
||||||
|
|
||||||
@ -97,22 +94,20 @@ NPMTS does no longer supports typings.json. Instead use the new TypeScript 2.x a
|
|||||||
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-browser](https://www.npmjs.com/package/gulp-typings)
|
* [gulp-browser](https://www.npmjs.com/package/gulp-browser)
|
||||||
|
|
||||||
> 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 EsDocs 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:
|
||||||
[](https://lossless.com/)
|
[](https://lossless.com/)
|
||||||
|
3
dist/npmts.assets.js
vendored
3
dist/npmts.assets.js
vendored
@ -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
1
dist/npmts.cli.d.ts
vendored
@ -1 +0,0 @@
|
|||||||
import "typings-global";
|
|
2
dist/npmts.cli.js
vendored
2
dist/npmts.cli.js
vendored
@ -1,2 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
require("typings-global");
|
|
18
dist/npmts.compile.js
vendored
18
dist/npmts.compile.js
vendored
@ -7,16 +7,22 @@ var promiseArray = [];
|
|||||||
var compileTs = function (tsFileArrayArg, tsOptionsArg) {
|
var compileTs = function (tsFileArrayArg, tsOptionsArg) {
|
||||||
if (tsOptionsArg === void 0) { tsOptionsArg = {}; }
|
if (tsOptionsArg === void 0) { tsOptionsArg = {}; }
|
||||||
var done = plugins.Q.defer();
|
var done = plugins.Q.defer();
|
||||||
var tsOptionsDefault = {
|
var compilerOptionsDefault = {
|
||||||
declaration: true,
|
declaration: true,
|
||||||
target: "ES5",
|
module: "CommonJS",
|
||||||
module: "commonjs"
|
target: "ES6"
|
||||||
};
|
};
|
||||||
/**
|
/**
|
||||||
* merges default ts options with those found in npmts.json
|
* merges default ts options with those found in npmts.json
|
||||||
*/
|
*/
|
||||||
var tsOptions = function (keyArg) {
|
var compilerOptions = function (keyArg) {
|
||||||
return plugins.lodashObject.assign(tsOptionsDefault, tsOptionsArg);
|
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) {
|
var _loop_1 = function(keyArg) {
|
||||||
plugins.beautylog.info("TypeScript assignment: transpile from " + keyArg.blue + " to " + tsFileArrayArg[keyArg].blue);
|
plugins.beautylog.info("TypeScript assignment: transpile from " + keyArg.blue + " to " + tsFileArrayArg[keyArg].blue);
|
||||||
@ -25,7 +31,7 @@ var compileTs = function (tsFileArrayArg, tsOptionsArg) {
|
|||||||
.then(function (filesToConvertArg) {
|
.then(function (filesToConvertArg) {
|
||||||
var filesToConvertAbsolute = plugins.smartpath.transform.toAbsolute(filesToConvertArg, process.cwd());
|
var filesToConvertAbsolute = plugins.smartpath.transform.toAbsolute(filesToConvertArg, process.cwd());
|
||||||
var destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg], process.cwd());
|
var destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg], process.cwd());
|
||||||
var filesCompiledPromise = plugins.tsn.compile(filesToConvertAbsolute, destDir);
|
var filesCompiledPromise = plugins.tsn.compile(filesToConvertAbsolute, destDir, compilerOptions(keyArg));
|
||||||
promiseArray.push(filesCompiledPromise);
|
promiseArray.push(filesCompiledPromise);
|
||||||
});
|
});
|
||||||
promiseArray.push(filesReadPromise);
|
promiseArray.push(filesReadPromise);
|
||||||
|
47
dist/npmts.configfile.js
vendored
47
dist/npmts.configfile.js
vendored
@ -2,33 +2,34 @@
|
|||||||
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!");
|
|
||||||
config = plugins.lodashObject.assign(config, plugins.smartfile.fs.toObjectSync(configPath));
|
|
||||||
switch (config.mode) {
|
|
||||||
case "default":
|
|
||||||
case "custom":
|
|
||||||
plugins.beautylog.ok("mode is " + config.mode.yellow);
|
|
||||||
done.resolve(config);
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
|
|
||||||
config.mode = "default";
|
|
||||||
done.resolve(config);
|
|
||||||
}
|
}
|
||||||
;
|
;
|
||||||
|
var config = plugins.npmextra.dataFor({
|
||||||
|
toolName: "npmts",
|
||||||
|
defaultSettings: defaultConfig,
|
||||||
|
cwd: paths.cwd
|
||||||
|
});
|
||||||
|
switch (config.mode) {
|
||||||
|
case "default":
|
||||||
|
case "custom":
|
||||||
|
plugins.beautylog.ok("mode is " + config.mode.yellow);
|
||||||
|
done.resolve(config);
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
done.resolve(config);
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
8
dist/npmts.plugins.d.ts
vendored
8
dist/npmts.plugins.d.ts
vendored
@ -3,7 +3,7 @@ export import beautylog = require("beautylog");
|
|||||||
export declare let gulp: any;
|
export declare let gulp: any;
|
||||||
export declare let g: {
|
export declare let g: {
|
||||||
babel: any;
|
babel: any;
|
||||||
babelIstanbul: any;
|
istanbul: any;
|
||||||
gFunction: any;
|
gFunction: any;
|
||||||
injectModules: any;
|
injectModules: any;
|
||||||
mocha: any;
|
mocha: any;
|
||||||
@ -11,15 +11,15 @@ export declare let g: {
|
|||||||
sourcemaps: any;
|
sourcemaps: any;
|
||||||
typedoc: any;
|
typedoc: any;
|
||||||
};
|
};
|
||||||
export declare let lodashObject: any;
|
export import lodashObject = require('lodash');
|
||||||
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");
|
||||||
export import shelljs = require("shelljs");
|
export import shelljs = require("shelljs");
|
||||||
export declare let smartci: any;
|
export declare let smartci: any;
|
||||||
export import smartcli = require("smartcli");
|
export import smartcli = require("smartcli");
|
||||||
export declare let smartcov: any;
|
export import smartcov = require("smartcov");
|
||||||
export import smartenv = require("smartenv");
|
export import smartenv = require("smartenv");
|
||||||
export import smartfile = require("smartfile");
|
export import smartfile = require("smartfile");
|
||||||
export import smartpath = require("smartpath");
|
export import smartpath = require("smartpath");
|
||||||
|
6
dist/npmts.plugins.js
vendored
6
dist/npmts.plugins.js
vendored
@ -4,7 +4,7 @@ exports.beautylog = require("beautylog");
|
|||||||
exports.gulp = require("gulp");
|
exports.gulp = require("gulp");
|
||||||
exports.g = {
|
exports.g = {
|
||||||
babel: require("gulp-babel"),
|
babel: require("gulp-babel"),
|
||||||
babelIstanbul: require("gulp-babel-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"),
|
||||||
@ -12,8 +12,8 @@ exports.g = {
|
|||||||
sourcemaps: require("gulp-sourcemaps"),
|
sourcemaps: require("gulp-sourcemaps"),
|
||||||
typedoc: require("gulp-typedoc")
|
typedoc: require("gulp-typedoc")
|
||||||
};
|
};
|
||||||
exports.lodashObject = require('lodash/fp/object');
|
exports.lodashObject = require('lodash');
|
||||||
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");
|
||||||
|
30
dist/npmts.tests.js
vendored
30
dist/npmts.tests.js
vendored
@ -13,15 +13,27 @@ var mocha = function (configArg) {
|
|||||||
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.sourcemaps.init())
|
.pipe(plugins.g.sourcemaps.init())
|
||||||
.pipe(plugins.g.babelIstanbul())
|
.pipe(plugins.g.babel({
|
||||||
.pipe(plugins.g.babelIstanbul.hookRequire())
|
presets: [
|
||||||
|
require.resolve("babel-preset-es2015")
|
||||||
|
]
|
||||||
|
}))
|
||||||
|
.pipe(plugins.g.istanbul({}))
|
||||||
.pipe(plugins.g.sourcemaps.write())
|
.pipe(plugins.g.sourcemaps.write())
|
||||||
|
.pipe(plugins.g.injectModules())
|
||||||
.on("finish", function () {
|
.on("finish", function () {
|
||||||
plugins.gulp.src([plugins.path.join(paths.cwd, "dist/*.js")])
|
plugins.gulp.src([plugins.path.join(paths.cwd, "test/test.js")])
|
||||||
.pipe(plugins.g.babel())
|
.pipe(plugins.g.babel({
|
||||||
|
presets: [
|
||||||
|
plugins.path.join(paths.npmtsPackageRoot, "node_modules/babel-preset-es2015/index.js")
|
||||||
|
]
|
||||||
|
}))
|
||||||
.pipe(plugins.g.injectModules())
|
.pipe(plugins.g.injectModules())
|
||||||
.pipe(plugins.g.mocha())
|
.pipe(plugins.g.mocha())
|
||||||
.pipe(plugins.g.babelIstanbul.writeReports())
|
.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("Tested!");
|
plugins.beautylog.ok("Tested!");
|
||||||
done.resolve(configArg);
|
done.resolve(configArg);
|
||||||
@ -31,15 +43,13 @@ var mocha = function (configArg) {
|
|||||||
};
|
};
|
||||||
var coverage = function (configArg) {
|
var coverage = function (configArg) {
|
||||||
var done = plugins.Q.defer();
|
var done = plugins.Q.defer();
|
||||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, "lcov.info"))
|
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, "lcov.info"), 2)
|
||||||
.then(function (percentageArg) {
|
.then(function (percentageArg) {
|
||||||
if (percentageArg >= configArg.coverageTreshold) {
|
if (percentageArg >= configArg.coverageTreshold) {
|
||||||
plugins.beautylog.ok("your coverage of " + percentageArg.toString().blue + "% ".blue + "exceeds your treshold of " +
|
plugins.beautylog.ok(percentageArg.toString() + "% coverage exceeds your treshold of " + configArg.coverageTreshold.toString() + "%");
|
||||||
configArg.coverageTreshold.toString().blue + "%".blue);
|
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
plugins.beautylog.warn("your coverage of " + percentageArg + "% " + "fails your treshold of " +
|
plugins.beautylog.warn(percentageArg.toString() + "% coverage fails your treshold of " + configArg.coverageTreshold.toString() + "%");
|
||||||
configArg.coverageTreshold + "%");
|
|
||||||
plugins.beautylog.error("exiting due to coverage failure");
|
plugins.beautylog.error("exiting due to coverage failure");
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
|
30
package.json
30
package.json
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "npmts",
|
"name": "npmts",
|
||||||
"version": "5.3.14",
|
"version": "5.3.28",
|
||||||
"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,37 +29,37 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/npmts#readme",
|
"homepage": "https://gitlab.com/pushrocks/npmts#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/minimatch": "*",
|
"@types/minimatch": "^2.0.28",
|
||||||
"@types/q": "*",
|
"@types/q": "^0.0.27",
|
||||||
"@types/shelljs": "*",
|
"@types/shelljs": "^0.3.27",
|
||||||
"beautylog": "5.0.14",
|
"babel-preset-es2015": "^6.9.0",
|
||||||
|
"beautylog": "5.0.18",
|
||||||
"early": "^2.0.13",
|
"early": "^2.0.13",
|
||||||
"esdoc": "^0.4.7",
|
|
||||||
"gulp": "3.9.1",
|
"gulp": "3.9.1",
|
||||||
"gulp-babel": "^6.1.2",
|
"gulp-babel": "^6.1.2",
|
||||||
"gulp-babel-istanbul": "^1.4.0",
|
|
||||||
"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-inject-modules": "^1.0.0",
|
||||||
|
"gulp-istanbul": "^1.0.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-sourcemaps": "^1.6.0",
|
||||||
"gulp-typedoc": "^2.0.0",
|
"gulp-typedoc": "^2.0.0",
|
||||||
"lodash": "^4.13.1",
|
"lodash": "^4.14.0",
|
||||||
"merge2": "1.0.2",
|
"npmextra": "^1.0.8",
|
||||||
"projectinfo": "1.0.3",
|
"projectinfo": "1.0.3",
|
||||||
"q": "^1.4.1",
|
"q": "^1.4.1",
|
||||||
"shelljs": "^0.7.0",
|
"shelljs": "^0.7.2",
|
||||||
"smartci": "0.0.1",
|
"smartci": "0.0.1",
|
||||||
"smartcli": "1.0.4",
|
"smartcli": "1.0.4",
|
||||||
"smartcov": "0.0.6",
|
"smartcov": "0.0.9",
|
||||||
"smartenv": "1.2.5",
|
"smartenv": "1.2.5",
|
||||||
"smartfile": "4.0.10",
|
"smartfile": "4.0.12",
|
||||||
"smartpath": "3.2.2",
|
"smartpath": "3.2.2",
|
||||||
"smartstring": "^2.0.14",
|
"smartstring": "^2.0.15",
|
||||||
"source-map-support": "^0.4.2",
|
"source-map-support": "^0.4.2",
|
||||||
"tsn": "^1.0.7",
|
"tsn": "^1.0.9",
|
||||||
"typedoc": "^0.4.4",
|
"typedoc": "^0.4.4",
|
||||||
"typescript": "^2.0.0-dev.20160630",
|
"typescript": "^2.0.0-dev.20160630",
|
||||||
"typings-global": "*"
|
"typings-global": "*"
|
||||||
|
@ -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;
|
||||||
|
@ -1 +0,0 @@
|
|||||||
import "typings-global";
|
|
@ -8,17 +8,23 @@ let promiseArray = [];
|
|||||||
let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => {
|
let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => {
|
||||||
let done = plugins.Q.defer();
|
let done = plugins.Q.defer();
|
||||||
|
|
||||||
let tsOptionsDefault = {
|
let compilerOptionsDefault = {
|
||||||
declaration: true,
|
declaration: true,
|
||||||
target: "ES5",
|
module: "CommonJS",
|
||||||
module: "commonjs"
|
target: "ES6"
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* merges default ts options with those found in npmts.json
|
* merges default ts options with those found in npmts.json
|
||||||
*/
|
*/
|
||||||
let tsOptions = function (keyArg:string) {
|
let compilerOptions = function (keyArg:string) {
|
||||||
return plugins.lodashObject.assign(tsOptionsDefault, tsOptionsArg)
|
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) {
|
for (let keyArg in tsFileArrayArg) {
|
||||||
plugins.beautylog.info(`TypeScript assignment: transpile from ${keyArg.blue} to ${tsFileArrayArg[keyArg].blue}`);
|
plugins.beautylog.info(`TypeScript assignment: transpile from ${keyArg.blue} to ${tsFileArrayArg[keyArg].blue}`);
|
||||||
@ -29,7 +35,8 @@ let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => {
|
|||||||
let destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg],process.cwd());
|
let destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg],process.cwd());
|
||||||
let filesCompiledPromise = plugins.tsn.compile(
|
let filesCompiledPromise = plugins.tsn.compile(
|
||||||
filesToConvertAbsolute,
|
filesToConvertAbsolute,
|
||||||
destDir
|
destDir,
|
||||||
|
compilerOptions(keyArg)
|
||||||
);
|
);
|
||||||
promiseArray.push(filesCompiledPromise);
|
promiseArray.push(filesCompiledPromise);
|
||||||
});
|
});
|
||||||
|
@ -1,33 +1,32 @@
|
|||||||
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 = {
|
||||||
if(argvArg.notest){
|
mode: "default",
|
||||||
config.notest = true;
|
notest:false
|
||||||
}
|
|
||||||
if(plugins.smartfile.fs.fileExistsSync(configPath)){
|
|
||||||
plugins.beautylog.info("npmts.json".blue + " config file found!");
|
|
||||||
config = plugins.lodashObject.assign(
|
|
||||||
config,
|
|
||||||
plugins.smartfile.fs.toObjectSync(configPath)
|
|
||||||
);
|
|
||||||
switch (config.mode){
|
|
||||||
case "default":
|
|
||||||
case "custom":
|
|
||||||
plugins.beautylog.ok("mode is " + config.mode.yellow);
|
|
||||||
done.resolve(config);
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
|
|
||||||
process.exit(1);
|
|
||||||
};
|
|
||||||
} else {
|
|
||||||
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
|
|
||||||
config.mode = "default";
|
|
||||||
done.resolve(config);
|
|
||||||
};
|
};
|
||||||
|
if(argvArg.notest){
|
||||||
|
defaultConfig.notest = true;
|
||||||
|
};
|
||||||
|
let config = plugins.npmextra.dataFor({
|
||||||
|
toolName:"npmts",
|
||||||
|
defaultSettings:defaultConfig,
|
||||||
|
cwd:paths.cwd
|
||||||
|
});
|
||||||
|
switch (config.mode){
|
||||||
|
case "default":
|
||||||
|
case "custom":
|
||||||
|
plugins.beautylog.ok("mode is " + config.mode.yellow);
|
||||||
|
done.resolve(config);
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
|
||||||
|
process.exit(1);
|
||||||
|
};
|
||||||
|
done.resolve(config);
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
@ -3,7 +3,7 @@ export import beautylog = require("beautylog");
|
|||||||
export let gulp = require("gulp");
|
export let gulp = require("gulp");
|
||||||
export let g = {
|
export let g = {
|
||||||
babel: require("gulp-babel"),
|
babel: require("gulp-babel"),
|
||||||
babelIstanbul: require("gulp-babel-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"),
|
||||||
@ -11,15 +11,15 @@ export let g = {
|
|||||||
sourcemaps: require("gulp-sourcemaps"),
|
sourcemaps: require("gulp-sourcemaps"),
|
||||||
typedoc: require("gulp-typedoc")
|
typedoc: require("gulp-typedoc")
|
||||||
};
|
};
|
||||||
export let lodashObject = require('lodash/fp/object');
|
export import lodashObject = require('lodash');
|
||||||
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");
|
||||||
export import shelljs = require("shelljs");
|
export import shelljs = require("shelljs");
|
||||||
export let smartci = require("smartci");
|
export let smartci = require("smartci");
|
||||||
export import smartcli = require("smartcli");
|
export import smartcli = require("smartcli");
|
||||||
export let smartcov = require("smartcov");
|
export import smartcov = require("smartcov");
|
||||||
export import smartenv = require("smartenv");
|
export import smartenv = require("smartenv");
|
||||||
export import smartfile = require("smartfile");
|
export import smartfile = require("smartfile");
|
||||||
export import smartpath = require("smartpath");
|
export import smartpath = require("smartpath");
|
||||||
|
@ -13,15 +13,28 @@ let mocha = function (configArg) {
|
|||||||
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.sourcemaps.init())
|
.pipe(plugins.g.sourcemaps.init())
|
||||||
.pipe(plugins.g.babelIstanbul())
|
.pipe(plugins.g.babel({
|
||||||
.pipe(plugins.g.babelIstanbul.hookRequire())
|
presets: [
|
||||||
|
require.resolve("babel-preset-es2015")
|
||||||
|
]
|
||||||
|
}))
|
||||||
|
.pipe(plugins.g.istanbul({
|
||||||
|
}))
|
||||||
.pipe(plugins.g.sourcemaps.write())
|
.pipe(plugins.g.sourcemaps.write())
|
||||||
|
.pipe(plugins.g.injectModules())
|
||||||
.on("finish",function(){
|
.on("finish",function(){
|
||||||
plugins.gulp.src([plugins.path.join(paths.cwd,"dist/*.js")])
|
plugins.gulp.src([plugins.path.join(paths.cwd,"test/test.js")])
|
||||||
.pipe(plugins.g.babel())
|
.pipe(plugins.g.babel({
|
||||||
|
presets: [
|
||||||
|
plugins.path.join(paths.npmtsPackageRoot,"node_modules/babel-preset-es2015/index.js")
|
||||||
|
]
|
||||||
|
}))
|
||||||
.pipe(plugins.g.injectModules())
|
.pipe(plugins.g.injectModules())
|
||||||
.pipe(plugins.g.mocha())
|
.pipe(plugins.g.mocha())
|
||||||
.pipe(plugins.g.babelIstanbul.writeReports())
|
.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("Tested!");
|
plugins.beautylog.ok("Tested!");
|
||||||
done.resolve(configArg);
|
done.resolve(configArg);
|
||||||
@ -32,17 +45,15 @@ let mocha = function (configArg) {
|
|||||||
|
|
||||||
let coverage = function(configArg){
|
let coverage = function(configArg){
|
||||||
let done = plugins.Q.defer();
|
let done = plugins.Q.defer();
|
||||||
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir,"lcov.info"))
|
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir,"lcov.info"),2)
|
||||||
.then(function(percentageArg){
|
.then(function(percentageArg){
|
||||||
if (percentageArg >= configArg.coverageTreshold){
|
if (percentageArg >= configArg.coverageTreshold){
|
||||||
plugins.beautylog.ok(
|
plugins.beautylog.ok(
|
||||||
"your coverage of " + percentageArg.toString().blue + "% ".blue + "exceeds your treshold of " +
|
`${percentageArg.toString()}% coverage exceeds your treshold of ${configArg.coverageTreshold.toString()}%`
|
||||||
configArg.coverageTreshold.toString().blue + "%".blue
|
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
plugins.beautylog.warn(
|
plugins.beautylog.warn(
|
||||||
"your coverage of " + percentageArg + "% " + "fails your treshold of " +
|
`${percentageArg.toString()}% coverage fails your treshold of ${configArg.coverageTreshold.toString()}%`
|
||||||
configArg.coverageTreshold + "%"
|
|
||||||
);
|
);
|
||||||
plugins.beautylog.error("exiting due to coverage failure");
|
plugins.beautylog.error("exiting due to coverage failure");
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
|
Reference in New Issue
Block a user