Compare commits
14 Commits
Author | SHA1 | Date | |
---|---|---|---|
329e0dc101 | |||
da45d002a3 | |||
59e811247f | |||
7bcd2f4f5d | |||
78d77c003c | |||
aca85d2ff3 | |||
f03c4a45c2 | |||
faf55e4e31 | |||
b78fe35e88 | |||
7ab4561727 | |||
200f44a792 | |||
312dc4bd7f | |||
60bed4cb1f | |||
8831a8d173 |
@ -1,3 +1,4 @@
|
|||||||
|
# standard ci
|
||||||
image: hosttoday/ht-docker-node:npmci
|
image: hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
@ -50,7 +51,7 @@ pages:
|
|||||||
image: hosttoday/ht-docker-node:npmpage
|
image: hosttoday/ht-docker-node:npmpage
|
||||||
stage: pages
|
stage: pages
|
||||||
script:
|
script:
|
||||||
- npmci command npmpage --host gitlab
|
- npmci command npmpage --publish gitlab
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
artifacts:
|
artifacts:
|
||||||
|
@ -1,4 +1,3 @@
|
|||||||
.idea/
|
|
||||||
compile/
|
compile/
|
||||||
coverage/
|
coverage/
|
||||||
test/
|
test/
|
||||||
|
@ -1,7 +1,5 @@
|
|||||||
Please view this file on the master branch, on stable branches it's out of date.
|
Please view this file on the master branch, on stable branches it's out of date.
|
||||||
|
|
||||||
v 6.0.0 (unreleased)
|
v 6.0.0 (released)
|
||||||
- handle bithound
|
- remove TypeDoc, please look at npmpage
|
||||||
- check package.json
|
- check package.json
|
||||||
- check .gitlab-ci-yml
|
|
||||||
- check appveyor.yml
|
|
46
dist/mod01/index.js
vendored
46
dist/mod01/index.js
vendored
@ -3,52 +3,8 @@
|
|||||||
* This module creates TypeScript documentation
|
* This module creates TypeScript documentation
|
||||||
* -------------------------------------------- */
|
* -------------------------------------------- */
|
||||||
const q = require("q");
|
const q = require("q");
|
||||||
const paths = require("../npmts.paths");
|
|
||||||
const npmts_log_1 = require("../npmts.log");
|
|
||||||
const plugins = require("./mod01.plugins");
|
|
||||||
const mod00_check_1 = require("../mod00/mod00.check");
|
|
||||||
let genTypeDoc = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
npmts_log_1.npmtsOra.text('now generating ' + 'TypeDoc documentation'.yellow);
|
|
||||||
plugins.beautylog.log('TypeDoc Output:');
|
|
||||||
let localSmartstream = new plugins.smartstream.Smartstream([
|
|
||||||
plugins.gulp.src(plugins.path.join(paths.tsDir, '**/*.ts')),
|
|
||||||
plugins.gulpTypedoc({
|
|
||||||
// TypeScript options (see typescript docs)
|
|
||||||
module: 'commonjs',
|
|
||||||
target: 'es6',
|
|
||||||
includeDeclarations: true,
|
|
||||||
// Output options (see typedoc docs)
|
|
||||||
out: paths.pagesApiDir,
|
|
||||||
json: plugins.path.join(paths.pagesApiDir, 'file.json'),
|
|
||||||
// TypeDoc options (see typedoc docs)
|
|
||||||
name: mod00_check_1.projectInfo.name,
|
|
||||||
readme: plugins.path.join(paths.cwd, 'README.md'),
|
|
||||||
// theme: "default",
|
|
||||||
version: true
|
|
||||||
})
|
|
||||||
]);
|
|
||||||
localSmartstream.run().then(() => {
|
|
||||||
plugins.beautylog.ok('TypeDoc documentation generated!');
|
|
||||||
done.resolve(configArg);
|
|
||||||
}, (err) => {
|
|
||||||
plugins.beautylog.warn('TypeDoc documentation generation failed!');
|
|
||||||
console.log(err);
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
exports.run = function (configArg) {
|
exports.run = function (configArg) {
|
||||||
let done = q.defer();
|
let done = q.defer();
|
||||||
if (configArg.docs) {
|
done.resolve(configArg);
|
||||||
genTypeDoc(configArg)
|
|
||||||
.then(() => {
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
done.resolve(configArg);
|
|
||||||
}
|
|
||||||
;
|
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
3
dist/mod01/mod01.plugins.d.ts
vendored
3
dist/mod01/mod01.plugins.d.ts
vendored
@ -1,4 +1 @@
|
|||||||
export * from '../npmts.plugins';
|
export * from '../npmts.plugins';
|
||||||
import * as gulp from 'gulp';
|
|
||||||
declare let gulpTypedoc: any;
|
|
||||||
export { gulp, gulpTypedoc };
|
|
||||||
|
4
dist/mod01/mod01.plugins.js
vendored
4
dist/mod01/mod01.plugins.js
vendored
@ -3,7 +3,3 @@ function __export(m) {
|
|||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
||||||
}
|
}
|
||||||
__export(require("../npmts.plugins"));
|
__export(require("../npmts.plugins"));
|
||||||
const gulp = require("gulp");
|
|
||||||
exports.gulp = gulp;
|
|
||||||
let gulpTypedoc = require('gulp-typedoc');
|
|
||||||
exports.gulpTypedoc = gulpTypedoc;
|
|
||||||
|
35
dist/mod02/index.js
vendored
35
dist/mod02/index.js
vendored
@ -1,4 +1,12 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
|
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
||||||
|
return new (P || (P = Promise))(function (resolve, reject) {
|
||||||
|
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
||||||
|
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
||||||
|
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
|
||||||
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
||||||
|
});
|
||||||
|
};
|
||||||
/* ------------------------------------------
|
/* ------------------------------------------
|
||||||
* This module tests the compiled TypeScript files
|
* This module tests the compiled TypeScript files
|
||||||
* -------------------------------------------- */
|
* -------------------------------------------- */
|
||||||
@ -15,28 +23,33 @@ let mocha = function (configArg) {
|
|||||||
npmts_log_1.npmtsOra.end(); // end npmtsOra for tests.
|
npmts_log_1.npmtsOra.end(); // end npmtsOra for tests.
|
||||||
let done = q.defer();
|
let done = q.defer();
|
||||||
let coverageSmartstream = new plugins.smartstream.Smartstream([
|
let coverageSmartstream = new plugins.smartstream.Smartstream([
|
||||||
plugins.gulp.src([plugins.path.join(paths.cwd, './dist/**/*.js')]),
|
plugins.gulp.src([plugins.path.join(paths.cwd, './ts/**/*.ts')]),
|
||||||
plugins.gulpSourcemaps.init(),
|
plugins.gulpSourcemaps.init(),
|
||||||
plugins.gulpBabel({
|
plugins.gulpTypeScript({
|
||||||
presets: [
|
target: 'ES5',
|
||||||
require.resolve('babel-preset-es2015')
|
emitDecoratorMetadata: true,
|
||||||
]
|
experimentalDecorators: true,
|
||||||
|
lib: ['es2015.promise', 'es5']
|
||||||
}),
|
}),
|
||||||
plugins.gulpIstanbul({}),
|
plugins.gulpIstanbul({}),
|
||||||
plugins.gulpSourcemaps.write(),
|
plugins.gulpSourcemaps.write(),
|
||||||
|
plugins.gulpFunction.forEach((file) => __awaiter(this, void 0, void 0, function* () {
|
||||||
|
file.path = file.path.replace(paths.tsDir, paths.distDir);
|
||||||
|
console.log(file.path);
|
||||||
|
})),
|
||||||
plugins.gulpInjectModules(),
|
plugins.gulpInjectModules(),
|
||||||
plugins.through2.obj((file, enc, cb) => {
|
plugins.through2.obj((file, enc, cb) => {
|
||||||
cb(null, file);
|
cb();
|
||||||
}, (cb) => {
|
}, (cb) => {
|
||||||
cb();
|
cb();
|
||||||
})
|
})
|
||||||
]);
|
]);
|
||||||
let localSmartstream = new plugins.smartstream.Smartstream([
|
let localSmartstream = new plugins.smartstream.Smartstream([
|
||||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')]),
|
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.ts')]),
|
||||||
plugins.gulpBabel({
|
plugins.gulpTypeScript({
|
||||||
presets: [
|
target: 'ES5',
|
||||||
require.resolve('babel-preset-es2015')
|
emitDecoratorMetadata: true,
|
||||||
]
|
experimentalDecorators: true
|
||||||
}),
|
}),
|
||||||
plugins.gulpInjectModules(),
|
plugins.gulpInjectModules(),
|
||||||
plugins.gulpMocha(),
|
plugins.gulpMocha(),
|
||||||
|
6
dist/mod02/mod02.plugins.d.ts
vendored
6
dist/mod02/mod02.plugins.d.ts
vendored
@ -1,9 +1,9 @@
|
|||||||
export * from '../npmts.plugins';
|
export * from '../npmts.plugins';
|
||||||
import * as gulp from 'gulp';
|
import * as gulp from 'gulp';
|
||||||
import * as gulpBabel from 'gulp-babel';
|
|
||||||
import * as gulpIstanbul from 'gulp-istanbul';
|
|
||||||
import * as gulpFunction from 'gulp-function';
|
import * as gulpFunction from 'gulp-function';
|
||||||
|
import * as gulpIstanbul from 'gulp-istanbul';
|
||||||
declare let gulpInjectModules: any;
|
declare let gulpInjectModules: any;
|
||||||
import * as gulpMocha from 'gulp-mocha';
|
import * as gulpMocha from 'gulp-mocha';
|
||||||
import * as gulpSourcemaps from 'gulp-sourcemaps';
|
import * as gulpSourcemaps from 'gulp-sourcemaps';
|
||||||
export { gulp, gulpBabel, gulpIstanbul, gulpFunction, gulpInjectModules, gulpMocha, gulpSourcemaps };
|
import * as gulpTypeScript from 'gulp-typescript';
|
||||||
|
export { gulp, gulpFunction, gulpIstanbul, gulpInjectModules, gulpMocha, gulpSourcemaps, gulpTypeScript };
|
||||||
|
8
dist/mod02/mod02.plugins.js
vendored
8
dist/mod02/mod02.plugins.js
vendored
@ -5,15 +5,15 @@ function __export(m) {
|
|||||||
__export(require("../npmts.plugins"));
|
__export(require("../npmts.plugins"));
|
||||||
const gulp = require("gulp");
|
const gulp = require("gulp");
|
||||||
exports.gulp = gulp;
|
exports.gulp = gulp;
|
||||||
const gulpBabel = require("gulp-babel");
|
|
||||||
exports.gulpBabel = gulpBabel;
|
|
||||||
const gulpIstanbul = require("gulp-istanbul");
|
|
||||||
exports.gulpIstanbul = gulpIstanbul;
|
|
||||||
const gulpFunction = require("gulp-function");
|
const gulpFunction = require("gulp-function");
|
||||||
exports.gulpFunction = gulpFunction;
|
exports.gulpFunction = gulpFunction;
|
||||||
|
const gulpIstanbul = require("gulp-istanbul");
|
||||||
|
exports.gulpIstanbul = gulpIstanbul;
|
||||||
let gulpInjectModules = require('gulp-inject-modules');
|
let gulpInjectModules = require('gulp-inject-modules');
|
||||||
exports.gulpInjectModules = gulpInjectModules;
|
exports.gulpInjectModules = gulpInjectModules;
|
||||||
const gulpMocha = require("gulp-mocha");
|
const gulpMocha = require("gulp-mocha");
|
||||||
exports.gulpMocha = gulpMocha;
|
exports.gulpMocha = gulpMocha;
|
||||||
const gulpSourcemaps = require("gulp-sourcemaps");
|
const gulpSourcemaps = require("gulp-sourcemaps");
|
||||||
exports.gulpSourcemaps = gulpSourcemaps;
|
exports.gulpSourcemaps = gulpSourcemaps;
|
||||||
|
const gulpTypeScript = require("gulp-typescript");
|
||||||
|
exports.gulpTypeScript = gulpTypeScript;
|
||||||
|
1
dist/npmts.config.d.ts
vendored
1
dist/npmts.config.d.ts
vendored
@ -4,7 +4,6 @@ export declare type npmtsMode = 'default' | 'custom';
|
|||||||
export interface INpmtsConfig {
|
export interface INpmtsConfig {
|
||||||
argv: any;
|
argv: any;
|
||||||
coverageTreshold: number;
|
coverageTreshold: number;
|
||||||
docs: boolean;
|
|
||||||
mode: npmtsMode;
|
mode: npmtsMode;
|
||||||
test: boolean;
|
test: boolean;
|
||||||
testTs: any;
|
testTs: any;
|
||||||
|
5
dist/npmts.config.js
vendored
5
dist/npmts.config.js
vendored
@ -9,7 +9,6 @@ exports.run = function (argvArg) {
|
|||||||
let defaultConfig = {
|
let defaultConfig = {
|
||||||
argv: undefined,
|
argv: undefined,
|
||||||
coverageTreshold: 70,
|
coverageTreshold: 70,
|
||||||
docs: true,
|
|
||||||
mode: 'default',
|
mode: 'default',
|
||||||
test: true,
|
test: true,
|
||||||
testTs: {},
|
testTs: {},
|
||||||
@ -50,10 +49,6 @@ exports.run = function (argvArg) {
|
|||||||
config.test = false;
|
config.test = false;
|
||||||
}
|
}
|
||||||
;
|
;
|
||||||
if (config.argv.nodocs) {
|
|
||||||
config.docs = false;
|
|
||||||
}
|
|
||||||
;
|
|
||||||
if (config.argv.watch) {
|
if (config.argv.watch) {
|
||||||
config.watch = true;
|
config.watch = true;
|
||||||
}
|
}
|
||||||
|
@ -20,7 +20,6 @@ with default behaviour.
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"mode":"custom",
|
"mode":"custom",
|
||||||
"docs":false,
|
|
||||||
"test":true,
|
"test":true,
|
||||||
"npmts":{
|
"npmts":{
|
||||||
"ts":{
|
"ts":{
|
||||||
@ -38,7 +37,6 @@ with default behaviour.
|
|||||||
| key | default value | description |
|
| key | default value | description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
|
| `"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 |
|
| `"test"` | `true` | test your module |
|
||||||
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
|
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
|
||||||
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
|
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
|
||||||
@ -63,11 +61,6 @@ 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.
|
||||||
|
|
||||||
### 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:
|
## 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 no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
|
NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
|
||||||
|
@ -4,5 +4,4 @@
|
|||||||
1. **Clean:** Clean up from any previous builds (old js files)
|
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. **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. **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.
|
1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
|
@ -5,11 +5,13 @@ Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
|||||||
[](https://www.npmjs.com/package/npmts)
|
[](https://www.npmjs.com/package/npmts)
|
||||||
[](https://gitlab.com/pushrocks/npmts)
|
[](https://gitlab.com/pushrocks/npmts)
|
||||||
[](https://github.com/pushrocks/npmts)
|
[](https://github.com/pushrocks/npmts)
|
||||||
[](https://pushrocks.gitlab.io/npmts/gitbook)
|
[](https://pushrocks.gitlab.io/npmts/)
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||||
|
[](https://www.npmjs.com/package/npmts)
|
||||||
|
[](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||||
[](https://david-dm.org/pushrocks/npmts)
|
[](https://david-dm.org/pushrocks/npmts)
|
||||||
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||||
[](https://www.bithound.io/github/pushrocks/npmts)
|
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||||
@ -32,11 +34,11 @@ This works on your machine and in CI. There is a prebuild docker image available
|
|||||||
[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/)
|
||||||
|
|
||||||
For further information read the docs:
|
For further information read the docs:
|
||||||
* [1. Intro](https://pushrocks.gitlab.io/npmts/gitbook/index.md)
|
1. [Intro](https://pushrocks.gitlab.io/npmts/index.html)
|
||||||
* [2. Install](https://pushrocks.gitlab.io/npmts/gitbook/install.md)
|
2. [Install](https://pushrocks.gitlab.io/npmts/install.html)
|
||||||
* [3. Default Behaviour](https://pushrocks.gitlab.io/npmts/gitbook/default.md)
|
3. [Default Behaviour](https://pushrocks.gitlab.io/npmts/default.html)
|
||||||
* [4. Configuration](https://pushrocks.gitlab.io/npmts/gitbook/config.md)
|
4. [Configuration](https://pushrocks.gitlab.io/npmts/config.html)
|
||||||
* [5. Examples](https://pushrocks.gitlab.io/npmts/gitbook/examples.md)
|
5. [Examples](https://pushrocks.gitlab.io/npmts/examples.html)
|
||||||
* [6. Info](https://pushrocks.gitlab.io/npmts/gitbook/info.md)
|
6. [Info](https://pushrocks.gitlab.io/npmts/info.html)
|
||||||
|
|
||||||
[](https://push.rocks)
|
[](https://push.rocks)
|
||||||
|
36
package.json
36
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "npmts",
|
"name": "npmts",
|
||||||
"version": "5.5.8",
|
"version": "6.1.1",
|
||||||
"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": {
|
||||||
@ -35,7 +35,6 @@
|
|||||||
"homepage": "https://gitlab.com/pushrocks/npmts#readme",
|
"homepage": "https://gitlab.com/pushrocks/npmts#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/gulp": "^3.8.32",
|
"@types/gulp": "^3.8.32",
|
||||||
"@types/gulp-babel": "^6.1.29",
|
|
||||||
"@types/gulp-istanbul": "^0.9.30",
|
"@types/gulp-istanbul": "^0.9.30",
|
||||||
"@types/gulp-mocha": "0.0.29",
|
"@types/gulp-mocha": "0.0.29",
|
||||||
"@types/gulp-sourcemaps": "0.0.29",
|
"@types/gulp-sourcemaps": "0.0.29",
|
||||||
@ -43,41 +42,38 @@
|
|||||||
"@types/q": "^0.x.x",
|
"@types/q": "^0.x.x",
|
||||||
"@types/shelljs": "^0.3.33",
|
"@types/shelljs": "^0.3.33",
|
||||||
"@types/through2": "^2.0.32",
|
"@types/through2": "^2.0.32",
|
||||||
"babel-preset-es2015": "^6.18.0",
|
|
||||||
"beautylog": "6.0.0",
|
"beautylog": "6.0.0",
|
||||||
"depcheck": "^0.6.5",
|
"depcheck": "^0.6.7",
|
||||||
"early": "^2.0.35",
|
"early": "^2.0.35",
|
||||||
"gulp": "3.9.1",
|
"gulp": "3.9.1",
|
||||||
"gulp-babel": "^6.1.2",
|
"gulp-function": "^2.2.3",
|
||||||
"gulp-function": "^2.2.2",
|
|
||||||
"gulp-inject-modules": "^1.0.0",
|
"gulp-inject-modules": "^1.0.0",
|
||||||
"gulp-istanbul": "^1.1.1",
|
"gulp-istanbul": "^1.1.1",
|
||||||
"gulp-mocha": "^3.0.1",
|
"gulp-mocha": "^3.0.1",
|
||||||
"gulp-sourcemaps": "^2.2.0",
|
"gulp-sourcemaps": "^2.4.0",
|
||||||
"gulp-typedoc": "^2.0.0",
|
"gulp-typescript": "^3.1.4",
|
||||||
"lodash": "^4.17.2",
|
"lodash": "^4.17.4",
|
||||||
"npmextra": "^2.0.3",
|
"npmextra": "^2.0.3",
|
||||||
"projectinfo": "1.0.4",
|
"projectinfo": "3.0.1",
|
||||||
"q": "^1.4.1",
|
"q": "^1.4.1",
|
||||||
"shelljs": "^0.7.5",
|
"shelljs": "^0.7.6",
|
||||||
"smartchok": "^1.0.4",
|
"smartchok": "^1.0.4",
|
||||||
"smartcli": "1.0.15",
|
"smartcli": "2.0.1",
|
||||||
"smartcov": "1.0.0",
|
"smartcov": "1.0.0",
|
||||||
"smartenv": "2.0.0",
|
"smartenv": "2.0.0",
|
||||||
"smartfile": "4.1.0",
|
"smartfile": "4.1.2",
|
||||||
"smartpath": "3.2.5",
|
"smartpath": "3.2.7",
|
||||||
"smartstream": "^1.0.5",
|
"smartstream": "^1.0.5",
|
||||||
"smartstring": "^2.0.22",
|
"smartstring": "^2.0.22",
|
||||||
"smartsystem": "^1.0.9",
|
"smartsystem": "^1.0.12",
|
||||||
"source-map-support": "^0.4.6",
|
"source-map-support": "^0.4.8",
|
||||||
"through2": "^2.0.1",
|
"through2": "^2.0.3",
|
||||||
"tsn": "^2.0.13",
|
"tsn": "^2.0.14",
|
||||||
"typedoc": "^0.5.1",
|
|
||||||
"typescript": "next",
|
"typescript": "next",
|
||||||
"typings-global": "^1.0.14"
|
"typings-global": "^1.0.14"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/should": "^8.1.30",
|
"@types/should": "^8.1.30",
|
||||||
"should": "^11.1.1"
|
"should": "^11.1.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -9,55 +9,8 @@ import { INpmtsConfig } from '../npmts.config'
|
|||||||
|
|
||||||
import * as plugins from './mod01.plugins'
|
import * as plugins from './mod01.plugins'
|
||||||
|
|
||||||
|
|
||||||
import { projectInfo } from '../mod00/mod00.check'
|
|
||||||
|
|
||||||
let genTypeDoc = function (configArg: INpmtsConfig) {
|
|
||||||
let done = q.defer()
|
|
||||||
npmtsOra.text('now generating ' + 'TypeDoc documentation'.yellow)
|
|
||||||
plugins.beautylog.log('TypeDoc Output:')
|
|
||||||
let localSmartstream = new plugins.smartstream.Smartstream([
|
|
||||||
plugins.gulp.src(plugins.path.join(paths.tsDir, '**/*.ts')),
|
|
||||||
plugins.gulpTypedoc({
|
|
||||||
// TypeScript options (see typescript docs)
|
|
||||||
module: 'commonjs',
|
|
||||||
target: 'es6',
|
|
||||||
includeDeclarations: true,
|
|
||||||
|
|
||||||
// Output options (see typedoc docs)
|
|
||||||
out: paths.pagesApiDir,
|
|
||||||
json: plugins.path.join(paths.pagesApiDir, 'file.json'),
|
|
||||||
|
|
||||||
// TypeDoc options (see typedoc docs)
|
|
||||||
name: projectInfo.name,
|
|
||||||
readme: plugins.path.join(paths.cwd, 'README.md'),
|
|
||||||
// theme: "default",
|
|
||||||
version: true
|
|
||||||
})
|
|
||||||
])
|
|
||||||
localSmartstream.run().then(
|
|
||||||
() => {
|
|
||||||
plugins.beautylog.ok('TypeDoc documentation generated!')
|
|
||||||
done.resolve(configArg)
|
|
||||||
},
|
|
||||||
(err) => {
|
|
||||||
plugins.beautylog.warn('TypeDoc documentation generation failed!')
|
|
||||||
console.log(err)
|
|
||||||
done.resolve(configArg)
|
|
||||||
}
|
|
||||||
)
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
export let run = function (configArg: INpmtsConfig) {
|
export let run = function (configArg: INpmtsConfig) {
|
||||||
let done = q.defer<INpmtsConfig>()
|
let done = q.defer<INpmtsConfig>()
|
||||||
if (configArg.docs) {
|
done.resolve(configArg)
|
||||||
genTypeDoc(configArg)
|
|
||||||
.then(() => {
|
|
||||||
done.resolve(configArg)
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
done.resolve(configArg)
|
|
||||||
};
|
|
||||||
return done.promise
|
return done.promise
|
||||||
}
|
}
|
||||||
|
@ -1,9 +1,2 @@
|
|||||||
export * from '../npmts.plugins'
|
export * from '../npmts.plugins'
|
||||||
|
|
||||||
import * as gulp from 'gulp'
|
|
||||||
let gulpTypedoc = require('gulp-typedoc')
|
|
||||||
|
|
||||||
export {
|
|
||||||
gulp,
|
|
||||||
gulpTypedoc
|
|
||||||
}
|
|
||||||
|
@ -19,20 +19,25 @@ let mocha = function (configArg: INpmtsConfig) {
|
|||||||
let done = q.defer()
|
let done = q.defer()
|
||||||
|
|
||||||
let coverageSmartstream = new plugins.smartstream.Smartstream([
|
let coverageSmartstream = new plugins.smartstream.Smartstream([
|
||||||
plugins.gulp.src([plugins.path.join(paths.cwd, './dist/**/*.js')]),
|
plugins.gulp.src([plugins.path.join(paths.cwd, './ts/**/*.ts')]),
|
||||||
plugins.gulpSourcemaps.init(),
|
plugins.gulpSourcemaps.init(),
|
||||||
plugins.gulpBabel({
|
plugins.gulpTypeScript({
|
||||||
presets: [
|
target: 'ES5',
|
||||||
require.resolve('babel-preset-es2015')
|
emitDecoratorMetadata: true,
|
||||||
]
|
experimentalDecorators: true,
|
||||||
|
lib: ['es2015.promise','es5']
|
||||||
}),
|
}),
|
||||||
plugins.gulpIstanbul({
|
plugins.gulpIstanbul({
|
||||||
}),
|
}),
|
||||||
plugins.gulpSourcemaps.write(),
|
plugins.gulpSourcemaps.write(),
|
||||||
|
plugins.gulpFunction.forEach(async file => {
|
||||||
|
file.path = file.path.replace(paths.tsDir, paths.distDir)
|
||||||
|
console.log(file.path)
|
||||||
|
}),
|
||||||
plugins.gulpInjectModules(),
|
plugins.gulpInjectModules(),
|
||||||
plugins.through2.obj(
|
plugins.through2.obj(
|
||||||
(file, enc, cb) => {
|
(file, enc, cb) => {
|
||||||
cb(null, file)
|
cb()
|
||||||
},
|
},
|
||||||
(cb) => {
|
(cb) => {
|
||||||
cb()
|
cb()
|
||||||
@ -41,11 +46,11 @@ let mocha = function (configArg: INpmtsConfig) {
|
|||||||
])
|
])
|
||||||
|
|
||||||
let localSmartstream = new plugins.smartstream.Smartstream([
|
let localSmartstream = new plugins.smartstream.Smartstream([
|
||||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')]),
|
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.ts')]),
|
||||||
plugins.gulpBabel({
|
plugins.gulpTypeScript({
|
||||||
presets: [
|
target: 'ES5',
|
||||||
require.resolve('babel-preset-es2015')
|
emitDecoratorMetadata: true,
|
||||||
]
|
experimentalDecorators: true
|
||||||
}),
|
}),
|
||||||
plugins.gulpInjectModules(),
|
plugins.gulpInjectModules(),
|
||||||
plugins.gulpMocha(),
|
plugins.gulpMocha(),
|
||||||
|
@ -1,19 +1,19 @@
|
|||||||
export * from '../npmts.plugins'
|
export * from '../npmts.plugins'
|
||||||
|
|
||||||
import * as gulp from 'gulp'
|
import * as gulp from 'gulp'
|
||||||
import * as gulpBabel from 'gulp-babel'
|
|
||||||
import * as gulpIstanbul from 'gulp-istanbul'
|
|
||||||
import * as gulpFunction from 'gulp-function'
|
import * as gulpFunction from 'gulp-function'
|
||||||
|
import * as gulpIstanbul from 'gulp-istanbul'
|
||||||
let gulpInjectModules = require('gulp-inject-modules')
|
let gulpInjectModules = require('gulp-inject-modules')
|
||||||
import * as gulpMocha from 'gulp-mocha'
|
import * as gulpMocha from 'gulp-mocha'
|
||||||
import * as gulpSourcemaps from 'gulp-sourcemaps'
|
import * as gulpSourcemaps from 'gulp-sourcemaps'
|
||||||
|
import * as gulpTypeScript from 'gulp-typescript'
|
||||||
|
|
||||||
export {
|
export {
|
||||||
gulp,
|
gulp,
|
||||||
gulpBabel,
|
|
||||||
gulpIstanbul,
|
|
||||||
gulpFunction,
|
gulpFunction,
|
||||||
|
gulpIstanbul,
|
||||||
gulpInjectModules,
|
gulpInjectModules,
|
||||||
gulpMocha,
|
gulpMocha,
|
||||||
gulpSourcemaps
|
gulpSourcemaps,
|
||||||
|
gulpTypeScript
|
||||||
}
|
}
|
||||||
|
@ -10,7 +10,6 @@ export type npmtsMode = 'default' | 'custom'
|
|||||||
export interface INpmtsConfig {
|
export interface INpmtsConfig {
|
||||||
argv: any,
|
argv: any,
|
||||||
coverageTreshold: number,
|
coverageTreshold: number,
|
||||||
docs: boolean,
|
|
||||||
mode: npmtsMode,
|
mode: npmtsMode,
|
||||||
test: boolean,
|
test: boolean,
|
||||||
testTs: any,
|
testTs: any,
|
||||||
@ -25,7 +24,6 @@ export var run = function (argvArg) {
|
|||||||
let defaultConfig: INpmtsConfig = {
|
let defaultConfig: INpmtsConfig = {
|
||||||
argv: undefined,
|
argv: undefined,
|
||||||
coverageTreshold: 70,
|
coverageTreshold: 70,
|
||||||
docs: true,
|
|
||||||
mode: 'default',
|
mode: 'default',
|
||||||
test: true,
|
test: true,
|
||||||
testTs: {},
|
testTs: {},
|
||||||
@ -72,9 +70,6 @@ export var run = function (argvArg) {
|
|||||||
if (config.argv.notest) {
|
if (config.argv.notest) {
|
||||||
config.test = false
|
config.test = false
|
||||||
};
|
};
|
||||||
if (config.argv.nodocs) {
|
|
||||||
config.docs = false
|
|
||||||
};
|
|
||||||
if (config.argv.watch) {
|
if (config.argv.watch) {
|
||||||
config.watch = true
|
config.watch = true
|
||||||
};
|
};
|
||||||
|
Reference in New Issue
Block a user