separate docs from dist

Author: dweber019

.gitignore

@@ -23,6 +23,9 @@ Thumbs.db
 # Dist #
 /dist
 
+# Docs #
+/docs
+
 # Cordova #
 cordova/plugins
 cordova/platforms

README.md

@@ -199,7 +199,7 @@ Cordova takes the ```www``` folder source to create the Cordova app. This ```www
 So make sure you run for example ```npm run build``` first before runing/buildinga Cordova app.
 
 ### Typedocs
-The typedoc is generated into ```dist/docs``` and can be served with ```npm run server:docs```.
+The typedoc is generated with command ```npm run build:docs``` into directoy ```dist/docs``` and can be served with ```npm run server:docs```.
 
 
 # ToDo's

config/config-typedoc.js

@@ -8,14 +8,19 @@ const TypedocWebpackPlugin = require('typedoc-webpack-plugin');
 /**
  * Typedoc config
  */
-const configTypedoc = function () {
+const configTypedoc = function (options) {
+  if (!options.run) {
+    return {};
+  }
+
   return {
 		plugins: [
 			new TypedocWebpackPlugin({
+        out: options.output,
         target: 'es6',
         disableOutputCheck: true
-      }, ['./typings', './typings_custom', './src/app'])
+      }, options.inputs)
 		]
-		};
+	};
 };
 module.exports = configTypedoc;

package.json

@@ -8,6 +8,7 @@
     "test": "cross-env NODE_ENV=test TS_NODE_PROJECT=tsconfig.tsnode.json TS_NODE_FAST=true ts-node ./node_modules/karma/bin/karma start test/karma.conf.js",
     "clean": "npm cache clean && rimraf node_modules test/coverage dist",
     "clean:dist": "rimraf dist",
+    "clean:docs": "rimraf docs",
     "preclean:install": "npm run clean",
     "clean:install": "npm set progress=false && npm install",
     "preclean:start": "npm run clean",
@@ -22,12 +23,14 @@
     "build:dev": "cross-env NODE_ENV=development npm run webpack -- --progress --profile",
     "prebuild:prod": "npm run clean:dist",
     "build:prod": "cross-env NODE_ENV=production npm run webpack -- --progress --profile",
+    "prebuild:docs": "npm run clean:docs && npm run clean:dist",
+    "build:docs": "cross-env NODE_ENV=development npm run webpack -- --progress --profile --env.docs=true",
     "start": "npm run server:dev",
     "server": "npm run server:dev",
     "server:dev": "cross-env NODE_ENV=development npm run webpack-dev-server --inline --progress --profile --watch",
     "server:dev:hmr": "npm run server:dev -- --hot",
     "server:prod": "http-server dist --cors",
-    "server:docs": "http-server dist/docs --cors",
+    "server:docs": "http-server docs --cors",
     "lint": "lint:app && lint:test",
     "lint:app": "tslint -c ./tslint.json './src/app/**/*.ts'",
     "lint:test": "tslint -c ./tslint.json './test/unit/**/*.ts'",

webpack.config.js

@@ -15,9 +15,11 @@ module.exports = function (envArguments) {
   const pkg = require(path.join(process.cwd(), 'package.json'));
   let PLATFORM = 'web';
   let TARGET = ENV;
+  let DOCS = false;
   if (envArguments) {
     PLATFORM = envArguments.platform || PLATFORM;
     TARGET = envArguments.target || TARGET;
+    DOCS = envArguments.docs || DOCS;
   }
   console.log('');
   console.log(chalk.yellow('➜') + ' ' + chalk.white('NODE_ENV: ') + chalk.green.bold(ENV));
@@ -33,6 +35,7 @@ module.exports = function (envArguments) {
   const rootDir = path.resolve();
   const srcDir = path.resolve('src/app');
   const outDir = path.resolve('dist');
+  const outDirDocs = path.resolve('docs');
   const faviconPath = 'src/assets/images/favicon.ico';
 
   // context to fill the index file
@@ -176,6 +179,16 @@ module.exports = function (envArguments) {
     }
   };
 
+  const typedocsOptions = {
+    run: DOCS,
+    output: outDirDocs,
+    inputs: [
+      path.join(rootDir, 'typings'),
+      path.join(rootDir, 'typings_custom'),
+      srcDir
+    ]
+  };
+
   // advanced configuration:
   switch (ENV) {
     /**
@@ -266,7 +279,7 @@ module.exports = function (envArguments) {
         require('./config/config-globals.js')(),
         require('./config/config-favicon.js')(configFavicon),
         require('./config/config-notifier.js')(configNotifier),
-        require('./config/config-typedoc.js')(),
+        require('./config/config-typedoc.js')(typedocsOptions),
         require('./config/config-loader-options.js')(WebpackOptionLoader().initalConfig, WebpackOptionLoader().extraction)
       );
       break;