Compare commits
94 Commits
Author | SHA1 | Date | |
---|---|---|---|
784aec1ec3 | |||
61b7bbb168 | |||
1d662ddef4 | |||
f7351c914e | |||
7132ae11a8 | |||
b195b8911b | |||
e331e870d9 | |||
3a6bd3b583 | |||
594bccfc82 | |||
d9f1d36d14 | |||
f12c4aabd8 | |||
b62f7d8b31 | |||
56cccb1b14 | |||
850df45d7f | |||
2b1f371d8a | |||
8196ca50a7 | |||
ad96661dda | |||
2fc6c3d358 | |||
0c74fb3343 | |||
d821a2efa6 | |||
66f2321d99 | |||
816f4f57fb | |||
9bdf3ec4c7 | |||
b9d4953bcd | |||
8c0fcdf5b7 | |||
a477cc00e7 | |||
00b9a742ab | |||
f5b8ab84cf | |||
4fc4efc0b9 | |||
30136f01a8 | |||
d1d85819d7 | |||
e267fce3bb | |||
f964b2737f | |||
6ac634e178 | |||
3105f8f401 | |||
70b83fcafc | |||
7e8e4b1891 | |||
aa8279c281 | |||
7564e1fd18 | |||
a6fbe7da33 | |||
e0f208ba41 | |||
d2cf4346d4 | |||
b769dcae4f | |||
7b58535dda | |||
f16103a632 | |||
befed099c5 | |||
6c0fa380a9 | |||
22de2c784f | |||
e8fe4f1720 | |||
d7443bbf17 | |||
c4668bc0a6 | |||
bc489b6bf3 | |||
e2d0a7a939 | |||
0f5e451e60 | |||
3595bf3590 | |||
efe73d0fd0 | |||
c52322ec12 | |||
b7cf9949bf | |||
beac49d5d2 | |||
25993bd66f | |||
83b324054a | |||
2c574fe015 | |||
3b50365ea9 | |||
e6f487eeee | |||
07c100ae44 | |||
55888cce89 | |||
d4c66af0d8 | |||
9359b5f7e9 | |||
87c0ec5728 | |||
aeb79f053f | |||
e01ecb9369 | |||
fd29434fa6 | |||
4684b9616c | |||
a2701bc3be | |||
425a86b33c | |||
20631eb0a8 | |||
27287d24fb | |||
1b2393c7ed | |||
330b0527c5 | |||
4485b5bfc6 | |||
cf6f636d3e | |||
37e726a45f | |||
0f0f2dd4ed | |||
9033eede2c | |||
e65e7da26b | |||
ef5c5eb2b8 | |||
ed156e6de8 | |||
d889a20572 | |||
da1ec0329f | |||
95e3f9cb10 | |||
def19f76e9 | |||
455c89d68d | |||
2bd187b704 | |||
29dff4c0e3 |
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,3 +1,4 @@
|
||||
.nogit/
|
||||
node_modules/
|
||||
test/
|
||||
pages/
|
||||
|
@ -7,15 +7,26 @@ cache:
|
||||
key: "$CI_BUILD_STAGE"
|
||||
|
||||
stages:
|
||||
- mirror
|
||||
- test
|
||||
- release
|
||||
- trigger
|
||||
- pages
|
||||
|
||||
mirror:
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
stage: mirror
|
||||
script:
|
||||
- npmci git mirror
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testLEGACY:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test legacy
|
||||
- npmci node install legacy
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
@ -24,7 +35,9 @@ testLEGACY:
|
||||
testLTS:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test lts
|
||||
- npmci node install lts
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
@ -32,7 +45,9 @@ testLTS:
|
||||
testSTABLE:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test stable
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
@ -40,7 +55,8 @@ testSTABLE:
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci publish
|
||||
- npmci npm prepare
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
|
11
CHANGELOG
11
CHANGELOG
@ -1,11 +0,0 @@
|
||||
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
|
3
dist/mod00/mod00.check.d.ts
vendored
3
dist/mod00/mod00.check.d.ts
vendored
@ -1,3 +1,4 @@
|
||||
import { ProjectinfoNpm } from 'projectinfo';
|
||||
import { INpmtsConfig } from '../npmts.config';
|
||||
export declare let projectInfo: ProjectinfoNpm;
|
||||
export declare let run: (configArg: any) => Promise<{}>;
|
||||
export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;
|
||||
|
31
dist/mod00/mod00.check.js
vendored
31
dist/mod00/mod00.check.js
vendored
@ -1,4 +1,12 @@
|
||||
"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");
|
||||
@ -107,14 +115,17 @@ let checkNodeVersion = (configArg) => {
|
||||
done.resolve(configArg);
|
||||
return done.promise;
|
||||
};
|
||||
exports.run = (configArg) => {
|
||||
let done = q.defer();
|
||||
exports.run = (configArg) => __awaiter(this, void 0, void 0, function* () {
|
||||
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;
|
||||
};
|
||||
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;
|
||||
}
|
||||
});
|
||||
|
35
dist/mod02/index.js
vendored
35
dist/mod02/index.js
vendored
@ -14,6 +14,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
||||
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
|
||||
@ -24,21 +33,14 @@ 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.gulpSourcemaps.init(),
|
||||
plugins.gulpTypeScript({
|
||||
target: 'ES5',
|
||||
emitDecoratorMetadata: true,
|
||||
experimentalDecorators: true,
|
||||
lib: ['DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable']
|
||||
}),
|
||||
plugins.gulpFunction.forEach((file) => __awaiter(this, void 0, void 0, function* () {
|
||||
file.path = file.path.replace(paths.tsDir, paths.distDir);
|
||||
})),
|
||||
plugins.gulpTypeScript(testTypeScriptConfig),
|
||||
plugins.gulpSourcemaps.write(),
|
||||
npmtsTapBuffer.pipeTestableFiles(),
|
||||
plugins.smartstream.cleanPipe()
|
||||
@ -49,12 +51,7 @@ let tap = function (configArg) {
|
||||
let testFilesSmartstream = new plugins.smartstream.Smartstream([
|
||||
plugins.smartgulp.src([plugins.path.join(paths.cwd, 'test/*.ts')]),
|
||||
plugins.gulpSourcemaps.init(),
|
||||
plugins.gulpTypeScript({
|
||||
target: 'ES5',
|
||||
emitDecoratorMetadata: true,
|
||||
experimentalDecorators: true,
|
||||
lib: ['DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable']
|
||||
}),
|
||||
plugins.gulpTypeScript(testTypeScriptConfig),
|
||||
plugins.gulpSourcemaps.write(),
|
||||
npmtsTapBuffer.pipeTestFiles(),
|
||||
plugins.smartstream.cleanPipe()
|
||||
@ -109,12 +106,20 @@ 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); });
|
||||
}
|
||||
}
|
||||
else {
|
||||
plugins.beautylog.ora.end();
|
||||
done.resolve(config);
|
||||
|
39
dist/npmts.cli.js
vendored
39
dist/npmts.cli.js
vendored
@ -1,4 +1,12 @@
|
||||
"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,18 +23,35 @@ const NpmtsShip = require("./npmts.ship");
|
||||
* 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 Google Analytics.
|
||||
* 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.AnalyticsAccount('npmts', 'UA-64087619-5');
|
||||
npmtsAnalytics.sendEvent('npm', 'exec', 'git.zone');
|
||||
exports.run = () => {
|
||||
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();
|
||||
npmtsCli.standardTask()
|
||||
.then((argvArg) => {
|
||||
plugins.beautylog.figletSync('NPMTS');
|
||||
plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
|
||||
return NpmtsConfig.run(argvArg);
|
||||
})
|
||||
@ -68,5 +93,5 @@ exports.run = () => {
|
||||
} });
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version);
|
||||
npmtsCli.startParse();
|
||||
return done.promise;
|
||||
};
|
||||
return yield done.promise;
|
||||
});
|
||||
|
12
dist/npmts.config.d.ts
vendored
12
dist/npmts.config.d.ts
vendored
@ -1,10 +1,19 @@
|
||||
export declare type npmtsMode = 'default' | 'custom';
|
||||
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;
|
||||
@ -14,3 +23,4 @@ export interface INpmtsConfig {
|
||||
};
|
||||
}
|
||||
export declare let run: (argvArg: any) => Promise<{}>;
|
||||
export declare let configPromise: Promise<INpmtsConfig>;
|
||||
|
29
dist/npmts.config.js
vendored
29
dist/npmts.config.js
vendored
@ -2,16 +2,20 @@
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
const plugins = require("./npmts.plugins");
|
||||
const paths = require("./npmts.paths");
|
||||
const q = require("smartq");
|
||||
;
|
||||
const smartq = require("smartq");
|
||||
exports.run = function (argvArg) {
|
||||
let done = q.defer();
|
||||
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,
|
||||
@ -27,16 +31,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!`);
|
||||
plugins.beautylog.error(`mode not recognised! Can be default or custom`);
|
||||
process.exit(1);
|
||||
}
|
||||
;
|
||||
// handle default mode
|
||||
if (config.mode === 'default') {
|
||||
if (config.mode === 'default' || config.mode === 'merge') {
|
||||
config.ts = {
|
||||
'./ts/**/*.ts': './dist/'
|
||||
};
|
||||
@ -44,17 +48,24 @@ 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;
|
||||
|
3
dist/npmts.plugins.d.ts
vendored
3
dist/npmts.plugins.d.ts
vendored
@ -13,5 +13,6 @@ 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, through2 };
|
||||
export { beautylog, depcheck, lodash, npmextra, projectinfo, path, smartanalytics, smartcli, smarterror, smartfile, smartpath, smartstream, smartstring, smartsystem, smartupdate, through2 };
|
||||
|
2
dist/npmts.plugins.js
vendored
2
dist/npmts.plugins.js
vendored
@ -29,5 +29,7 @@ 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;
|
||||
|
9
docs/changelog.md
Normal file
9
docs/changelog.md
Normal file
@ -0,0 +1,9 @@
|
||||
# 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
|
||||
```
|
@ -39,11 +39,12 @@ with default behaviour.
|
||||
|
||||
| key | default value | description |
|
||||
| --- | --- | --- |
|
||||
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
|
||||
| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify, "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. |
|
||||
| `"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
|
||||
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
||||
|
38
docs/getstarted.md
Normal file
38
docs/getstarted.md
Normal file
@ -0,0 +1,38 @@
|
||||
---
|
||||
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,8 +1,9 @@
|
||||
---
|
||||
name: Start
|
||||
name: Index
|
||||
description: best practice npm TypeScript modules
|
||||
---
|
||||
# npmts
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
best practice npm TypeScript modules
|
||||
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
|
26
docs/structure.md
Normal file
26
docs/structure.md
Normal file
@ -0,0 +1,26 @@
|
||||
---
|
||||
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**
|
37
package.json
37
package.json
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "npmts",
|
||||
"version": "7.1.2",
|
||||
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
||||
"version": "8.0.23",
|
||||
"description": "best practice npm TypeScript modules",
|
||||
"main": "dist/index.js",
|
||||
"bin": {
|
||||
"npmts": "assets/cliNpmts.js"
|
||||
@ -34,35 +34,36 @@
|
||||
},
|
||||
"homepage": "https://gitlab.com/gitzone/npmts#readme",
|
||||
"dependencies": {
|
||||
"@types/gulp-sourcemaps": "0.0.30",
|
||||
"@types/minimatch": "^2.0.29",
|
||||
"@types/gulp-sourcemaps": "0.0.31",
|
||||
"@types/minimatch": "^3.0.1",
|
||||
"@types/through2": "^2.0.33",
|
||||
"beautylog": "6.1.10",
|
||||
"beautylog": "^6.1.10",
|
||||
"depcheck": "^0.6.7",
|
||||
"early": "^2.1.1",
|
||||
"gulp-function": "^2.2.9",
|
||||
"gulp-sourcemaps": "^2.6.0",
|
||||
"gulp-typescript": "^3.1.7",
|
||||
"gulp-sourcemaps": "^2.6.1",
|
||||
"gulp-typescript": "^3.2.2",
|
||||
"lodash": "^4.17.4",
|
||||
"npmextra": "^2.0.5",
|
||||
"projectinfo": "^3.0.2",
|
||||
"smartanalytics": "^1.0.6",
|
||||
"smartchok": "^1.0.8",
|
||||
"npmextra": "^2.0.9",
|
||||
"projectinfo": "^3.0.4",
|
||||
"smartanalytics": "^2.0.9",
|
||||
"smartchok": "^1.0.11",
|
||||
"smartcli": "^2.0.7",
|
||||
"smartcov": "^1.0.2",
|
||||
"smarterror": "^1.0.3",
|
||||
"smartfile": "^4.2.17",
|
||||
"smartfile": "^4.2.26",
|
||||
"smartgulp": "^1.0.6",
|
||||
"smartpath": "^3.2.8",
|
||||
"smartq": "^1.1.1",
|
||||
"smartstream": "^1.0.8",
|
||||
"smartq": "^1.1.6",
|
||||
"smartstream": "^1.0.10",
|
||||
"smartstring": "^2.0.24",
|
||||
"smartsystem": "^1.0.17",
|
||||
"tapbuffer": "^1.0.13",
|
||||
"smartsystem": "^2.0.2",
|
||||
"smartupdate": "^1.0.12",
|
||||
"tapbuffer": "^1.0.29",
|
||||
"through2": "^2.0.3",
|
||||
"tsn": "^2.0.15",
|
||||
"typescript": "^2.3.4",
|
||||
"typings-global": "^1.0.16"
|
||||
"typescript": "^2.5.2",
|
||||
"typings-global": "^1.0.20"
|
||||
},
|
||||
"devDependencies": {}
|
||||
}
|
||||
|
@ -1,5 +1,5 @@
|
||||
# npmts
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
best practice npm TypeScript modules
|
||||
|
||||
## Availabililty
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
@ -33,9 +33,14 @@ npmts will
|
||||
|
||||
For more information on how tests are run check out the [tapbuffer module](https://www.npmjs.com/package/tapbuffer).
|
||||
|
||||
For more information about how to best write tap tests check out the [tapbundle module's linked docs](https://www.npmjs.com/package/tapbundle).
|
||||
|
||||
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/)
|
||||
|
||||
## Changelog
|
||||
For breaking changes please see the [changelog](https://gitzone.gitlab.io/npmts/changelog.html).
|
||||
|
||||
For further information read the linked docs at the top of this README.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
|
@ -1,14 +1,17 @@
|
||||
import * as q from 'smartq'
|
||||
import { ProjectinfoNpm } from 'projectinfo'
|
||||
|
||||
// interfaces
|
||||
import { INpmtsConfig } from '../npmts.config'
|
||||
|
||||
import * as paths from '../npmts.paths'
|
||||
|
||||
import * as plugins from './mod00.plugins'
|
||||
|
||||
export let projectInfo: ProjectinfoNpm
|
||||
|
||||
let checkProjectTypings = (configArg) => {
|
||||
let done = q.defer()
|
||||
let checkProjectTypings = (configArg: INpmtsConfig) => {
|
||||
let done = q.defer<INpmtsConfig>()
|
||||
plugins.beautylog.ora.text('Check Module: Check Project Typings...')
|
||||
projectInfo = new ProjectinfoNpm(paths.cwd)
|
||||
if (typeof projectInfo.packageJson.typings === 'undefined') {
|
||||
@ -34,8 +37,8 @@ const depcheckOptions = {
|
||||
]
|
||||
}
|
||||
|
||||
let checkDependencies = (configArg) => {
|
||||
let done = q.defer()
|
||||
let checkDependencies = (configArg: INpmtsConfig) => {
|
||||
let done = q.defer<INpmtsConfig>()
|
||||
plugins.beautylog.ora.text('Check Module: Check Dependencies...')
|
||||
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
|
||||
ignoreDirs: [ // folder with these names will be ignored
|
||||
@ -70,8 +73,8 @@ let checkDependencies = (configArg) => {
|
||||
return done.promise
|
||||
}
|
||||
|
||||
let checkDevDependencies = (configArg) => {
|
||||
let done = q.defer()
|
||||
let checkDevDependencies = (configArg: INpmtsConfig) => {
|
||||
let done = q.defer<INpmtsConfig>()
|
||||
plugins.beautylog.ora.text('Check Module: Check devDependencies...')
|
||||
let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
|
||||
ignoreDirs: [ // folder with these names will be ignored
|
||||
@ -106,21 +109,24 @@ let checkDevDependencies = (configArg) => {
|
||||
return done.promise
|
||||
}
|
||||
|
||||
let checkNodeVersion = (configArg) => {
|
||||
let done = q.defer()
|
||||
let checkNodeVersion = (configArg: INpmtsConfig) => {
|
||||
let done = q.defer<INpmtsConfig>()
|
||||
plugins.beautylog.ora.text('checking node version')
|
||||
done.resolve(configArg)
|
||||
return done.promise
|
||||
}
|
||||
|
||||
export let run = (configArg) => {
|
||||
let done = q.defer()
|
||||
export let run = async (configArg: INpmtsConfig) => {
|
||||
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
|
||||
|
||||
if (configArg.checkDependencies) {
|
||||
configArg = await checkProjectTypings(configArg)
|
||||
configArg = await checkDependencies(configArg)
|
||||
configArg = await checkDevDependencies(configArg)
|
||||
configArg = await checkNodeVersion(configArg)
|
||||
return configArg
|
||||
} else {
|
||||
configArg = await checkProjectTypings(configArg)
|
||||
return configArg
|
||||
}
|
||||
}
|
||||
|
@ -6,7 +6,19 @@ import paths = require('../npmts.paths')
|
||||
|
||||
import * as q from 'smartq'
|
||||
|
||||
// interfaces
|
||||
import { INpmtsConfig } from '../npmts.config'
|
||||
import { Smartfile } from 'smartfile'
|
||||
|
||||
let testTypeScriptConfig = {
|
||||
target: 'ES5',
|
||||
emitDecoratorMetadata: true,
|
||||
experimentalDecorators: true,
|
||||
lib: [
|
||||
'DOM',
|
||||
'ESNext'
|
||||
]
|
||||
}
|
||||
|
||||
/**
|
||||
* runs mocha
|
||||
@ -20,21 +32,15 @@ let tap = function (configArg: INpmtsConfig) {
|
||||
*/
|
||||
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({
|
||||
target: 'ES5',
|
||||
emitDecoratorMetadata: true,
|
||||
experimentalDecorators: true,
|
||||
lib: [ 'DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable' ]
|
||||
}),
|
||||
plugins.gulpFunction.forEach(async file => {
|
||||
file.path = file.path.replace(paths.tsDir, paths.distDir)
|
||||
}),
|
||||
plugins.gulpTypeScript(testTypeScriptConfig),
|
||||
plugins.gulpSourcemaps.write(),
|
||||
npmtsTapBuffer.pipeTestableFiles(),
|
||||
plugins.smartstream.cleanPipe()
|
||||
@ -46,12 +52,7 @@ let tap = function (configArg: INpmtsConfig) {
|
||||
let testFilesSmartstream = new plugins.smartstream.Smartstream([
|
||||
plugins.smartgulp.src([ plugins.path.join(paths.cwd, 'test/*.ts') ]),
|
||||
plugins.gulpSourcemaps.init(),
|
||||
plugins.gulpTypeScript({
|
||||
target: 'ES5',
|
||||
emitDecoratorMetadata: true,
|
||||
experimentalDecorators: true,
|
||||
lib: [ 'DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable' ]
|
||||
}),
|
||||
plugins.gulpTypeScript(testTypeScriptConfig),
|
||||
plugins.gulpSourcemaps.write(),
|
||||
npmtsTapBuffer.pipeTestFiles(),
|
||||
plugins.smartstream.cleanPipe()
|
||||
@ -114,12 +115,19 @@ export let run = function (configArg: INpmtsConfig) {
|
||||
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)
|
||||
|
@ -15,19 +15,38 @@ import * as NpmtsShip from './npmts.ship'
|
||||
* 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 Google Analytics.
|
||||
* 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.AnalyticsAccount('npmts','UA-64087619-5')
|
||||
npmtsAnalytics.sendEvent('npm','exec','git.zone')
|
||||
let npmtsAnalytics = new plugins.smartanalytics.Analytics({
|
||||
apiEndPoint: 'https://pubapi.lossless.one/analytics',
|
||||
projectId: 'gitzone',
|
||||
appName: 'npmts'
|
||||
})
|
||||
|
||||
export let run = () => {
|
||||
process.nextTick(async () => {
|
||||
// make the analytics call
|
||||
npmtsAnalytics.recordEvent('npmToolExecution', {
|
||||
executionMode: (await NpmtsConfig.configPromise).mode,
|
||||
tsOptions: (await NpmtsConfig.configPromise).tsOptions,
|
||||
watch: (await NpmtsConfig.configPromise).watch,
|
||||
coverageTreshold: (await NpmtsConfig.configPromise).coverageTreshold
|
||||
}).catch(err => {
|
||||
plugins.beautylog.warn('Lossless Analytics API not available...')
|
||||
})
|
||||
})
|
||||
|
||||
export let run = async () => {
|
||||
let done = q.defer()
|
||||
|
||||
plugins.beautylog.figletSync('NPMTS')
|
||||
let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot)
|
||||
// check for updates
|
||||
await plugins.smartupdate.standardHandler.check('npmts', npmtsProjectInfo.version, 'http://gitzone.gitlab.io/npmts/changelog.html')
|
||||
plugins.beautylog.log('---------------------------------------------')
|
||||
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)
|
||||
})
|
||||
@ -68,5 +87,5 @@ export let run = () => {
|
||||
.catch((err) => { if (err instanceof Error) { console.log(err) } })
|
||||
npmtsCli.addVersion(npmtsProjectInfo.version)
|
||||
npmtsCli.startParse()
|
||||
return done.promise
|
||||
return await done.promise
|
||||
}
|
||||
|
@ -1,33 +1,49 @@
|
||||
import plugins = require('./npmts.plugins')
|
||||
import paths = require('./npmts.paths')
|
||||
|
||||
import * as q from 'smartq'
|
||||
import * as smartq from 'smartq'
|
||||
|
||||
export type npmtsMode = 'default' | 'custom'
|
||||
// interfaces
|
||||
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 type npmtsMode = 'default' | 'custom' | 'merge'
|
||||
|
||||
export interface INpmtsConfig {
|
||||
argv: any,
|
||||
coverageTreshold: number,
|
||||
mode: npmtsMode,
|
||||
test: boolean,
|
||||
testTs: any,
|
||||
ts: any,
|
||||
tsOptions: any,
|
||||
argv: any
|
||||
coverageTreshold: number
|
||||
checkDependencies: boolean
|
||||
mode: npmtsMode
|
||||
test: boolean
|
||||
testTs: any
|
||||
testConfig: ITapbufferConfig
|
||||
ts: any
|
||||
tsOptions: any
|
||||
watch: boolean
|
||||
runData: {
|
||||
coverageLcovInfo?: string,
|
||||
coverageLcovInfo?: string
|
||||
coverageResult?: number
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
export let run = function (argvArg) {
|
||||
let done = q.defer()
|
||||
let done = smartq.defer()
|
||||
let defaultConfig: INpmtsConfig = {
|
||||
argv: undefined,
|
||||
coverageTreshold: 70,
|
||||
checkDependencies: true,
|
||||
mode: 'default',
|
||||
test: true,
|
||||
testTs: {},
|
||||
testConfig: {
|
||||
parallel: true,
|
||||
coverage: true
|
||||
},
|
||||
ts: {},
|
||||
tsOptions: {},
|
||||
watch: false,
|
||||
@ -50,33 +66,48 @@ export let 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!`)
|
||||
plugins.beautylog.error(`mode not recognised! Can be default or custom`)
|
||||
process.exit(1)
|
||||
};
|
||||
}
|
||||
|
||||
// handle default mode
|
||||
if (config.mode === 'default') {
|
||||
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<INpmtsConfig>()
|
||||
export let configPromise = configDeferred.promise
|
||||
|
@ -14,6 +14,7 @@ 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 {
|
||||
@ -31,5 +32,6 @@ export {
|
||||
smartstream,
|
||||
smartstring,
|
||||
smartsystem,
|
||||
smartupdate,
|
||||
through2
|
||||
}
|
||||
|
Reference in New Issue
Block a user