Compare commits
No commits in common. "master" and "v7.0.1" have entirely different histories.
24
.gitignore
vendored
24
.gitignore
vendored
@ -1,20 +1,6 @@
|
||||
.nogit/
|
||||
|
||||
# artifacts
|
||||
coverage/
|
||||
public/
|
||||
pages/
|
||||
|
||||
# installs
|
||||
node_modules/
|
||||
|
||||
# caches
|
||||
.yarn/
|
||||
.cache/
|
||||
.rpt2_cache
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_*/
|
||||
|
||||
# custom
|
||||
test/
|
||||
pages/
|
||||
public/
|
||||
npm-debug/
|
||||
.DS_Store
|
||||
115
.gitlab-ci.yml
115
.gitlab-ci.yml
@ -1,127 +1,60 @@
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
# standard ci
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
- test
|
||||
- release
|
||||
- trigger
|
||||
- pages
|
||||
|
||||
# ====================
|
||||
# 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:
|
||||
testLEGACY:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
- npmci test legacy
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
allow_failure: true
|
||||
|
||||
testBuild:
|
||||
testLTS:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
- npmci test lts
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testSTABLE:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test stable
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
- npmci publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- 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:
|
||||
stage: metadata
|
||||
stage: trigger
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
stage: metadata
|
||||
image: hosttoday/ht-docker-node:npmpage
|
||||
stage: pages
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
- npmci command npmpage --publish gitlab
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
- public
|
||||
|
||||
6
.npmignore
Normal file
6
.npmignore
Normal file
@ -0,0 +1,6 @@
|
||||
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"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
11
CHANGELOG
Normal file
11
CHANGELOG
Normal file
@ -0,0 +1,11 @@
|
||||
Please view this file on the master branch, on stable branches it's out of date.
|
||||
|
||||
v 6.0.0 (released)
|
||||
- remove TypeDoc, please look at npmpage
|
||||
- check package.json
|
||||
|
||||
v 7.0.0
|
||||
- switch from mocha to tap
|
||||
- run tests in SubProcesses with coverage
|
||||
- improve ES6 handling
|
||||
- add smartanalytics
|
||||
39
README.md
Normal file
39
README.md
Normal file
@ -0,0 +1,39 @@
|
||||
# npmts
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://GitLab.com/gitzone/npmts)
|
||||
[](https://github.com/gitzone/npmts)
|
||||
[](https://gitzone.gitlab.io/npmts/)
|
||||
|
||||
## Status for master
|
||||
[](https://GitLab.com/gitzone/npmts/commits/master)
|
||||
[](https://GitLab.com/gitzone/npmts/commits/master)
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://david-dm.org/gitzone/npmts)
|
||||
[](https://www.bithound.io/github/gitzone/npmts/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/gitzone/npmts)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](http://standardjs.com/)
|
||||
|
||||
## Usage
|
||||
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
||||
|
||||
npmts will
|
||||
|
||||
1. check your dependencies and package.json (unused, missing, updates, security)
|
||||
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. create coverage with istanbul (supports tracing of the originating TypeScript)
|
||||
|
||||
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:
|
||||
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
|
||||
[](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("../{{pathToIndex}}");
|
||||
2
assets/cliNpmts.js
Normal file
2
assets/cliNpmts.js
Normal file
@ -0,0 +1,2 @@
|
||||
#!/usr/bin/env node
|
||||
var index = require("../dist/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();
|
||||
1
dist/index.d.ts
vendored
1
dist/index.d.ts
vendored
@ -1 +0,0 @@
|
||||
export {};
|
||||
5
dist/index.js
vendored
5
dist/index.js
vendored
@ -1,14 +1,15 @@
|
||||
"use strict";
|
||||
/* ================================================== *
|
||||
**** NPMTS ****
|
||||
Fabulous TypeScript development
|
||||
* ================================================== */
|
||||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const early = require("early");
|
||||
early.start('NPMTS');
|
||||
const plugins = require("./npmts.plugins");
|
||||
const cli = require("./npmts.cli");
|
||||
early.stop().then(() => {
|
||||
early.stop()
|
||||
.then(() => {
|
||||
let loaded = plugins; // to make sure plugins get actually loaded
|
||||
cli.run();
|
||||
});
|
||||
|
||||
10
dist/mod_compile/index.js → dist/mod00/index.js
vendored
10
dist/mod_compile/index.js → dist/mod00/index.js
vendored
@ -5,11 +5,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
||||
* 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");
|
||||
const plugins = require("./mod00.plugins");
|
||||
const NpmtsAssets = require("./mod00.assets");
|
||||
const NpmtsCheck = require("./mod00.check");
|
||||
const NpmtsClean = require("./mod00.clean");
|
||||
const NpmtsCompile = require("./mod00.compile");
|
||||
exports.run = function (configArg) {
|
||||
let done = q.defer();
|
||||
plugins.beautylog.ora.text('starting TypeScript Compilation');
|
||||
@ -2,14 +2,14 @@
|
||||
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");
|
||||
const plugins = require("./mod00.plugins");
|
||||
const mod00_check_1 = require("../mod00/mod00.check");
|
||||
exports.run = function (configArg) {
|
||||
let done = q.defer();
|
||||
let config = configArg;
|
||||
plugins.beautylog.ora.text('now looking at ' + 'required assets');
|
||||
plugins.beautylog.ora.text('now looking at ' + 'required assets'.yellow);
|
||||
if (config.cli === true) {
|
||||
let mainJsPath = mod_check_1.projectInfo.packageJson.main;
|
||||
let mainJsPath = mod00_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'));
|
||||
3
dist/mod00/mod00.check.d.ts
vendored
Normal file
3
dist/mod00/mod00.check.d.ts
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
import { ProjectinfoNpm } from 'projectinfo';
|
||||
export declare let projectInfo: ProjectinfoNpm;
|
||||
export declare let run: (configArg: any) => Promise<{}>;
|
||||
@ -1,17 +1,9 @@
|
||||
"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");
|
||||
const plugins = require("./mod00.plugins");
|
||||
let checkProjectTypings = (configArg) => {
|
||||
let done = q.defer();
|
||||
plugins.beautylog.ora.text('Check Module: Check Project Typings...');
|
||||
@ -20,22 +12,20 @@ let checkProjectTypings = (configArg) => {
|
||||
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
|
||||
]
|
||||
@ -45,18 +35,16 @@ let checkDependencies = (configArg) => {
|
||||
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 => {
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
||||
for (let item of unused.dependencies) {
|
||||
plugins.beautylog.warn(`Watch out: unused dependency "${item}"`);
|
||||
}
|
||||
@ -68,10 +56,11 @@ let checkDependencies = (configArg) => {
|
||||
process.exit(1);
|
||||
}
|
||||
for (let item in unused.invalidFiles) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item}`);
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
||||
}
|
||||
;
|
||||
for (let item in unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item}`);
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
|
||||
}
|
||||
done.resolve(configArg);
|
||||
});
|
||||
@ -82,33 +71,31 @@ let checkDevDependencies = (configArg) => {
|
||||
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 => {
|
||||
plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
|
||||
for (let item of unused.devDependencies) {
|
||||
plugins.beautylog.log(`unused devDependency ${item}`);
|
||||
plugins.beautylog.log(`unused devDependency ${item.red}`);
|
||||
}
|
||||
for (let item in unused.missing) {
|
||||
plugins.beautylog.error(`missing devDependency ${item}`);
|
||||
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 in unused.invalidFiles) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item}`);
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
||||
}
|
||||
for (let item in unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item}`);
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
|
||||
}
|
||||
done.resolve(configArg);
|
||||
});
|
||||
@ -120,17 +107,14 @@ let checkNodeVersion = (configArg) => {
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = (configArg) => __awaiter(this, void 0, void 0, function* () {
|
||||
exports.run = (configArg) => {
|
||||
let done = q.defer();
|
||||
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;
|
||||
}
|
||||
});
|
||||
checkProjectTypings(configArg)
|
||||
.then(checkDependencies)
|
||||
.then(checkDevDependencies)
|
||||
.then(checkNodeVersion)
|
||||
.then(done.resolve)
|
||||
.catch((err) => { console.log(err); });
|
||||
return done.promise;
|
||||
};
|
||||
@ -2,7 +2,7 @@
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const q = require("smartq");
|
||||
const paths = require("../npmts.paths");
|
||||
const plugins = require("./mod.plugins");
|
||||
const plugins = require("./mod00.plugins");
|
||||
/**
|
||||
* removes the dist directory which will be entirely rebuild
|
||||
*/
|
||||
@ -10,6 +10,17 @@ let removeDist = function () {
|
||||
plugins.beautylog.ora.text('cleaning dist folder');
|
||||
return plugins.smartfile.fs.remove(paths.distDir);
|
||||
};
|
||||
/**
|
||||
* remove .d.ts files from testDirctory
|
||||
*/
|
||||
let removeTestDeclarations = function () {
|
||||
let done = q.defer();
|
||||
plugins.smartfile.fs.listFileTree('./test/', '**/*.d.ts').then(fileArray => {
|
||||
let fileArrayToRemove = plugins.smartpath.transform.toAbsolute(fileArray, process.cwd() + '//test/');
|
||||
plugins.smartfile.fs.removeManySync(fileArrayToRemove);
|
||||
done.resolve();
|
||||
});
|
||||
};
|
||||
/**
|
||||
* remove old pages
|
||||
*/
|
||||
@ -21,6 +32,7 @@ exports.run = function (configArg) {
|
||||
plugins.beautylog.ora.text('cleaning up from previous builds...');
|
||||
let done = q.defer();
|
||||
removeDist()
|
||||
.then(removeTestDeclarations)
|
||||
.then(removePages)
|
||||
.then(function () {
|
||||
plugins.beautylog.ok('Cleaned up from previous builds!');
|
||||
@ -2,19 +2,15 @@
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const q = require("smartq");
|
||||
const paths = require("../npmts.paths");
|
||||
const plugins = require("./mod.plugins");
|
||||
const plugins = require("./mod00.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)
|
||||
plugins.beautylog.ora.text('now compiling ' + 'TypeScript'.yellow);
|
||||
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);
|
||||
});
|
||||
}).catch(err => { console.log(err); });
|
||||
return done.promise;
|
||||
};
|
||||
@ -1,6 +1,2 @@
|
||||
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>;
|
||||
98
dist/mod_test/index.js → dist/mod02/index.js
vendored
98
dist/mod_test/index.js → dist/mod02/index.js
vendored
@ -11,15 +11,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
||||
/* ------------------------------------------
|
||||
* This module tests the compiled TypeScript files
|
||||
* -------------------------------------------- */
|
||||
const plugins = require("./mod.plugins");
|
||||
const plugins = require("./mod02.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
|
||||
@ -30,15 +24,22 @@ let tap = function (configArg) {
|
||||
* 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.gulp.src([plugins.path.join(paths.cwd, './ts/**/*.ts')]),
|
||||
plugins.gulpSourcemaps.init(),
|
||||
plugins.gulpTypeScript(testTypeScriptConfig),
|
||||
plugins.gulpTypeScript({
|
||||
target: 'ES5',
|
||||
emitDecoratorMetadata: true,
|
||||
experimentalDecorators: true,
|
||||
lib: ['DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable']
|
||||
}),
|
||||
plugins.gulpSourcemaps.write(),
|
||||
plugins.gulpFunction.forEach((file) => __awaiter(this, void 0, void 0, function* () {
|
||||
file.path = file.path.replace(paths.tsDir, paths.distDir);
|
||||
})),
|
||||
npmtsTapBuffer.pipeTestableFiles(),
|
||||
plugins.smartstream.cleanPipe()
|
||||
]);
|
||||
@ -46,18 +47,24 @@ let tap = function (configArg) {
|
||||
* 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(),
|
||||
plugins.gulp.src([plugins.path.join(paths.cwd, 'test/test.ts')]),
|
||||
plugins.gulpTypeScript({
|
||||
target: 'ES5',
|
||||
emitDecoratorMetadata: true,
|
||||
experimentalDecorators: true,
|
||||
lib: ['DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable']
|
||||
}),
|
||||
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();
|
||||
Promise.all([
|
||||
testableFilesSmartstream.run(),
|
||||
testFilesSmartstream.run()
|
||||
]).then(() => __awaiter(this, void 0, void 0, function* () {
|
||||
yield npmtsTapBuffer.runTests();
|
||||
done.resolve(configArg);
|
||||
}), err => {
|
||||
}), (err) => {
|
||||
plugins.beautylog.error('Tests failed!');
|
||||
console.log(err);
|
||||
if (configArg.watch) {
|
||||
@ -69,34 +76,25 @@ let tap = function (configArg) {
|
||||
});
|
||||
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);
|
||||
let handleCoverageData = function (configArg) {
|
||||
let done = q.defer();
|
||||
if (71 >= configArg.coverageTreshold) {
|
||||
plugins.beautylog.ok(`${(71).toString()}% `
|
||||
+ `coverage exceeds your treshold of `
|
||||
+ `${configArg.coverageTreshold.toString()}%`);
|
||||
}
|
||||
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.warn(`${(71).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
|
||||
*/
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = function (configArg) {
|
||||
let done = q.defer();
|
||||
let config = configArg;
|
||||
@ -104,25 +102,11 @@ exports.run = function (configArg) {
|
||||
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);
|
||||
});
|
||||
}
|
||||
tap(config)
|
||||
.then(handleCoverageData)
|
||||
.then(() => {
|
||||
done.resolve(config);
|
||||
}).catch(err => { console.log(err); });
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.ora.end();
|
||||
@ -1,8 +1,7 @@
|
||||
export * from '../npmts.plugins';
|
||||
import * as gulp from 'gulp';
|
||||
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 };
|
||||
export { gulp, gulpFunction, gulpSourcemaps, gulpTypeScript, tapbuffer };
|
||||
@ -4,15 +4,13 @@ function __export(m) {
|
||||
}
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
__export(require("../npmts.plugins"));
|
||||
const gulp = require("gulp");
|
||||
exports.gulp = gulp;
|
||||
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/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>;
|
||||
98
dist/npmts.cli.js
vendored
98
dist/npmts.cli.js
vendored
@ -1,12 +1,4 @@
|
||||
"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");
|
||||
@ -15,62 +7,30 @@ 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 npmtsAnalytics = new plugins.smartanalytics.AnalyticsAccount('npmts', 'UA-64087619-2');
|
||||
npmtsAnalytics.sendEvent('npm', 'exec', 'push.rocks');
|
||||
exports.run = () => {
|
||||
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();
|
||||
npmtsCli.standardTask()
|
||||
.then((argvArg) => {
|
||||
plugins.beautylog.figletSync('NPMTS');
|
||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
|
||||
const configArg = yield NpmtsConfig.run(argvArg);
|
||||
return NpmtsConfig.run(argvArg);
|
||||
})
|
||||
.then((configArg) => {
|
||||
let done = q.defer();
|
||||
plugins.beautylog.ora.start('loading additional modules...');
|
||||
NpmtsMods.modCompile
|
||||
.load()
|
||||
.then(modCompile => {
|
||||
return modCompile.run(configArg);
|
||||
NpmtsMods.mod00.load()
|
||||
.then((mod00) => {
|
||||
return mod00.run(configArg);
|
||||
})
|
||||
.then(configArg => {
|
||||
let done = q.defer();
|
||||
NpmtsMods.modDocs
|
||||
.load()
|
||||
.then(modDocs => {
|
||||
return modDocs.run(configArg);
|
||||
NpmtsMods.mod01.load()
|
||||
.then(mod01 => {
|
||||
return mod01.run(configArg);
|
||||
})
|
||||
.then(configArg => {
|
||||
done.resolve(configArg);
|
||||
@ -79,10 +39,9 @@ exports.run = () => __awaiter(this, void 0, void 0, function* () {
|
||||
})
|
||||
.then(configArg => {
|
||||
let done = q.defer();
|
||||
NpmtsMods.modTest
|
||||
.load()
|
||||
.then(modTest => {
|
||||
return modTest.run(configArg);
|
||||
NpmtsMods.mod02.load()
|
||||
.then(mod02 => {
|
||||
return mod02.run(configArg);
|
||||
})
|
||||
.then(configArg => {
|
||||
done.resolve(configArg);
|
||||
@ -92,18 +51,11 @@ exports.run = () => __awaiter(this, void 0, void 0, function* () {
|
||||
.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
|
||||
})
|
||||
.catch((err) => { if (err instanceof Error) {
|
||||
console.log(err);
|
||||
} });
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version);
|
||||
// start parsing
|
||||
npmtsCli.startParse();
|
||||
return yield done.promise;
|
||||
});
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
18
dist/npmts.config.d.ts
vendored
18
dist/npmts.config.d.ts
vendored
@ -1,26 +1,12 @@
|
||||
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 declare type npmtsMode = 'default' | 'custom';
|
||||
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>;
|
||||
export declare let run: (argvArg: any) => Promise<{}>;
|
||||
|
||||
32
dist/npmts.config.js
vendored
32
dist/npmts.config.js
vendored
@ -2,24 +2,19 @@
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const plugins = require("./npmts.plugins");
|
||||
const paths = require("./npmts.paths");
|
||||
const smartq = require("smartq");
|
||||
const q = require("smartq");
|
||||
;
|
||||
exports.run = function (argvArg) {
|
||||
let done = smartq.defer();
|
||||
let done = q.defer();
|
||||
let defaultConfig = {
|
||||
argv: undefined,
|
||||
coverageTreshold: 70,
|
||||
checkDependencies: true,
|
||||
mode: 'default',
|
||||
test: true,
|
||||
testTs: {},
|
||||
testConfig: {
|
||||
parallel: true,
|
||||
coverage: true
|
||||
},
|
||||
ts: {},
|
||||
tsOptions: {},
|
||||
watch: false,
|
||||
runData: {}
|
||||
watch: false
|
||||
};
|
||||
// mix with configfile
|
||||
plugins.beautylog.ora.text('running npmextra');
|
||||
@ -31,16 +26,16 @@ exports.run = function (argvArg) {
|
||||
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`);
|
||||
plugins.beautylog.error(`mode not recognised!`);
|
||||
process.exit(1);
|
||||
}
|
||||
;
|
||||
// handle default mode
|
||||
if (config.mode === 'default' || config.mode === 'merge') {
|
||||
if (config.mode === 'default') {
|
||||
config.ts = {
|
||||
'./ts/**/*.ts': './dist/'
|
||||
};
|
||||
@ -48,24 +43,17 @@ exports.run = function (argvArg) {
|
||||
'./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;
|
||||
|
||||
14
dist/npmts.mods.d.ts
vendored
14
dist/npmts.mods.d.ts
vendored
@ -1,7 +1,7 @@
|
||||
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>;
|
||||
import { LazyModule } from 'smartsystem';
|
||||
import * as _mod00 from './mod00/index';
|
||||
import * as _mod01 from './mod01/index';
|
||||
import * as _mod02 from './mod02/index';
|
||||
export declare let mod00: LazyModule<typeof _mod00>;
|
||||
export declare let mod01: LazyModule<typeof _mod01>;
|
||||
export declare let mod02: LazyModule<typeof _mod02>;
|
||||
|
||||
6
dist/npmts.mods.js
vendored
6
dist/npmts.mods.js
vendored
@ -1,6 +1,6 @@
|
||||
"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);
|
||||
exports.mod00 = new smartsystem_1.LazyModule('./mod00/index', __dirname);
|
||||
exports.mod01 = new smartsystem_1.LazyModule('./mod01/index', __dirname);
|
||||
exports.mod02 = new smartsystem_1.LazyModule('./mod02/index', __dirname);
|
||||
|
||||
9
dist/npmts.plugins.d.ts
vendored
9
dist/npmts.plugins.d.ts
vendored
@ -1,3 +1,4 @@
|
||||
import 'typings-global';
|
||||
import * as beautylog from 'beautylog';
|
||||
declare let depcheck: any;
|
||||
import * as lodash from 'lodash';
|
||||
@ -5,13 +6,13 @@ import * as npmextra from 'npmextra';
|
||||
import * as projectinfo from 'projectinfo';
|
||||
import * as path from 'path';
|
||||
import * as smartanalytics from 'smartanalytics';
|
||||
import * as smartcli from '@pushrocks/smartcli';
|
||||
import * as smarterror from 'smarterror';
|
||||
import * as smartcli from 'smartcli';
|
||||
import * as smartenv from 'smartenv';
|
||||
import * as smartfile from 'smartfile';
|
||||
import * as smartpath from 'smartpath';
|
||||
import * as smartstream from 'smartstream';
|
||||
import * as smartstring from 'smartstring';
|
||||
import * as smartsystem from 'smartsystem';
|
||||
import * as smartupdate from 'smartupdate';
|
||||
import * as through2 from 'through2';
|
||||
export { beautylog, depcheck, lodash, npmextra, projectinfo, path, smartanalytics, smartcli, smarterror, smartfile, smartpath, smartstream, smartstring, smartsystem, smartupdate, through2 };
|
||||
export declare let sourceMapSupport: any;
|
||||
export { beautylog, depcheck, lodash, npmextra, projectinfo, path, smartanalytics, smartcli, smartenv, smartfile, smartpath, smartstream, smartstring, smartsystem, through2 };
|
||||
|
||||
10
dist/npmts.plugins.js
vendored
10
dist/npmts.plugins.js
vendored
@ -1,5 +1,6 @@
|
||||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
require("typings-global");
|
||||
const beautylog = require("beautylog");
|
||||
exports.beautylog = beautylog;
|
||||
let depcheck = require('depcheck');
|
||||
@ -14,10 +15,10 @@ const path = require("path");
|
||||
exports.path = path;
|
||||
const smartanalytics = require("smartanalytics");
|
||||
exports.smartanalytics = smartanalytics;
|
||||
const smartcli = require("@pushrocks/smartcli");
|
||||
const smartcli = require("smartcli");
|
||||
exports.smartcli = smartcli;
|
||||
const smarterror = require("smarterror");
|
||||
exports.smarterror = smarterror;
|
||||
const smartenv = require("smartenv");
|
||||
exports.smartenv = smartenv;
|
||||
const smartfile = require("smartfile");
|
||||
exports.smartfile = smartfile;
|
||||
const smartpath = require("smartpath");
|
||||
@ -28,7 +29,6 @@ const smartstring = require("smartstring");
|
||||
exports.smartstring = smartstring;
|
||||
const smartsystem = require("smartsystem");
|
||||
exports.smartsystem = smartsystem;
|
||||
const smartupdate = require("smartupdate");
|
||||
exports.smartupdate = smartupdate;
|
||||
const through2 = require("through2");
|
||||
exports.through2 = through2;
|
||||
exports.sourceMapSupport = require('source-map-support').install(); // display errors correctly during testing
|
||||
|
||||
2
dist/npmts.watch.js
vendored
2
dist/npmts.watch.js
vendored
@ -16,7 +16,7 @@ exports.run = (configArg) => {
|
||||
pathsToWatch.push(key);
|
||||
}
|
||||
npmtsSmartchok = new smartchok.Smartchok(pathsToWatch);
|
||||
npmtsSmartchok.getObservableFor('change').then(changeObservableArg => {
|
||||
npmtsSmartchok.getObservableFor('change').then((changeObservableArg) => {
|
||||
plugins.beautylog.info('now watching...');
|
||||
changeObservableArg.subscribe(() => {
|
||||
cli.run();
|
||||
|
||||
@ -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>
|
||||
///
|
||||
@ -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,65 +1,54 @@
|
||||
---
|
||||
name: config
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
npmts can be configured to your needs.
|
||||
# Configuration of NPMTS
|
||||
npmts can be configured to your needs:
|
||||
|
||||
### npmextra.json
|
||||
|
||||
the npmts section in npmextra.json can be used to configure npmts.
|
||||
|
||||
**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.)
|
||||
> with default behaviour.
|
||||
>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.
|
||||
|
||||
```json
|
||||
{
|
||||
"npmts": {
|
||||
"mode": "default"
|
||||
"npmts":{
|
||||
"mode":"default"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Custom settings**
|
||||
|
||||
```json
|
||||
{
|
||||
"mode": "custom",
|
||||
"test": true,
|
||||
"npmts": {
|
||||
"ts": {
|
||||
"./customdir/*.ts": "./"
|
||||
"mode":"custom",
|
||||
"test":true,
|
||||
"npmts":{
|
||||
"ts":{
|
||||
"./customdir/*.ts":"./"
|
||||
},
|
||||
"tsOptions": {
|
||||
"declaration": false,
|
||||
"target": "ES6"
|
||||
"tsOptions":{
|
||||
"declaration":false,
|
||||
"target":"ES6"
|
||||
},
|
||||
"cli": true
|
||||
"cli":true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
| 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 |
|
||||
| `"test"` | `true` | test your module |
|
||||
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
|
||||
| `"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. |
|
||||
| `"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 |
|
||||
| key | default value | description |
|
||||
| --- | --- | --- |
|
||||
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
|
||||
| `"test"` | `true` | test your module |
|
||||
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
|
||||
| `"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. |
|
||||
|
||||
### TypeScript
|
||||
|
||||
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
||||
`./dist/*.js` and `./test/test.js`
|
||||
|
||||
Use commonjs module system for wiring up files.
|
||||
|
||||
### Declaration files
|
||||
|
||||
**npmts** also creates declaration files like `./dist/index.d.ts` by default.
|
||||
You can reference it in your package.json like this.
|
||||
|
||||
@ -73,16 +62,12 @@ You can then import plugins via the TypeScript `import` Syntax
|
||||
and tsc will pick up the declaration file automatically.
|
||||
|
||||
## Some notes:
|
||||
|
||||
#### 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.
|
||||
|
||||
#### Instrumentalize Code
|
||||
|
||||
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
||||
|
||||
#### Tests
|
||||
|
||||
Any errors will be shown with reference to their originating source in TypeScript
|
||||
thanks to autogenerated source maps.
|
||||
@ -1,13 +1,7 @@
|
||||
---
|
||||
name: Default Behaviour
|
||||
---
|
||||
# Default task execution of npmts
|
||||
|
||||
# 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. **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. **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. **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. **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. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
|
||||
@ -1,23 +1,13 @@
|
||||
---
|
||||
name: Examples
|
||||
---
|
||||
# Examples for npmts
|
||||
|
||||
# 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 |
|
||||
| ---------------------------------------------------------- | --------------------------- |
|
||||
| [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 |
|
||||
## Tips and tricks:
|
||||
|
||||
> There are tons more... We will add them here over time.
|
||||
|
||||
### Tips and tricks:
|
||||
|
||||
- Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available.
|
||||
- Use [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.
|
||||
* 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: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.
|
||||
@ -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,44 @@
|
||||
---
|
||||
name: Index
|
||||
description: best practice npm TypeScript modules
|
||||
---
|
||||
|
||||
# npmts
|
||||
|
||||
best practice npm TypeScript modules
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
|
||||
## Availabililty
|
||||
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://GitLab.com/gitzone/npmts)
|
||||
[](https://github.com/gitzone/npmts)
|
||||
[](https://gitzone.gitlab.io/npmts/)
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://gitlab.com/pushrocks/npmts)
|
||||
[](https://github.com/pushrocks/npmts)
|
||||
[](https://pushrocks.gitlab.io/npmts/)
|
||||
|
||||
## Status for master
|
||||
|
||||
[](https://GitLab.com/gitzone/npmts/commits/master)
|
||||
[](https://GitLab.com/gitzone/npmts/commits/master)
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://david-dm.org/gitzonetools/npmts)
|
||||
[](https://www.bithound.io/github/gitzonetools/npmts/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/gitzonetools/npmts)
|
||||
[](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||
[](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/)
|
||||
|
||||
## Quick Demo
|
||||
|
||||
[](https://asciinema.org/a/9c3assmh21i49qhe5lmi48sze?speed=2&t=0)
|
||||
|
||||
## Usage
|
||||
|
||||
## 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 (unused, missing, updates, security)
|
||||
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. create coverage with istanbul (supports tracing of the originating TypeScript)
|
||||
|
||||
For more information on how tests are run check out the [tapbuffer module](https://www.npmjs.com/package/tapbuffer).
|
||||
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/)
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
For further information read the docs:
|
||||
1. [Intro](https://pushrocks.gitlab.io/npmts/index.html)
|
||||
2. [Install](https://pushrocks.gitlab.io/npmts/install.html)
|
||||
3. [Default Behaviour](https://pushrocks.gitlab.io/npmts/default.html)
|
||||
4. [Configuration](https://pushrocks.gitlab.io/npmts/config.html)
|
||||
5. [Examples](https://pushrocks.gitlab.io/npmts/examples.html)
|
||||
6. [Info](https://pushrocks.gitlab.io/npmts/info.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
|
||||
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
|
||||
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
80
package.json
80
package.json
@ -1,15 +1,23 @@
|
||||
{
|
||||
"name": "@gitzone/tscoverage",
|
||||
"version": "9.0.2",
|
||||
"description": "get coverage information for gitzone projects",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"name": "npmts",
|
||||
"version": "7.0.1",
|
||||
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
||||
"main": "dist/index.js",
|
||||
"bin": {
|
||||
"tscoverage": "cli.js"
|
||||
"npmts": "assets/cliNpmts.js"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild --web)"
|
||||
"test": "(npm run compile && npm run prepareTest && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest && npm run checkNoDocs)",
|
||||
"testShort": "(npm run compile && npm run check)",
|
||||
"prepareTest": "(rm -rf test/)",
|
||||
"compile": "(rm -rf dist/ && tsc)",
|
||||
"setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
|
||||
"typedoc": "(typedoc --out ./pages/api --target ES6 ./ts/)",
|
||||
"npmpage": "(npmpage)",
|
||||
"check": "(cd test && yarn 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": {
|
||||
"type": "git",
|
||||
@ -25,28 +33,38 @@
|
||||
"url": "https://gitlab.com/gitzone/npmts/issues"
|
||||
},
|
||||
"homepage": "https://gitlab.com/gitzone/npmts#readme",
|
||||
"dependencies": {},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.24",
|
||||
"@gitzone/tsbundle": "^1.0.69",
|
||||
"@gitzone/tstest": "^1.0.33",
|
||||
"@gitzone/tswatch": "^1.0.46",
|
||||
"@pushrocks/tapbundle": "^3.2.1",
|
||||
"@types/node": "^10.0.3",
|
||||
"tslint": "^6.1.2",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
"dependencies": {
|
||||
"@types/gulp": "^4.0.2",
|
||||
"@types/gulp-sourcemaps": "0.0.30",
|
||||
"@types/minimatch": "^2.0.29",
|
||||
"@types/through2": "^2.0.32",
|
||||
"beautylog": "6.1.5",
|
||||
"depcheck": "^0.6.7",
|
||||
"early": "^2.0.36",
|
||||
"gulp": "3.9.1",
|
||||
"gulp-function": "^2.2.3",
|
||||
"gulp-sourcemaps": "^2.4.1",
|
||||
"gulp-typescript": "^3.1.6",
|
||||
"lodash": "^4.17.4",
|
||||
"npmextra": "^2.0.5",
|
||||
"projectinfo": "^3.0.2",
|
||||
"smartanalytics": "^1.0.3",
|
||||
"smartchok": "^1.0.5",
|
||||
"smartcli": "2.0.1",
|
||||
"smartcov": "1.0.0",
|
||||
"smartenv": "2.0.0",
|
||||
"smartfile": "^4.1.9",
|
||||
"smartpath": "^3.2.8",
|
||||
"smartq": "^1.1.1",
|
||||
"smartstream": "^1.0.8",
|
||||
"smartstring": "^2.0.24",
|
||||
"smartsystem": "^1.0.12",
|
||||
"source-map-support": "^0.4.14",
|
||||
"tapbuffer": "^1.0.9",
|
||||
"through2": "^2.0.3",
|
||||
"tsn": "^2.0.15",
|
||||
"typescript": "^2.2.1",
|
||||
"typings-global": "^1.0.14"
|
||||
},
|
||||
"private": true,
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_*/**/*",
|
||||
"dist_ts/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
]
|
||||
"devDependencies": {}
|
||||
}
|
||||
|
||||
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();
|
||||
15
ts/index.ts
15
ts/index.ts
@ -1 +1,14 @@
|
||||
console.log('tscoverage');
|
||||
/* ================================================== *
|
||||
**** NPMTS ****
|
||||
Fabulous TypeScript development
|
||||
* ================================================== */
|
||||
|
||||
import * as early from 'early'
|
||||
early.start('NPMTS')
|
||||
import * as plugins from './npmts.plugins'
|
||||
import * as cli from './npmts.cli'
|
||||
early.stop()
|
||||
.then(() => {
|
||||
let loaded = plugins // to make sure plugins get actually loaded
|
||||
cli.run()
|
||||
})
|
||||
|
||||
27
ts/mod00/index.ts
Normal file
27
ts/mod00/index.ts
Normal file
@ -0,0 +1,27 @@
|
||||
/* ------------------------------------------
|
||||
* This module compiles the module's TypeScript files
|
||||
* Note: Test files are only compiled in memory
|
||||
* -------------------------------------------- */
|
||||
import * as q from 'smartq'
|
||||
|
||||
import { INpmtsConfig } from '../npmts.config'
|
||||
|
||||
import * as plugins from './mod00.plugins'
|
||||
|
||||
import * as NpmtsAssets from './mod00.assets'
|
||||
import * as NpmtsCheck from './mod00.check'
|
||||
import * as NpmtsClean from './mod00.clean'
|
||||
import * as NpmtsCompile from './mod00.compile'
|
||||
|
||||
export let run = function(configArg: INpmtsConfig): Promise<INpmtsConfig> {
|
||||
let done = q.defer<INpmtsConfig>()
|
||||
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
|
||||
}
|
||||
24
ts/mod00/mod00.assets.ts
Normal file
24
ts/mod00/mod00.assets.ts
Normal file
@ -0,0 +1,24 @@
|
||||
import * as q from 'smartq'
|
||||
|
||||
import paths = require('../npmts.paths')
|
||||
|
||||
import plugins = require('./mod00.plugins')
|
||||
import { projectInfo } from '../mod00/mod00.check'
|
||||
|
||||
export let run = function(configArg){
|
||||
let done = q.defer()
|
||||
let config = configArg
|
||||
plugins.beautylog.ora.text('now looking at ' + 'required assets'.yellow)
|
||||
if (config.cli === true) {
|
||||
let mainJsPath = projectInfo.packageJson.main
|
||||
let cliJsString: string = 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
|
||||
}
|
||||
126
ts/mod00/mod00.check.ts
Normal file
126
ts/mod00/mod00.check.ts
Normal file
@ -0,0 +1,126 @@
|
||||
import * as q from 'smartq'
|
||||
import { ProjectinfoNpm } from 'projectinfo'
|
||||
|
||||
import * as paths from '../npmts.paths'
|
||||
|
||||
import * as plugins from './mod00.plugins'
|
||||
|
||||
export let projectInfo: ProjectinfoNpm
|
||||
|
||||
let checkProjectTypings = (configArg) => {
|
||||
let done = q.defer()
|
||||
plugins.beautylog.ora.text('Check Module: Check Project Typings...')
|
||||
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 = 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.red}`)
|
||||
};
|
||||
for (let item in unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
|
||||
}
|
||||
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.red}`)
|
||||
}
|
||||
for (let item in 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 in unused.invalidFiles) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`)
|
||||
}
|
||||
for (let item in unused.invalidDirs) {
|
||||
plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`)
|
||||
}
|
||||
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
|
||||
}
|
||||
|
||||
export let run = (configArg) => {
|
||||
let done = q.defer()
|
||||
plugins.beautylog.ora.text('Check Module: ...')
|
||||
checkProjectTypings(configArg)
|
||||
.then(checkDependencies)
|
||||
.then(checkDevDependencies)
|
||||
.then(checkNodeVersion)
|
||||
.then(done.resolve)
|
||||
.catch((err) => { console.log(err) })
|
||||
return done.promise
|
||||
}
|
||||
45
ts/mod00/mod00.clean.ts
Normal file
45
ts/mod00/mod00.clean.ts
Normal file
@ -0,0 +1,45 @@
|
||||
import * as q from 'smartq'
|
||||
import paths = require('../npmts.paths')
|
||||
|
||||
import plugins = require('./mod00.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 .d.ts files from testDirctory
|
||||
*/
|
||||
let removeTestDeclarations = function () {
|
||||
let done = q.defer()
|
||||
plugins.smartfile.fs.listFileTree('./test/', '**/*.d.ts').then(fileArray => {
|
||||
let fileArrayToRemove = plugins.smartpath.transform.toAbsolute(fileArray, process.cwd() + '//test/')
|
||||
plugins.smartfile.fs.removeManySync(fileArrayToRemove)
|
||||
done.resolve()
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* remove old pages
|
||||
*/
|
||||
let removePages = function () {
|
||||
plugins.beautylog.ora.text('cleaning pages folder')
|
||||
return plugins.smartfile.fs.remove(paths.pagesDir)
|
||||
}
|
||||
|
||||
export let run = function (configArg) {
|
||||
plugins.beautylog.ora.text('cleaning up from previous builds...')
|
||||
let done = q.defer()
|
||||
removeDist()
|
||||
.then(removeTestDeclarations)
|
||||
.then(removePages)
|
||||
.then(function () {
|
||||
plugins.beautylog.ok('Cleaned up from previous builds!')
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
}
|
||||
17
ts/mod00/mod00.compile.ts
Normal file
17
ts/mod00/mod00.compile.ts
Normal file
@ -0,0 +1,17 @@
|
||||
import * as q from 'smartq'
|
||||
|
||||
import * as paths from '../npmts.paths'
|
||||
|
||||
import * as plugins from './mod00.plugins'
|
||||
|
||||
export let run = function (configArg) {
|
||||
let done = q.defer()
|
||||
let config = configArg
|
||||
plugins.beautylog.ora.text('now compiling ' + 'TypeScript'.yellow)
|
||||
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
|
||||
}
|
||||
11
ts/mod00/mod00.plugins.ts
Normal file
11
ts/mod00/mod00.plugins.ts
Normal file
@ -0,0 +1,11 @@
|
||||
export * from '../npmts.plugins'
|
||||
|
||||
import * as tsn from 'tsn'
|
||||
import * as smartchok from 'smartchok'
|
||||
import * as smartstream from 'smartstream'
|
||||
|
||||
export {
|
||||
tsn,
|
||||
smartchok,
|
||||
smartstream
|
||||
}
|
||||
15
ts/mod01/index.ts
Normal file
15
ts/mod01/index.ts
Normal file
@ -0,0 +1,15 @@
|
||||
/* ------------------------------------------
|
||||
* This module creates TypeScript documentation
|
||||
* -------------------------------------------- */
|
||||
import * as q from 'smartq'
|
||||
|
||||
import * as paths from '../npmts.paths'
|
||||
import { INpmtsConfig } from '../npmts.config'
|
||||
|
||||
import * as plugins from './mod01.plugins'
|
||||
|
||||
export let run = function (configArg: INpmtsConfig) {
|
||||
let done = q.defer<INpmtsConfig>()
|
||||
done.resolve(configArg)
|
||||
return done.promise
|
||||
}
|
||||
2
ts/mod01/mod01.plugins.ts
Normal file
2
ts/mod01/mod01.plugins.ts
Normal file
@ -0,0 +1,2 @@
|
||||
export * from '../npmts.plugins'
|
||||
|
||||
118
ts/mod02/index.ts
Normal file
118
ts/mod02/index.ts
Normal file
@ -0,0 +1,118 @@
|
||||
/* ------------------------------------------
|
||||
* This module tests the compiled TypeScript files
|
||||
* -------------------------------------------- */
|
||||
import plugins = require('./mod02.plugins')
|
||||
import paths = require('../npmts.paths')
|
||||
|
||||
import * as q from 'smartq'
|
||||
|
||||
import { INpmtsConfig } from '../npmts.config'
|
||||
|
||||
/**
|
||||
* runs mocha
|
||||
* @returns INpmtsConfig
|
||||
*/
|
||||
let tap = function (configArg: INpmtsConfig) {
|
||||
let done = q.defer()
|
||||
|
||||
/**
|
||||
* the TabBuffer for npmts
|
||||
*/
|
||||
let npmtsTapBuffer = new plugins.tapbuffer.TabBuffer()
|
||||
|
||||
/**
|
||||
* handle the testable files
|
||||
*/
|
||||
let testableFilesSmartstream = new plugins.smartstream.Smartstream([
|
||||
plugins.gulp.src([ plugins.path.join(paths.cwd, './ts/**/*.ts') ]),
|
||||
plugins.gulpSourcemaps.init(),
|
||||
plugins.gulpTypeScript({
|
||||
target: 'ES5',
|
||||
emitDecoratorMetadata: true,
|
||||
experimentalDecorators: true,
|
||||
lib: [ 'DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable' ]
|
||||
}),
|
||||
plugins.gulpSourcemaps.write(),
|
||||
plugins.gulpFunction.forEach(async file => {
|
||||
file.path = file.path.replace(paths.tsDir, paths.distDir)
|
||||
}),
|
||||
npmtsTapBuffer.pipeTestableFiles(),
|
||||
plugins.smartstream.cleanPipe()
|
||||
])
|
||||
|
||||
/**
|
||||
* handle the test files
|
||||
*/
|
||||
let testFilesSmartstream = new plugins.smartstream.Smartstream([
|
||||
plugins.gulp.src([ plugins.path.join(paths.cwd, 'test/test.ts') ]),
|
||||
plugins.gulpTypeScript({
|
||||
target: 'ES5',
|
||||
emitDecoratorMetadata: true,
|
||||
experimentalDecorators: true,
|
||||
lib: [ 'DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable' ]
|
||||
}),
|
||||
npmtsTapBuffer.pipeTestFiles(),
|
||||
plugins.smartstream.cleanPipe()
|
||||
])
|
||||
|
||||
// lets run the smartstream
|
||||
Promise.all([
|
||||
testableFilesSmartstream.run(),
|
||||
testFilesSmartstream.run()
|
||||
]).then(
|
||||
async () => {
|
||||
await 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 = function (configArg: INpmtsConfig) {
|
||||
let done = q.defer()
|
||||
if (71 >= configArg.coverageTreshold) {
|
||||
plugins.beautylog.ok(
|
||||
`${(71).toString()}% `
|
||||
+ `coverage exceeds your treshold of `
|
||||
+ `${configArg.coverageTreshold.toString()}%`
|
||||
)
|
||||
} else {
|
||||
plugins.beautylog.warn(
|
||||
`${(71).toString()}% `
|
||||
+ `coverage fails your treshold of `
|
||||
+ `${configArg.coverageTreshold.toString()}%`
|
||||
)
|
||||
plugins.beautylog.error('exiting due to coverage failure')
|
||||
if (!configArg.watch) { process.exit(1) }
|
||||
}
|
||||
done.resolve(configArg)
|
||||
return done.promise
|
||||
}
|
||||
|
||||
export let run = function (configArg: INpmtsConfig) {
|
||||
let done = q.defer<INpmtsConfig>()
|
||||
let config = configArg
|
||||
if (config.test === true) {
|
||||
plugins.beautylog.ora.text('now starting tests')
|
||||
plugins.beautylog.ora.end()
|
||||
plugins.beautylog.log('ready for tapbuffer:')
|
||||
|
||||
tap(config)
|
||||
.then(handleCoverageData)
|
||||
.then(() => {
|
||||
done.resolve(config)
|
||||
}).catch(err => { console.log(err) })
|
||||
} else {
|
||||
plugins.beautylog.ora.end()
|
||||
done.resolve(config)
|
||||
}
|
||||
return done.promise
|
||||
}
|
||||
15
ts/mod02/mod02.plugins.ts
Normal file
15
ts/mod02/mod02.plugins.ts
Normal file
@ -0,0 +1,15 @@
|
||||
export * from '../npmts.plugins'
|
||||
|
||||
import * as gulp from 'gulp'
|
||||
import * as gulpFunction from 'gulp-function'
|
||||
import * as gulpSourcemaps from 'gulp-sourcemaps'
|
||||
import * as gulpTypeScript from 'gulp-typescript'
|
||||
import * as tapbuffer from 'tapbuffer'
|
||||
|
||||
export {
|
||||
gulp,
|
||||
gulpFunction,
|
||||
gulpSourcemaps,
|
||||
gulpTypeScript,
|
||||
tapbuffer
|
||||
}
|
||||
61
ts/npmts.cli.ts
Normal file
61
ts/npmts.cli.ts
Normal file
@ -0,0 +1,61 @@
|
||||
import * as q from 'smartq'
|
||||
|
||||
import * as plugins from './npmts.plugins'
|
||||
import * as paths from './npmts.paths'
|
||||
import * as NpmtsConfig from './npmts.config'
|
||||
import * as NpmtsMods from './npmts.mods'
|
||||
import * as NpmtsWatch from './npmts.watch'
|
||||
import * as NpmtsShip from './npmts.ship'
|
||||
|
||||
let npmtsAnalytics = new plugins.smartanalytics.AnalyticsAccount('npmts','UA-64087619-2')
|
||||
npmtsAnalytics.sendEvent('npm','exec','push.rocks')
|
||||
|
||||
export let run = () => {
|
||||
let done = q.defer()
|
||||
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)
|
||||
return NpmtsConfig.run(argvArg)
|
||||
})
|
||||
.then((configArg: NpmtsConfig.INpmtsConfig) => {
|
||||
let done = q.defer()
|
||||
plugins.beautylog.ora.start('loading additional modules...')
|
||||
NpmtsMods.mod00.load()
|
||||
.then((mod00) => {
|
||||
return mod00.run(configArg)
|
||||
})
|
||||
.then(configArg => {
|
||||
let done = q.defer<NpmtsConfig.INpmtsConfig>()
|
||||
NpmtsMods.mod01.load()
|
||||
.then(mod01 => {
|
||||
return mod01.run(configArg)
|
||||
})
|
||||
.then(configArg => {
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
})
|
||||
.then(configArg => {
|
||||
let done = q.defer<NpmtsConfig.INpmtsConfig>()
|
||||
NpmtsMods.mod02.load()
|
||||
.then(mod02 => {
|
||||
return mod02.run(configArg)
|
||||
})
|
||||
.then(configArg => {
|
||||
done.resolve(configArg)
|
||||
})
|
||||
return done.promise
|
||||
})
|
||||
.then(NpmtsWatch.run)
|
||||
.then(NpmtsShip.run)
|
||||
|
||||
return done.promise
|
||||
})
|
||||
.catch((err) => { if (err instanceof Error) { console.log(err) } })
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version)
|
||||
npmtsCli.startParse()
|
||||
return done.promise
|
||||
}
|
||||
78
ts/npmts.config.ts
Normal file
78
ts/npmts.config.ts
Normal file
@ -0,0 +1,78 @@
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
|
||||
import * as q from 'smartq'
|
||||
|
||||
export type npmtsMode = 'default' | 'custom'
|
||||
|
||||
export interface INpmtsConfig {
|
||||
argv: any,
|
||||
coverageTreshold: number,
|
||||
mode: npmtsMode,
|
||||
test: boolean,
|
||||
testTs: any,
|
||||
ts: any,
|
||||
tsOptions: any,
|
||||
watch: boolean
|
||||
|
||||
};
|
||||
|
||||
export let run = function (argvArg) {
|
||||
let done = q.defer()
|
||||
let defaultConfig: INpmtsConfig = {
|
||||
argv: undefined,
|
||||
coverageTreshold: 70,
|
||||
mode: 'default',
|
||||
test: true,
|
||||
testTs: {},
|
||||
ts: {},
|
||||
tsOptions: {},
|
||||
watch: false
|
||||
}
|
||||
|
||||
// mix with configfile
|
||||
plugins.beautylog.ora.text('running npmextra')
|
||||
|
||||
let localNpmextra = new plugins.npmextra.Npmextra(paths.cwd)
|
||||
let config: INpmtsConfig = localNpmextra.dataFor<INpmtsConfig>(
|
||||
'npmts',
|
||||
defaultConfig
|
||||
)
|
||||
|
||||
// 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/**/*.ts': './test/'
|
||||
}
|
||||
};
|
||||
|
||||
// mix with commandline
|
||||
if (config.argv.notest) {
|
||||
config.test = false
|
||||
};
|
||||
if (config.argv.watch) {
|
||||
config.watch = true
|
||||
};
|
||||
|
||||
plugins.beautylog.ok('build options are ready!')
|
||||
done.resolve(config)
|
||||
return done.promise
|
||||
}
|
||||
11
ts/npmts.mods.ts
Normal file
11
ts/npmts.mods.ts
Normal file
@ -0,0 +1,11 @@
|
||||
import * as plugins from './npmts.plugins'
|
||||
|
||||
import { LazyModule } from 'smartsystem'
|
||||
|
||||
import * as _mod00 from './mod00/index'
|
||||
import * as _mod01 from './mod01/index'
|
||||
import * as _mod02 from './mod02/index'
|
||||
|
||||
export let mod00 = new LazyModule<typeof _mod00>('./mod00/index',__dirname)
|
||||
export let mod01 = new LazyModule<typeof _mod01>('./mod01/index',__dirname)
|
||||
export let mod02 = new LazyModule<typeof _mod02>('./mod02/index',__dirname)
|
||||
24
ts/npmts.paths.ts
Normal file
24
ts/npmts.paths.ts
Normal file
@ -0,0 +1,24 @@
|
||||
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')
|
||||
36
ts/npmts.plugins.ts
Normal file
36
ts/npmts.plugins.ts
Normal file
@ -0,0 +1,36 @@
|
||||
import 'typings-global'
|
||||
import * as beautylog from 'beautylog'
|
||||
let depcheck = require('depcheck')
|
||||
|
||||
import * as lodash from 'lodash'
|
||||
import * as npmextra from 'npmextra'
|
||||
import * as projectinfo from 'projectinfo'
|
||||
import * as path from 'path'
|
||||
import * as smartanalytics from 'smartanalytics'
|
||||
import * as smartcli from 'smartcli'
|
||||
import * as smartenv from 'smartenv'
|
||||
import * as smartfile from 'smartfile'
|
||||
import * as smartpath from 'smartpath'
|
||||
import * as smartstream from 'smartstream'
|
||||
import * as smartstring from 'smartstring'
|
||||
import * as smartsystem from 'smartsystem'
|
||||
import * as through2 from 'through2'
|
||||
export let sourceMapSupport = require('source-map-support').install() // display errors correctly during testing
|
||||
|
||||
export {
|
||||
beautylog,
|
||||
depcheck,
|
||||
lodash,
|
||||
npmextra,
|
||||
projectinfo,
|
||||
path,
|
||||
smartanalytics,
|
||||
smartcli,
|
||||
smartenv,
|
||||
smartfile,
|
||||
smartpath,
|
||||
smartstream,
|
||||
smartstring,
|
||||
smartsystem,
|
||||
through2
|
||||
}
|
||||
30
ts/npmts.ship.ts
Normal file
30
ts/npmts.ship.ts
Normal file
@ -0,0 +1,30 @@
|
||||
import * as q from 'smartq'
|
||||
|
||||
import * as plugins from './npmts.plugins'
|
||||
|
||||
import { INpmtsConfig } from './npmts.config'
|
||||
|
||||
export let run = (configArg: INpmtsConfig) => {
|
||||
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)
|
||||
}
|
||||
34
ts/npmts.watch.ts
Normal file
34
ts/npmts.watch.ts
Normal file
@ -0,0 +1,34 @@
|
||||
import * as q from 'smartq'
|
||||
import * as smartchok from 'smartchok'
|
||||
|
||||
import * as plugins from './npmts.plugins'
|
||||
import * as cli from './npmts.cli'
|
||||
|
||||
import { INpmtsConfig } from './npmts.config'
|
||||
|
||||
let npmtsSmartchok: smartchok.Smartchok = null
|
||||
export let run = (configArg: INpmtsConfig) => {
|
||||
let done = q.defer()
|
||||
if (configArg.watch && npmtsSmartchok === null) {
|
||||
let pathsToWatch: string[] = []
|
||||
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
|
||||
}
|
||||
16
tslint.json
16
tslint.json
@ -1,17 +1,3 @@
|
||||
{
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
"extends": "tslint-config-standard"
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user