Compare commits
6 Commits
Author | SHA1 | Date | |
---|---|---|---|
41b1fe85d6 | |||
8372c1437c | |||
aedf9f3115 | |||
25320bdf5c | |||
33c83de1fb | |||
07a56fcaca |
13
README.md
13
README.md
@ -17,10 +17,17 @@ Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
|||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
|
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
||||||
By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works.
|
|
||||||
|
|
||||||
There is a docker image available that includes npmts to make CI a breeze:
|
npmts will
|
||||||
|
|
||||||
|
1. check your dependencies and package.json
|
||||||
|
1. transpile your code with tsc,
|
||||||
|
1. document your code with typedoc,
|
||||||
|
1. test your code with mocha
|
||||||
|
1. create coverage with istanbul
|
||||||
|
|
||||||
|
This works on your machine and in CI. There is a prebuild docker image available that includes npmts to make CI a breeze:
|
||||||
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||||
|
|
||||||
For further information read the docs.
|
For further information read the docs.
|
||||||
|
3
dist/npmts.check.js
vendored
3
dist/npmts.check.js
vendored
@ -2,9 +2,10 @@
|
|||||||
var plugins = require("./npmts.plugins");
|
var plugins = require("./npmts.plugins");
|
||||||
var paths = require("./npmts.paths");
|
var paths = require("./npmts.paths");
|
||||||
var npmts_promisechain_1 = require("./npmts.promisechain");
|
var npmts_promisechain_1 = require("./npmts.promisechain");
|
||||||
exports.projectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.cwd);
|
var projectinfo_1 = require("projectinfo");
|
||||||
var checkProjectTypings = function (configArg) {
|
var checkProjectTypings = function (configArg) {
|
||||||
var done = plugins.Q.defer();
|
var done = plugins.Q.defer();
|
||||||
|
exports.projectInfo = new projectinfo_1.ProjectinfoNpm(paths.cwd);
|
||||||
if (typeof exports.projectInfo.packageJson.typings == "undefined") {
|
if (typeof exports.projectInfo.packageJson.typings == "undefined") {
|
||||||
plugins.beautylog.error("please add typings field to package.json");
|
plugins.beautylog.error("please add typings field to package.json");
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
|
3
dist/npmts.compile.js
vendored
3
dist/npmts.compile.js
vendored
@ -20,7 +20,8 @@ var compileTs = function (tsFileArrayArg, tsOptionsArg) {
|
|||||||
var compilerOptions = {
|
var compilerOptions = {
|
||||||
declaration: tsOptionsCombined.declaration,
|
declaration: tsOptionsCombined.declaration,
|
||||||
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
||||||
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target]
|
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target],
|
||||||
|
exclude: "node_modules/**/*"
|
||||||
};
|
};
|
||||||
return compilerOptions;
|
return compilerOptions;
|
||||||
};
|
};
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# Default task execution order
|
# Default task execution of npmts
|
||||||
|
|
||||||
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,4 +1,4 @@
|
|||||||
# Examples for NPMTS
|
# Examples for npmts
|
||||||
|
|
||||||
## Example Usage in modules:
|
## Example Usage in modules:
|
||||||
* [gulp-browser](https://www.npmjs.com/package/gulp-browser)
|
* [gulp-browser](https://www.npmjs.com/package/gulp-browser)
|
||||||
|
@ -17,10 +17,17 @@ Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
|||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
|
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
||||||
By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works.
|
|
||||||
|
|
||||||
There is a docker image available that includes npmts to make CI a breeze:
|
npmts will
|
||||||
|
|
||||||
|
1. check your dependencies and package.json
|
||||||
|
1. transpile your code with tsc,
|
||||||
|
1. document your code with typedoc,
|
||||||
|
1. test your code with mocha
|
||||||
|
1. create coverage with istanbul
|
||||||
|
|
||||||
|
This works on your machine and in CI. There is a prebuild docker image available that includes npmts to make CI a breeze:
|
||||||
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||||
|
|
||||||
For further information read the docs.
|
For further information read the docs.
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# Install NPMTS
|
# Install npmts
|
||||||
First install npmts globally, then install the npmts-g locally.
|
First install npmts globally, then install the npmts-g locally.
|
||||||
|
|
||||||
> **npmts-g* checks if the global version of npmts suffices the modules requirements.
|
> **npmts-g* checks if the global version of npmts suffices the modules requirements.
|
||||||
|
22
package.json
22
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "npmts",
|
"name": "npmts",
|
||||||
"version": "5.4.24",
|
"version": "5.4.27",
|
||||||
"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": {
|
||||||
@ -32,19 +32,19 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/npmts#readme",
|
"homepage": "https://gitlab.com/pushrocks/npmts#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/gulp": "^3.8.30",
|
"@types/gulp": "^3.8.31",
|
||||||
"@types/minimatch": "^2.0.28",
|
"@types/minimatch": "^2.0.28",
|
||||||
"@types/q": "^0.x.x",
|
"@types/q": "^0.x.x",
|
||||||
"@types/shelljs": "^0.3.29",
|
"@types/shelljs": "^0.3.30",
|
||||||
"babel-preset-es2015": "^6.13.2",
|
"babel-preset-es2015": "^6.14.0",
|
||||||
"beautylog": "5.0.20",
|
"beautylog": "5.0.22",
|
||||||
"depcheck": "^0.6.4",
|
"depcheck": "^0.6.4",
|
||||||
"early": "^2.0.25",
|
"early": "^2.0.26",
|
||||||
"gulp": "3.9.1",
|
"gulp": "3.9.1",
|
||||||
"gulp-babel": "^6.1.2",
|
"gulp-babel": "^6.1.2",
|
||||||
"gulp-function": "^1.3.6",
|
"gulp-function": "^1.3.6",
|
||||||
"gulp-inject-modules": "^1.0.0",
|
"gulp-inject-modules": "^1.0.0",
|
||||||
"gulp-istanbul": "^1.1.0",
|
"gulp-istanbul": "^1.1.1",
|
||||||
"gulp-mocha": "^3.0.1",
|
"gulp-mocha": "^3.0.1",
|
||||||
"gulp-sourcemaps": "^1.6.0",
|
"gulp-sourcemaps": "^1.6.0",
|
||||||
"gulp-typedoc": "^2.0.0",
|
"gulp-typedoc": "^2.0.0",
|
||||||
@ -52,18 +52,18 @@
|
|||||||
"npmextra": "^1.0.9",
|
"npmextra": "^1.0.9",
|
||||||
"projectinfo": "1.0.3",
|
"projectinfo": "1.0.3",
|
||||||
"q": "^1.4.1",
|
"q": "^1.4.1",
|
||||||
"shelljs": "^0.7.3",
|
"shelljs": "^0.7.4",
|
||||||
"smartcli": "1.0.4",
|
"smartcli": "1.0.5",
|
||||||
"smartcov": "1.0.0",
|
"smartcov": "1.0.0",
|
||||||
"smartenv": "1.2.5",
|
"smartenv": "1.2.5",
|
||||||
"smartfile": "4.0.13",
|
"smartfile": "4.0.15",
|
||||||
"smartpath": "3.2.2",
|
"smartpath": "3.2.2",
|
||||||
"smartstring": "^2.0.17",
|
"smartstring": "^2.0.17",
|
||||||
"source-map-support": "^0.4.2",
|
"source-map-support": "^0.4.2",
|
||||||
"tsn": "^1.0.12",
|
"tsn": "^1.0.12",
|
||||||
"typedoc": "^0.4.5",
|
"typedoc": "^0.4.5",
|
||||||
"typescript": "next",
|
"typescript": "next",
|
||||||
"typings-global": "*"
|
"typings-global": "^1.0.14"
|
||||||
},
|
},
|
||||||
"devDependencies": {}
|
"devDependencies": {}
|
||||||
}
|
}
|
||||||
|
@ -4,11 +4,11 @@ import { npmtsOra } from "./npmts.promisechain";
|
|||||||
|
|
||||||
import {ProjectinfoNpm} from "projectinfo";
|
import {ProjectinfoNpm} from "projectinfo";
|
||||||
|
|
||||||
export let projectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.cwd);
|
export let projectInfo:ProjectinfoNpm;
|
||||||
|
|
||||||
let checkProjectTypings = (configArg) => {
|
let checkProjectTypings = (configArg) => {
|
||||||
let done = plugins.Q.defer();
|
let done = plugins.Q.defer();
|
||||||
|
projectInfo = new ProjectinfoNpm(paths.cwd);
|
||||||
if(typeof projectInfo.packageJson.typings == "undefined"){
|
if(typeof projectInfo.packageJson.typings == "undefined"){
|
||||||
plugins.beautylog.error(`please add typings field to package.json`);
|
plugins.beautylog.error(`please add typings field to package.json`);
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
|
@ -22,7 +22,8 @@ let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => {
|
|||||||
let compilerOptions:plugins.tsn.CompilerOptions = {
|
let compilerOptions:plugins.tsn.CompilerOptions = {
|
||||||
declaration: tsOptionsCombined.declaration,
|
declaration: tsOptionsCombined.declaration,
|
||||||
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
|
||||||
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target]
|
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target],
|
||||||
|
exclude: "node_modules/**/*"
|
||||||
};
|
};
|
||||||
return compilerOptions;
|
return compilerOptions;
|
||||||
};
|
};
|
||||||
|
Reference in New Issue
Block a user