Compare commits

...

50 Commits

Author SHA1 Message Date
9ad59704be 2.4.1 2016-02-17 04:26:44 +01:00
29f3832d63 switch to commonjs module as default 2016-02-17 04:26:26 +01:00
2d82a3a037 2.4.0 2016-02-17 01:48:38 +01:00
4806f5ceff updated readme 2016-02-17 01:40:01 +01:00
f2ef982189 added sourcemap support 2016-02-17 01:16:21 +01:00
5d6ead017b 2.3.2 2016-02-16 11:29:07 +01:00
1c2b4e421d fix compile script 2016-02-16 11:28:57 +01:00
6cf7d2ca0b update test 2016-02-16 11:14:05 +01:00
676c072631 2.3.1 2016-02-16 10:58:50 +01:00
f29c04e09c update .gitignore 2016-02-16 10:58:42 +01:00
77a06a0fc4 2.3.0 2016-02-16 10:29:26 +01:00
c9792b1955 update target from ES3 to ES5 2016-02-16 10:29:14 +01:00
b87de178c0 2.2.4 2016-02-16 09:53:35 +01:00
0580f29d30 update ReadeMe 2016-02-16 09:52:24 +01:00
2c17273671 update badge order 2016-02-14 03:20:53 +01:00
669ed2e6ab add badges 2016-02-14 03:19:54 +01:00
8bc73b2bf4 update readme 2016-02-14 03:13:03 +01:00
78e5defd7c update readme 2016-02-14 03:12:02 +01:00
7e540bda87 2.2.3 2016-02-11 19:10:14 +01:00
b293dfe92d add figlet greeting 2016-02-11 19:10:01 +01:00
a753a5db2c 2.2.2 2016-02-09 20:36:40 +01:00
27f79b4425 readded test.ts to default build process 2016-02-09 20:36:31 +01:00
1ada5dd5a9 2.2.1 2016-02-09 17:42:43 +01:00
a41bfd442c fix coveralls initial value 2016-02-09 17:42:31 +01:00
2917b10ffb 2.2.0 2016-02-09 17:26:37 +01:00
bfc5bbbbb7 fix coverage path 2016-02-09 17:26:25 +01:00
cf507a4a17 add coverage badge 2016-02-09 17:19:27 +01:00
73a57ed264 2.1.10 2016-02-09 17:01:45 +01:00
39b79b679c fix config traveling 2016-02-09 17:01:37 +01:00
cc053ee396 2.1.9 2016-02-09 16:34:55 +01:00
df5371187b remove scoping problem with gulp task names 2016-02-09 16:34:52 +01:00
cbda76c380 2.1.8 2016-02-09 16:00:20 +01:00
e20bcec133 finetune some paths 2016-02-09 16:00:07 +01:00
3e673e04b2 2.1.7 2016-02-09 06:01:39 +01:00
2090dad540 refine coverage treshold for failure 2016-02-09 06:01:32 +01:00
ebe7a02ef0 2.1.6 2016-02-09 05:47:11 +01:00
3f9194f344 add coveralls config option 2016-02-09 05:46:55 +01:00
13c9c96cc6 add code coverage 2016-02-09 05:39:31 +01:00
3f0b2b1599 2.1.5 2016-02-07 12:19:50 +01:00
d477e492eb small fix 2016-02-07 12:19:42 +01:00
f39cb03fc2 2.1.4 2016-02-07 01:00:28 +01:00
f42744b927 2.1.3 2016-02-06 19:00:20 +01:00
038994e9e5 updated log output 2016-02-06 19:00:02 +01:00
7a26721420 2.1.2 2016-02-06 18:56:51 +01:00
0dc307f082 now handles multiple typings recursivly 2016-02-06 18:56:42 +01:00
4b2c0fe461 2.1.1 2016-02-06 18:07:20 +01:00
50fd5e83ad improve path handling 2016-02-06 18:06:55 +01:00
3e55a666b2 update npm test 2016-02-04 20:43:52 +01:00
5d8ce3f227 2.1.0 2016-02-04 20:41:46 +01:00
de4bbaed9f now accepts config file 2016-02-04 20:41:34 +01:00
38 changed files with 569 additions and 191 deletions

1
.gitignore vendored
View File

