Compare commits

...

6 Commits

Author SHA1 Message Date
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
9 changed files with 79 additions and 76 deletions

View File

@ -36,29 +36,28 @@ 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. 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 up from any previous builds (old js files)
1. Install typings 1. Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES6
1. Transpile TypeScript with **inline sourcemaps** and **declaration files** 1. Create TypeDoc Documentation from TypeScript files
1. Create EsDoc Documentation 1. Instrumentalize transpiled ES6 JavaScript with istanbul and run tests with Mocha
1. Instrumentalize created JavaScript files with istanbul
1. Run Tests
1. Create Coverage report
#### npmts.json #### npmtsextra.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
}
} }
``` ```
@ -111,7 +110,7 @@ thanks to autogenerated source maps.
## 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/npmtspage) 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
## About the authors: ## About the authors:

View File

@ -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;
}; };

View File

@ -12,6 +12,7 @@ export declare let g: {
typedoc: any; typedoc: any;
}; };
export declare let lodashObject: any; export declare let lodashObject: 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");

View File

@ -13,6 +13,7 @@ exports.g = {
typedoc: require("gulp-typedoc") typedoc: require("gulp-typedoc")
}; };
exports.lodashObject = require('lodash/fp/object'); exports.lodashObject = require('lodash/fp/object');
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");

4
dist/npmts.tests.js vendored
View File

@ -15,7 +15,7 @@ var mocha = function (configArg) {
.pipe(plugins.g.sourcemaps.init()) .pipe(plugins.g.sourcemaps.init())
.pipe(plugins.g.babel({ .pipe(plugins.g.babel({
presets: [ presets: [
plugins.path.join(paths.npmtsPackageRoot, "node_modules/babel-preset-es2015/index.js") require.resolve("babel-preset-es2015")
] ]
})) }))
.pipe(plugins.g.istanbul({})) .pipe(plugins.g.istanbul({}))
@ -31,7 +31,7 @@ var mocha = function (configArg) {
.pipe(plugins.g.injectModules()) .pipe(plugins.g.injectModules())
.pipe(plugins.g.mocha()) .pipe(plugins.g.mocha())
.pipe(plugins.g.istanbul.writeReports({ .pipe(plugins.g.istanbul.writeReports({
dir: './coverage', dir: plugins.path.join(paths.cwd, "./coverage"),
reporters: ['lcovonly', 'json', 'text', 'text-summary'] reporters: ['lcovonly', 'json', 'text', 'text-summary']
})) }))
.pipe(plugins.g.gFunction(function () { .pipe(plugins.g.gFunction(function () {

View File

@ -1,6 +1,6 @@
{ {
"name": "npmts", "name": "npmts",
"version": "5.3.20", "version": "5.3.23",
"description": "write npm modules with TypeScript", "description": "write npm modules with TypeScript",
"main": "dist/index.js", "main": "dist/index.js",
"bin": { "bin": {
@ -29,9 +29,9 @@
}, },
"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",
"babel-preset-es2015": "^6.9.0", "babel-preset-es2015": "^6.9.0",
"beautylog": "5.0.14", "beautylog": "5.0.14",
"early": "^2.0.13", "early": "^2.0.13",
@ -47,6 +47,7 @@
"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.13.1",
"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",

View File

@ -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;
}; };

View File

@ -12,6 +12,7 @@ export let g = {
typedoc: require("gulp-typedoc") typedoc: require("gulp-typedoc")
}; };
export let lodashObject = require('lodash/fp/object'); export let lodashObject = require('lodash/fp/object');
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");

View File

@ -15,7 +15,7 @@ let mocha = function (configArg) {
.pipe(plugins.g.sourcemaps.init()) .pipe(plugins.g.sourcemaps.init())
.pipe(plugins.g.babel({ .pipe(plugins.g.babel({
presets: [ presets: [
plugins.path.join(paths.npmtsPackageRoot,"node_modules/babel-preset-es2015/index.js") require.resolve("babel-preset-es2015")
] ]
})) }))
.pipe(plugins.g.istanbul({ .pipe(plugins.g.istanbul({
@ -32,7 +32,7 @@ let mocha = function (configArg) {
.pipe(plugins.g.injectModules()) .pipe(plugins.g.injectModules())
.pipe(plugins.g.mocha()) .pipe(plugins.g.mocha())
.pipe(plugins.g.istanbul.writeReports({ .pipe(plugins.g.istanbul.writeReports({
dir: './coverage', dir: plugins.path.join(paths.cwd,"./coverage"),
reporters: [ 'lcovonly', 'json', 'text', 'text-summary'] reporters: [ 'lcovonly', 'json', 'text', 'text-summary']
})) }))
.pipe(plugins.g.gFunction(function(){ .pipe(plugins.g.gFunction(function(){