Compare commits
10 Commits
Author | SHA1 | Date | |
---|---|---|---|
2c254a2ecf | |||
425bc6150a | |||
b2aaa51882 | |||
8ee6623984 | |||
91ec17c51d | |||
646dbdaa3a | |||
4550fcd375 | |||
4d1b992193 | |||
cf2d482798 | |||
43853e4d71 |
17
README.md
17
README.md
@ -6,7 +6,7 @@ Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
|||||||
[](https://david-dm.org/pushrocks/npmts)
|
[](https://david-dm.org/pushrocks/npmts)
|
||||||
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||||
[](https://www.bithound.io/github/pushrocks/npmts)
|
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||||
[](https://codecov.io/github/pushrocks/npmts?branch=master)
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
|
|
||||||
## What is NPMTS?
|
## What is NPMTS?
|
||||||
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
|
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
|
||||||
@ -38,12 +38,13 @@ Then add it to your package.json's script section to trigger a build:
|
|||||||
|
|
||||||
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
|
1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
|
||||||
1. **Clean:** Clean up from any previous builds (old js files)
|
1. **Clean:** Clean up from any previous builds (old js files)
|
||||||
1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES6
|
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. **Documentation:** Create TypeDoc Documentation from TypeScript files
|
1. **Documentation:** Create TypeDoc Documentation from TypeScript files
|
||||||
1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
|
1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
|
||||||
|
|
||||||
### npmextra.json
|
### npmextra.json
|
||||||
the npmts section in npmtsextra.json can be used to configure npmts.
|
the npmts section in npmextra.json can be used to configure npmts.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@ -64,6 +65,7 @@ the npmts section in npmtsextra.json can be used to configure npmts.
|
|||||||
| key | default value | description |
|
| key | default value | description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `"mode"` | `"default"` | "default" will do some default stuff, "custom" only does what you specify |
|
| `"mode"` | `"default"` | "default" will do some default stuff, "custom" only does what you specify |
|
||||||
|
| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
|
||||||
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
|
| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
|
||||||
| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
|
| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
|
||||||
|
|
||||||
@ -74,7 +76,7 @@ by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
|
|||||||
Use commonjs module system for wiring up files.
|
Use commonjs module system for wiring up files.
|
||||||
|
|
||||||
### Declaration files
|
### Declaration files
|
||||||
**npmts** also creates an `./dist/index.d.ts` declaration file by default.
|
**npmts** also creates declaration files like `./dist/index.d.ts` by default.
|
||||||
You can reference it in your package.json like this.
|
You can reference it in your package.json like this.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@ -88,7 +90,7 @@ and tsc will pick up the declaration file automatically.
|
|||||||
|
|
||||||
## Some notes:
|
## Some notes:
|
||||||
#### Typings for third party modules that do not bundle declaration files
|
#### Typings for third party modules that do not bundle declaration files
|
||||||
NPMTS does no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
|
NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
|
||||||
|
|
||||||
#### Instrumentalize Code
|
#### Instrumentalize Code
|
||||||
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
||||||
@ -109,6 +111,11 @@ thanks to autogenerated source maps.
|
|||||||
* Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds
|
* Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds
|
||||||
* Use [npmdocker](https://www.npmjs.com/package/npmdocker) for running tests consistently with docker.
|
* Use [npmdocker](https://www.npmjs.com/package/npmdocker) for running tests consistently with docker.
|
||||||
|
|
||||||
|
## 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:
|
## About the authors:
|
||||||
[](https://lossless.com/)
|
[](https://lossless.com/)
|
||||||
|
|
||||||
|
19
dist/npmts.check.js
vendored
19
dist/npmts.check.js
vendored
@ -55,18 +55,13 @@ var checkDependencies = function (configArg) {
|
|||||||
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
for (var _d = 0, _e = unused.using; _d < _e.length; _d++) {
|
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||||
var item = _e[_d];
|
var item = _e[_d];
|
||||||
console.log(item);
|
|
||||||
}
|
|
||||||
;
|
|
||||||
for (var _f = 0, _g = unused.invalidFiles; _f < _g.length; _f++) {
|
|
||||||
var item = _g[_f];
|
|
||||||
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||||
}
|
}
|
||||||
;
|
;
|
||||||
for (var _h = 0, _j = unused.invalidDirs; _h < _j.length; _h++) {
|
for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
|
||||||
var item = _j[_h];
|
var item = _g[_f];
|
||||||
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
|
||||||
}
|
}
|
||||||
;
|
;
|
||||||
@ -93,11 +88,15 @@ var checkDevDependencies = function (configArg) {
|
|||||||
plugins.beautylog.log("unused devDependency " + item.red);
|
plugins.beautylog.log("unused devDependency " + item.red);
|
||||||
}
|
}
|
||||||
;
|
;
|
||||||
for (var _b = 0, _c = unused.using; _b < _c.length; _b++) {
|
for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
|
||||||
var item = _c[_b];
|
var item = _c[_b];
|
||||||
console.log(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 (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
|
||||||
var item = _e[_d];
|
var item = _e[_d];
|
||||||
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
plugins.beautylog.warn("Watch out: could not parse file " + item.red);
|
||||||
|
2
dist/npmts.tests.js
vendored
2
dist/npmts.tests.js
vendored
@ -25,7 +25,7 @@ var mocha = function (configArg) {
|
|||||||
plugins.gulp.src([plugins.path.join(paths.cwd, "test/test.js")])
|
plugins.gulp.src([plugins.path.join(paths.cwd, "test/test.js")])
|
||||||
.pipe(plugins.g.babel({
|
.pipe(plugins.g.babel({
|
||||||
presets: [
|
presets: [
|
||||||
plugins.path.join(paths.npmtsPackageRoot, "node_modules/babel-preset-es2015/index.js")
|
require.resolve("babel-preset-es2015")
|
||||||
]
|
]
|
||||||
}))
|
}))
|
||||||
.pipe(plugins.g.injectModules())
|
.pipe(plugins.g.injectModules())
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "npmts",
|
"name": "npmts",
|
||||||
"version": "5.4.2",
|
"version": "5.4.5",
|
||||||
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"bin": {
|
"bin": {
|
||||||
@ -10,7 +10,7 @@
|
|||||||
"test": "(npm run compile && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest)",
|
"test": "(npm run compile && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest)",
|
||||||
"compile": "(rm -rf test/ && rm -r dist/ && mkdir dist/ && tsc && cp assets/cli.js dist/ )",
|
"compile": "(rm -rf test/ && rm -r dist/ && mkdir dist/ && tsc && cp assets/cli.js dist/ )",
|
||||||
"setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
|
"setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
|
||||||
"check": "(cd test && node ../dist/index.js)",
|
"check": "(cd test && npm install && node ../dist/index.js)",
|
||||||
"checkVersion": "(cd test/ && node ../dist/index.js -v)",
|
"checkVersion": "(cd test/ && node ../dist/index.js -v)",
|
||||||
"checkNoTest": "(cd test && node ../dist/index.js --notest)"
|
"checkNoTest": "(cd test && node ../dist/index.js --notest)"
|
||||||
},
|
},
|
||||||
|
@ -52,9 +52,6 @@ let checkDependencies = (configArg) => {
|
|||||||
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
plugins.beautylog.info("exiting due to missing dependencies in package.json");
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
for (let item of unused.using) {
|
|
||||||
console.log(item);
|
|
||||||
};
|
|
||||||
for (let item of unused.invalidFiles) {
|
for (let item of unused.invalidFiles) {
|
||||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
||||||
};
|
};
|
||||||
@ -83,9 +80,13 @@ let checkDevDependencies = (configArg) => {
|
|||||||
for (let item of unused.devDependencies) {
|
for (let item of unused.devDependencies) {
|
||||||
plugins.beautylog.log(`unused devDependency ${item.red}`);
|
plugins.beautylog.log(`unused devDependency ${item.red}`);
|
||||||
};
|
};
|
||||||
for (let item of unused.using) {
|
for (let item of unused.missing) {
|
||||||
console.log(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 of unused.invalidFiles) {
|
for (let item of unused.invalidFiles) {
|
||||||
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
|
||||||
};
|
};
|
||||||
|
@ -26,7 +26,7 @@ let mocha = function (configArg) {
|
|||||||
plugins.gulp.src([plugins.path.join(paths.cwd,"test/test.js")])
|
plugins.gulp.src([plugins.path.join(paths.cwd,"test/test.js")])
|
||||||
.pipe(plugins.g.babel({
|
.pipe(plugins.g.babel({
|
||||||
presets: [
|
presets: [
|
||||||
plugins.path.join(paths.npmtsPackageRoot,"node_modules/babel-preset-es2015/index.js")
|
require.resolve("babel-preset-es2015")
|
||||||
]
|
]
|
||||||
}))
|
}))
|
||||||
.pipe(plugins.g.injectModules())
|
.pipe(plugins.g.injectModules())
|
||||||
|
Reference in New Issue
Block a user