@ -3,5 +3,6 @@
node_modules/ node_modules/
test/**/node_modules/ test/**/node_modules/
test/**/typings/ test/**/typings/
test/**/coverage/
ts/*.js ts/*.js
ts/*.js.map ts/*.js.map

View File

@ -1,6 +1,13 @@
# npmts # npmts
Write npm modules with TypeScript without hassle. Write npm modules with TypeScript without hassle.
## Status
[![Build Status](https://travis-ci.org/pushrocks/npmts.svg?branch=master)](https://travis-ci.org/pushrocks/npmts)
[![Dependency Status](https://david-dm.org/pushrocks/npmts.svg)](https://david-dm.org/pushrocks/npmts)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmts/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/npmts/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmts)
[![Coverage Status](https://coveralls.io/repos/github/pushrocks/npmts/badge.svg?branch=master)](https://coveralls.io/github/pushrocks/npmts?branch=master)
## How to use npmts ## How to use npmts
### Install ### Install
@ -19,6 +26,23 @@ Then use it in package.json's script section to trigger a build:
``` ```
### Default behaviour ### Default behaviour
**Execution order of tasks**
1. Install typings
2. Transpile TypeScript with inline sourcemaps
3. Create Declaration Files
4. Instrumentalize created JavaScript files with istanbul
5. Run Tests
6. Create Coverage report
7. Upload Coverage reports to travis (must be activated, only triggers on travis)
#### Typings
**npmts** looks for `./ts/typings.json` by default and installs any defined typings to `.ts/typings/`.
You can then reference the ./ts/typings/main.d.ts file in your TypeScript code.
#### TypeScript
by default npmts looks for `./ts/index.ts` and `./ts/test.ts` that will compile to by default npmts looks for `./ts/index.ts` and `./ts/test.ts` that will compile to
`./index.js` and `./test.js` `./index.js` and `./test.js`
@ -31,14 +55,40 @@ You can reference it in your package.json like this:
"typings": "./index.d.ts", "typings": "./index.d.ts",
``` ```
#### Instrumentalize Code
npmts instrumentalizes the created JavaScript code to create a coverage report.
#### Tests
When Typings have been installed, TypeScript + Declaration files have been transpiled and the resulting JS has been instrumentalized,
npmts runs `.test/test.js` with mocha.
Any errors will be shown with reference to their originating source in TypeScript.
When requiring the module from other TypeScript files, When requiring the module from other TypeScript files,
the TypeScript Compiler will use the declaration file to resolve typings. the TypeScript Compiler will use the declaration file to resolve typings.
### Custom behaviour ### Custom behaviour
We are currently building support for custom behaviour with a super simple config file. Custom behaviour can be achieved through a config file at the root of your package.
Check back soon. The file must be named **npmts.json**
```json
{
"mode":"custom",
"ts":{
"./customdir/custom.ts":"./customcompiled.js"
},
"typings":[
"./customdir"
]
}
```
* **mode** can be "default" or "custom"
* **ts** You can list as many TypeScript files as you like. The key represents the source TypeScript file, the value the output file.
* **typings** is an array of all direcories that have a typings.json present. Uses the new typings tool from npm.
## Readme for Devs ## Readme for Devs
There is a [README-dev.md](README-dev.md) in the repo. There is a [README-dev.md](README-dev.md) in the repo.

View File

@ -4,7 +4,7 @@ var plugins = {
gulp: require("gulp"), gulp: require("gulp"),
g:{ g:{
typescript: require("gulp-typescript"), typescript: require("gulp-typescript"),
insert: require("gulp-insert") header: require("gulp-header")
}, },
mergeStream: require("merge2") mergeStream: require("merge2")
@ -23,7 +23,7 @@ plugins.gulp.task('indexTS', function() {
return plugins.mergeStream([ return plugins.mergeStream([
tsResult.dts.pipe(plugins.gulp.dest('../')), tsResult.dts.pipe(plugins.gulp.dest('../')),
tsResult.js tsResult.js
.pipe(plugins.g.insert.prepend('#!/usr/bin/env node\n\n')) .pipe(plugins.g.header('#!/usr/bin/env node\n\n'))
.pipe(plugins.gulp.dest('../')) .pipe(plugins.gulp.dest('../'))
]); ]);
}); });

34
index.d.ts vendored
View File

@ -5,32 +5,36 @@ declare module NpmtsPlugins {
fs: any; fs: any;
gulp: any; gulp: any;
g: { g: {
insert: any; coveralls: any;
sequence: any; header: any;
istanbul: any;
mocha: any;
sourcemaps: any;
typescript: any; typescript: any;
}; };
mergeStream: any; mergeStream: any;
mocha: any; sourceMapSupport: any;
path: any; path: any;
q: any; q: any;
smartcli: any; smartcli: any;
smartfile: any;
typings: any; typings: any;
}; };
} }
declare module NpmtsPaths { declare module NpmtsPaths {
var init: () => any; var init: () => any;
} }
declare module NpmtsConfigFile {
var run: () => any;
}
declare module NpmtsOptions { declare module NpmtsOptions {
var run: () => any; var run: (configArg: any) => any;
} }
declare module NpmtsTypings { declare module NpmtsCompile {
var run: () => any; var run: (configArg: any) => any;
}
declare module NpmtsDefault {
var run: () => any;
} }
declare module NpmtsTests { declare module NpmtsTests {
var run: () => any; var run: (configArg: any) => any;
} }
declare module NpmtsPromisechain { declare module NpmtsPromisechain {
var init: () => any; var init: () => any;
@ -40,15 +44,19 @@ declare var plugins: {
fs: any; fs: any;
gulp: any; gulp: any;
g: { g: {
insert: any; coveralls: any;
sequence: any; header: any;
istanbul: any;
mocha: any;
sourcemaps: any;
typescript: any; typescript: any;
}; };
mergeStream: any; mergeStream: any;
mocha: any; sourceMapSupport: any;
path: any; path: any;
q: any; q: any;
smartcli: any; smartcli: any;
smartfile: any;
typings: any; typings: any;
}; };
declare var paths: any; declare var paths: any;

253
index.js
View File

@ -9,15 +9,19 @@ var NpmtsPlugins;
fs: require("fs-extra"), fs: require("fs-extra"),
gulp: require("gulp"), gulp: require("gulp"),
g: { g: {
insert: require("gulp-insert"), coveralls: require("gulp-coveralls"),
sequence: require("gulp-sequence"), header: require("gulp-header"),
istanbul: require("gulp-istanbul"),
mocha: require("gulp-mocha"),
sourcemaps: require("gulp-sourcemaps"),
typescript: require("gulp-typescript") typescript: require("gulp-typescript")
}, },
mergeStream: require("merge2"), mergeStream: require("merge2"),
mocha: require("mocha"), sourceMapSupport: require("source-map-support").install(),
path: require("path"), path: require("path"),
q: require("q"), q: require("q"),
smartcli: require("smartcli"), smartcli: require("smartcli"),
smartfile: require("smartfile"),
typings: require("typings") typings: require("typings")
}; };
return plugins; return plugins;
@ -38,80 +42,193 @@ var NpmtsPaths;
}; };
})(NpmtsPaths || (NpmtsPaths = {})); })(NpmtsPaths || (NpmtsPaths = {}));
/// <reference path="./index.ts" /> /// <reference path="./index.ts" />
var NpmtsConfigFile;
(function (NpmtsConfigFile) {
NpmtsConfigFile.run = function () {
var done = plugins.q.defer();
var config = {};
var configPath = plugins.path.join(paths.cwd, "npmts.json");
if (plugins.smartfile.checks.fileExistsSync(configPath)) {
plugins.beautylog.info("npmts.json".blue + " config file found!");
config = plugins.smartfile.readFileToObject(configPath);
switch (config.mode) {
case "default":
case "custom":
plugins.beautylog.log("mode is " + config.mode.yellow);
done.resolve(config);
break;
default:
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
}
;
}
else {
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
config.mode = "default";
done.resolve(config);
}
;
return done.promise;
};
})(NpmtsConfigFile || (NpmtsConfigFile = {}));
/// <reference path="./index.ts" />
var NpmtsOptions; var NpmtsOptions;
(function (NpmtsOptions) { (function (NpmtsOptions) {
NpmtsOptions.run = function () { NpmtsOptions.run = function (configArg) {
var done = plugins.q.defer(); var done = plugins.q.defer();
done.resolve(); //TODO: check for options var config = configArg;
if (typeof config.coveralls === "undefined") {
config.coveralls = false;
}
if (config.mode == "default") {
config.typings = [
"./ts/"
];
config.ts = (_a = {},
_a["./ts/index.ts"] = "./index.js",
_a["./ts/test.ts"] = "./test/test.js",
_a
);
config.test = ["./index.js"];
done.resolve(config);
}
else {
done.resolve(config);
}
return done.promise; return done.promise;
var _a;
}; };
})(NpmtsOptions || (NpmtsOptions = {})); })(NpmtsOptions || (NpmtsOptions = {}));
/// <reference path="./index.ts" /> /// <reference path="./index.ts" />
var NpmtsTypings; var NpmtsCompile;
(function (NpmtsTypings) { (function (NpmtsCompile) {
NpmtsTypings.run = function () { NpmtsCompile.run = function (configArg) {
var done = plugins.q.defer(); var done = plugins.q.defer();
plugins.beautylog.log("now installing typings"); var config = configArg;
plugins.typings.install({ production: false, cwd: paths.tsDir }) plugins.beautylog.log("now running custom tasks");
.then(function () { var moduleStream = plugins.mergeStream({ end: false });
done.resolve(); /* -------------------------------------------------
* ----------- first install typings ---------------
* ----------------------------------------------- */
var typingsDone = plugins.q.defer();
var typingsCounter = 0;
var typingsCounterAdvance = function () {
typingsCounter++;
if (typeof config.typings[typingsCounter] != "undefined") {
installTypings();
}
else {
plugins.beautylog.success("custom typings installed successfully");
typingsDone.resolve();
}
};
var installTypings = function () {
plugins.beautylog.log("now installing " + "typings.json".yellow + " from " + config.typings[typingsCounter].blue);
plugins.typings.install({ production: false, cwd: plugins.path.join(paths.cwd, config.typings[typingsCounter]) })
.then(function () {
typingsCounterAdvance();
}, function () {
plugins.beautylog.error("something went wrong: Check if path is correct: " + config.typings[typingsCounter].blue);
typingsCounterAdvance();
});
};
installTypings();
/* -------------------------------------------------
* ----------- second compile TS -------------------
* ----------------------------------------------- */
typingsDone.promise.then(function () {
for (var key in config.ts) {
plugins.beautylog.log("now compiling" + key.blue);
var outputPathIsDir;
try {
if (plugins.fs.statSync(plugins.path.join(paths.cwd, config.ts[key])).isDirectory()) {
outputPathIsDir = true;
}
}
catch (err) {
outputPathIsDir = false;
}
//do some evaluation of the environment
var outputNameSpecified = (!outputPathIsDir
&& (plugins.path.extname(config.ts[key]) == ".js"));
var outputName = (function () {
if (outputNameSpecified) {
return plugins.path.basename(config.ts[key]);
}
else {
return undefined;
}
})();
var outputDir = (function () {
if (outputNameSpecified) {
return plugins.path.dirname(plugins.path.join(paths.cwd, config.ts[key]));
}
else {
return plugins.path.join(paths.cwd, config.ts[key]);
}
})();
var tsStream = plugins.gulp.src(plugins.path.join(paths.cwd, key))
.pipe(plugins.g.sourcemaps.init()) // This means sourcemaps will be generated
.pipe(plugins.g.typescript({
out: outputName,
declaration: true,
target: "ES5",
module: "commonjs"
}));
var stream = plugins.mergeStream([
tsStream.dts.pipe(plugins.gulp.dest(outputDir)),
tsStream.js
.pipe(plugins.g.sourcemaps.write()) // Now the sourcemaps are added to the .js file
.pipe(plugins.g.header('#!/usr/bin/env node\n\n'))
.pipe(plugins.gulp.dest(outputDir))
]);
moduleStream.add(stream);
}
moduleStream.on("queueDrain", function () {
plugins.beautylog.success("custom TypeScript installed successfully");
moduleStream.on("finish", function () {
done.resolve(config);
});
moduleStream.end();
});
}); });
return done.promise; return done.promise;
}; };
})(NpmtsTypings || (NpmtsTypings = {})); })(NpmtsCompile || (NpmtsCompile = {}));
/// <reference path="./index.ts" />
/// <reference path="./index.ts" />
var NpmtsDefault;
(function (NpmtsDefault) {
NpmtsDefault.run = function () {
var done = plugins.q.defer();
plugins.gulp.task("defaultIndexTS", function () {
plugins.beautylog.log("now compiling" + " ts/index.ts".blue);
var tsResult = plugins.gulp.src(paths.indexTS)
.pipe(plugins.g.typescript({
out: "index.js",
declaration: true
}));
return plugins.mergeStream([
tsResult.dts.pipe(plugins.gulp.dest(paths.cwd)),
tsResult.js
.pipe(plugins.g.insert.prepend('#!/usr/bin/env node\n\n'))
.pipe(plugins.gulp.dest(paths.cwd))
]);
});
plugins.gulp.task("defaultTestTS", function () {
plugins.beautylog.log("now compiling" + " ts/test.ts".blue);
var stream = plugins.gulp.src(paths.testTS)
.pipe(plugins.g.typescript({
out: "test.js"
}))
.pipe(plugins.gulp.dest(paths.testDir));
return stream;
});
plugins.gulp.task("defaultCleanup", function (cb) {
plugins.beautylog.success("TypeScript for this module compiled successfully.");
done.resolve();
cb();
});
plugins.gulp.task("default", function (cb) {
plugins.g.sequence("defaultIndexTS", "defaultTestTS", "defaultCleanup", cb);
});
plugins.gulp.start.apply(plugins.gulp, ['default']);
return done.promise;
};
})(NpmtsDefault || (NpmtsDefault = {}));
/// <reference path="./index.ts" /> /// <reference path="./index.ts" />
var NpmtsTests; var NpmtsTests;
(function (NpmtsTests) { (function (NpmtsTests) {
NpmtsTests.run = function () { NpmtsTests.run = function (configArg) {
var done = plugins.q.defer(); var done = plugins.q.defer();
plugins.fs.ensureDirSync(paths.testDir); //make sure that mocha has a directory to look for tests var config = configArg;
plugins.beautylog.info("Now running mocha tests"); var istanbul = function () {
var mocha = new plugins.mocha(); // Instantiate a Mocha instance. var stream = plugins.gulp.src([plugins.path.join(paths.cwd, "index.js")])
mocha.addFile(plugins.path.join(paths.testDir, "test.js")); .pipe(plugins.g.istanbul())
mocha.run(function (failures) { .pipe(plugins.g.istanbul.hookRequire());
process.on('exit', function () { return stream;
process.exit(failures); };
var mocha = function () {
var stream = plugins.gulp.src(["./test/test.js"])
.pipe(plugins.g.mocha())
.pipe(plugins.g.istanbul.writeReports())
.pipe(plugins.g.istanbul.enforceThresholds({ thresholds: { global: 30 } }));
return stream;
};
var coveralls = function () {
var stream = plugins.gulp.src([plugins.path.join(paths.cwd, "./coverage/lcov.info")])
.pipe(plugins.g.coveralls());
return stream;
};
istanbul().on("finish", function () {
mocha().on("finish", function () {
if (process.env.TRAVIS && config.coveralls) {
coveralls().on("finish", function () {
done.resolve(config);
});
}
else {
done.resolve(config);
}
}); });
}); });
return done.promise; return done.promise;
@ -122,9 +239,9 @@ var NpmtsPromisechain;
(function (NpmtsPromisechain) { (function (NpmtsPromisechain) {
NpmtsPromisechain.init = function () { NpmtsPromisechain.init = function () {
var promisechain; var promisechain;
NpmtsOptions.run() NpmtsConfigFile.run()
.then(NpmtsTypings.run) .then(NpmtsOptions.run)
.then(NpmtsDefault.run) .then(NpmtsCompile.run)
.then(NpmtsTests.run); .then(NpmtsTests.run);
return promisechain; return promisechain;
}; };
@ -133,13 +250,13 @@ var NpmtsPromisechain;
/// <reference path="./npmts.plugins.ts" /> /// <reference path="./npmts.plugins.ts" />
/// <reference path="./npmts.cli.ts" /> /// <reference path="./npmts.cli.ts" />
/// <reference path="./npmts.paths.ts" /> /// <reference path="./npmts.paths.ts" />
/// <reference path="./npmts.configfile.ts" />
/// <reference path="./npmts.options.ts" /> /// <reference path="./npmts.options.ts" />
/// <reference path="./npmts.typings.ts" /> /// <reference path="./npmts.compile.ts" />
/// <reference path="./npmts.custom.ts" />
/// <reference path="./npmts.default.ts" />
/// <reference path="./npmts.tests.ts" /> /// <reference path="./npmts.tests.ts" />
/// <reference path="./npmts.promisechain.ts" /> /// <reference path="./npmts.promisechain.ts" />
console.log("**** starting NPMTS ****"); console.log("**** starting NPMTS ****");
var plugins = NpmtsPlugins.init(); var plugins = NpmtsPlugins.init();
plugins.beautylog.figletSync("NPMTS");
var paths = NpmtsPaths.init(); var paths = NpmtsPaths.init();
var promisechain = NpmtsPromisechain.init(); var promisechain = NpmtsPromisechain.init();

View File

@ -1,6 +1,6 @@
{ {
"name": "npmts", "name": "npmts",
"version": "2.0.3", "version": "2.4.1",
"description": "write npm modules with TypeScript", "description": "write npm modules with TypeScript",
"main": "index.js", "main": "index.js",
"typings": "./index.d.ts", "typings": "./index.d.ts",
@ -8,8 +8,7 @@
"npmts": "./index.js" "npmts": "./index.js"
}, },
"scripts": { "scripts": {
"test": "(cd compile && node compile.js)", "test": "(cd compile && node compile.js) && (cd test/assets && node ../../index.js)",
"testm": "(npm test) && (cd test/assets && node ../../index.js)",
"release": "(git add -A && git commit -m 'update' && git push origin master && npm version patch && npm publish)" "release": "(git add -A && git commit -m 'update' && git push origin master && npm version patch && npm publish)"
}, },
"repository": { "repository": {
@ -27,17 +26,21 @@
}, },
"homepage": "https://github.com/pushrocks/npmts#readme", "homepage": "https://github.com/pushrocks/npmts#readme",
"dependencies": { "dependencies": {
"beautylog": "2.0.6", "beautylog": "2.1.1",
"fs-extra": "^0.26.5", "fs-extra": "^0.26.5",
"gulp": "3.9.0", "gulp": "3.9.1",
"gulp-insert": "0.5.0", "gulp-coveralls": "^0.1.4",
"gulp-sequence": "^0.4.4", "gulp-header": "^1.7.1",
"gulp-typescript": "2.10.0", "gulp-istanbul": "^0.10.3",
"gulp-mocha": "^2.2.0",
"gulp-sourcemaps": "^1.6.0",
"gulp-typescript": "2.11.0",
"gulp-typings": "0.0.0", "gulp-typings": "0.0.0",
"merge2": "1.0.0", "merge2": "1.0.1",
"mocha": "^2.4.5",
"q": "^1.4.1", "q": "^1.4.1",
"smartcli": "0.0.11", "smartcli": "0.0.11",
"typings": "^0.6.5" "smartfile": "0.0.11",
"source-map-support": "^0.4.0",
"typings": "^0.6.8"
} }
} }

View File

@ -0,0 +1,2 @@
var hello = "hello";
//# sourceMappingURL=custom.js.map

View File

@ -0,0 +1 @@
{"version":3,"file":"custom.js","sourceRoot":"","sources":["custom.ts"],"names":[],"mappings":"AAAA,IAAI,KAAK,GAAG,OAAO,CAAC"}

View File

@ -0,0 +1 @@
var hello = "hello";

View File

@ -0,0 +1,2 @@
var something = "something";
//# sourceMappingURL=tsfile1.js.map

View File

@ -0,0 +1 @@
{"version":3,"file":"tsfile1.js","sourceRoot":"","sources":["tsfile1.ts"],"names":[],"mappings":"AAAA,IAAI,SAAS,GAAG,WAAW,CAAC"}

View File

@ -0,0 +1 @@
var something = "something";

View File

@ -0,0 +1,7 @@
{
"ambientDependencies": {
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
}
}

View File

@ -0,0 +1,4 @@
/// <reference path="ts/typings/main.d.ts" />
declare var testplugin: {
logSomething: () => void;
};

View File

@ -1,5 +1,11 @@
#!/usr/bin/env node #!/usr/bin/env node
(function () { /// <reference path="./typings/main.d.ts" />
console.log("test"); var testplugin = {
}()); logSomething: function () {
console.log("only function executed");
}
};
module.exports = testplugin;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLDRDQUE0QztBQUM1QyxJQUFJLFVBQVUsR0FBRztJQUNiLFlBQVksRUFBRTtRQUNWLE9BQU8sQ0FBQyxHQUFHLENBQUMsd0JBQXdCLENBQUMsQ0FBQztJQUMxQyxDQUFDO0NBQ0osQ0FBQztBQUNGLE1BQU0sQ0FBQyxPQUFPLEdBQUcsVUFBVSxDQUFDIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9tYWluLmQudHNcIiAvPlxudmFyIHRlc3RwbHVnaW4gPSB7XG4gICAgbG9nU29tZXRoaW5nOiBmdW5jdGlvbigpe1xuICAgICAgICBjb25zb2xlLmxvZyhcIm9ubHkgZnVuY3Rpb24gZXhlY3V0ZWRcIik7XG4gICAgfVxufTtcbm1vZHVsZS5leHBvcnRzID0gdGVzdHBsdWdpbjsiXSwic291cmNlUm9vdCI6Ii9zb3VyY2UvIn0=

13
test/assets/npmts.json Normal file
View File

@ -0,0 +1,13 @@
{
"mode":"default",
"ts":{
"./customdir/*.ts":"./"
},
"typings":[
"./ts",
"./subts1/",
"./subts2/",
"./customdir"
],
"coveralls":true
}

View File

@ -0,0 +1,7 @@
{
"ambientDependencies": {
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
}
}

2
test/assets/test/test.d.ts vendored Normal file
View File

@ -0,0 +1,2 @@
/// <reference path="ts/typings/main.d.ts" />
declare var testplugin: any;

View File

@ -1 +1,14 @@
#!/usr/bin/env node
/// <reference path="./typings/main.d.ts" />
console.log("**** starting test ****"); console.log("**** starting test ****");
var testplugin = require("../index.js");
describe("testplugins", function () {
describe(".logSomething", function () {
it("should log something", function () {
testplugin.logSomething();
});
});
});
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsNENBQTRDO0FBQzVDLE9BQU8sQ0FBQyxHQUFHLENBQUMseUJBQXlCLENBQUMsQ0FBQztBQUN2QyxJQUFJLFVBQVUsR0FBRyxPQUFPLENBQUMsYUFBYSxDQUFDLENBQUM7QUFDeEMsUUFBUSxDQUFDLGFBQWEsRUFBQztJQUNuQixRQUFRLENBQUMsZUFBZSxFQUFDO1FBQ3JCLEVBQUUsQ0FBQyxzQkFBc0IsRUFBQztZQUN0QixVQUFVLENBQUMsWUFBWSxFQUFFLENBQUE7UUFDN0IsQ0FBQyxDQUFDLENBQUM7SUFDUCxDQUFDLENBQUMsQ0FBQztBQUNQLENBQUMsQ0FBQyxDQUFDIiwiZmlsZSI6InRlc3QuanMiLCJzb3VyY2VzQ29udGVudCI6WyIvLy8gPHJlZmVyZW5jZSBwYXRoPVwiLi90eXBpbmdzL21haW4uZC50c1wiIC8+XG5jb25zb2xlLmxvZyhcIioqKiogc3RhcnRpbmcgdGVzdCAqKioqXCIpO1xudmFyIHRlc3RwbHVnaW4gPSByZXF1aXJlKFwiLi4vaW5kZXguanNcIik7XG5kZXNjcmliZShcInRlc3RwbHVnaW5zXCIsZnVuY3Rpb24oKXtcbiAgICBkZXNjcmliZShcIi5sb2dTb21ldGhpbmdcIixmdW5jdGlvbigpe1xuICAgICAgICBpdChcInNob3VsZCBsb2cgc29tZXRoaW5nXCIsZnVuY3Rpb24oKXtcbiAgICAgICAgICAgIHRlc3RwbHVnaW4ubG9nU29tZXRoaW5nKClcbiAgICAgICAgfSk7XG4gICAgfSk7XG59KTsiXSwic291cmNlUm9vdCI6Ii9zb3VyY2UvIn0=

View File

@ -1,4 +1,8 @@
(function () { /// <reference path="./typings/main.d.ts" />
console.log("test"); var testplugin = {
}()); logSomething: function () {
console.log("only function executed");
}
};
module.exports = testplugin;
//# sourceMappingURL=index.js.map //# sourceMappingURL=index.js.map

View File

@ -1 +1 @@
{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,CAAC;IACG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;AACvB,CAAC,EAAE,CAAC,CAAC"} {"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,IAAI,UAAU,GAAG;IACb,YAAY,EAAE;QACV,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;IAC1C,CAAC;CACJ,CAAC;AACF,MAAM,CAAC,OAAO,GAAG,UAAU,CAAC"}

View File

@ -1,3 +1,7 @@
(function(){ /// <reference path="./typings/main.d.ts" />
console.log("test") var testplugin = {
}()); logSomething: function(){
console.log("only function executed");
}
};
module.exports = testplugin;

View File

@ -1,2 +1,11 @@
/// <reference path="./typings/main.d.ts" />
console.log("**** starting test ****"); console.log("**** starting test ****");
var testplugin = require("../index.js");
describe("testplugins", function () {
describe(".logSomething", function () {
it("should log something", function () {
testplugin.logSomething();
});
});
});
//# sourceMappingURL=test.js.map //# sourceMappingURL=test.js.map

View File

@ -1 +1 @@
{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC"} {"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;AACvC,IAAI,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;AACxC,QAAQ,CAAC,aAAa,EAAC;IACnB,QAAQ,CAAC,eAAe,EAAC;QACrB,EAAE,CAAC,sBAAsB,EAAC;YACtB,UAAU,CAAC,YAAY,EAAE,CAAA;QAC7B,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

View File

@ -1 +1,10 @@
console.log("**** starting test ****"); /// <reference path="./typings/main.d.ts" />
console.log("**** starting test ****");
var testplugin = require("../index.js");
describe("testplugins",function(){
describe(".logSomething",function(){
it("should log something",function(){
testplugin.logSomething()
});
});
});

View File

@ -1,6 +1,7 @@
{ {
"ambientDependencies": { "ambientDependencies": {
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777", "node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777",
"mocha": "github:Bartvds/tsd-deftools/typings/DefinitelyTyped/mocha/mocha.d.ts",
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d", "colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts#09e37435ffb2c56a6f908081194a74756f24f99d",
"vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777" "vinyl": "github:DefinitelyTyped/DefinitelyTyped/vinyl/vinyl.d.ts#78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
} }

1
test/assets/tsfile1.d.ts vendored Normal file
View File

@ -0,0 +1 @@
declare var something: string;

3
test/assets/tsfile1.js Normal file
View File

@ -0,0 +1,3 @@
#!/usr/bin/env node
var something = "something";

View File

@ -2,13 +2,13 @@
/// <reference path="./npmts.plugins.ts" /> /// <reference path="./npmts.plugins.ts" />
/// <reference path="./npmts.cli.ts" /> /// <reference path="./npmts.cli.ts" />
/// <reference path="./npmts.paths.ts" /> /// <reference path="./npmts.paths.ts" />
/// <reference path="./npmts.configfile.ts" />
/// <reference path="./npmts.options.ts" /> /// <reference path="./npmts.options.ts" />
/// <reference path="./npmts.typings.ts" /> /// <reference path="./npmts.compile.ts" />
/// <reference path="./npmts.custom.ts" />
/// <reference path="./npmts.default.ts" />
/// <reference path="./npmts.tests.ts" /> /// <reference path="./npmts.tests.ts" />
/// <reference path="./npmts.promisechain.ts" /> /// <reference path="./npmts.promisechain.ts" />
console.log("**** starting NPMTS ****") console.log("**** starting NPMTS ****");
var plugins = NpmtsPlugins.init(); var plugins = NpmtsPlugins.init();
plugins.beautylog.figletSync("NPMTS");
var paths = NpmtsPaths.init(); var paths = NpmtsPaths.init();
var promisechain = NpmtsPromisechain.init(); var promisechain = NpmtsPromisechain.init();

97
ts/npmts.compile.ts Normal file
View File

@ -0,0 +1,97 @@
/// <reference path="./index.ts" />
module NpmtsCompile {
export var run = function(configArg){
var done = plugins.q.defer();
var config = configArg;
plugins.beautylog.log("now running custom tasks");
var moduleStream = plugins.mergeStream({end: false});
/* -------------------------------------------------
* ----------- first install typings ---------------
* ----------------------------------------------- */
var typingsDone = plugins.q.defer();
var typingsCounter:number = 0;
var typingsCounterAdvance = function(){
typingsCounter++;
if(typeof config.typings[typingsCounter] != "undefined"){
installTypings();
} else {
plugins.beautylog.success("custom typings installed successfully");
typingsDone.resolve();
}
};
var installTypings = function() {
plugins.beautylog.log("now installing " + "typings.json".yellow + " from " + config.typings[typingsCounter].blue);
plugins.typings.install({production: false, cwd: plugins.path.join(paths.cwd,config.typings[typingsCounter])})
.then(function(){
typingsCounterAdvance();
},function(){
plugins.beautylog.error("something went wrong: Check if path is correct: " + config.typings[typingsCounter].blue);
typingsCounterAdvance();
});
};
installTypings();
/* -------------------------------------------------
* ----------- second compile TS -------------------
* ----------------------------------------------- */
typingsDone.promise.then(function(){
for (var key in config.ts) {
plugins.beautylog.log("now compiling" + key.blue);
var outputPathIsDir:boolean;
try {
if(plugins.fs.statSync(plugins.path.join(paths.cwd,config.ts[key])).isDirectory()){
outputPathIsDir = true;
}
}
catch(err) {
outputPathIsDir = false;
}
//do some evaluation of the environment
var outputNameSpecified:boolean = (
!outputPathIsDir
&& (plugins.path.extname(config.ts[key]) == ".js")
);
var outputName = (function(){
if(outputNameSpecified){
return plugins.path.basename(config.ts[key])
} else {
return undefined
}
})();
var outputDir = (function(){
if(outputNameSpecified){
return plugins.path.dirname(
plugins.path.join(paths.cwd,config.ts[key])
)
} else {
return plugins.path.join(paths.cwd,config.ts[key])
}
})();
var tsStream = plugins.gulp.src(plugins.path.join(paths.cwd,key))
.pipe(plugins.g.sourcemaps.init()) // This means sourcemaps will be generated
.pipe(plugins.g.typescript({
out: outputName,
declaration: true,
target: "ES5",
module: "commonjs"
}));
var stream = plugins.mergeStream([
tsStream.dts.pipe(plugins.gulp.dest(outputDir)),
tsStream.js
.pipe(plugins.g.sourcemaps.write()) // Now the sourcemaps are added to the .js file
.pipe(plugins.g.header('#!/usr/bin/env node\n\n'))
.pipe(plugins.gulp.dest(outputDir))
]);
moduleStream.add(stream);
}
moduleStream.on("queueDrain",function(){
plugins.beautylog.success("custom TypeScript installed successfully");
moduleStream.on("finish",function(){
done.resolve(config);
});
moduleStream.end();
});
});
return done.promise;
}
}

26
ts/npmts.configfile.ts Normal file
View File

@ -0,0 +1,26 @@
/// <reference path="./index.ts" />
module NpmtsConfigFile {
export var run = function(){
var done = plugins.q.defer();
var config:any = {};
var configPath = plugins.path.join(paths.cwd,"npmts.json");
if(plugins.smartfile.checks.fileExistsSync(configPath)){
plugins.beautylog.info("npmts.json".blue + " config file found!");
config = plugins.smartfile.readFileToObject(configPath);
switch (config.mode){
case "default":
case "custom":
plugins.beautylog.log("mode is " + config.mode.yellow);
done.resolve(config);
break;
default:
plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
};
} else {
plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
config.mode = "default";
done.resolve(config);
};
return done.promise;
}
}

View File

@ -1 +0,0 @@
/// <reference path="./index.ts" />

View File

@ -1,47 +0,0 @@
/// <reference path="./index.ts" />
module NpmtsDefault {
export var run = function() {
var done = plugins.q.defer();
plugins.gulp.task("defaultIndexTS", function(){
plugins.beautylog.log("now compiling" + " ts/index.ts".blue);
var tsResult = plugins.gulp.src(paths.indexTS)
.pipe(plugins.g.typescript({
out:"index.js",
declaration:true
}));
return plugins.mergeStream([
tsResult.dts.pipe(plugins.gulp.dest(paths.cwd)),
tsResult.js
.pipe(plugins.g.insert.prepend('#!/usr/bin/env node\n\n'))
.pipe(plugins.gulp.dest(paths.cwd))
]);
});
plugins.gulp.task("defaultTestTS", function(){
plugins.beautylog.log("now compiling" + " ts/test.ts".blue);
var stream = plugins.gulp.src(paths.testTS)
.pipe(plugins.g.typescript({
out: "test.js"
}))
.pipe(plugins.gulp.dest(paths.testDir));
return stream;
});
plugins.gulp.task("defaultCleanup",function(cb){
plugins.beautylog.success("TypeScript for this module compiled successfully.");
done.resolve();
cb();
});
plugins.gulp.task("default",function(cb){
plugins.g.sequence("defaultIndexTS","defaultTestTS","defaultCleanup",cb);
});
plugins.gulp.start.apply(plugins.gulp, ['default']);
return done.promise;
}
}

View File

@ -1,8 +1,24 @@
/// <reference path="./index.ts" /> /// <reference path="./index.ts" />
module NpmtsOptions { module NpmtsOptions {
export var run = function(){ export var run = function(configArg){
var done = plugins.q.defer(); var done = plugins.q.defer();
done.resolve(); //TODO: check for options var config = configArg;
if (typeof config.coveralls === "undefined"){
config.coveralls = false;
}
if (config.mode == "default"){
config.typings = [
"./ts/"
];
config.ts = {
["./ts/index.ts"]: "./index.js",
["./ts/test.ts"]: "./test/test.js"
};
config.test = ["./index.js"];
done.resolve(config);
} else {
done.resolve(config);
}
return done.promise; return done.promise;
} }
} }

View File

@ -6,16 +6,20 @@ module NpmtsPlugins {
fs: require("fs-extra"), fs: require("fs-extra"),
gulp: require("gulp"), gulp: require("gulp"),
g: { g: {
insert: require("gulp-insert"), coveralls: require("gulp-coveralls"),
sequence: require("gulp-sequence"), header: require("gulp-header"),
istanbul: require("gulp-istanbul"),
mocha: require("gulp-mocha"),
sourcemaps: require("gulp-sourcemaps"),
typescript: require("gulp-typescript") typescript: require("gulp-typescript")
}, },
mergeStream: require("merge2"), mergeStream: require("merge2"),
mocha: require("mocha"), sourceMapSupport:require("source-map-support").install(),
path: require("path"), path: require("path"),
q:require("q"), q:require("q"),
smartcli: require("smartcli"), smartcli: require("smartcli"),
smartfile: require("smartfile"),
typings: require("typings") typings: require("typings")
}; };
return plugins; return plugins;

View File

@ -2,9 +2,9 @@
module NpmtsPromisechain { module NpmtsPromisechain {
export var init = function(){ export var init = function(){
var promisechain; var promisechain;
NpmtsOptions.run() NpmtsConfigFile.run()
.then(NpmtsTypings.run) .then(NpmtsOptions.run)
.then(NpmtsDefault.run) .then(NpmtsCompile.run)
.then(NpmtsTests.run); .then(NpmtsTests.run);
return promisechain; return promisechain;
} }

View File

@ -1,18 +1,43 @@
/// <reference path="./index.ts" /> /// <reference path="./index.ts" />
module NpmtsTests { module NpmtsTests {
export var run = function() { export var run = function(configArg) {
var done = plugins.q.defer(); var done = plugins.q.defer();
plugins.fs.ensureDirSync(paths.testDir); //make sure that mocha has a directory to look for tests var config = configArg;
plugins.beautylog.info("Now running mocha tests"); var istanbul = function () {
var stream = plugins.gulp.src([plugins.path.join(paths.cwd,"index.js")])
// Covering files
.pipe(plugins.g.istanbul())
// Force `require` to return covered files
.pipe(plugins.g.istanbul.hookRequire());
return stream;
};
var mocha = new plugins.mocha(); // Instantiate a Mocha instance. var mocha = function () {
mocha.addFile( var stream = plugins.gulp.src(["./test/test.js"])
plugins.path.join(paths.testDir, "test.js") .pipe(plugins.g.mocha())
); // Creating the reports after tests ran
mocha.run(function(failures){ .pipe(plugins.g.istanbul.writeReports())
process.on('exit', function () { // Enforce a coverage of at least 90%
process.exit(failures); .pipe(plugins.g.istanbul.enforceThresholds({ thresholds: { global: 30 } }));
}); return stream;
};
var coveralls = function(){
var stream = plugins.gulp.src([plugins.path.join(paths.cwd,"./coverage/lcov.info")])
.pipe(plugins.g.coveralls());
return stream;
};
istanbul().on("finish",function(){
mocha().on("finish",function(){
if(process.env.TRAVIS && config.coveralls){
coveralls().on("finish",function(){
done.resolve(config);
})
} else {
done.resolve(config);
}
})
}); });
return done.promise; return done.promise;
} }

View File

@ -1,12 +0,0 @@
/// <reference path="./index.ts" />
module NpmtsTypings {
export var run = function(){
var done = plugins.q.defer();
plugins.beautylog.log("now installing typings");
plugins.typings.install({production: false, cwd: paths.tsDir})
.then(function(){
done.resolve();
});
return done.promise;
}
}