5.4.14

.gitlab-ci.yml

@@ -1,10 +1,10 @@
-image: hosttoday/ht-docker-node:npmts
+image: hosttoday/ht-docker-node:npmci
 
 stages:
 - test
 - release
 - trigger
-- page
+- pages
 
 testLEGACY:
   stage: test
@@ -45,3 +45,15 @@ trigger:
     - tags
   tags:
     - docker
+
+pages:
+  image: ht-docker-node:npmpage
+  stage: pages
+  script:
+    - npmpage
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - pages

README.md

@@ -107,6 +107,11 @@ This is in line with the latest TypeScript best practices.
 You can then import plugins via the TypeScript `import` Syntax
 and tsc will pick up the declaration file automatically.
 
+### TypeDoc
+By default TypeDoc will create docs for your module in `./pages/api/` directory.
+> Note: You can use `./docs/` directory to create a gitbook.
+Use [npmpage](https://www.npmjs.com/package/npmpage) from npm to fuse gitbook and TypeDoc into a website. 
+
 ## Some notes:
 #### Typings for third party modules that do not bundle declaration files
 NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.

dist/npmts.clean.js

@@ -4,24 +4,18 @@ var plugins = require("./npmts.plugins");
 var paths = require("./npmts.paths");
 var npmts_promisechain_1 = require("./npmts.promisechain");
 var removeDist = function () {
-    npmts_promisechain_1.npmtsOra.text("cleaning " + "dist".yellow + " folder");
+    npmts_promisechain_1.npmtsOra.text("cleaning dist folder");
     return plugins.smartfile.fs.remove(paths.distDir);
 };
-var removeTypings = function () {
-    var done = plugins.Q.defer();
-    npmts_promisechain_1.npmtsOra.text("cleaning " + "typings".yellow + " folder");
-    if (false) {
-    }
-    else {
-        done.resolve();
-    }
-    return done.promise;
+var removePages = function () {
+    npmts_promisechain_1.npmtsOra.text("cleaning pages folder");
+    return plugins.smartfile.fs.remove(paths.pagesDir);
 };
 exports.run = function (configArg) {
     npmts_promisechain_1.npmtsOra.text("cleaning up from previous builds...");
     var done = plugins.Q.defer();
     removeDist()
-        .then(removeTypings)
+        .then(removePages)
         .then(function () {
         plugins.beautylog.ok("Cleaned up from previous builds!");
         done.resolve(configArg);

dist/npmts.paths.d.ts

@@ -3,10 +3,11 @@ export declare let npmtsPackageRoot: string;
 export declare let cwd: string;
 export declare let tsDir: string;
 export declare let distDir: string;
-export declare let docsDir: string;
 export declare let testDir: string;
 export declare let typingsDir: string;
 export declare let coverageDir: string;
+export declare let pagesDir: string;
+export declare let pagesApiDir: string;
 export declare let npmtsAssetsDir: string;
 export declare let indexTS: string;
 export declare let testTS: string;

dist/npmts.paths.js

@@ -1,17 +1,19 @@
 "use strict";
 require("typings-global");
 var plugins = require("./npmts.plugins");
-//Npmts Paths
+// NPMTS Paths
 exports.npmtsPackageRoot = plugins.path.join(__dirname, "../");
-//Project paths
+// Project paths
 exports.cwd = process.cwd();
-//Directories
+// Directories
 exports.tsDir = plugins.path.join(exports.cwd, "ts/");
 exports.distDir = plugins.path.join(exports.cwd, "dist/");
-exports.docsDir = plugins.path.join(exports.cwd, "docs/");
 exports.testDir = plugins.path.join(exports.cwd, "test/");
 exports.typingsDir = plugins.path.join(exports.cwd, "ts/typings/");
 exports.coverageDir = plugins.path.join(exports.cwd, "coverage/");
+// Pages
+exports.pagesDir = plugins.path.join(exports.cwd, "pages/");
+exports.pagesApiDir = plugins.path.join(exports.pagesDir, "/api");
 exports.npmtsAssetsDir = plugins.path.join(__dirname, "../assets/");
 //Files
 exports.indexTS = plugins.path.join(exports.cwd, "ts/index.ts");

dist/npmts.typedoc.js

@@ -14,8 +14,8 @@ var genTypeDoc = function (configArg) {
         target: "es6",
         includeDeclarations: true,
         // Output options (see typedoc docs) 
-        out: paths.docsDir,
-        json: plugins.path.join(paths.docsDir, "file.json"),
+        out: paths.pagesApiDir,
+        json: plugins.path.join(paths.pagesApiDir, "file.json"),
         // TypeDoc options (see typedoc docs) 
         name: "my-project",
         //theme: "default",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "npmts",
-  "version": "5.4.9",
+  "version": "5.4.14",
   "description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
   "main": "dist/index.js",
   "bin": {
@@ -30,14 +30,14 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmts#readme",
   "dependencies": {
-    "@types/gulp": "^3.8.29",
+    "@types/gulp": "^3.8.30",
     "@types/minimatch": "^2.0.28",
     "@types/q": "^0.x.x",
-    "@types/shelljs": "^0.3.28",
+    "@types/shelljs": "^0.3.29",
     "babel-preset-es2015": "^6.13.2",
     "beautylog": "5.0.20",
     "depcheck": "^0.6.4",
-    "early": "^2.0.13",
+    "early": "^2.0.25",
     "gulp": "3.9.1",
     "gulp-babel": "^6.1.2",
     "gulp-function": "^1.3.6",

ts/npmts.clean.ts

@@ -4,27 +4,20 @@ import paths = require("./npmts.paths");
 import {npmtsOra} from "./npmts.promisechain";
 
 let removeDist = function(){
-    npmtsOra.text("cleaning " + "dist".yellow + " folder");
+    npmtsOra.text("cleaning dist folder");
     return plugins.smartfile.fs.remove(paths.distDir);
 };
 
-let removeTypings = function(){
-    let done = plugins.Q.defer();
-    npmtsOra.text("cleaning " + "typings".yellow + " folder");
-    if(false){
-        //plugins.smartfile.fsaction.remove(paths.typingsDir)
-        //    .then(done.resolve);
-    } else {
-        done.resolve();
-    }
-    return done.promise;
+let removePages = function(){
+    npmtsOra.text("cleaning pages folder");
+    return plugins.smartfile.fs.remove(paths.pagesDir);
 };
 
 export let run = function(configArg){
     npmtsOra.text("cleaning up from previous builds...");
     let done = plugins.Q.defer();
     removeDist()
-        .then(removeTypings)
+        .then(removePages)
         .then(function(){
             plugins.beautylog.ok("Cleaned up from previous builds!");
             done.resolve(configArg);

ts/npmts.paths.ts

@@ -1,21 +1,24 @@
 import "typings-global";
 import plugins = require("./npmts.plugins");
 
-//Npmts Paths
+// NPMTS Paths
 export let npmtsPackageRoot = plugins.path.join(__dirname,"../");
 
 
-//Project paths
+// Project paths
 export let cwd = process.cwd();
 
-//Directories
+// Directories
 export let tsDir = plugins.path.join(cwd,"ts/");
 export let distDir = plugins.path.join(cwd,"dist/");
-export let docsDir = plugins.path.join(cwd,"docs/");
 export let testDir = plugins.path.join(cwd,"test/");
 export let typingsDir = plugins.path.join(cwd,"ts/typings/");
 export let coverageDir = plugins.path.join(cwd,"coverage/");
 
+// Pages
+export let pagesDir = plugins.path.join(cwd,"pages/");
+export let pagesApiDir = plugins.path.join(pagesDir,"/api");
+
 export let npmtsAssetsDir = plugins.path.join(__dirname,"../assets/");
 
 //Files

ts/npmts.typedoc.ts

@@ -15,8 +15,8 @@ let genTypeDoc = function (configArg) {
             includeDeclarations: true,
 
             // Output options (see typedoc docs) 
-            out: paths.docsDir,
-            json: plugins.path.join(paths.docsDir, "file.json"),
+            out: paths.pagesApiDir,
+            json: plugins.path.join(paths.pagesApiDir, "file.json"),
 
             // TypeDoc options (see typedoc docs) 
             name: "my-project",