Compare commits
No commits in common. "master" and "v5.4.32" have entirely different histories.
22
.gitignore
vendored
22
.gitignore
vendored
@ -1,20 +1,4 @@
|
|||||||
.nogit/
|
|
||||||
|
|
||||||
# artifacts
|
|
||||||
coverage/
|
|
||||||
public/
|
|
||||||
pages/
|
|
||||||
|
|
||||||
# installs
|
|
||||||
node_modules/
|
node_modules/
|
||||||
|
test/
|
||||||
# caches
|
pages/
|
||||||
.yarn/
|
.DS_Store
|
||||||
.cache/
|
|
||||||
.rpt2_cache
|
|
||||||
|
|
||||||
# builds
|
|
||||||
dist/
|
|
||||||
dist_*/
|
|
||||||
|
|
||||||
# custom
|
|
108
.gitlab-ci.yml
108
.gitlab-ci.yml
@ -1,127 +1,59 @@
|
|||||||
# gitzone ci_default
|
image: hosttoday/ht-docker-node:npmci
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
|
|
||||||
cache:
|
|
||||||
paths:
|
|
||||||
- .npmci_cache/
|
|
||||||
key: '$CI_BUILD_STAGE'
|
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- security
|
|
||||||
- test
|
- test
|
||||||
- release
|
- release
|
||||||
- metadata
|
- trigger
|
||||||
|
- pages
|
||||||
|
|
||||||
# ====================
|
testLEGACY:
|
||||||
# security stage
|
|
||||||
# ====================
|
|
||||||
mirror:
|
|
||||||
stage: security
|
|
||||||
script:
|
|
||||||
- npmci git mirror
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
audit:
|
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
stage: security
|
|
||||||
script:
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci command npm install --ignore-scripts
|
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
- npmci command npm audit --audit-level=high
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
# ====================
|
|
||||||
# test stage
|
|
||||||
# ====================
|
|
||||||
|
|
||||||
testStable:
|
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci test legacy
|
||||||
- npmci node install stable
|
|
||||||
- npmci npm install
|
|
||||||
- npmci npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
- priv
|
allow_failure: true
|
||||||
|
|
||||||
testBuild:
|
testLTS:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci test lts
|
||||||
- npmci node install stable
|
tags:
|
||||||
- npmci npm install
|
- docker
|
||||||
- npmci command npm run build
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
testSTABLE:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci test stable
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
script:
|
script:
|
||||||
- npmci node install stable
|
- npmci publish
|
||||||
- npmci npm publish
|
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
|
||||||
# ====================
|
|
||||||
# metadata stage
|
|
||||||
# ====================
|
|
||||||
codequality:
|
|
||||||
stage: metadata
|
|
||||||
allow_failure: true
|
|
||||||
script:
|
|
||||||
- npmci command npm install -g tslint typescript
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci npm install
|
|
||||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- priv
|
|
||||||
|
|
||||||
trigger:
|
trigger:
|
||||||
stage: metadata
|
stage: trigger
|
||||||
script:
|
script:
|
||||||
- npmci trigger
|
- npmci trigger
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
stage: metadata
|
image: hosttoday/ht-docker-node:npmpage
|
||||||
|
stage: pages
|
||||||
script:
|
script:
|
||||||
- npmci node install lts
|
- npmci command npmpage --host gitlab
|
||||||
- npmci command npm install -g @gitzone/tsdoc
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci npm install
|
|
||||||
- npmci command tsdoc
|
|
||||||
tags:
|
|
||||||
- lossless
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
artifacts:
|
artifacts:
|
||||||
expire_in: 1 week
|
expire_in: 1 week
|
||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
allow_failure: true
|
|
||||||
|
7
.npmignore
Normal file
7
.npmignore
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
.idea/
|
||||||
|
compile/
|
||||||
|
coverage/
|
||||||
|
test/
|
||||||
|
docs/
|
||||||
|
examples
|
||||||
|
.gitignore
|
29
.vscode/launch.json
vendored
29
.vscode/launch.json
vendored
@ -1,29 +0,0 @@
|
|||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"name": "current file",
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"args": [
|
|
||||||
"${relativeFile}"
|
|
||||||
],
|
|
||||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
|
||||||
"cwd": "${workspaceRoot}",
|
|
||||||
"protocol": "inspector",
|
|
||||||
"internalConsoleOptions": "openOnSessionStart"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "test.ts",
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"args": [
|
|
||||||
"test/test.ts"
|
|
||||||
],
|
|
||||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
|
||||||
"cwd": "${workspaceRoot}",
|
|
||||||
"protocol": "inspector",
|
|
||||||
"internalConsoleOptions": "openOnSessionStart"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
26
.vscode/settings.json
vendored
26
.vscode/settings.json
vendored
@ -1,26 +0,0 @@
|
|||||||
{
|
|
||||||
"json.schemas": [
|
|
||||||
{
|
|
||||||
"fileMatch": ["/npmextra.json"],
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"npmci": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "settings for npmci"
|
|
||||||
},
|
|
||||||
"gitzone": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "settings for gitzone",
|
|
||||||
"properties": {
|
|
||||||
"projectType": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": ["website", "element", "service", "npm"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
7
CHANGELOG
Normal file
7
CHANGELOG
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
Please view this file on the master branch, on stable branches it's out of date.
|
||||||
|
|
||||||
|
v 6.0.0 (unreleased)
|
||||||
|
- handle bithound
|
||||||
|
- check package.json
|
||||||
|
- check .gitlab-ci-yml
|
||||||
|
- check appveyor.yml
|
@ -1,6 +1,6 @@
|
|||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2016 Lossless GmbH
|
Copyright (c) 2016 Push.Rocks
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
36
README.md
Normal file
36
README.md
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
# npmts
|
||||||
|
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||||
|
|
||||||
|
## Availabililty
|
||||||
|
[](https://www.npmjs.com/package/npmts)
|
||||||
|
[](https://gitlab.com/pushrocks/npmts)
|
||||||
|
[](https://github.com/pushrocks/npmts)
|
||||||
|
[](https://pushrocks.gitlab.io/npmts/gitbook)
|
||||||
|
|
||||||
|
## Status for master
|
||||||
|
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||||
|
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||||
|
[](https://david-dm.org/pushrocks/npmts)
|
||||||
|
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||||
|
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||||
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
|
[](http://standardjs.com/)
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
||||||
|
|
||||||
|
npmts will
|
||||||
|
|
||||||
|
1. check your dependencies and package.json
|
||||||
|
1. transpile your code with tsc,
|
||||||
|
1. document your code with typedoc,
|
||||||
|
1. test your code with mocha
|
||||||
|
1. create coverage with istanbul
|
||||||
|
|
||||||
|
This works on your machine and in CI. There is a prebuild docker image available that includes npmts to make CI a breeze:
|
||||||
|
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||||
|
|
||||||
|
For further information read the docs.
|
||||||
|
|
||||||
|
[](https://push.rocks)
|
2
assets/cli.js
Normal file
2
assets/cli.js
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
var index = require("./index.js");
|
4
cli.js
4
cli.js
@ -1,4 +0,0 @@
|
|||||||
#!/usr/bin/env node
|
|
||||||
process.env.CLI_CALL = 'true';
|
|
||||||
const cliTool = require('./dist_ts/index');
|
|
||||||
cliTool.runCli();
|
|
@ -1,5 +0,0 @@
|
|||||||
#!/usr/bin/env node
|
|
||||||
process.env.CLI_CALL = 'true';
|
|
||||||
require('@gitzone/tsrun');
|
|
||||||
const cliTool = require('./ts/index');
|
|
||||||
cliTool.runCli();
|
|
2
dist/cli.js
vendored
Normal file
2
dist/cli.js
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
var index = require("./index.js");
|
2
dist/index.d.ts
vendored
2
dist/index.d.ts
vendored
@ -1 +1 @@
|
|||||||
export {};
|
import 'typings-global';
|
||||||
|
32
dist/index.js
vendored
32
dist/index.js
vendored
@ -1,14 +1,28 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
/* ================================================== *
|
/* ================================================== *
|
||||||
**** NPMTS ****
|
Starting NPMTS main process.
|
||||||
Fabulous TypeScript development
|
|
||||||
* ================================================== */
|
* ================================================== */
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
var early = require("early");
|
||||||
const early = require("early");
|
|
||||||
early.start('NPMTS');
|
early.start('NPMTS');
|
||||||
const plugins = require("./npmts.plugins");
|
var plugins = require("./npmts.plugins");
|
||||||
const cli = require("./npmts.cli");
|
var paths = require("./npmts.paths");
|
||||||
early.stop().then(() => {
|
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||||
let loaded = plugins; // to make sure plugins get actually loaded
|
early.stop()
|
||||||
cli.run();
|
.then(function () {
|
||||||
|
var npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
|
||||||
|
var npmtsCli = new plugins.smartcli.Smartcli();
|
||||||
|
npmtsCli.standardTask()
|
||||||
|
.then(function (argvArg) {
|
||||||
|
plugins.beautylog.figletSync('NPMTS');
|
||||||
|
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
|
||||||
|
try {
|
||||||
|
npmts_promisechain_1.promisechain(argvArg);
|
||||||
|
}
|
||||||
|
catch (err) {
|
||||||
|
console.log(err);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
npmtsCli.addVersion(npmtsProjectInfo.version);
|
||||||
|
npmtsCli.startParse();
|
||||||
});
|
});
|
||||||
|
2
dist/mod_compile/index.d.ts
vendored
2
dist/mod_compile/index.d.ts
vendored
@ -1,2 +0,0 @@
|
|||||||
import { INpmtsConfig } from '../npmts.config';
|
|
||||||
export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;
|
|
24
dist/mod_compile/index.js
vendored
24
dist/mod_compile/index.js
vendored
@ -1,24 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
/* ------------------------------------------
|
|
||||||
* This module compiles the module's TypeScript files
|
|
||||||
* Note: Test files are only compiled in memory
|
|
||||||
* -------------------------------------------- */
|
|
||||||
const q = require("smartq");
|
|
||||||
const plugins = require("./mod.plugins");
|
|
||||||
const NpmtsAssets = require("./mod.assets");
|
|
||||||
const NpmtsCheck = require("./mod.check");
|
|
||||||
const NpmtsClean = require("./mod.clean");
|
|
||||||
const NpmtsCompile = require("./mod.compile");
|
|
||||||
exports.run = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
plugins.beautylog.ora.text('starting TypeScript Compilation');
|
|
||||||
NpmtsClean.run(configArg)
|
|
||||||
.then(NpmtsCheck.run)
|
|
||||||
.then(NpmtsCompile.run)
|
|
||||||
.then(NpmtsAssets.run)
|
|
||||||
.then(function () {
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
1
dist/mod_compile/mod.assets.d.ts
vendored
1
dist/mod_compile/mod.assets.d.ts
vendored
@ -1 +0,0 @@
|
|||||||
export declare let run: (configArg: any) => Promise<{}>;
|
|
24
dist/mod_compile/mod.assets.js
vendored
24
dist/mod_compile/mod.assets.js
vendored
@ -1,24 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const q = require("smartq");
|
|
||||||
const paths = require("../npmts.paths");
|
|
||||||
const plugins = require("./mod.plugins");
|
|
||||||
const mod_check_1 = require("../mod_compile/mod.check");
|
|
||||||
exports.run = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
let config = configArg;
|
|
||||||
plugins.beautylog.ora.text('now looking at ' + 'required assets');
|
|
||||||
if (config.cli === true) {
|
|
||||||
let mainJsPath = mod_check_1.projectInfo.packageJson.main;
|
|
||||||
let cliJsString = plugins.smartfile.fs.toStringSync(plugins.path.join(paths.npmtsAssetsDir, 'cli.js'));
|
|
||||||
cliJsString = cliJsString.replace('{{pathToIndex}}', mainJsPath);
|
|
||||||
plugins.smartfile.memory.toFsSync(cliJsString, plugins.path.join(paths.distDir, 'cli.js'));
|
|
||||||
plugins.beautylog.ok('installed CLI assets!');
|
|
||||||
done.resolve(config);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.ok('No additional assets required!');
|
|
||||||
done.resolve(config);
|
|
||||||
}
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
4
dist/mod_compile/mod.check.d.ts
vendored
4
dist/mod_compile/mod.check.d.ts
vendored
@ -1,4 +0,0 @@
|
|||||||
import { ProjectinfoNpm } from 'projectinfo';
|
|
||||||
import { INpmtsConfig } from '../npmts.config';
|
|
||||||
export declare let projectInfo: ProjectinfoNpm;
|
|
||||||
export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;
|
|
136
dist/mod_compile/mod.check.js
vendored
136
dist/mod_compile/mod.check.js
vendored
@ -1,136 +0,0 @@
|
|||||||
"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());
|
|
||||||
});
|
|
||||||
};
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const q = require("smartq");
|
|
||||||
const projectinfo_1 = require("projectinfo");
|
|
||||||
const paths = require("../npmts.paths");
|
|
||||||
const plugins = require("./mod.plugins");
|
|
||||||
let checkProjectTypings = (configArg) => {
|
|
||||||
let done = q.defer();
|
|
||||||
plugins.beautylog.ora.text('Check Module: Check Project Typings...');
|
|
||||||
exports.projectInfo = new projectinfo_1.ProjectinfoNpm(paths.cwd);
|
|
||||||
if (typeof exports.projectInfo.packageJson.typings === 'undefined') {
|
|
||||||
plugins.beautylog.error(`please add typings field to package.json`);
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
done.resolve(configArg);
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
const depcheckOptions = {
|
|
||||||
ignoreBinPackage: false,
|
|
||||||
parsers: {
|
|
||||||
// the target parsers
|
|
||||||
'*.ts': plugins.depcheck.parser.typescript
|
|
||||||
},
|
|
||||||
detectors: [
|
|
||||||
// the target detectors
|
|
||||||
plugins.depcheck.detector.requireCallExpression,
|
|
||||||
plugins.depcheck.detector.importDeclaration
|
|
||||||
],
|
|
||||||
specials: [
|
|
||||||
// the target special parsers
|
|
||||||
plugins.depcheck.special.eslint,
|
|
||||||
plugins.depcheck.special.webpack
|
|
||||||
]
|
|
||||||
};
|
|
||||||
let checkDependencies = (configArg) => {
|
|
||||||
let done = q.defer();
|
|
||||||
plugins.beautylog.ora.text('Check Module: Check Dependencies...');
|
|
||||||
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
|
|
||||||
ignoreDirs: [
|
|
||||||
// folder with these names will be ignored
|
|
||||||
'test',
|
|
||||||
'dist',
|
|
||||||
'bower_components'
|
|
||||||
],
|
|
||||||
ignoreMatches: [
|
|
||||||
// ignore dependencies that matches these globs
|
|
||||||
'@types/*',
|
|
||||||
'babel-preset-*'
|
|
||||||
]
|
|
||||||
});
|
|
||||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, unused => {
|
|
||||||
for (let item of unused.dependencies) {
|
|
||||||
plugins.beautylog.warn(`Watch out: unused dependency "${item}"`);
|
|
||||||
}
|
|
||||||
for (let item in unused.missing) {
|
|
||||||
plugins.beautylog.error(`missing dependency "${item}" in package.json`);
|
|
||||||
}
|
|
||||||
if (unused.missing.length > 0) {
|
|
||||||
plugins.beautylog.info('exiting due to missing dependencies in package.json');
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
for (let item in unused.invalidFiles) {
|
|
||||||
plugins.beautylog.warn(`Watch out: could not parse file ${item}`);
|
|
||||||
}
|
|
||||||
for (let item in unused.invalidDirs) {
|
|
||||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item}`);
|
|
||||||
}
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
let checkDevDependencies = (configArg) => {
|
|
||||||
let done = q.defer();
|
|
||||||
plugins.beautylog.ora.text('Check Module: Check devDependencies...');
|
|
||||||
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
|
|
||||||
ignoreDirs: [
|
|
||||||
// folder with these names will be ignored
|
|
||||||
'ts',
|
|
||||||
'dist',
|
|
||||||
'bower_components'
|
|
||||||
],
|
|
||||||
ignoreMatches: [
|
|
||||||
// ignore dependencies that matches these globs
|
|
||||||
'@types/*',
|
|
||||||
'babel-preset-*'
|
|
||||||
]
|
|
||||||
});
|
|
||||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, unused => {
|
|
||||||
for (let item of unused.devDependencies) {
|
|
||||||
plugins.beautylog.log(`unused devDependency ${item}`);
|
|
||||||
}
|
|
||||||
for (let item in unused.missing) {
|
|
||||||
plugins.beautylog.error(`missing devDependency ${item}`);
|
|
||||||
}
|
|
||||||
if (unused.missing.length > 0) {
|
|
||||||
plugins.beautylog.info('exiting due to missing dependencies in package.json');
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
for (let item in unused.invalidFiles) {
|
|
||||||
plugins.beautylog.warn(`Watch out: could not parse file ${item}`);
|
|
||||||
}
|
|
||||||
for (let item in unused.invalidDirs) {
|
|
||||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item}`);
|
|
||||||
}
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
let checkNodeVersion = (configArg) => {
|
|
||||||
let done = q.defer();
|
|
||||||
plugins.beautylog.ora.text('checking node version');
|
|
||||||
done.resolve(configArg);
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
exports.run = (configArg) => __awaiter(this, void 0, void 0, function* () {
|
|
||||||
plugins.beautylog.ora.text('Check Module: ...');
|
|
||||||
if (configArg.checkDependencies) {
|
|
||||||
configArg = yield checkProjectTypings(configArg);
|
|
||||||
configArg = yield checkDependencies(configArg);
|
|
||||||
configArg = yield checkDevDependencies(configArg);
|
|
||||||
configArg = yield checkNodeVersion(configArg);
|
|
||||||
return configArg;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
configArg = yield checkProjectTypings(configArg);
|
|
||||||
return configArg;
|
|
||||||
}
|
|
||||||
});
|
|
1
dist/mod_compile/mod.clean.d.ts
vendored
1
dist/mod_compile/mod.clean.d.ts
vendored
@ -1 +0,0 @@
|
|||||||
export declare let run: (configArg: any) => Promise<{}>;
|
|
30
dist/mod_compile/mod.clean.js
vendored
30
dist/mod_compile/mod.clean.js
vendored
@ -1,30 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const q = require("smartq");
|
|
||||||
const paths = require("../npmts.paths");
|
|
||||||
const plugins = require("./mod.plugins");
|
|
||||||
/**
|
|
||||||
* removes the dist directory which will be entirely rebuild
|
|
||||||
*/
|
|
||||||
let removeDist = function () {
|
|
||||||
plugins.beautylog.ora.text('cleaning dist folder');
|
|
||||||
return plugins.smartfile.fs.remove(paths.distDir);
|
|
||||||
};
|
|
||||||
/**
|
|
||||||
* remove old pages
|
|
||||||
*/
|
|
||||||
let removePages = function () {
|
|
||||||
plugins.beautylog.ora.text('cleaning pages folder');
|
|
||||||
return plugins.smartfile.fs.remove(paths.pagesDir);
|
|
||||||
};
|
|
||||||
exports.run = function (configArg) {
|
|
||||||
plugins.beautylog.ora.text('cleaning up from previous builds...');
|
|
||||||
let done = q.defer();
|
|
||||||
removeDist()
|
|
||||||
.then(removePages)
|
|
||||||
.then(function () {
|
|
||||||
plugins.beautylog.ok('Cleaned up from previous builds!');
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
1
dist/mod_compile/mod.compile.d.ts
vendored
1
dist/mod_compile/mod.compile.d.ts
vendored
@ -1 +0,0 @@
|
|||||||
export declare let run: (configArg: any) => Promise<{}>;
|
|
20
dist/mod_compile/mod.compile.js
vendored
20
dist/mod_compile/mod.compile.js
vendored
@ -1,20 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const q = require("smartq");
|
|
||||||
const paths = require("../npmts.paths");
|
|
||||||
const plugins = require("./mod.plugins");
|
|
||||||
exports.run = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
let config = configArg;
|
|
||||||
plugins.beautylog.ora.text('now compiling ' + 'TypeScript');
|
|
||||||
plugins.tsn
|
|
||||||
.compileGlobStringObject(config.ts, config.tsOptions, paths.cwd)
|
|
||||||
.then(() => {
|
|
||||||
plugins.beautylog.ok(`compiled the module's TypeScript!`);
|
|
||||||
done.resolve(config);
|
|
||||||
})
|
|
||||||
.catch(err => {
|
|
||||||
console.log(err);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
5
dist/mod_compile/mod.plugins.d.ts
vendored
5
dist/mod_compile/mod.plugins.d.ts
vendored
@ -1,5 +0,0 @@
|
|||||||
export * from '../npmts.plugins';
|
|
||||||
import * as tsn from 'tsn';
|
|
||||||
import * as smartchok from 'smartchok';
|
|
||||||
import * as smartstream from 'smartstream';
|
|
||||||
export { tsn, smartchok, smartstream };
|
|
12
dist/mod_compile/mod.plugins.js
vendored
12
dist/mod_compile/mod.plugins.js
vendored
@ -1,12 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
function __export(m) {
|
|
||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
|
||||||
}
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
__export(require("../npmts.plugins"));
|
|
||||||
const tsn = require("tsn");
|
|
||||||
exports.tsn = tsn;
|
|
||||||
const smartchok = require("smartchok");
|
|
||||||
exports.smartchok = smartchok;
|
|
||||||
const smartstream = require("smartstream");
|
|
||||||
exports.smartstream = smartstream;
|
|
2
dist/mod_docs/index.d.ts
vendored
2
dist/mod_docs/index.d.ts
vendored
@ -1,2 +0,0 @@
|
|||||||
import { INpmtsConfig } from '../npmts.config';
|
|
||||||
export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;
|
|
11
dist/mod_docs/index.js
vendored
11
dist/mod_docs/index.js
vendored
@ -1,11 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
/* ------------------------------------------
|
|
||||||
* This module creates TypeScript documentation
|
|
||||||
* -------------------------------------------- */
|
|
||||||
const q = require("smartq");
|
|
||||||
exports.run = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
done.resolve(configArg);
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
1
dist/mod_docs/mod.plugins.d.ts
vendored
1
dist/mod_docs/mod.plugins.d.ts
vendored
@ -1 +0,0 @@
|
|||||||
export * from '../npmts.plugins';
|
|
6
dist/mod_docs/mod.plugins.js
vendored
6
dist/mod_docs/mod.plugins.js
vendored
@ -1,6 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
function __export(m) {
|
|
||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
|
||||||
}
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
__export(require("../npmts.plugins"));
|
|
6
dist/mod_test/index.d.ts
vendored
6
dist/mod_test/index.d.ts
vendored
@ -1,6 +0,0 @@
|
|||||||
import { INpmtsConfig } from '../npmts.config';
|
|
||||||
/**
|
|
||||||
* run this module
|
|
||||||
* @param configArg some config for how to run this module
|
|
||||||
*/
|
|
||||||
export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;
|
|
132
dist/mod_test/index.js
vendored
132
dist/mod_test/index.js
vendored
@ -1,132 +0,0 @@
|
|||||||
"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());
|
|
||||||
});
|
|
||||||
};
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
/* ------------------------------------------
|
|
||||||
* This module tests the compiled TypeScript files
|
|
||||||
* -------------------------------------------- */
|
|
||||||
const plugins = require("./mod.plugins");
|
|
||||||
const paths = require("../npmts.paths");
|
|
||||||
const q = require("smartq");
|
|
||||||
let testTypeScriptConfig = {
|
|
||||||
target: 'ES5',
|
|
||||||
emitDecoratorMetadata: true,
|
|
||||||
experimentalDecorators: true,
|
|
||||||
lib: ['DOM', 'ESNext']
|
|
||||||
};
|
|
||||||
/**
|
|
||||||
* runs mocha
|
|
||||||
* @returns INpmtsConfig
|
|
||||||
*/
|
|
||||||
let tap = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
/**
|
|
||||||
* the TabBuffer for npmts
|
|
||||||
*/
|
|
||||||
let npmtsTapBuffer = new plugins.tapbuffer.TabBuffer();
|
|
||||||
npmtsTapBuffer.setConfig(configArg.testConfig);
|
|
||||||
/**
|
|
||||||
* handle the testable files
|
|
||||||
*/
|
|
||||||
let testableFilesSmartstream = new plugins.smartstream.Smartstream([
|
|
||||||
plugins.smartgulp.src([plugins.path.join(paths.cwd, './ts/**/*.ts')]),
|
|
||||||
plugins.gulpSourcemaps.init(),
|
|
||||||
plugins.gulpTypeScript(testTypeScriptConfig),
|
|
||||||
plugins.gulpSourcemaps.write(),
|
|
||||||
npmtsTapBuffer.pipeTestableFiles(),
|
|
||||||
plugins.smartstream.cleanPipe()
|
|
||||||
]);
|
|
||||||
/**
|
|
||||||
* handle the test files
|
|
||||||
*/
|
|
||||||
let testFilesSmartstream = new plugins.smartstream.Smartstream([
|
|
||||||
plugins.smartgulp.src([plugins.path.join(paths.cwd, 'test/*.ts')]),
|
|
||||||
plugins.gulpSourcemaps.init(),
|
|
||||||
plugins.gulpTypeScript(testTypeScriptConfig),
|
|
||||||
plugins.gulpSourcemaps.write(),
|
|
||||||
npmtsTapBuffer.pipeTestFiles(),
|
|
||||||
plugins.smartstream.cleanPipe()
|
|
||||||
]);
|
|
||||||
// lets run the smartstream
|
|
||||||
Promise.all([testableFilesSmartstream.run(), testFilesSmartstream.run()]).then(() => __awaiter(this, void 0, void 0, function* () {
|
|
||||||
configArg.runData.coverageLcovInfo = yield npmtsTapBuffer.runTests();
|
|
||||||
done.resolve(configArg);
|
|
||||||
}), err => {
|
|
||||||
plugins.beautylog.error('Tests failed!');
|
|
||||||
console.log(err);
|
|
||||||
if (configArg.watch) {
|
|
||||||
done.resolve(configArg);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
let handleCoverageData = (configArg) => __awaiter(this, void 0, void 0, function* () {
|
|
||||||
let coverageResult = 0; // the coverage in percent
|
|
||||||
if (configArg.runData.coverageLcovInfo) {
|
|
||||||
coverageResult = yield plugins.smartcov.get.percentageFromLcovString(configArg.runData.coverageLcovInfo, 2);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.warn('Hey... Did your tests import and use your module that you are trying to test?');
|
|
||||||
}
|
|
||||||
if (coverageResult >= configArg.coverageTreshold) {
|
|
||||||
plugins.beautylog.ok(`${coverageResult.toString()}% ` +
|
|
||||||
`coverage exceeds your treshold of ` +
|
|
||||||
`${configArg.coverageTreshold.toString()}%`);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.warn(`${coverageResult.toString()}% ` +
|
|
||||||
`coverage fails your treshold of ` +
|
|
||||||
`${configArg.coverageTreshold.toString()}%`);
|
|
||||||
plugins.beautylog.error('exiting due to coverage failure');
|
|
||||||
if (!configArg.watch) {
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return configArg;
|
|
||||||
});
|
|
||||||
/**
|
|
||||||
* run this module
|
|
||||||
* @param configArg some config for how to run this module
|
|
||||||
*/
|
|
||||||
exports.run = function (configArg) {
|
|
||||||
let done = q.defer();
|
|
||||||
let config = configArg;
|
|
||||||
if (config.test === true) {
|
|
||||||
plugins.beautylog.ora.text('now starting tests');
|
|
||||||
plugins.beautylog.ora.end();
|
|
||||||
plugins.beautylog.log('ready for tapbuffer:');
|
|
||||||
if (configArg.testConfig.coverage) {
|
|
||||||
tap(config)
|
|
||||||
.then(handleCoverageData)
|
|
||||||
.then(() => {
|
|
||||||
done.resolve(config);
|
|
||||||
})
|
|
||||||
.catch(err => {
|
|
||||||
console.log(err);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
tap(config)
|
|
||||||
.then(() => {
|
|
||||||
done.resolve(config);
|
|
||||||
})
|
|
||||||
.catch(err => {
|
|
||||||
console.log(err);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.ora.end();
|
|
||||||
done.resolve(config);
|
|
||||||
}
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
8
dist/mod_test/mod.plugins.d.ts
vendored
8
dist/mod_test/mod.plugins.d.ts
vendored
@ -1,8 +0,0 @@
|
|||||||
export * from '../npmts.plugins';
|
|
||||||
import * as gulpFunction from 'gulp-function';
|
|
||||||
import * as gulpSourcemaps from 'gulp-sourcemaps';
|
|
||||||
import * as gulpTypeScript from 'gulp-typescript';
|
|
||||||
import * as smartcov from 'smartcov';
|
|
||||||
import * as smartgulp from 'smartgulp';
|
|
||||||
import * as tapbuffer from 'tapbuffer';
|
|
||||||
export { gulpFunction, gulpSourcemaps, gulpTypeScript, smartcov, smartgulp, tapbuffer };
|
|
18
dist/mod_test/mod.plugins.js
vendored
18
dist/mod_test/mod.plugins.js
vendored
@ -1,18 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
function __export(m) {
|
|
||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
|
||||||
}
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
__export(require("../npmts.plugins"));
|
|
||||||
const gulpFunction = require("gulp-function");
|
|
||||||
exports.gulpFunction = gulpFunction;
|
|
||||||
const gulpSourcemaps = require("gulp-sourcemaps");
|
|
||||||
exports.gulpSourcemaps = gulpSourcemaps;
|
|
||||||
const gulpTypeScript = require("gulp-typescript");
|
|
||||||
exports.gulpTypeScript = gulpTypeScript;
|
|
||||||
const smartcov = require("smartcov");
|
|
||||||
exports.smartcov = smartcov;
|
|
||||||
const smartgulp = require("smartgulp");
|
|
||||||
exports.smartgulp = smartgulp;
|
|
||||||
const tapbuffer = require("tapbuffer");
|
|
||||||
exports.tapbuffer = tapbuffer;
|
|
4
dist/npmts.assets.d.ts
vendored
Normal file
4
dist/npmts.assets.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
/// <reference types="q" />
|
||||||
|
import 'typings-global';
|
||||||
|
import plugins = require('./npmts.plugins');
|
||||||
|
export declare var run: (configArg: any) => plugins.Q.Promise<{}>;
|
20
dist/npmts.assets.js
vendored
Normal file
20
dist/npmts.assets.js
vendored
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
|
var plugins = require("./npmts.plugins");
|
||||||
|
var paths = require("./npmts.paths");
|
||||||
|
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||||
|
exports.run = function (configArg) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
var config = configArg;
|
||||||
|
npmts_promisechain_1.npmtsOra.text('now looking at ' + 'required assets'.yellow);
|
||||||
|
if (config.cli === true) {
|
||||||
|
plugins.smartfile.fs.copySync(plugins.path.join(paths.npmtsAssetsDir, 'cli.js'), plugins.path.join(paths.distDir, 'cli.js'));
|
||||||
|
plugins.beautylog.ok('installed CLI assets!');
|
||||||
|
done.resolve(config);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
plugins.beautylog.ok('No additional assets required!');
|
||||||
|
done.resolve(config);
|
||||||
|
}
|
||||||
|
return done.promise;
|
||||||
|
};
|
5
dist/npmts.check.d.ts
vendored
Normal file
5
dist/npmts.check.d.ts
vendored
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
/// <reference types="q" />
|
||||||
|
import * as plugins from './npmts.plugins';
|
||||||
|
import { ProjectinfoNpm } from 'projectinfo';
|
||||||
|
export declare let projectInfo: ProjectinfoNpm;
|
||||||
|
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
127
dist/npmts.check.js
vendored
Normal file
127
dist/npmts.check.js
vendored
Normal file
@ -0,0 +1,127 @@
|
|||||||
|
"use strict";
|
||||||
|
var plugins = require("./npmts.plugins");
|
||||||
|
var paths = require("./npmts.paths");
|
||||||
|
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||||
|
var projectinfo_1 = require("projectinfo");
|
||||||
|
var checkProjectTypings = function (configArg) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
exports.projectInfo = new projectinfo_1.ProjectinfoNpm(paths.cwd);
|
||||||
|
if (typeof exports.projectInfo.packageJson.typings === 'undefined') {
|
||||||
|
plugins.beautylog.error("please add typings field to package.json");
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
done.resolve(configArg);
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
var depcheckOptions = {
|
||||||
|
ignoreBinPackage: false,
|
||||||
|
parsers: {
|
||||||
|
'*.ts': plugins.depcheck.parser.typescript
|
||||||
|
},
|
||||||
|
detectors: [
|
||||||
|
plugins.depcheck.detector.requireCallExpression,
|
||||||
|
plugins.depcheck.detector.importDeclaration
|
||||||
|
],
|
||||||
|
specials: [
|
||||||
|
plugins.depcheck.special.eslint,
|
||||||
|
plugins.depcheck.special.webpack
|
||||||
|
]
|
||||||
|
};
|
||||||
|
var checkDependencies = function (configArg) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||||
|
ignoreDirs: [
|
||||||
|
'test',
|
||||||
|
'dist',
|
||||||
|
'bower_components'
|
||||||
|
],
|
||||||
|
ignoreMatches: [
|
||||||
|
'@types/*',
|
||||||
|
'babel-preset-*'
|
||||||
|
]
|
||||||
|
});
|
||||||
|
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
|
||||||
|
for (var _i = 0, _a = unused.dependencies; _i < _a.length; _i++) {
|
||||||
|
var item = _a[_i];
|
||||||
|
plugins.beautylog.warn("Watch out: unused dependency " + item.red);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
|
||||||
|
var item = _c[_b];
|
||||||
|
plugins.beautylog.error("unused devDependency " + item.red);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
if (unused.missing.length > 0) {
|
||||||
|
plugins.beautylog.info('exiting due to missing dependencies in package.json');
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||||
|
var item = _e[_d];
|
||||||
|
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
|
||||||
|
var item = _g[_f];
|
||||||
|
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
done.resolve(configArg);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
var checkDevDependencies = function (configArg) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||||
|
ignoreDirs: [
|
||||||
|
'ts',
|
||||||
|
'dist',
|
||||||
|
'bower_components'
|
||||||
|
],
|
||||||
|
ignoreMatches: [
|
||||||
|
'@types/*',
|
||||||
|
'babel-preset-*'
|
||||||
|
]
|
||||||
|
});
|
||||||
|
plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
|
||||||
|
for (var _i = 0, _a = unused.devDependencies; _i < _a.length; _i++) {
|
||||||
|
var item = _a[_i];
|
||||||
|
plugins.beautylog.log("unused devDependency " + item.red);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
|
||||||
|
var item = _c[_b];
|
||||||
|
plugins.beautylog.error("unused devDependency " + item.red);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
if (unused.missing.length > 0) {
|
||||||
|
plugins.beautylog.info('exiting due to missing dependencies in package.json');
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||||
|
var item = _e[_d];
|
||||||
|
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||||
|
}
|
||||||
|
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
|
||||||
|
var item = _g[_f];
|
||||||
|
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
||||||
|
}
|
||||||
|
done.resolve(configArg);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
var checkNodeVersion = function (configArg) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
done.resolve(configArg);
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
exports.run = function (configArg) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
npmts_promisechain_1.npmtsOra.text('running project checks...');
|
||||||
|
checkProjectTypings(configArg)
|
||||||
|
.then(checkDependencies)
|
||||||
|
.then(checkDevDependencies)
|
||||||
|
.then(checkNodeVersion)
|
||||||
|
.then(done.resolve);
|
||||||
|
return done.promise;
|
||||||
|
};
|
4
dist/npmts.clean.d.ts
vendored
Normal file
4
dist/npmts.clean.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
/// <reference types="q" />
|
||||||
|
import 'typings-global';
|
||||||
|
import plugins = require('./npmts.plugins');
|
||||||
|
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
24
dist/npmts.clean.js
vendored
Normal file
24
dist/npmts.clean.js
vendored
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
|
var plugins = require("./npmts.plugins");
|
||||||
|
var paths = require("./npmts.paths");
|
||||||
|
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||||
|
var removeDist = function () {
|
||||||
|
npmts_promisechain_1.npmtsOra.text('cleaning dist folder');
|
||||||
|
return plugins.smartfile.fs.remove(paths.distDir);
|
||||||
|
};
|
||||||
|
var removePages = function () {
|
||||||
|
npmts_promisechain_1.npmtsOra.text('cleaning pages folder');
|
||||||
|
return plugins.smartfile.fs.remove(paths.pagesDir);
|
||||||
|
};
|
||||||
|
exports.run = function (configArg) {
|
||||||
|
npmts_promisechain_1.npmtsOra.text('cleaning up from previous builds...');
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
removeDist()
|
||||||
|
.then(removePages)
|
||||||
|
.then(function () {
|
||||||
|
plugins.beautylog.ok('Cleaned up from previous builds!');
|
||||||
|
done.resolve(configArg);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
1
dist/npmts.cli.d.ts
vendored
1
dist/npmts.cli.d.ts
vendored
@ -1 +0,0 @@
|
|||||||
export declare let run: () => Promise<{}>;
|
|
109
dist/npmts.cli.js
vendored
109
dist/npmts.cli.js
vendored
@ -1,109 +0,0 @@
|
|||||||
"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());
|
|
||||||
});
|
|
||||||
};
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const q = require("smartq");
|
|
||||||
const plugins = require("./npmts.plugins");
|
|
||||||
const paths = require("./npmts.paths");
|
|
||||||
const NpmtsConfig = require("./npmts.config");
|
|
||||||
const NpmtsMods = require("./npmts.mods");
|
|
||||||
const NpmtsWatch = require("./npmts.watch");
|
|
||||||
const NpmtsShip = require("./npmts.ship");
|
|
||||||
/**
|
|
||||||
* smartanalytics
|
|
||||||
* this data is fully anonymized (no Ips or any other personal information is tracked).
|
|
||||||
* It just keeps track which of our tools are really used...
|
|
||||||
* ... so we know where to spend our limited resources for improving them.
|
|
||||||
* Since yarn is out and there is heavy caching going on,
|
|
||||||
* pure download stats are just not reliable enough for us anymore
|
|
||||||
* Feel free to dig into the smartanalytics package, if you are interested in how it works.
|
|
||||||
* It is just an https call to our own Lossless Analytics API.
|
|
||||||
* Our privacy policy can be found here: https://lossless.gmbh/privacy.html
|
|
||||||
*/
|
|
||||||
let npmtsAnalytics = new plugins.smartanalytics.Analytics({
|
|
||||||
apiEndPoint: 'https://pubapi.lossless.one/analytics',
|
|
||||||
projectId: 'gitzone',
|
|
||||||
appName: 'npmts'
|
|
||||||
});
|
|
||||||
process.nextTick(() => __awaiter(this, void 0, void 0, function* () {
|
|
||||||
// make the analytics call
|
|
||||||
npmtsAnalytics
|
|
||||||
.recordEvent('npmToolExecution', {
|
|
||||||
executionMode: (yield NpmtsConfig.configPromise).mode,
|
|
||||||
tsOptions: (yield NpmtsConfig.configPromise).tsOptions,
|
|
||||||
watch: (yield NpmtsConfig.configPromise).watch,
|
|
||||||
coverageTreshold: (yield NpmtsConfig.configPromise).coverageTreshold
|
|
||||||
})
|
|
||||||
.catch(err => {
|
|
||||||
plugins.beautylog.warn('Lossless Analytics API not available...');
|
|
||||||
});
|
|
||||||
}));
|
|
||||||
exports.run = () => __awaiter(this, void 0, void 0, function* () {
|
|
||||||
let done = q.defer();
|
|
||||||
plugins.beautylog.figletSync('NPMTS');
|
|
||||||
let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
|
|
||||||
// check for updates
|
|
||||||
yield plugins.smartupdate.standardHandler.check('npmts', npmtsProjectInfo.version, 'http://gitzone.gitlab.io/npmts/changelog.html');
|
|
||||||
plugins.beautylog.log('---------------------------------------------');
|
|
||||||
let npmtsCli = new plugins.smartcli.Smartcli();
|
|
||||||
// build
|
|
||||||
npmtsCli
|
|
||||||
.addCommand('build')
|
|
||||||
.subscribe((argvArg) => __awaiter(this, void 0, void 0, function* () {
|
|
||||||
let done = q.defer();
|
|
||||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
|
|
||||||
const configArg = yield NpmtsConfig.run(argvArg);
|
|
||||||
plugins.beautylog.ora.start('loading additional modules...');
|
|
||||||
NpmtsMods.modCompile
|
|
||||||
.load()
|
|
||||||
.then(modCompile => {
|
|
||||||
return modCompile.run(configArg);
|
|
||||||
})
|
|
||||||
.then(configArg => {
|
|
||||||
let done = q.defer();
|
|
||||||
NpmtsMods.modDocs
|
|
||||||
.load()
|
|
||||||
.then(modDocs => {
|
|
||||||
return modDocs.run(configArg);
|
|
||||||
})
|
|
||||||
.then(configArg => {
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
})
|
|
||||||
.then(configArg => {
|
|
||||||
let done = q.defer();
|
|
||||||
NpmtsMods.modTest
|
|
||||||
.load()
|
|
||||||
.then(modTest => {
|
|
||||||
return modTest.run(configArg);
|
|
||||||
})
|
|
||||||
.then(configArg => {
|
|
||||||
done.resolve(configArg);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
})
|
|
||||||
.then(NpmtsWatch.run)
|
|
||||||
.then(NpmtsShip.run);
|
|
||||||
return done.promise;
|
|
||||||
}), err => {
|
|
||||||
if (err instanceof Error) {
|
|
||||||
console.log(err);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
// standard task
|
|
||||||
npmtsCli.standardTask().subscribe((argvArg) => __awaiter(this, void 0, void 0, function* () {
|
|
||||||
yield npmtsCli.trigger('build');
|
|
||||||
}));
|
|
||||||
// cli metadata
|
|
||||||
npmtsCli.addVersion(npmtsProjectInfo.version);
|
|
||||||
// start parsing
|
|
||||||
npmtsCli.startParse();
|
|
||||||
return yield done.promise;
|
|
||||||
});
|
|
4
dist/npmts.compile.d.ts
vendored
Normal file
4
dist/npmts.compile.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
/// <reference types="q" />
|
||||||
|
import 'typings-global';
|
||||||
|
import plugins = require('./npmts.plugins');
|
||||||
|
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
1
dist/npmts.compile.helpers.d.ts
vendored
Normal file
1
dist/npmts.compile.helpers.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
export declare let checkOutputPath: (tsArrayArg: any, keyArg: any) => boolean;
|
16
dist/npmts.compile.helpers.js
vendored
Normal file
16
dist/npmts.compile.helpers.js
vendored
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
"use strict";
|
||||||
|
var plugins = require("./npmts.plugins");
|
||||||
|
var paths = require("./npmts.paths");
|
||||||
|
var outputPathIsDir = function (tsArrayArg, keyArg) {
|
||||||
|
return plugins.smartpath.check.isDir(plugins.path.join(paths.cwd, tsArrayArg[keyArg]));
|
||||||
|
};
|
||||||
|
exports.checkOutputPath = function (tsArrayArg, keyArg) {
|
||||||
|
if (!outputPathIsDir(tsArrayArg, keyArg)) {
|
||||||
|
plugins.beautylog.warn('Skipping ' + keyArg + ' because ' + tsArrayArg[keyArg] + ' it is no directory!');
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
;
|
||||||
|
};
|
64
dist/npmts.compile.js
vendored
Normal file
64
dist/npmts.compile.js
vendored
Normal file
@ -0,0 +1,64 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
|
var plugins = require("./npmts.plugins");
|
||||||
|
var helpers = require("./npmts.compile.helpers");
|
||||||
|
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||||
|
var promiseArray = [];
|
||||||
|
var compileTs = function (tsFileArrayArg, tsOptionsArg) {
|
||||||
|
if (tsOptionsArg === void 0) { tsOptionsArg = {}; }
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
var compilerOptionsDefault = {
|
||||||
|
declaration: true,
|
||||||
|
module: 'CommonJS',
|
||||||
|
target: 'ES6'
|
||||||
|
};
|
||||||
|
/**
|
||||||
|
* merges default ts options with those found in npmts.json
|
||||||
|
*/
|
||||||
|
var compilerOptions = function (keyArg) {
|
||||||
|
var tsOptionsCombined = plugins.lodashObject.merge(compilerOptionsDefault, tsOptionsArg);
|
||||||
|
var compilerOptions = {
|
||||||
|
declaration: tsOptionsCombined.declaration,
|
||||||
|
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
||||||
|
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target],
|
||||||
|
exclude: 'node_modules/**/*'
|
||||||
|
};
|
||||||
|
return compilerOptions;
|
||||||
|
};
|
||||||
|
var _loop_1 = function (keyArg) {
|
||||||
|
plugins.beautylog.info("TypeScript assignment: transpile from " + keyArg.blue + " to " + tsFileArrayArg[keyArg].blue);
|
||||||
|
if (helpers.checkOutputPath(tsFileArrayArg, keyArg)) {
|
||||||
|
var filesReadPromise = plugins.smartfile.fs.listFileTree(process.cwd(), keyArg)
|
||||||
|
.then(function (filesToConvertArg) {
|
||||||
|
var filesToConvertAbsolute = plugins.smartpath.transform.toAbsolute(filesToConvertArg, process.cwd());
|
||||||
|
var destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg], process.cwd());
|
||||||
|
var filesCompiledPromise = plugins.tsn.compile(filesToConvertAbsolute, destDir, compilerOptions(keyArg));
|
||||||
|
promiseArray.push(filesCompiledPromise);
|
||||||
|
});
|
||||||
|
promiseArray.push(filesReadPromise);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
for (var keyArg in tsFileArrayArg) {
|
||||||
|
_loop_1(keyArg);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
plugins.Q.all(promiseArray)
|
||||||
|
.then(done.resolve);
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
exports.run = function (configArg) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
var config = configArg;
|
||||||
|
npmts_promisechain_1.npmtsOra.text('now compiling ' + 'TypeScript'.yellow);
|
||||||
|
compileTs(config.ts, config.tsOptions)
|
||||||
|
.then(function () {
|
||||||
|
plugins.beautylog.ok('compiled main TypeScript!');
|
||||||
|
plugins.beautylog.log('now compiling tests!');
|
||||||
|
return compileTs(config.testTs);
|
||||||
|
})
|
||||||
|
.then(function () {
|
||||||
|
plugins.beautylog.ok('compiled all TypeScript!');
|
||||||
|
done.resolve(config);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
26
dist/npmts.config.d.ts
vendored
26
dist/npmts.config.d.ts
vendored
@ -1,26 +0,0 @@
|
|||||||
import { ITapbufferConfig } from 'tapbuffer';
|
|
||||||
/**
|
|
||||||
* specifies the different modes available
|
|
||||||
* default -> uses default options no matterm what
|
|
||||||
* merge -> uses merged default + custom options
|
|
||||||
* custom -> only uses specified options
|
|
||||||
*/
|
|
||||||
export declare type npmtsMode = 'default' | 'custom' | 'merge';
|
|
||||||
export interface INpmtsConfig {
|
|
||||||
argv: any;
|
|
||||||
coverageTreshold: number;
|
|
||||||
checkDependencies: boolean;
|
|
||||||
mode: npmtsMode;
|
|
||||||
test: boolean;
|
|
||||||
testTs: any;
|
|
||||||
testConfig: ITapbufferConfig;
|
|
||||||
ts: any;
|
|
||||||
tsOptions: any;
|
|
||||||
watch: boolean;
|
|
||||||
runData: {
|
|
||||||
coverageLcovInfo?: string;
|
|
||||||
coverageResult?: number;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
export declare let run: (argvArg: any) => Promise<INpmtsConfig>;
|
|
||||||
export declare let configPromise: Promise<INpmtsConfig>;
|
|
71
dist/npmts.config.js
vendored
71
dist/npmts.config.js
vendored
@ -1,71 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const plugins = require("./npmts.plugins");
|
|
||||||
const paths = require("./npmts.paths");
|
|
||||||
const smartq = require("smartq");
|
|
||||||
exports.run = function (argvArg) {
|
|
||||||
let done = smartq.defer();
|
|
||||||
let defaultConfig = {
|
|
||||||
argv: undefined,
|
|
||||||
coverageTreshold: 70,
|
|
||||||
checkDependencies: true,
|
|
||||||
mode: 'default',
|
|
||||||
test: true,
|
|
||||||
testTs: {},
|
|
||||||
testConfig: {
|
|
||||||
parallel: true,
|
|
||||||
coverage: true
|
|
||||||
},
|
|
||||||
ts: {},
|
|
||||||
tsOptions: {},
|
|
||||||
watch: false,
|
|
||||||
runData: {}
|
|
||||||
};
|
|
||||||
// mix with configfile
|
|
||||||
plugins.beautylog.ora.text('running npmextra');
|
|
||||||
let localNpmextra = new plugins.npmextra.Npmextra(paths.cwd);
|
|
||||||
let config = localNpmextra.dataFor('npmts', defaultConfig);
|
|
||||||
// add argv
|
|
||||||
config.argv = argvArg;
|
|
||||||
// check mode
|
|
||||||
switch (config.mode) {
|
|
||||||
case 'default':
|
|
||||||
case 'custom':
|
|
||||||
case 'merge':
|
|
||||||
plugins.beautylog.ok('mode is ' + config.mode);
|
|
||||||
done.resolve(config);
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
plugins.beautylog.error(`mode not recognised! Can be default or custom`);
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
// handle default mode
|
|
||||||
if (config.mode === 'default' || config.mode === 'merge') {
|
|
||||||
config.ts = {
|
|
||||||
'./ts/**/*.ts': './dist/'
|
|
||||||
};
|
|
||||||
config.testTs = {
|
|
||||||
'./test/**/*.ts': './test/'
|
|
||||||
};
|
|
||||||
}
|
|
||||||
// mix with commandline
|
|
||||||
if (config.argv.notest) {
|
|
||||||
config.test = false;
|
|
||||||
}
|
|
||||||
if (config.argv.nocoverage) {
|
|
||||||
config.testConfig.coverage = false;
|
|
||||||
}
|
|
||||||
if (config.argv.nochecks) {
|
|
||||||
config.checkDependencies = false;
|
|
||||||
}
|
|
||||||
if (config.argv.watch) {
|
|
||||||
config.watch = true;
|
|
||||||
}
|
|
||||||
plugins.beautylog.ok('build options are ready!');
|
|
||||||
done.resolve(config);
|
|
||||||
configDeferred.resolve(config);
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
// config deferred usage
|
|
||||||
let configDeferred = smartq.defer();
|
|
||||||
exports.configPromise = configDeferred.promise;
|
|
7
dist/npmts.mods.d.ts
vendored
7
dist/npmts.mods.d.ts
vendored
@ -1,7 +0,0 @@
|
|||||||
import * as plugins from './npmts.plugins';
|
|
||||||
import * as _modCompile from './mod_compile/index';
|
|
||||||
import * as _modDocs from './mod_docs/index';
|
|
||||||
import * as _modTest from './mod_test/index';
|
|
||||||
export declare let modCompile: plugins.smartsystem.LazyModule<typeof _modCompile>;
|
|
||||||
export declare let modDocs: plugins.smartsystem.LazyModule<typeof _modDocs>;
|
|
||||||
export declare let modTest: plugins.smartsystem.LazyModule<typeof _modTest>;
|
|
6
dist/npmts.mods.js
vendored
6
dist/npmts.mods.js
vendored
@ -1,6 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const smartsystem_1 = require("smartsystem");
|
|
||||||
exports.modCompile = new smartsystem_1.LazyModule('./mod_compile/index', __dirname);
|
|
||||||
exports.modDocs = new smartsystem_1.LazyModule('./mod_docs/index', __dirname);
|
|
||||||
exports.modTest = new smartsystem_1.LazyModule('./mod_test/index', __dirname);
|
|
15
dist/npmts.options.d.ts
vendored
Normal file
15
dist/npmts.options.d.ts
vendored
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
/// <reference types="q" />
|
||||||
|
import 'typings-global';
|
||||||
|
import plugins = require('./npmts.plugins');
|
||||||
|
export declare type npmtsMode = 'default' | 'custom';
|
||||||
|
export interface INpmtsConfig {
|
||||||
|
argv: any;
|
||||||
|
coverageTreshold: number;
|
||||||
|
docs: boolean;
|
||||||
|
mode: npmtsMode;
|
||||||
|
test: boolean;
|
||||||
|
testTs: any;
|
||||||
|
ts: any;
|
||||||
|
tsOptions: any;
|
||||||
|
}
|
||||||
|
export declare var run: (argvArg: any) => plugins.Q.Promise<{}>;
|
63
dist/npmts.options.js
vendored
Normal file
63
dist/npmts.options.js
vendored
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
|
var plugins = require("./npmts.plugins");
|
||||||
|
var paths = require("./npmts.paths");
|
||||||
|
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||||
|
;
|
||||||
|
exports.run = function (argvArg) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
var defaultConfig = {
|
||||||
|
argv: undefined,
|
||||||
|
coverageTreshold: 70,
|
||||||
|
docs: true,
|
||||||
|
mode: 'default',
|
||||||
|
test: true,
|
||||||
|
testTs: {},
|
||||||
|
ts: {},
|
||||||
|
tsOptions: {}
|
||||||
|
};
|
||||||
|
// mix with configfile
|
||||||
|
npmts_promisechain_1.npmtsOra.text('looking for npmextra.json');
|
||||||
|
var config = plugins.npmextra.dataFor({
|
||||||
|
toolName: 'npmts',
|
||||||
|
defaultSettings: defaultConfig,
|
||||||
|
cwd: paths.cwd
|
||||||
|
});
|
||||||
|
// add argv
|
||||||
|
config.argv = argvArg;
|
||||||
|
// check mode
|
||||||
|
switch (config.mode) {
|
||||||
|
case 'default':
|
||||||
|
case 'custom':
|
||||||
|
plugins.beautylog.ok('mode is ' + config.mode);
|
||||||
|
done.resolve(config);
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
plugins.beautylog.error("mode not recognised!");
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
// handle default mode
|
||||||
|
if (config.mode === 'default') {
|
||||||
|
config.ts = (_a = {},
|
||||||
|
_a['./ts/**/*.ts'] = './dist/',
|
||||||
|
_a);
|
||||||
|
config.testTs = (_b = {},
|
||||||
|
_b['./test/test.ts'] = './test/',
|
||||||
|
_b);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
// mix with commandline
|
||||||
|
if (config.argv.notest) {
|
||||||
|
config.test = false;
|
||||||
|
}
|
||||||
|
;
|
||||||
|
if (config.argv.nodocs) {
|
||||||
|
config.docs = false;
|
||||||
|
}
|
||||||
|
;
|
||||||
|
plugins.beautylog.ok('build options are ready!');
|
||||||
|
done.resolve(config);
|
||||||
|
return done.promise;
|
||||||
|
var _a, _b;
|
||||||
|
};
|
1
dist/npmts.paths.d.ts
vendored
1
dist/npmts.paths.d.ts
vendored
@ -1,3 +1,4 @@
|
|||||||
|
import 'typings-global';
|
||||||
export declare let npmtsPackageRoot: string;
|
export declare let npmtsPackageRoot: string;
|
||||||
export declare let cwd: string;
|
export declare let cwd: string;
|
||||||
export declare let tsDir: string;
|
export declare let tsDir: string;
|
||||||
|
4
dist/npmts.paths.js
vendored
4
dist/npmts.paths.js
vendored
@ -1,6 +1,6 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
require("typings-global");
|
||||||
const plugins = require("./npmts.plugins");
|
var plugins = require("./npmts.plugins");
|
||||||
// NPMTS Paths
|
// NPMTS Paths
|
||||||
exports.npmtsPackageRoot = plugins.path.join(__dirname, '../');
|
exports.npmtsPackageRoot = plugins.path.join(__dirname, '../');
|
||||||
// Project paths
|
// Project paths
|
||||||
|
44
dist/npmts.plugins.d.ts
vendored
44
dist/npmts.plugins.d.ts
vendored
@ -1,17 +1,27 @@
|
|||||||
import * as beautylog from 'beautylog';
|
import 'typings-global';
|
||||||
declare let depcheck: any;
|
export import beautylog = require('beautylog');
|
||||||
import * as lodash from 'lodash';
|
export declare let depcheck: any;
|
||||||
import * as npmextra from 'npmextra';
|
export import gulp = require('gulp');
|
||||||
import * as projectinfo from 'projectinfo';
|
export declare let g: {
|
||||||
import * as path from 'path';
|
babel: any;
|
||||||
import * as smartanalytics from 'smartanalytics';
|
istanbul: any;
|
||||||
import * as smartcli from '@pushrocks/smartcli';
|
gFunction: any;
|
||||||
import * as smarterror from 'smarterror';
|
injectModules: any;
|
||||||
import * as smartfile from 'smartfile';
|
mocha: any;
|
||||||
import * as smartpath from 'smartpath';
|
sourcemaps: any;
|
||||||
import * as smartstream from 'smartstream';
|
typedoc: any;
|
||||||
import * as smartstring from 'smartstring';
|
};
|
||||||
import * as smartsystem from 'smartsystem';
|
export import lodashObject = require('lodash');
|
||||||
import * as smartupdate from 'smartupdate';
|
export import npmextra = require('npmextra');
|
||||||
import * as through2 from 'through2';
|
export import projectinfo = require('projectinfo');
|
||||||
export { beautylog, depcheck, lodash, npmextra, projectinfo, path, smartanalytics, smartcli, smarterror, smartfile, smartpath, smartstream, smartstring, smartsystem, smartupdate, through2 };
|
export import path = require('path');
|
||||||
|
export import Q = require('q');
|
||||||
|
export import shelljs = require('shelljs');
|
||||||
|
export import smartcli = require('smartcli');
|
||||||
|
export import smartcov = require('smartcov');
|
||||||
|
export import smartenv = require('smartenv');
|
||||||
|
export import smartfile = require('smartfile');
|
||||||
|
export import smartpath = require('smartpath');
|
||||||
|
export import smartstring = require('smartstring');
|
||||||
|
export declare let sourceMapSupport: any;
|
||||||
|
export import tsn = require('tsn');
|
||||||
|
60
dist/npmts.plugins.js
vendored
60
dist/npmts.plugins.js
vendored
@ -1,34 +1,28 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
require("typings-global");
|
||||||
const beautylog = require("beautylog");
|
exports.beautylog = require("beautylog");
|
||||||
exports.beautylog = beautylog;
|
exports.depcheck = require('depcheck');
|
||||||
let depcheck = require('depcheck');
|
exports.gulp = require("gulp");
|
||||||
exports.depcheck = depcheck;
|
exports.g = {
|
||||||
const lodash = require("lodash");
|
babel: require('gulp-babel'),
|
||||||
exports.lodash = lodash;
|
istanbul: require('gulp-istanbul'),
|
||||||
const npmextra = require("npmextra");
|
gFunction: require('gulp-function'),
|
||||||
exports.npmextra = npmextra;
|
injectModules: require('gulp-inject-modules'),
|
||||||
const projectinfo = require("projectinfo");
|
mocha: require('gulp-mocha'),
|
||||||
exports.projectinfo = projectinfo;
|
sourcemaps: require('gulp-sourcemaps'),
|
||||||
const path = require("path");
|
typedoc: require('gulp-typedoc')
|
||||||
exports.path = path;
|
};
|
||||||
const smartanalytics = require("smartanalytics");
|
exports.lodashObject = require("lodash");
|
||||||
exports.smartanalytics = smartanalytics;
|
exports.npmextra = require("npmextra");
|
||||||
const smartcli = require("@pushrocks/smartcli");
|
exports.projectinfo = require("projectinfo");
|
||||||
exports.smartcli = smartcli;
|
exports.path = require("path");
|
||||||
const smarterror = require("smarterror");
|
exports.Q = require("q");
|
||||||
exports.smarterror = smarterror;
|
exports.shelljs = require("shelljs");
|
||||||
const smartfile = require("smartfile");
|
exports.smartcli = require("smartcli");
|
||||||
exports.smartfile = smartfile;
|
exports.smartcov = require("smartcov");
|
||||||
const smartpath = require("smartpath");
|
exports.smartenv = require("smartenv");
|
||||||
exports.smartpath = smartpath;
|
exports.smartfile = require("smartfile");
|
||||||
const smartstream = require("smartstream");
|
exports.smartpath = require("smartpath");
|
||||||
exports.smartstream = smartstream;
|
exports.smartstring = require("smartstring");
|
||||||
const smartstring = require("smartstring");
|
exports.sourceMapSupport = require('source-map-support').install(); // display errors correctly during testing
|
||||||
exports.smartstring = smartstring;
|
exports.tsn = require("tsn");
|
||||||
const smartsystem = require("smartsystem");
|
|
||||||
exports.smartsystem = smartsystem;
|
|
||||||
const smartupdate = require("smartupdate");
|
|
||||||
exports.smartupdate = smartupdate;
|
|
||||||
const through2 = require("through2");
|
|
||||||
exports.through2 = through2;
|
|
||||||
|
6
dist/npmts.promisechain.d.ts
vendored
Normal file
6
dist/npmts.promisechain.d.ts
vendored
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
/// <reference types="q" />
|
||||||
|
import 'typings-global';
|
||||||
|
import plugins = require('./npmts.plugins');
|
||||||
|
import { Ora } from 'beautylog';
|
||||||
|
export declare let npmtsOra: Ora;
|
||||||
|
export declare let promisechain: (argvArg: any) => plugins.Q.Promise<{}>;
|
48
dist/npmts.promisechain.js
vendored
Normal file
48
dist/npmts.promisechain.js
vendored
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
|
var plugins = require("./npmts.plugins");
|
||||||
|
var beautylog_1 = require("beautylog");
|
||||||
|
exports.npmtsOra = new beautylog_1.Ora('setting up TaskChain', 'cyan');
|
||||||
|
var NpmtsAssets = require("./npmts.assets");
|
||||||
|
var NpmtsCheck = require("./npmts.check");
|
||||||
|
var NpmtsClean = require("./npmts.clean");
|
||||||
|
var NpmtsCompile = require("./npmts.compile");
|
||||||
|
var NpmtsTypeDoc = require("./npmts.typedoc");
|
||||||
|
var NpmtsOptions = require("./npmts.options");
|
||||||
|
var NpmtsTests = require("./npmts.tests");
|
||||||
|
exports.promisechain = function (argvArg) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
exports.npmtsOra.start();
|
||||||
|
NpmtsOptions.run(argvArg)
|
||||||
|
.then(NpmtsClean.run)
|
||||||
|
.then(NpmtsCheck.run)
|
||||||
|
.then(NpmtsCompile.run)
|
||||||
|
.then(NpmtsAssets.run)
|
||||||
|
.then(NpmtsTypeDoc.run)
|
||||||
|
.then(NpmtsTests.run)
|
||||||
|
.then(function (configArg) {
|
||||||
|
var shipString = '' +
|
||||||
|
'\n' +
|
||||||
|
'\n' +
|
||||||
|
' # # ( )\n' +
|
||||||
|
' ___#_#___|__\n' +
|
||||||
|
' _ |____________| _\n' +
|
||||||
|
' _=====| | | | | |==== _\n' +
|
||||||
|
' =====| |.---------------------------. | |====\n' +
|
||||||
|
" <--------------------' . . . . . . . . '--------------/\n" +
|
||||||
|
' \\ /\n' +
|
||||||
|
' \\___________________________________________________________/\n' +
|
||||||
|
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
||||||
|
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
||||||
|
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n';
|
||||||
|
if (process.env.CI) {
|
||||||
|
console.log(shipString);
|
||||||
|
plugins.beautylog.success('READY TO SHIP!');
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
plugins.beautylog.success('Done!');
|
||||||
|
}
|
||||||
|
done.resolve();
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
2
dist/npmts.ship.d.ts
vendored
2
dist/npmts.ship.d.ts
vendored
@ -1,2 +0,0 @@
|
|||||||
import { INpmtsConfig } from './npmts.config';
|
|
||||||
export declare let run: (configArg: INpmtsConfig) => void;
|
|
29
dist/npmts.ship.js
vendored
29
dist/npmts.ship.js
vendored
@ -1,29 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const q = require("smartq");
|
|
||||||
const plugins = require("./npmts.plugins");
|
|
||||||
exports.run = (configArg) => {
|
|
||||||
let done = q.defer();
|
|
||||||
let shipString = '' +
|
|
||||||
'\n' +
|
|
||||||
'\n' +
|
|
||||||
' # # ( )\n' +
|
|
||||||
' ___#_#___|__\n' +
|
|
||||||
' _ |____________| _\n' +
|
|
||||||
' _=====| | | | | |==== _\n' +
|
|
||||||
' =====| |.---------------------------. | |====\n' +
|
|
||||||
" <--------------------' . . . . . . . . '--------------/\n" +
|
|
||||||
' \\ /\n' +
|
|
||||||
' \\___________________________________________________________/\n' +
|
|
||||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
|
||||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
|
||||||
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n';
|
|
||||||
if (process.env.CI) {
|
|
||||||
console.log(shipString);
|
|
||||||
plugins.beautylog.success('READY TO SHIP!');
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.success('Done!');
|
|
||||||
}
|
|
||||||
done.resolve(configArg);
|
|
||||||
};
|
|
4
dist/npmts.tests.d.ts
vendored
Normal file
4
dist/npmts.tests.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
/// <reference types="q" />
|
||||||
|
import 'typings-global';
|
||||||
|
import plugins = require('./npmts.plugins');
|
||||||
|
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
83
dist/npmts.tests.js
vendored
Normal file
83
dist/npmts.tests.js
vendored
Normal file
@ -0,0 +1,83 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
|
var plugins = require("./npmts.plugins");
|
||||||
|
var paths = require("./npmts.paths");
|
||||||
|
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @returns {*}
|
||||||
|
*/
|
||||||
|
var mocha = function (configArg) {
|
||||||
|
npmts_promisechain_1.npmtsOra.text('Instrumentalizing and testing transpiled JS');
|
||||||
|
npmts_promisechain_1.npmtsOra.end(); // end npmtsOra for tests.
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
plugins.gulp.src([plugins.path.join(paths.cwd, 'dist/*.js')])
|
||||||
|
.pipe(plugins.g.sourcemaps.init())
|
||||||
|
.pipe(plugins.g.babel({
|
||||||
|
presets: [
|
||||||
|
require.resolve('babel-preset-es2015')
|
||||||
|
]
|
||||||
|
}))
|
||||||
|
.pipe(plugins.g.istanbul({}))
|
||||||
|
.pipe(plugins.g.sourcemaps.write())
|
||||||
|
.pipe(plugins.g.injectModules())
|
||||||
|
.on('finish', function () {
|
||||||
|
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')])
|
||||||
|
.pipe(plugins.g.babel({
|
||||||
|
presets: [
|
||||||
|
require.resolve('babel-preset-es2015')
|
||||||
|
]
|
||||||
|
}))
|
||||||
|
.pipe(plugins.g.injectModules())
|
||||||
|
.pipe(plugins.g.mocha())
|
||||||
|
.pipe(plugins.g.istanbul.writeReports({
|
||||||
|
dir: plugins.path.join(paths.cwd, './coverage'),
|
||||||
|
reporters: ['lcovonly', 'json', 'text', 'text-summary']
|
||||||
|
}))
|
||||||
|
.pipe(plugins.g.gFunction(function () {
|
||||||
|
plugins.beautylog.ok('Tested!');
|
||||||
|
done.resolve(configArg);
|
||||||
|
}, 'atEnd'));
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
var coverage = function (configArg) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, 'lcov.info'), 2)
|
||||||
|
.then(function (percentageArg) {
|
||||||
|
if (percentageArg >= configArg.coverageTreshold) {
|
||||||
|
plugins.beautylog.ok(percentageArg.toString() + "% "
|
||||||
|
+ "coverage exceeds your treshold of "
|
||||||
|
+ (configArg.coverageTreshold.toString() + "%"));
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
plugins.beautylog.warn(percentageArg.toString() + "% "
|
||||||
|
+ "coverage fails your treshold of "
|
||||||
|
+ (configArg.coverageTreshold.toString() + "%"));
|
||||||
|
plugins.beautylog.error('exiting due to coverage failure');
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
done.resolve(configArg);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
exports.run = function (configArg) {
|
||||||
|
var done = plugins.Q.defer();
|
||||||
|
var config = configArg;
|
||||||
|
if (config.test === true) {
|
||||||
|
npmts_promisechain_1.npmtsOra.text('now starting tests');
|
||||||
|
plugins.beautylog.log('-------------------------------------------------------\n' +
|
||||||
|
'*************************** TESTS: ***************************\n' +
|
||||||
|
'--------------------------------------------------------------');
|
||||||
|
mocha(config)
|
||||||
|
.then(coverage)
|
||||||
|
.then(function () {
|
||||||
|
done.resolve(config);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
npmts_promisechain_1.npmtsOra.end();
|
||||||
|
done.resolve(config);
|
||||||
|
}
|
||||||
|
return done.promise;
|
||||||
|
};
|
4
dist/npmts.typedoc.d.ts
vendored
Normal file
4
dist/npmts.typedoc.d.ts
vendored
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
/// <reference types="q" />
|
||||||
|
import 'typings-global';
|
||||||
|
import plugins = require('./npmts.plugins');
|
||||||
|
export declare let run: (configArg: any) => plugins.Q.Promise<{}>;
|
43
dist/npmts.typedoc.js
vendored
Normal file
43
dist/npmts.typedoc.js
vendored
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-global");
|
||||||
|
var plugins = require("./npmts.plugins");
|
||||||
|
var paths = require("./npmts.paths");
|
||||||
|
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||||
|
var npmts_check_1 = require("./npmts.check");
|
||||||
|
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.pagesApiDir,
|
||||||
|
json: plugins.path.join(paths.pagesApiDir, 'file.json'),
|
||||||
|
// TypeDoc options (see typedoc docs)
|
||||||
|
name: npmts_check_1.projectInfo.name,
|
||||||
|
readme: plugins.path.join(paths.cwd, 'README.md'),
|
||||||
|
// 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();
|
||||||
|
if (configArg.docs) {
|
||||||
|
genTypeDoc(configArg)
|
||||||
|
.then(function () {
|
||||||
|
done.resolve(configArg);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
done.resolve(configArg);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
return done.promise;
|
||||||
|
};
|
2
dist/npmts.watch.d.ts
vendored
2
dist/npmts.watch.d.ts
vendored
@ -1,2 +0,0 @@
|
|||||||
import { INpmtsConfig } from './npmts.config';
|
|
||||||
export declare let run: (configArg: INpmtsConfig) => Promise<{}>;
|
|
33
dist/npmts.watch.js
vendored
33
dist/npmts.watch.js
vendored
@ -1,33 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const q = require("smartq");
|
|
||||||
const smartchok = require("smartchok");
|
|
||||||
const plugins = require("./npmts.plugins");
|
|
||||||
const cli = require("./npmts.cli");
|
|
||||||
let npmtsSmartchok = null;
|
|
||||||
exports.run = (configArg) => {
|
|
||||||
let done = q.defer();
|
|
||||||
if (configArg.watch && npmtsSmartchok === null) {
|
|
||||||
let pathsToWatch = [];
|
|
||||||
for (let key in configArg.ts) {
|
|
||||||
pathsToWatch.push(key);
|
|
||||||
}
|
|
||||||
for (let key in configArg.testTs) {
|
|
||||||
pathsToWatch.push(key);
|
|
||||||
}
|
|
||||||
npmtsSmartchok = new smartchok.Smartchok(pathsToWatch);
|
|
||||||
npmtsSmartchok.getObservableFor('change').then(changeObservableArg => {
|
|
||||||
plugins.beautylog.info('now watching...');
|
|
||||||
changeObservableArg.subscribe(() => {
|
|
||||||
cli.run();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
npmtsSmartchok.start();
|
|
||||||
done.resolve(configArg);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.info('not watching');
|
|
||||||
done.resolve(configArg);
|
|
||||||
}
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
@ -1,9 +0,0 @@
|
|||||||
[Legal Info](https://lossless.gmbh)
|
|
||||||
[Privacy Policy](https://lossless.gmbh/privacy.html)
|
|
||||||
///
|
|
||||||
[Git.Zone](https://git.zone)
|
|
||||||
<span>tools for a seamless dev workflow</span>
|
|
||||||
|
|
||||||
[Lossless GmbH](https://push.rocks)
|
|
||||||
<span>the company behind git.zone and npmts</span>
|
|
||||||
///
|
|
15
docs/book.json
Normal file
15
docs/book.json
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"structure": {
|
||||||
|
"readme": "index.md"
|
||||||
|
},
|
||||||
|
"plugins": [
|
||||||
|
"tonic",
|
||||||
|
"edit-link"
|
||||||
|
],
|
||||||
|
"pluginsConfig": {
|
||||||
|
"edit-link": {
|
||||||
|
"base": "https://gitlab.com/pushrocks/npmts/edit/master/docs/",
|
||||||
|
"label": "Edit on GitLab"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -1,10 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
## 2017-07-30: Version 7.x.x -> 8.x.x
|
|
||||||
|
|
||||||
Testfiles in ./test/ can now import files directly from the ts dir:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
// ./test/test.ts
|
|
||||||
import * as myModule from '../ts/index
|
|
||||||
```
|
|
@ -1,19 +1,12 @@
|
|||||||
---
|
# Configuration of NPMTS
|
||||||
name: config
|
npmts can be configured to your needs:
|
||||||
---
|
|
||||||
|
|
||||||
# Configuration
|
|
||||||
|
|
||||||
npmts can be configured to your needs.
|
|
||||||
|
|
||||||
### npmextra.json
|
### npmextra.json
|
||||||
|
|
||||||
the npmts section in npmextra.json can be used to configure npmts.
|
the npmts section in npmextra.json can be used to configure npmts.
|
||||||
|
|
||||||
**Default**
|
**Default**
|
||||||
|
|
||||||
>Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
|
>Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
|
||||||
> with default behaviour.
|
with default behaviour.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@ -24,10 +17,10 @@ the npmts section in npmextra.json can be used to configure npmts.
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Custom settings**
|
**Custom settings**
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"mode":"custom",
|
"mode":"custom",
|
||||||
|
"docs":false,
|
||||||
"test":true,
|
"test":true,
|
||||||
"npmts":{
|
"npmts":{
|
||||||
"ts":{
|
"ts":{
|
||||||
@ -43,23 +36,21 @@ the npmts section in npmextra.json can be used to configure npmts.
|
|||||||
```
|
```
|
||||||
|
|
||||||
| key | default value | description |
|
| key | default value | description |
|
||||||
| -------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| --- | --- | --- |
|
||||||
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify, "merge" will merge default options with whatever you specify on your own |
|
| `"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 |
|
||||||
| `"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. |
|
||||||
| `"testConfig"` | `{ parallel: true, coverage: true }` | allows you to control test behaviour. `"parallel"` controls wether testfiles are run sequentially or in parallel, and `"coverage` wether to create coverage reports |
|
|
||||||
|
|
||||||
### 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 declaration files like `./dist/index.d.ts` by default.
|
**npmts** also creates declaration files like `./dist/index.d.ts` by default.
|
||||||
You can reference it in your package.json like this.
|
You can reference it in your package.json like this.
|
||||||
|
|
||||||
@ -72,17 +63,18 @@ 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.
|
||||||
|
|
||||||
#### 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
|
||||||
|
|
||||||
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.
|
@ -1,13 +1,8 @@
|
|||||||
---
|
# Default task execution of npmts
|
||||||
name: Default Behaviour
|
|
||||||
---
|
|
||||||
|
|
||||||
# Default Behaviour
|
|
||||||
|
|
||||||
when you don't configure it otherwise.
|
|
||||||
|
|
||||||
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
|
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
|
||||||
1. **Clean:** Clean up from any previous builds (old js files)
|
1. **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. **Test:** transpile TypeScript of module to ES5 for tests (so it can be instrumentalized) and pipe it to tapbuffer. All this happens in memory.
|
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,23 +1,13 @@
|
|||||||
---
|
# Examples for npmts
|
||||||
name: Examples
|
|
||||||
---
|
|
||||||
|
|
||||||
# Examples
|
## Example Usage in modules:
|
||||||
|
* [gulp-browser](https://www.npmjs.com/package/gulp-browser)
|
||||||
|
|
||||||
modules that use npmts in theis development workflow
|
> We will add more options over time.
|
||||||
|
|
||||||
| Module Name | Description |
|
## Tips and tricks:
|
||||||
| ---------------------------------------------------------- | --------------------------- |
|
|
||||||
| [gitzone](https://www.npmjs.com/package/gitzone) | fast npm module prototyping |
|
|
||||||
| [gulp-browser](https://www.npmjs.com/package/gulp-browser) | browserify for gulp |
|
|
||||||
| [npmdocker](https://www.npmjs.com/package/npmdocker) | dockerized npm development |
|
|
||||||
| [smartcli](https://www.npmjs.com/package/smartcli) | easy cli tool creation |
|
|
||||||
|
|
||||||
> There are tons more... We will add them here over time.
|
* Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available.
|
||||||
|
* Use [npmpage](https://www.npmjs.com/package/npmpage) to create a webpage from coverage reports and TypeDoc for the module
|
||||||
### Tips and tricks:
|
* 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.
|
||||||
- Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available.
|
|
||||||
- Use [npmpage](https://www.npmjs.com/package/npmpage) to create a webpage from coverage reports and TypeDoc for the module
|
|
||||||
- Use [hosttoday/ht-docker-node:npmci](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.
|
|
@ -1,40 +0,0 @@
|
|||||||
---
|
|
||||||
name: Get Started
|
|
||||||
description: learn how to quickly write npm TypeScript modules
|
|
||||||
---
|
|
||||||
|
|
||||||
# Get Started with NPMTS
|
|
||||||
|
|
||||||
and learn how to quickly write npm TypeScript modules
|
|
||||||
|
|
||||||
## Step1: Install the tools
|
|
||||||
|
|
||||||
To use npmts install it using npm or yarn:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install -g npmts # install with npm
|
|
||||||
yarn global add npmts # install with yarn
|
|
||||||
```
|
|
||||||
|
|
||||||
For the purpose of getting started quickly please also install **gitzone**.
|
|
||||||
It'll proovide awesome scaffolding for new npmts maintained modules and also updates them later on.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install -g gitzone # install with npm
|
|
||||||
yarn global add gitzone # install with yarn
|
|
||||||
```
|
|
||||||
|
|
||||||
You can make sure npmts and gitzone are installed correctly by typing `npmts -v && gitzone -v`.
|
|
||||||
|
|
||||||
## Scaffold a new module
|
|
||||||
|
|
||||||
To scaffold a new module type
|
|
||||||
|
|
||||||
```shell
|
|
||||||
gitzone template npm
|
|
||||||
```
|
|
||||||
|
|
||||||
This will run you through a series of question to get gitzone to know the specifics of your module.
|
|
||||||
Enter all information accordingly.
|
|
||||||
|
|
||||||
## Run NPMTS for the first time
|
|
@ -1,52 +1,36 @@
|
|||||||
---
|
|
||||||
name: Index
|
|
||||||
description: best practice npm TypeScript modules
|
|
||||||
---
|
|
||||||
|
|
||||||
# npmts
|
# npmts
|
||||||
|
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||||
best practice npm TypeScript modules
|
|
||||||
|
|
||||||
## Availabililty
|
## Availabililty
|
||||||
|
[](https://www.npmjs.com/package/npmts)
|
||||||
[](https://www.npmjs.com/package/npmts)
|
[](https://gitlab.com/pushrocks/npmts)
|
||||||
[](https://GitLab.com/gitzone/npmts)
|
[](https://github.com/pushrocks/npmts)
|
||||||
[](https://github.com/gitzone/npmts)
|
[](https://pushrocks.gitlab.io/npmts/docs)
|
||||||
[](https://gitzone.gitlab.io/npmts/)
|
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
|
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||||
[](https://GitLab.com/gitzone/npmts/commits/master)
|
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||||
[](https://GitLab.com/gitzone/npmts/commits/master)
|
[](https://david-dm.org/pushrocks/npmts)
|
||||||
[](https://www.npmjs.com/package/npmts)
|
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||||
[](https://david-dm.org/gitzonetools/npmts)
|
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||||
[](https://www.bithound.io/github/gitzonetools/npmts/master/dependencies/npm)
|
|
||||||
[](https://www.bithound.io/github/gitzonetools/npmts)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
[](http://standardjs.com/)
|
[](http://standardjs.com/)
|
||||||
|
|
||||||
## Quick Demo
|
## Introduction
|
||||||
|
|
||||||
[](https://asciinema.org/a/9c3assmh21i49qhe5lmi48sze?speed=2&t=0)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
||||||
|
|
||||||
npmts will
|
npmts will
|
||||||
|
|
||||||
1. check your dependencies and package.json (unused, missing, updates, security)
|
1. check your dependencies and package.json
|
||||||
1. transpile your code with tsc,
|
1. transpile your code with tsc,
|
||||||
1. test your code with tap (supports the fancy stuff like Promises, Generators, async/await, sourcemaps, parallel test execution in child processes)
|
1. document your code with typedoc,
|
||||||
1. create coverage with istanbul (supports tracing of the originating TypeScript)
|
1. test your code with mocha
|
||||||
|
1. create coverage with istanbul
|
||||||
For more information on how tests are run check out the [tapbuffer module](https://www.npmjs.com/package/tapbuffer).
|
|
||||||
|
|
||||||
This works on your machine and in CI. There is a prebuild docker image available that includes npmts to make CI a breeze:
|
This works on your machine and in CI. There is a prebuild docker image available that includes npmts to make CI a breeze:
|
||||||
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
For further information read the docs.
|
||||||
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
||||||
|
|
||||||
[](https:/git.zone)
|
[](https://push.rocks)
|
||||||
|
14
docs/info.md
Normal file
14
docs/info.md
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
# Info
|
||||||
|
|
||||||
|
## Future Scope:
|
||||||
|
* automatically manage badges in README
|
||||||
|
* manage tslint to enforce code best practices
|
||||||
|
* tear down any differences between local and CI environments by using brand new npmdocker
|
||||||
|
|
||||||
|
## About the authors:
|
||||||
|
[](https://lossless.com/)
|
||||||
|
|
||||||
|
[](https://paypal.me/lossless)
|
||||||
|
|
||||||
|
## Legal Info
|
||||||
|
https://lossless.gmbh
|
@ -1,9 +1,8 @@
|
|||||||
# Install npmts
|
# Install npmts
|
||||||
|
First install npmts globally, then install the npmts-g locally.
|
||||||
|
|
||||||
Get started with TypeScript awesomeness.
|
> **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.
|
||||||
> \*_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
|
||||||
|
@ -1,27 +0,0 @@
|
|||||||
---
|
|
||||||
name: npmts project structure
|
|
||||||
description: how npmts projects are structured
|
|
||||||
---
|
|
||||||
|
|
||||||
# npmts - Project Structure
|
|
||||||
|
|
||||||
**locally**
|
|
||||||
|
|
||||||
```text
|
|
||||||
projectroot
|
|
||||||
|- .nogit/ # contains files that should not be checked into git - NOgit
|
|
||||||
|- dist/ # contains compiled js files and their corresponding typings - git
|
|
||||||
|- node_modules/ # contains the installed node modules - NOgit
|
|
||||||
|- test/ # contains the test files - git
|
|
||||||
|- ts/ # contains the source TypeScript files - git
|
|
||||||
|
|
|
||||||
|- .gitignore # the normal gitignore file
|
|
||||||
|- .gitlab-ci.yml # the gitlab ci yml file
|
|
||||||
|- npmextra.json # npmextra.json
|
|
||||||
|- package.json # the standard npm module package.json file
|
|
||||||
|- readme.md # the standard project readme
|
|
||||||
|- tslint.json # the standard tslint.json for TypeScript
|
|
||||||
|- yarn.lock # yarn.lock - the standard yarn.lock file
|
|
||||||
```
|
|
||||||
|
|
||||||
**in git**
|
|
8
docs/summary.md
Normal file
8
docs/summary.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# Summary
|
||||||
|
|
||||||
|
* [1. Intro](index.md)
|
||||||
|
* [2. Install](install.md)
|
||||||
|
* [3. Default Behaviour](default.md)
|
||||||
|
* [4. Configuration](config.md)
|
||||||
|
* [5. Examples](examples.md)
|
||||||
|
* [6. Info](info.md)
|
@ -1,16 +0,0 @@
|
|||||||
{
|
|
||||||
"npmci": {
|
|
||||||
"npmAccessLevel": "public"
|
|
||||||
},
|
|
||||||
"gitzone": {
|
|
||||||
"projectType": "npm",
|
|
||||||
"module": {
|
|
||||||
"githost": "gitlab.com",
|
|
||||||
"gitscope": "gitzone",
|
|
||||||
"gitrepo": "tscoverage",
|
|
||||||
"shortDescription": "get coverage information for gitzone projects",
|
|
||||||
"npmPackagename": "@gitzone/tscoverage",
|
|
||||||
"license": "MIT"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
11399
package-lock.json
generated
11399
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
87
package.json
87
package.json
@ -1,52 +1,69 @@
|
|||||||
{
|
{
|
||||||
"name": "@gitzone/tscoverage",
|
"name": "npmts",
|
||||||
"version": "9.0.2",
|
"version": "5.4.32",
|
||||||
"description": "get coverage information for gitzone projects",
|
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
|
||||||
"bin": {
|
"bin": {
|
||||||
"tscoverage": "cli.js"
|
"npmts": "dist/cli.js"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "(npm run compile && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest && npm run checkNoDocs)",
|
||||||
"build": "(tsbuild --web)"
|
"compile": "(rm -rf test/ && rm -r dist/ && mkdir dist/ && tsc && cp assets/cli.js dist/ )",
|
||||||
|
"setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
|
||||||
|
"typedoc": "(typedoc --out ./pages/api --target ES6 ./ts/)",
|
||||||
|
"npmpage": "(npmpage)",
|
||||||
|
"check": "(cd test && npm install && node ../dist/index.js)",
|
||||||
|
"checkVersion": "(cd test/ && node ../dist/index.js -v)",
|
||||||
|
"checkNoTest": "(cd test && node ../dist/index.js --notest)",
|
||||||
|
"checkNoDocs": "(cd test && node ../dist/index.js --nodocs)"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://gitlab.com/gitzone/npmts.git"
|
"url": "git+https://gitlab.com/pushrocks/npmts.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"TypeScript",
|
"TypeScript",
|
||||||
"Declaration"
|
"Declaration"
|
||||||
],
|
],
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless Digital UG (haftungsbeschraenkt)",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://gitlab.com/gitzone/npmts/issues"
|
"url": "https://gitlab.com/pushrocks/npmts/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/gitzone/npmts#readme",
|
"homepage": "https://gitlab.com/pushrocks/npmts#readme",
|
||||||
"dependencies": {},
|
"dependencies": {
|
||||||
"devDependencies": {
|
"@types/gulp": "^3.8.31",
|
||||||
"@gitzone/tsbuild": "^2.1.24",
|
"@types/minimatch": "^2.0.28",
|
||||||
"@gitzone/tsbundle": "^1.0.69",
|
"@types/q": "^0.x.x",
|
||||||
"@gitzone/tstest": "^1.0.33",
|
"@types/shelljs": "^0.3.30",
|
||||||
"@gitzone/tswatch": "^1.0.46",
|
"babel-preset-es2015": "^6.14.0",
|
||||||
"@pushrocks/tapbundle": "^3.2.1",
|
"beautylog": "5.0.23",
|
||||||
"@types/node": "^10.0.3",
|
"depcheck": "^0.6.4",
|
||||||
"tslint": "^6.1.2",
|
"early": "^2.0.26",
|
||||||
"tslint-config-prettier": "^1.18.0"
|
"gulp": "3.9.1",
|
||||||
|
"gulp-babel": "^6.1.2",
|
||||||
|
"gulp-function": "^1.3.6",
|
||||||
|
"gulp-inject-modules": "^1.0.0",
|
||||||
|
"gulp-istanbul": "^1.1.1",
|
||||||
|
"gulp-mocha": "^3.0.1",
|
||||||
|
"gulp-sourcemaps": "^1.6.0",
|
||||||
|
"gulp-typedoc": "^2.0.0",
|
||||||
|
"lodash": "^4.15.0",
|
||||||
|
"npmextra": "^1.0.9",
|
||||||
|
"projectinfo": "1.0.3",
|
||||||
|
"q": "^1.4.1",
|
||||||
|
"shelljs": "^0.7.4",
|
||||||
|
"smartcli": "1.0.9",
|
||||||
|
"smartcov": "1.0.0",
|
||||||
|
"smartenv": "1.2.5",
|
||||||
|
"smartfile": "4.0.15",
|
||||||
|
"smartpath": "3.2.2",
|
||||||
|
"smartstring": "^2.0.17",
|
||||||
|
"source-map-support": "^0.4.2",
|
||||||
|
"tsn": "^1.0.13",
|
||||||
|
"typedoc": "^0.4.5",
|
||||||
|
"typescript": "next",
|
||||||
|
"typings-global": "^1.0.14"
|
||||||
},
|
},
|
||||||
"private": true,
|
"devDependencies": {}
|
||||||
"files": [
|
|
||||||
"ts/**/*",
|
|
||||||
"ts_web/**/*",
|
|
||||||
"dist/**/*",
|
|
||||||
"dist_*/**/*",
|
|
||||||
"dist_ts/**/*",
|
|
||||||
"dist_ts_web/**/*",
|
|
||||||
"assets/**/*",
|
|
||||||
"cli.js",
|
|
||||||
"npmextra.json",
|
|
||||||
"readme.md"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
39
readme.md
39
readme.md
@ -1,39 +0,0 @@
|
|||||||
# @gitzone/tscoverage
|
|
||||||
get coverage information for gitzone projects
|
|
||||||
|
|
||||||
## Availabililty and Links
|
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tscoverage)
|
|
||||||
* [gitlab.com (source)](https://gitlab.com/gitzone/tscoverage)
|
|
||||||
* [github.com (source mirror)](https://github.com/gitzone/tscoverage)
|
|
||||||
* [docs (typedoc)](https://gitzone.gitlab.io/tscoverage/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
|
|
||||||
Status Category | Status Badge
|
|
||||||
-- | --
|
|
||||||
GitLab Pipelines | [](https://lossless.cloud)
|
|
||||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
||||||
npm | [](https://lossless.cloud)
|
|
||||||
Snyk | [](https://lossless.cloud)
|
|
||||||
TypeScript Support | [](https://lossless.cloud)
|
|
||||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
Code Style | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
||||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
||||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
tscoverage will run tests while computing coverage for your gitzone project.
|
|
||||||
|
|
||||||
## Contribution
|
|
||||||
|
|
||||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
|
@ -1,7 +0,0 @@
|
|||||||
import { tap, expect } from '@pushrocks/tapbundle';
|
|
||||||
|
|
||||||
tap.test('should run a test', async () => {
|
|
||||||
console.log('hi there');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.start();
|
|
29
ts/index.ts
29
ts/index.ts
@ -1 +1,28 @@
|
|||||||
console.log('tscoverage');
|
import 'typings-global'
|
||||||
|
|
||||||
|
/* ================================================== *
|
||||||
|
Starting NPMTS main process.
|
||||||
|
* ================================================== */
|
||||||
|
import * as early from 'early'
|
||||||
|
early.start('NPMTS')
|
||||||
|
import * as plugins from './npmts.plugins'
|
||||||
|
import * as paths from './npmts.paths'
|
||||||
|
import {promisechain} from './npmts.promisechain'
|
||||||
|
early.stop()
|
||||||
|
.then(() => {
|
||||||
|
let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot)
|
||||||
|
let npmtsCli = new plugins.smartcli.Smartcli()
|
||||||
|
npmtsCli.standardTask()
|
||||||
|
.then((argvArg) => {
|
||||||
|
plugins.beautylog.figletSync('NPMTS')
|
||||||
|
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version)
|
||||||
|
try {
|
||||||
|
promisechain(argvArg)
|
||||||
|
} catch (err) {
|
||||||
|
console.log(err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
npmtsCli.addVersion(npmtsProjectInfo.version)
|
||||||
|
npmtsCli.startParse()
|
||||||
|
})
|
||||||
|
22
ts/npmts.assets.ts
Normal file
22
ts/npmts.assets.ts
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
import 'typings-global'
|
||||||
|
import plugins = require('./npmts.plugins')
|
||||||
|
import paths = require('./npmts.paths')
|
||||||
|
import {npmtsOra} from './npmts.promisechain'
|
||||||
|
|
||||||
|
export var run = function(configArg){
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
let config = configArg
|
||||||
|
npmtsOra.text('now looking at ' + 'required assets'.yellow)
|
||||||
|
if (config.cli === true) {
|
||||||
|
plugins.smartfile.fs.copySync(
|
||||||
|
plugins.path.join(paths.npmtsAssetsDir,'cli.js'),
|
||||||
|
plugins.path.join(paths.distDir,'cli.js')
|
||||||
|
)
|
||||||
|
plugins.beautylog.ok('installed CLI assets!')
|
||||||
|
done.resolve(config)
|
||||||
|
} else {
|
||||||
|
plugins.beautylog.ok('No additional assets required!')
|
||||||
|
done.resolve(config)
|
||||||
|
}
|
||||||
|
return done.promise
|
||||||
|
}
|
120
ts/npmts.check.ts
Normal file
120
ts/npmts.check.ts
Normal file
@ -0,0 +1,120 @@
|
|||||||
|
import * as plugins from './npmts.plugins'
|
||||||
|
import * as paths from './npmts.paths'
|
||||||
|
import { npmtsOra } from './npmts.promisechain'
|
||||||
|
|
||||||
|
import {ProjectinfoNpm} from 'projectinfo'
|
||||||
|
|
||||||
|
export let projectInfo: ProjectinfoNpm
|
||||||
|
|
||||||
|
let checkProjectTypings = (configArg) => {
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
projectInfo = new ProjectinfoNpm(paths.cwd)
|
||||||
|
if (typeof projectInfo.packageJson.typings === 'undefined') {
|
||||||
|
plugins.beautylog.error(`please add typings field to package.json`)
|
||||||
|
process.exit(1)
|
||||||
|
};
|
||||||
|
done.resolve(configArg)
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
const depcheckOptions = {
|
||||||
|
ignoreBinPackage: false, // ignore the packages with bin entry
|
||||||
|
parsers: { // the target parsers
|
||||||
|
'*.ts': plugins.depcheck.parser.typescript
|
||||||
|
},
|
||||||
|
detectors: [ // the target detectors
|
||||||
|
plugins.depcheck.detector.requireCallExpression,
|
||||||
|
plugins.depcheck.detector.importDeclaration
|
||||||
|
],
|
||||||
|
specials: [ // the target special parsers
|
||||||
|
plugins.depcheck.special.eslint,
|
||||||
|
plugins.depcheck.special.webpack
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
let checkDependencies = (configArg) => {
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||||
|
ignoreDirs: [ // folder with these names will be ignored
|
||||||
|
'test',
|
||||||
|
'dist',
|
||||||
|
'bower_components'
|
||||||
|
],
|
||||||
|
ignoreMatches: [ // ignore dependencies that matches these globs
|
||||||
|
'@types/*',
|
||||||
|
'babel-preset-*'
|
||||||
|
]
|
||||||
|
})
|
||||||
|
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
||||||
|
for (let item of unused.dependencies) {
|
||||||
|
plugins.beautylog.warn(`Watch out: unused dependency ${item.red}`)
|
||||||
|
};
|
||||||
|
for (let item of unused.missing) {
|
||||||
|
plugins.beautylog.error(`unused devDependency ${item.red}`)
|
||||||
|
};
|
||||||
|
if (unused.missing.length > 0) {
|
||||||
|
plugins.beautylog.info('exiting due to missing dependencies in package.json')
|
||||||
|
process.exit(1)
|
||||||
|
}
|
||||||
|
for (let item of unused.invalidFiles) {
|
||||||
|
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`)
|
||||||
|
};
|
||||||
|
for (let item of unused.invalidDirs) {
|
||||||
|
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
|
||||||
|
};
|
||||||
|
done.resolve(configArg)
|
||||||
|
})
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
let checkDevDependencies = (configArg) => {
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
|
||||||
|
ignoreDirs: [ // folder with these names will be ignored
|
||||||
|
'ts',
|
||||||
|
'dist',
|
||||||
|
'bower_components'
|
||||||
|
],
|
||||||
|
ignoreMatches: [ // ignore dependencies that matches these globs
|
||||||
|
'@types/*',
|
||||||
|
'babel-preset-*'
|
||||||
|
]
|
||||||
|
})
|
||||||
|
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
||||||
|
for (let item of unused.devDependencies) {
|
||||||
|
plugins.beautylog.log(`unused devDependency ${item.red}`)
|
||||||
|
};
|
||||||
|
for (let item of unused.missing) {
|
||||||
|
plugins.beautylog.error(`unused devDependency ${item.red}`)
|
||||||
|
};
|
||||||
|
if (unused.missing.length > 0) {
|
||||||
|
plugins.beautylog.info('exiting due to missing dependencies in package.json')
|
||||||
|
process.exit(1)
|
||||||
|
}
|
||||||
|
for (let item of unused.invalidFiles) {
|
||||||
|
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`)
|
||||||
|
}
|
||||||
|
for (let item of unused.invalidDirs) {
|
||||||
|
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
|
||||||
|
}
|
||||||
|
done.resolve(configArg)
|
||||||
|
})
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
let checkNodeVersion = (configArg) => {
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
done.resolve(configArg)
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
export let run = (configArg) => {
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
npmtsOra.text('running project checks...')
|
||||||
|
checkProjectTypings(configArg)
|
||||||
|
.then(checkDependencies)
|
||||||
|
.then(checkDevDependencies)
|
||||||
|
.then(checkNodeVersion)
|
||||||
|
.then(done.resolve)
|
||||||
|
return done.promise
|
||||||
|
}
|
26
ts/npmts.clean.ts
Normal file
26
ts/npmts.clean.ts
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
import 'typings-global'
|
||||||
|
import plugins = require('./npmts.plugins')
|
||||||
|
import paths = require('./npmts.paths')
|
||||||
|
import {npmtsOra} from './npmts.promisechain'
|
||||||
|
|
||||||
|
let removeDist = function(){
|
||||||
|
npmtsOra.text('cleaning dist folder')
|
||||||
|
return plugins.smartfile.fs.remove(paths.distDir)
|
||||||
|
}
|
||||||
|
|
||||||
|
let removePages = function(){
|
||||||
|
npmtsOra.text('cleaning pages folder')
|
||||||
|
return plugins.smartfile.fs.remove(paths.pagesDir)
|
||||||
|
}
|
||||||
|
|
||||||
|
export let run = function(configArg){
|
||||||
|
npmtsOra.text('cleaning up from previous builds...')
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
removeDist()
|
||||||
|
.then(removePages)
|
||||||
|
.then(function(){
|
||||||
|
plugins.beautylog.ok('Cleaned up from previous builds!')
|
||||||
|
done.resolve(configArg)
|
||||||
|
})
|
||||||
|
return done.promise
|
||||||
|
}
|
15
ts/npmts.compile.helpers.ts
Normal file
15
ts/npmts.compile.helpers.ts
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
import plugins = require('./npmts.plugins')
|
||||||
|
import paths = require('./npmts.paths')
|
||||||
|
|
||||||
|
let outputPathIsDir = function (tsArrayArg,keyArg) {
|
||||||
|
return plugins.smartpath.check.isDir(plugins.path.join(paths.cwd, tsArrayArg[keyArg]))
|
||||||
|
}
|
||||||
|
|
||||||
|
export let checkOutputPath = function(tsArrayArg,keyArg){
|
||||||
|
if (!outputPathIsDir(tsArrayArg,keyArg)) {
|
||||||
|
plugins.beautylog.warn('Skipping ' + keyArg + ' because ' + tsArrayArg[keyArg] + ' it is no directory!')
|
||||||
|
return false
|
||||||
|
} else {
|
||||||
|
return true
|
||||||
|
};
|
||||||
|
}
|
68
ts/npmts.compile.ts
Normal file
68
ts/npmts.compile.ts
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
import 'typings-global'
|
||||||
|
import plugins = require('./npmts.plugins')
|
||||||
|
import paths = require('./npmts.paths')
|
||||||
|
import helpers = require('./npmts.compile.helpers')
|
||||||
|
import {npmtsOra} from './npmts.promisechain'
|
||||||
|
|
||||||
|
let promiseArray = []
|
||||||
|
let compileTs = (tsFileArrayArg: string[],tsOptionsArg = {}) => {
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
|
||||||
|
let compilerOptionsDefault = {
|
||||||
|
declaration: true,
|
||||||
|
module: 'CommonJS',
|
||||||
|
target: 'ES6'
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* merges default ts options with those found in npmts.json
|
||||||
|
*/
|
||||||
|
let compilerOptions = function (keyArg: string) {
|
||||||
|
let tsOptionsCombined = plugins.lodashObject.merge(compilerOptionsDefault, tsOptionsArg)
|
||||||
|
let compilerOptions: plugins.tsn.CompilerOptions = {
|
||||||
|
declaration: tsOptionsCombined.declaration,
|
||||||
|
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
||||||
|
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target],
|
||||||
|
exclude: 'node_modules/**/*'
|
||||||
|
}
|
||||||
|
return compilerOptions
|
||||||
|
}
|
||||||
|
for (let keyArg in tsFileArrayArg) {
|
||||||
|
plugins.beautylog.info(`TypeScript assignment: transpile from ${keyArg.blue} to ${tsFileArrayArg[keyArg].blue}`)
|
||||||
|
if (helpers.checkOutputPath(tsFileArrayArg,keyArg)) {
|
||||||
|
let filesReadPromise = plugins.smartfile.fs.listFileTree(process.cwd(),keyArg)
|
||||||
|
.then((filesToConvertArg) => {
|
||||||
|
let filesToConvertAbsolute = plugins.smartpath.transform.toAbsolute(filesToConvertArg,process.cwd())
|
||||||
|
let destDir = plugins.smartpath.transform.toAbsolute(tsFileArrayArg[keyArg],process.cwd())
|
||||||
|
let filesCompiledPromise = plugins.tsn.compile(
|
||||||
|
filesToConvertAbsolute,
|
||||||
|
destDir,
|
||||||
|
compilerOptions(keyArg)
|
||||||
|
)
|
||||||
|
promiseArray.push(filesCompiledPromise)
|
||||||
|
})
|
||||||
|
promiseArray.push(filesReadPromise)
|
||||||
|
}
|
||||||
|
};
|
||||||
|
plugins.Q.all(promiseArray)
|
||||||
|
.then(done.resolve)
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
export let run = function (configArg) {
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
let config = configArg
|
||||||
|
npmtsOra.text('now compiling ' + 'TypeScript'.yellow)
|
||||||
|
|
||||||
|
compileTs(config.ts,config.tsOptions)
|
||||||
|
.then(() => {
|
||||||
|
plugins.beautylog.ok('compiled main TypeScript!')
|
||||||
|
plugins.beautylog.log('now compiling tests!')
|
||||||
|
return compileTs(config.testTs)
|
||||||
|
})
|
||||||
|
.then(function () {
|
||||||
|
plugins.beautylog.ok('compiled all TypeScript!')
|
||||||
|
done.resolve(config)
|
||||||
|
})
|
||||||
|
return done.promise
|
||||||
|
}
|
77
ts/npmts.options.ts
Normal file
77
ts/npmts.options.ts
Normal file
@ -0,0 +1,77 @@
|
|||||||
|
import 'typings-global'
|
||||||
|
import plugins = require('./npmts.plugins')
|
||||||
|
import paths = require('./npmts.paths')
|
||||||
|
import { npmtsOra } from './npmts.promisechain'
|
||||||
|
|
||||||
|
export type npmtsMode = 'default' | 'custom'
|
||||||
|
|
||||||
|
export interface INpmtsConfig {
|
||||||
|
argv: any,
|
||||||
|
coverageTreshold: number,
|
||||||
|
docs: boolean,
|
||||||
|
mode: npmtsMode,
|
||||||
|
test: boolean,
|
||||||
|
testTs: any,
|
||||||
|
ts: any,
|
||||||
|
tsOptions: any
|
||||||
|
|
||||||
|
};
|
||||||
|
|
||||||
|
export var run = function (argvArg) {
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
let defaultConfig: INpmtsConfig = {
|
||||||
|
argv: undefined,
|
||||||
|
coverageTreshold: 70,
|
||||||
|
docs: true,
|
||||||
|
mode: 'default',
|
||||||
|
test: true,
|
||||||
|
testTs: {},
|
||||||
|
ts: {},
|
||||||
|
tsOptions: {}
|
||||||
|
}
|
||||||
|
|
||||||
|
// mix with configfile
|
||||||
|
npmtsOra.text('looking for npmextra.json')
|
||||||
|
let config: INpmtsConfig = plugins.npmextra.dataFor({
|
||||||
|
toolName: 'npmts',
|
||||||
|
defaultSettings: defaultConfig,
|
||||||
|
cwd: paths.cwd
|
||||||
|
})
|
||||||
|
|
||||||
|
// add argv
|
||||||
|
config.argv = argvArg
|
||||||
|
|
||||||
|
// check mode
|
||||||
|
switch (config.mode) {
|
||||||
|
case 'default':
|
||||||
|
case 'custom':
|
||||||
|
plugins.beautylog.ok('mode is ' + config.mode)
|
||||||
|
done.resolve(config)
|
||||||
|
break
|
||||||
|
default:
|
||||||
|
plugins.beautylog.error(`mode not recognised!`)
|
||||||
|
process.exit(1)
|
||||||
|
};
|
||||||
|
|
||||||
|
// handle default mode
|
||||||
|
if (config.mode === 'default') {
|
||||||
|
config.ts = {
|
||||||
|
['./ts/**/*.ts']: './dist/'
|
||||||
|
}
|
||||||
|
config.testTs = {
|
||||||
|
['./test/test.ts']: './test/'
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// mix with commandline
|
||||||
|
if (config.argv.notest) {
|
||||||
|
config.test = false
|
||||||
|
};
|
||||||
|
if (config.argv.nodocs) {
|
||||||
|
config.docs = false
|
||||||
|
};
|
||||||
|
|
||||||
|
plugins.beautylog.ok('build options are ready!')
|
||||||
|
done.resolve(config)
|
||||||
|
return done.promise
|
||||||
|
}
|
25
ts/npmts.paths.ts
Normal file
25
ts/npmts.paths.ts
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
import 'typings-global'
|
||||||
|
import plugins = require('./npmts.plugins')
|
||||||
|
|
||||||
|
// NPMTS Paths
|
||||||
|
export let npmtsPackageRoot = plugins.path.join(__dirname,'../')
|
||||||
|
|
||||||
|
// Project paths
|
||||||
|
export let cwd = process.cwd()
|
||||||
|
|
||||||
|
// Directories
|
||||||
|
export let tsDir = plugins.path.join(cwd,'ts/')
|
||||||
|
export let distDir = plugins.path.join(cwd,'dist/')
|
||||||
|
export let testDir = plugins.path.join(cwd,'test/')
|
||||||
|
export let typingsDir = plugins.path.join(cwd,'ts/typings/')
|
||||||
|
export let coverageDir = plugins.path.join(cwd,'coverage/')
|
||||||
|
|
||||||
|
// Pages
|
||||||
|
export let pagesDir = plugins.path.join(cwd,'pages/')
|
||||||
|
export let pagesApiDir = plugins.path.join(pagesDir,'/api')
|
||||||
|
|
||||||
|
export let npmtsAssetsDir = plugins.path.join(__dirname,'../assets/')
|
||||||
|
|
||||||
|
// Files
|
||||||
|
export let indexTS = plugins.path.join(cwd,'ts/index.ts')
|
||||||
|
export let testTS = plugins.path.join(cwd,'ts/test.ts')
|
27
ts/npmts.plugins.ts
Normal file
27
ts/npmts.plugins.ts
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
import 'typings-global'
|
||||||
|
export import beautylog = require('beautylog')
|
||||||
|
export let depcheck = require('depcheck')
|
||||||
|
export import gulp = require('gulp')
|
||||||
|
export let g = {
|
||||||
|
babel: require('gulp-babel'),
|
||||||
|
istanbul: require('gulp-istanbul'),
|
||||||
|
gFunction: require('gulp-function'),
|
||||||
|
injectModules: require('gulp-inject-modules'),
|
||||||
|
mocha: require('gulp-mocha'),
|
||||||
|
sourcemaps: require('gulp-sourcemaps'),
|
||||||
|
typedoc: require('gulp-typedoc')
|
||||||
|
}
|
||||||
|
export import lodashObject = require('lodash')
|
||||||
|
export import npmextra = require('npmextra')
|
||||||
|
export import projectinfo = require('projectinfo')
|
||||||
|
export import path = require('path')
|
||||||
|
export import Q = require('q')
|
||||||
|
export import shelljs = require('shelljs')
|
||||||
|
export import smartcli = require('smartcli')
|
||||||
|
export import smartcov = require('smartcov')
|
||||||
|
export import smartenv = require('smartenv')
|
||||||
|
export import smartfile = require('smartfile')
|
||||||
|
export import smartpath = require('smartpath')
|
||||||
|
export import smartstring = require('smartstring')
|
||||||
|
export let sourceMapSupport = require('source-map-support').install() // display errors correctly during testing
|
||||||
|
export import tsn = require('tsn')
|
49
ts/npmts.promisechain.ts
Normal file
49
ts/npmts.promisechain.ts
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
import 'typings-global'
|
||||||
|
import plugins = require('./npmts.plugins')
|
||||||
|
import {Ora} from 'beautylog'
|
||||||
|
|
||||||
|
export let npmtsOra = new Ora('setting up TaskChain','cyan')
|
||||||
|
|
||||||
|
import NpmtsAssets = require('./npmts.assets')
|
||||||
|
import NpmtsCheck = require('./npmts.check')
|
||||||
|
import NpmtsClean = require('./npmts.clean')
|
||||||
|
import NpmtsCompile = require('./npmts.compile')
|
||||||
|
import NpmtsTypeDoc = require('./npmts.typedoc')
|
||||||
|
import NpmtsOptions = require('./npmts.options')
|
||||||
|
import NpmtsTests = require('./npmts.tests')
|
||||||
|
|
||||||
|
export let promisechain = function(argvArg){
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
npmtsOra.start()
|
||||||
|
NpmtsOptions.run(argvArg)
|
||||||
|
.then(NpmtsClean.run)
|
||||||
|
.then(NpmtsCheck.run)
|
||||||
|
.then(NpmtsCompile.run)
|
||||||
|
.then(NpmtsAssets.run)
|
||||||
|
.then(NpmtsTypeDoc.run)
|
||||||
|
.then(NpmtsTests.run)
|
||||||
|
.then(function(configArg){
|
||||||
|
let shipString = '' +
|
||||||
|
'\n' +
|
||||||
|
'\n' +
|
||||||
|
' # # ( )\n' +
|
||||||
|
' ___#_#___|__\n' +
|
||||||
|
' _ |____________| _\n' +
|
||||||
|
' _=====| | | | | |==== _\n' +
|
||||||
|
' =====| |.---------------------------. | |====\n' +
|
||||||
|
" <--------------------' . . . . . . . . '--------------/\n" +
|
||||||
|
' \\ /\n' +
|
||||||
|
' \\___________________________________________________________/\n' +
|
||||||
|
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
||||||
|
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
|
||||||
|
' wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n'
|
||||||
|
if (process.env.CI) {
|
||||||
|
console.log(shipString)
|
||||||
|
plugins.beautylog.success('READY TO SHIP!')
|
||||||
|
} else {
|
||||||
|
plugins.beautylog.success('Done!')
|
||||||
|
}
|
||||||
|
done.resolve()
|
||||||
|
})
|
||||||
|
return done.promise
|
||||||
|
}
|
94
ts/npmts.tests.ts
Normal file
94
ts/npmts.tests.ts
Normal file
@ -0,0 +1,94 @@
|
|||||||
|
import 'typings-global'
|
||||||
|
import plugins = require('./npmts.plugins')
|
||||||
|
import paths = require('./npmts.paths')
|
||||||
|
import { npmtsOra } from './npmts.promisechain'
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @returns {*}
|
||||||
|
*/
|
||||||
|
let mocha = function (configArg) {
|
||||||
|
npmtsOra.text('Instrumentalizing and testing transpiled JS')
|
||||||
|
npmtsOra.end() // end npmtsOra for tests.
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
plugins.gulp.src([plugins.path.join(paths.cwd, 'dist/*.js')])
|
||||||
|
.pipe(plugins.g.sourcemaps.init())
|
||||||
|
.pipe(plugins.g.babel({
|
||||||
|
presets: [
|
||||||
|
require.resolve('babel-preset-es2015')
|
||||||
|
]
|
||||||
|
}))
|
||||||
|
.pipe(plugins.g.istanbul({
|
||||||
|
}))
|
||||||
|
.pipe(plugins.g.sourcemaps.write())
|
||||||
|
.pipe(plugins.g.injectModules())
|
||||||
|
.on('finish', function () {
|
||||||
|
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.js')])
|
||||||
|
.pipe(plugins.g.babel({
|
||||||
|
presets: [
|
||||||
|
require.resolve('babel-preset-es2015')
|
||||||
|
]
|
||||||
|
}))
|
||||||
|
.pipe(plugins.g.injectModules())
|
||||||
|
.pipe(plugins.g.mocha())
|
||||||
|
.pipe(plugins.g.istanbul.writeReports({
|
||||||
|
dir: plugins.path.join(paths.cwd, './coverage'),
|
||||||
|
reporters: ['lcovonly', 'json', 'text', 'text-summary']
|
||||||
|
}))
|
||||||
|
.pipe(plugins.g.gFunction(
|
||||||
|
function () {
|
||||||
|
plugins.beautylog.ok('Tested!')
|
||||||
|
done.resolve(configArg)
|
||||||
|
},
|
||||||
|
'atEnd'
|
||||||
|
))
|
||||||
|
})
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
let coverage = function (configArg) {
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
plugins.smartcov.get.percentage(plugins.path.join(paths.coverageDir, 'lcov.info'), 2)
|
||||||
|
.then(function (percentageArg) {
|
||||||
|
if (percentageArg >= configArg.coverageTreshold) {
|
||||||
|
plugins.beautylog.ok(
|
||||||
|
`${percentageArg.toString()}% `
|
||||||
|
+ `coverage exceeds your treshold of `
|
||||||
|
+ `${configArg.coverageTreshold.toString()}%`
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
plugins.beautylog.warn(
|
||||||
|
`${percentageArg.toString()}% `
|
||||||
|
+ `coverage fails your treshold of `
|
||||||
|
+ `${configArg.coverageTreshold.toString()}%`
|
||||||
|
)
|
||||||
|
plugins.beautylog.error('exiting due to coverage failure')
|
||||||
|
process.exit(1)
|
||||||
|
}
|
||||||
|
done.resolve(configArg)
|
||||||
|
})
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
export let run = function (configArg) {
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
let config = configArg
|
||||||
|
if (config.test === true) {
|
||||||
|
npmtsOra.text('now starting tests')
|
||||||
|
plugins.beautylog.log(
|
||||||
|
'-------------------------------------------------------\n' +
|
||||||
|
'*************************** TESTS: ***************************\n' +
|
||||||
|
'--------------------------------------------------------------'
|
||||||
|
)
|
||||||
|
|
||||||
|
mocha(config)
|
||||||
|
.then(coverage)
|
||||||
|
.then(() => {
|
||||||
|
done.resolve(config)
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
npmtsOra.end()
|
||||||
|
done.resolve(config)
|
||||||
|
}
|
||||||
|
return done.promise
|
||||||
|
}
|
45
ts/npmts.typedoc.ts
Normal file
45
ts/npmts.typedoc.ts
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
import 'typings-global'
|
||||||
|
import plugins = require('./npmts.plugins')
|
||||||
|
import paths = require('./npmts.paths')
|
||||||
|
import { npmtsOra } from './npmts.promisechain'
|
||||||
|
|
||||||
|
import { projectInfo } from './npmts.check'
|
||||||
|
|
||||||
|
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.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",
|
||||||
|
ignoreCompilerErrors: true,
|
||||||
|
version: true
|
||||||
|
}))
|
||||||
|
.pipe(plugins.g.gFunction(done.resolve, 'atEnd'))
|
||||||
|
return done.promise
|
||||||
|
}
|
||||||
|
|
||||||
|
export let run = function (configArg) {
|
||||||
|
let done = plugins.Q.defer()
|
||||||
|
if (configArg.docs) {
|
||||||
|
genTypeDoc(configArg)
|
||||||
|
.then(() => {
|
||||||
|
done.resolve(configArg)
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
done.resolve(configArg)
|
||||||
|
};
|
||||||
|
return done.promise
|
||||||
|
}
|
@ -2,12 +2,7 @@
|
|||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"declaration": true,
|
"declaration": true,
|
||||||
"module": "commonjs",
|
"module": "commonjs",
|
||||||
"target": "ES6",
|
"target": "ES5",
|
||||||
"outDir": "./dist/"
|
"outDir": "./dist/"
|
||||||
},
|
}
|
||||||
"exclude": [
|
|
||||||
"./node_modules",
|
|
||||||
"./test",
|
|
||||||
"./dist"
|
|
||||||
]
|
|
||||||
}
|
}
|
16
tslint.json
16
tslint.json
@ -1,17 +1,3 @@
|
|||||||
{
|
{
|
||||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
"extends": "tslint-config-standard"
|
||||||
"rules": {
|
|
||||||
"semicolon": [true, "always"],
|
|
||||||
"no-console": false,
|
|
||||||
"ordered-imports": false,
|
|
||||||
"object-literal-sort-keys": false,
|
|
||||||
"member-ordering": {
|
|
||||||
"options":{
|
|
||||||
"order": [
|
|
||||||
"static-method"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"defaultSeverity": "warning"
|
|
||||||
}
|
}
|
Loading…
x
Reference in New Issue
Block a user