js-build-tools 5.1.1 → 5.3.0

package/README.md

@@ -11,6 +11,7 @@ Using this tool suite, you can:
 * Bundle your distribution files to be used in a browser environment.
 * Run tests and watch for changes.
 * Generate jsdoc readme files.
+* Generate HTML documentation straight from your TypeScript source (with TypeDoc), with a module for each of your folders.
 
 ## Installation
 
@@ -50,6 +51,23 @@ provided are the defaults):
     // The output directory for the distribution files.
     "to": "dist"
   },
+  "docs": {
+    // Toggle generating the HTML documentation from the TypeScript source (see 'Configure TypeScript documentation').
+    // When on, the build does this instead of generating the readme from the jsdoc comments.
+    "enabled": false,
+    // The directory holding the TypeScript source, each folder in it becomes a module of the documentation.
+    "from": "src",
+    // The markdown file used as the front page of the documentation.
+    "index": "MAIN.md",
+    // How much TypeDoc reports: Verbose, Info, Warn, Error or None.
+    "logLevel": "Warn",
+    // The name of the documentation, defaults to the name in your package.json.
+    "title": "",
+    // The directory to generate the documentation in (it is cleared first).
+    "to": "docs",
+    // The tsconfig file to read the source with, false to use the one of 'typescript.config'.
+    "tsconfig": false
+  },
   "fonts": {
     // Toggle copy directory of fonts on
     "enabled": false,
@@ -130,6 +148,7 @@ For example:
 const {
   build,
   defaultCmd,
+  docs,
   partials,
   readme,
   sass,
@@ -145,6 +164,7 @@ const {
 // You can list your available tasks by running `gulp --tasks`.
 exports.build = build
 exports.default = defaultCmd
+exports.docs = docs
 exports.readme = readme
 exports.sass = sass
 exports.testFull = testFull
@@ -161,6 +181,7 @@ exports.watchTest = watchTest
 export {
   build,
   defaultCmd,
+  docs,
   partials,
   readme,
   sass,
@@ -248,6 +269,7 @@ module.exports = {
 ### Configure HTML JS Documentation (optional)
 
 It may be desirable to generate HTML documentation for your JS files.
+(For a TypeScript project, see 'Configure TypeScript documentation' instead.)
 
 Create a `.jsdoc.conf.js` file and add the following:
 
@@ -333,21 +355,29 @@ Create a `tsconfig.json` file in your project root with the following:
 
 ```json
 {
-  "files": [
-    "src/**/*.ts"
-  ],
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.test.*"],
   "compilerOptions": {
-    "noImplicitAny": true,
-    "target": "es6",
-    "moduleResolution": "node",
-    "declaration": true
+    "strict": true,
+    "target": "es2020",
+    "module": "commonjs",
+    "moduleResolution": "node10",
+    "ignoreDeprecations": "6.0",
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "declaration": true,
+    "types": []
   }
 }
 ```
 
-The pattern for `"files"` should match your .ts files, but the essential thing is that it is wrapped in an array.
-The actual pattern used comes from `build-tools.config.json` as `'typescript.from'` setting.
-To create the ts declaration files, you must add the `"declaration": true`.
+The pattern for `"include"` should match your .ts files (and leave out the tests, which can stay `.test.js` files).
+The actual pattern used to compile comes from `build-tools.config.json` as the `'typescript.from'` setting.
+To create the ts declaration files, you must add the `"declaration": true`. The `typescript` package is an optional peer
+dependency, install it in your project with `npm install --save-dev typescript` (versions 5.0 up to, but not including,
+7 are supported). When you write relative imports, leave the `.js` extension off (`import a from './a'`), because
+they stop resolving once the target is a `.ts` file. The compile only builds `.ts` files while `typescript.enabled` is
+on, so convert a whole library at once.
 
 Add the following to the exports in your `build-tools.config.json`:
 
@@ -382,6 +412,40 @@ babelConfig.presets.push('@babel/preset-typescript')
 module.exports = babelConfig
 ```
 
+### Configure TypeScript documentation (optional)
+
+`jsdoc-to-markdown` only reads `.js` files, so the types in your `.ts` files (and the comments on them) do not reach
+the readme it generates. Instead, this can generate HTML documentation straight from the TypeScript source with
+[TypeDoc](https://typedoc.org/). Every folder in your source directory becomes a module of the documentation, the default
+export of each file (one function per file) is listed under the name of the file, and everything else a file exports (for
+example the types in a `types.ts`) is listed as it is. Index files, tests and declaration files are left out. The
+comments on your code are the documentation, and the types come from the code itself, so `@module`, `@memberOf`,
+`@typedef` and the `{Type}` of `@param` are not needed.
+
+`typedoc` is an optional peer dependency (like `typescript`), install it in your project with
+`npm install --save-dev typedoc` (this needs a `typescript` version it supports).
+
+Add the following to the exports in your `build-tools.config.json`:
+
+```json
+{
+  "docs": {
+    // Generate the documentation from the TypeScript source
+    "enabled": true,
+    // The directory holding the TypeScript source, each folder in it becomes a module
+    "from": "src",
+    // The markdown file used as the front page of the documentation (a short overview of your project)
+    "index": "MAIN.md",
+    // Where the HTML is generated (the directory is cleared first)
+    "to": "docs"
+  }
+}
+```
+
+While `docs.enabled` is on, `gulp build` generates the documentation instead of the readme, so your `README.md` stays
+hand-written (a short overview which links to the documentation). If you also export `docs` from your gulpfile you can
+run it on its own with `gulp docs`, and can then add the script `"docs": "gulp docs"`.
+
 ### Configure Scripts
 
 In your `package.json` file, add the following scripts:
@@ -391,6 +455,7 @@ In your `package.json` file, add the following scripts:
   "scripts": {
     "build": "gulp build",
     "dev": "gulp",
+    "docs": "gulp docs",
     "htmldocs": "jsdoc -R MAIN.md -c ./.jsdoc.conf.js -d docs",
     "readme": "gulp readme",
     "sass": "gulp sass",
@@ -408,277 +473,276 @@ Run any of the above commands with `gulp` or `npm run`.
 
 # Available functions documentation
 
-## Modules
-
-<dl>
-<dt><a href="#module_js-build-tools">js-build-tools</a></dt>
-<dd><p>Export these functions to your own project to customize your build pipeline.</p>
-</dd>
-<dt><a href="#module_gulpConfig">gulpConfig</a></dt>
-<dd><p>Modify these configurations to match your project specifications.</p>
-</dd>
-</dl>
-
-<a name="module_js-build-tools"></a>
-
-## js-build-tools
-Export these functions to your own project to customize your build pipeline.
-
-**Version**: 3.0.0  
-**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
-<a name="module_js-build-tools.build"></a>
-
-### js-build-tools.build() ⇒ <code>stream.Stream</code>
-Runs several processes to build and validate the project.
-Cleans, distributes (lint and minify), bundles (lint and minify), creates the readme, then runs the tests.
-
-**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-<a name="module_gulpConfig"></a>
-
-## gulpConfig
-Modify these configurations to match your project specifications.
-
-**Version**: 3.0.0  
-**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
-
-* [gulpConfig](#module_gulpConfig)
-    * _static_
-        * [.get(path, defaultValue)](#module_gulpConfig.get) ⇒ <code>\*</code> \| <code>null</code>
-        * [.set(path, value)](#module_gulpConfig.set) ⇒ <code>\*</code>
-    * _inner_
-        * [~ArrayableSetting](#module_gulpConfig..ArrayableSetting) : <code>Array.&lt;string&gt;</code> \| <code>string</code>
-        * [~BooleanSetting](#module_gulpConfig..BooleanSetting) : <code>boolean</code>
-        * [~FlagStringSetting](#module_gulpConfig..FlagStringSetting) : <code>false</code> \| <code>StringSetting</code>
-        * [~FlagsSetting](#module_gulpConfig..FlagsSetting) : <code>Object.&lt;string, BooleanSetting&gt;</code>
-        * [~JestTestFlags](#module_gulpConfig..JestTestFlags) : <code>FlagsSetting</code>
-        * [~StringSetting](#module_gulpConfig..StringSetting) : <code>string</code>
-        * [~Setting](#module_gulpConfig..Setting) : <code>ArrayableSetting</code> \| <code>BooleanSetting</code> \| <code>FlagsSetting</code> \| <code>StringSetting</code>
-        * [~BrowserConfig](#module_gulpConfig..BrowserConfig) : <code>Object.&lt;string, Setting&gt;</code>
-        * [~DistConfig](#module_gulpConfig..DistConfig) : <code>Object.&lt;string, Setting&gt;</code>
-        * [~FontConfig](#module_gulpConfig..FontConfig) : <code>Object.&lt;string, Setting&gt;</code>
-        * [~ImageConfig](#module_gulpConfig..ImageConfig) : <code>Object.&lt;string, Setting&gt;</code>
-        * [~ReadmeConfig](#module_gulpConfig..ReadmeConfig) : <code>Object.&lt;string, Setting&gt;</code>
-        * [~SassConfig](#module_gulpConfig..SassConfig) : <code>Object.&lt;string, Setting&gt;</code>
-        * [~TestConfig](#module_gulpConfig..TestConfig) : <code>Object.&lt;string, Setting&gt;</code>
-        * [~TsConfig](#module_gulpConfig..TsConfig) : <code>Object.&lt;string, Setting&gt;</code>
-        * [~Configurations](#module_gulpConfig..Configurations) : <code>Object.&lt;string, Setting&gt;</code>
-
-<a name="module_gulpConfig.get"></a>
-
-### gulpConfig.get(path, defaultValue) ⇒ <code>\*</code> \| <code>null</code>
-Retrieve a value from the configurations, default may be returned.
-
-**Kind**: static method of [<code>gulpConfig</code>](#module_gulpConfig)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| path | <code>string</code> \| <code>null</code> | <code>null</code> | 
-| defaultValue | <code>\*</code> | <code></code> | 
-
-<a name="module_gulpConfig.set"></a>
-
-### gulpConfig.set(path, value) ⇒ <code>\*</code>
-Specify a value for the configurations to use.
-
-**Kind**: static method of [<code>gulpConfig</code>](#module_gulpConfig)  
-
-| Param |
-| --- |
-| path | 
-| value | 
-
-<a name="module_gulpConfig..ArrayableSetting"></a>
-
-### gulpConfig~ArrayableSetting : <code>Array.&lt;string&gt;</code> \| <code>string</code>
-A setting that may be an array of strings or a string only.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-<a name="module_gulpConfig..BooleanSetting"></a>
-
-### gulpConfig~BooleanSetting : <code>boolean</code>
-A setting that may be true or false.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-<a name="module_gulpConfig..FlagStringSetting"></a>
-
-### gulpConfig~FlagStringSetting : <code>false</code> \| <code>StringSetting</code>
-A setting that may be flag 'false' or provide a StringSetting
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-<a name="module_gulpConfig..FlagsSetting"></a>
-
-### gulpConfig~FlagsSetting : <code>Object.&lt;string, BooleanSetting&gt;</code>
-An object of boolean settings used as flags.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-<a name="module_gulpConfig..JestTestFlags"></a>
-
-### gulpConfig~JestTestFlags : <code>FlagsSetting</code>
-Configure cli options for running Jest.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-**Properties**
-
-| Name | Type |
-| --- | --- |
-| clearCache | <code>BooleanSetting</code> | 
-| debug | <code>BooleanSetting</code> | 
-| ignoreProjects: | <code>BooleanSetting</code> | 
-| json | <code>BooleanSetting</code> | 
-| selectProjects | <code>BooleanSetting</code> | 
-| showConfig | <code>BooleanSetting</code> | 
-| useStderr | <code>BooleanSetting</code> | 
-| watch | <code>BooleanSetting</code> | 
-| watchAll | <code>BooleanSetting</code> | 
-
-<a name="module_gulpConfig..StringSetting"></a>
-
-### gulpConfig~StringSetting : <code>string</code>
-A setting that may only be a string.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-<a name="module_gulpConfig..Setting"></a>
-
-### gulpConfig~Setting : <code>ArrayableSetting</code> \| <code>BooleanSetting</code> \| <code>FlagsSetting</code> \| <code>StringSetting</code>
-Any single configuration option is a Setting.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-<a name="module_gulpConfig..BrowserConfig"></a>
-
-### gulpConfig~BrowserConfig : <code>Object.&lt;string, Setting&gt;</code>
-Configurations for building the browser files.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| enabled | <code>BooleanSetting</code> | 'true' to generate browser bundled files; 'false' for node environment only |
-| from | <code>StringSetting</code> | The name to use for the browser-bundled output file (.js will be appended). |
-| name | <code>StringSetting</code> | The search pattern used for retrieving compiled distribution files. |
-| to | <code>StringSetting</code> | The output directory for browser-bundled files. |
-
-<a name="module_gulpConfig..DistConfig"></a>
-
-### gulpConfig~DistConfig : <code>Object.&lt;string, Setting&gt;</code>
-Configurations for building the node distribution files.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| from | <code>StringSetting</code> | The search pattern used for gathering source files for distribution. |
-| main | <code>StringSetting</code> | Name of the entry the distribution file. |
-| to | <code>StringSetting</code> | The output directory for the distribution files. |
-
-<a name="module_gulpConfig..FontConfig"></a>
-
-### gulpConfig~FontConfig : <code>Object.&lt;string, Setting&gt;</code>
-Configurations for copying the font files.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| enabled | <code>BooleanSetting</code> | Toggle copy directory of fonts on. |
-| from | <code>StringSetting</code> | Path to search for fonts. |
-| to | <code>StringSetting</code> | Path to output fonts. |
-
-<a name="module_gulpConfig..ImageConfig"></a>
-
-### gulpConfig~ImageConfig : <code>Object.&lt;string, Setting&gt;</code>
-Configurations to minify and copy the images.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| enabled | <code>BooleanSetting</code> | Toggle image minify and copy process. |
-| from | <code>StringSetting</code> | Path to search for images. |
-| to | <code>StringSetting</code> | Path to output images. |
-
-<a name="module_gulpConfig..ReadmeConfig"></a>
-
-### gulpConfig~ReadmeConfig : <code>Object.&lt;string, Setting&gt;</code>
-Configurations to compile and generate the Readme file.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| file | <code>StringSetting</code> | The name of the output documentation markdown file. |
-| from | <code>StringSetting</code> | Location of files to use for compiling documentation into the readme. |
-| options | <code>ArrayableSetting</code> | Options for formatting the output readme. |
-| template | <code>StringSetting</code> | The file which will be pre-fixed to your README.md output. |
-| to | <code>StringSetting</code> | The directory to output the readme file in. |
-
-<a name="module_gulpConfig..SassConfig"></a>
-
-### gulpConfig~SassConfig : <code>Object.&lt;string, Setting&gt;</code>
-Configurations to compile and copy the sass files into css.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| enabled | <code>BooleanSetting</code> | Toggle SASS to CSS process on. |
-| from | <code>StringSetting</code> | The pattern for finding all sass files. |
-| path | <code>StringSetting</code> | The directory were sass files will be stored. |
-| to | <code>StringSetting</code> | The destination path for where generated CSS (from SASS files) should go. |
-
-<a name="module_gulpConfig..TestConfig"></a>
-
-### gulpConfig~TestConfig : <code>Object.&lt;string, Setting&gt;</code>
-Configurations for running the test suite.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| options | <code>JestTestFlags</code> | Additional flags for programmatically running Jest Cli. |
-| path | <code>ArrayableSetting</code> | The directory where Jest test files are stored. By default, stored as *.test.js adjacent to the files they are testing. |
-| watch | <code>ArrayableSetting</code> | The search pattern for watching files for changes. |
-
-<a name="module_gulpConfig..TsConfig"></a>
-
-### gulpConfig~TsConfig : <code>Object.&lt;string, Setting&gt;</code>
-Configurations for compiling typescript into JS files.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| config | <code>FlagStringSetting</code> | The path the tsconfig file for running typescript or false if no ts file given. |
-| enabled | <code>BooleanSetting</code> | Toggle usage of typescript parsing. |
-| from | <code>StringSetting</code> | Pattern for finding the TypeScript files. |
-| to | <code>StringSetting</code> | Directory where parsed typescript files go. |
-
-<a name="module_gulpConfig..Configurations"></a>
-
-### gulpConfig~Configurations : <code>Object.&lt;string, Setting&gt;</code>
-A set of Configurations options defined by Settings.
-
-**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| browser | <code>BrowserConfig</code> | Browser bundling configuration group. |
-| cleanPaths | <code>ArrayableSetting</code> | The paths for directories to delete before build. |
-| dist | <code>DistConfig</code> | Distribution file generation configuration group. |
-| fonts | <code>FontConfig</code> | Fonts copy configuration group. |
-| images | <code>ImageConfig</code> | Minify and copy the images configuration. |
-| readme | <code>ReadmeConfig</code> | Build readme files configuration. |
-| rootPath | <code>StringSetting</code> | Base directory of the project. |
-| sass | <code>SassConfig</code> | Compile CSS from SASS configuration. |
-| srcPath | <code>StringSetting</code> | The directory where your source files are stored (the files you manually created). |
-| test | <code>TestConfig</code> | Run test suite configuration. |
-| typescript | <code>TsConfig</code> | Compile from typescript configuration. |
-
+## Modules
+
+<dl>
+<dt><a href="#module_js-build-tools">js-build-tools</a></dt>
+<dd><p>Export these functions to your own project to customize your build pipeline.</p>
+</dd>
+<dt><a href="#module_gulpConfig">gulpConfig</a></dt>
+<dd><p>Modify these configurations to match your project specifications.</p>
+</dd>
+</dl>
+
+<a name="module_js-build-tools"></a>
+
+## js-build-tools
+Export these functions to your own project to customize your build pipeline.
+
+**Version**: 3.0.0  
+**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
+<a name="module_js-build-tools.build"></a>
+
+### js-build-tools.build() ⇒ <code>stream.Stream</code>
+Runs several processes to build and validate the project.
+
+**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
+<a name="module_gulpConfig"></a>
+
+## gulpConfig
+Modify these configurations to match your project specifications.
+
+**Version**: 3.0.0  
+**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
+
+* [gulpConfig](#module_gulpConfig)
+    * _static_
+        * [.get(path, defaultValue)](#module_gulpConfig.get) ⇒ <code>\*</code> \| <code>null</code>
+        * [.set(path, value)](#module_gulpConfig.set) ⇒ <code>\*</code>
+    * _inner_
+        * [~ArrayableSetting](#module_gulpConfig..ArrayableSetting) : <code>Array.&lt;string&gt;</code> \| <code>string</code>
+        * [~BooleanSetting](#module_gulpConfig..BooleanSetting) : <code>boolean</code>
+        * [~FlagStringSetting](#module_gulpConfig..FlagStringSetting) : <code>false</code> \| <code>StringSetting</code>
+        * [~FlagsSetting](#module_gulpConfig..FlagsSetting) : <code>Object.&lt;string, BooleanSetting&gt;</code>
+        * [~JestTestFlags](#module_gulpConfig..JestTestFlags) : <code>FlagsSetting</code>
+        * [~StringSetting](#module_gulpConfig..StringSetting) : <code>string</code>
+        * [~Setting](#module_gulpConfig..Setting) : <code>ArrayableSetting</code> \| <code>BooleanSetting</code> \| <code>FlagsSetting</code> \| <code>StringSetting</code>
+        * [~BrowserConfig](#module_gulpConfig..BrowserConfig) : <code>Object.&lt;string, Setting&gt;</code>
+        * [~DistConfig](#module_gulpConfig..DistConfig) : <code>Object.&lt;string, Setting&gt;</code>
+        * [~FontConfig](#module_gulpConfig..FontConfig) : <code>Object.&lt;string, Setting&gt;</code>
+        * [~ImageConfig](#module_gulpConfig..ImageConfig) : <code>Object.&lt;string, Setting&gt;</code>
+        * [~ReadmeConfig](#module_gulpConfig..ReadmeConfig) : <code>Object.&lt;string, Setting&gt;</code>
+        * [~SassConfig](#module_gulpConfig..SassConfig) : <code>Object.&lt;string, Setting&gt;</code>
+        * [~TestConfig](#module_gulpConfig..TestConfig) : <code>Object.&lt;string, Setting&gt;</code>
+        * [~TsConfig](#module_gulpConfig..TsConfig) : <code>Object.&lt;string, Setting&gt;</code>
+        * [~Configurations](#module_gulpConfig..Configurations) : <code>Object.&lt;string, Setting&gt;</code>
+
+<a name="module_gulpConfig.get"></a>
+
+### gulpConfig.get(path, defaultValue) ⇒ <code>\*</code> \| <code>null</code>
+Retrieve a value from the configurations, default may be returned.
+
+**Kind**: static method of [<code>gulpConfig</code>](#module_gulpConfig)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| path | <code>string</code> \| <code>null</code> | <code>null</code> | 
+| defaultValue | <code>\*</code> | <code></code> | 
+
+<a name="module_gulpConfig.set"></a>
+
+### gulpConfig.set(path, value) ⇒ <code>\*</code>
+Specify a value for the configurations to use.
+
+**Kind**: static method of [<code>gulpConfig</code>](#module_gulpConfig)  
+
+| Param |
+| --- |
+| path | 
+| value | 
+
+<a name="module_gulpConfig..ArrayableSetting"></a>
+
+### gulpConfig~ArrayableSetting : <code>Array.&lt;string&gt;</code> \| <code>string</code>
+A setting that may be an array of strings or a string only.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+<a name="module_gulpConfig..BooleanSetting"></a>
+
+### gulpConfig~BooleanSetting : <code>boolean</code>
+A setting that may be true or false.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+<a name="module_gulpConfig..FlagStringSetting"></a>
+
+### gulpConfig~FlagStringSetting : <code>false</code> \| <code>StringSetting</code>
+A setting that may be flag 'false' or provide a StringSetting
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+<a name="module_gulpConfig..FlagsSetting"></a>
+
+### gulpConfig~FlagsSetting : <code>Object.&lt;string, BooleanSetting&gt;</code>
+An object of boolean settings used as flags.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+<a name="module_gulpConfig..JestTestFlags"></a>
+
+### gulpConfig~JestTestFlags : <code>FlagsSetting</code>
+Configure cli options for running Jest.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| clearCache | <code>BooleanSetting</code> | 
+| debug | <code>BooleanSetting</code> | 
+| ignoreProjects: | <code>BooleanSetting</code> | 
+| json | <code>BooleanSetting</code> | 
+| selectProjects | <code>BooleanSetting</code> | 
+| showConfig | <code>BooleanSetting</code> | 
+| useStderr | <code>BooleanSetting</code> | 
+| watch | <code>BooleanSetting</code> | 
+| watchAll | <code>BooleanSetting</code> | 
+
+<a name="module_gulpConfig..StringSetting"></a>
+
+### gulpConfig~StringSetting : <code>string</code>
+A setting that may only be a string.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+<a name="module_gulpConfig..Setting"></a>
+
+### gulpConfig~Setting : <code>ArrayableSetting</code> \| <code>BooleanSetting</code> \| <code>FlagsSetting</code> \| <code>StringSetting</code>
+Any single configuration option is a Setting.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+<a name="module_gulpConfig..BrowserConfig"></a>
+
+### gulpConfig~BrowserConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations for building the browser files.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| enabled | <code>BooleanSetting</code> | 'true' to generate browser bundled files; 'false' for node environment only |
+| from | <code>StringSetting</code> | The name to use for the browser-bundled output file (.js will be appended). |
+| name | <code>StringSetting</code> | The search pattern used for retrieving compiled distribution files. |
+| to | <code>StringSetting</code> | The output directory for browser-bundled files. |
+
+<a name="module_gulpConfig..DistConfig"></a>
+
+### gulpConfig~DistConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations for building the node distribution files.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| from | <code>StringSetting</code> | The search pattern used for gathering source files for distribution. |
+| main | <code>StringSetting</code> | Name of the entry the distribution file. |
+| to | <code>StringSetting</code> | The output directory for the distribution files. |
+
+<a name="module_gulpConfig..FontConfig"></a>
+
+### gulpConfig~FontConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations for copying the font files.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| enabled | <code>BooleanSetting</code> | Toggle copy directory of fonts on. |
+| from | <code>StringSetting</code> | Path to search for fonts. |
+| to | <code>StringSetting</code> | Path to output fonts. |
+
+<a name="module_gulpConfig..ImageConfig"></a>
+
+### gulpConfig~ImageConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations to minify and copy the images.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| enabled | <code>BooleanSetting</code> | Toggle image minify and copy process. |
+| from | <code>StringSetting</code> | Path to search for images. |
+| to | <code>StringSetting</code> | Path to output images. |
+
+<a name="module_gulpConfig..ReadmeConfig"></a>
+
+### gulpConfig~ReadmeConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations to compile and generate the Readme file.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| file | <code>StringSetting</code> | The name of the output documentation markdown file. |
+| from | <code>StringSetting</code> | Location of files to use for compiling documentation into the readme. |
+| options | <code>ArrayableSetting</code> | Options for formatting the output readme. |
+| template | <code>StringSetting</code> | The file which will be pre-fixed to your README.md output. |
+| to | <code>StringSetting</code> | The directory to output the readme file in. |
+
+<a name="module_gulpConfig..SassConfig"></a>
+
+### gulpConfig~SassConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations to compile and copy the sass files into css.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| enabled | <code>BooleanSetting</code> | Toggle SASS to CSS process on. |
+| from | <code>StringSetting</code> | The pattern for finding all sass files. |
+| path | <code>StringSetting</code> | The directory were sass files will be stored. |
+| to | <code>StringSetting</code> | The destination path for where generated CSS (from SASS files) should go. |
+
+<a name="module_gulpConfig..TestConfig"></a>
+
+### gulpConfig~TestConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations for running the test suite.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| options | <code>JestTestFlags</code> | Additional flags for programmatically running Jest Cli. |
+| path | <code>ArrayableSetting</code> | The directory where Jest test files are stored. By default, stored as *.test.js adjacent to the files they are testing. |
+| watch | <code>ArrayableSetting</code> | The search pattern for watching files for changes. |
+
+<a name="module_gulpConfig..TsConfig"></a>
+
+### gulpConfig~TsConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations for compiling typescript into JS files.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| config | <code>FlagStringSetting</code> | The path the tsconfig file for running typescript or false if no ts file given. |
+| enabled | <code>BooleanSetting</code> | Toggle usage of typescript parsing. |
+| from | <code>StringSetting</code> | Pattern for finding the TypeScript files. |
+| to | <code>StringSetting</code> | Directory where parsed typescript files go. |
+
+<a name="module_gulpConfig..Configurations"></a>
+
+### gulpConfig~Configurations : <code>Object.&lt;string, Setting&gt;</code>
+A set of Configurations options defined by Settings.
+
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| browser | <code>BrowserConfig</code> | Browser bundling configuration group. |
+| cleanPaths | <code>ArrayableSetting</code> | The paths for directories to delete before build. |
+| dist | <code>DistConfig</code> | Distribution file generation configuration group. |
+| fonts | <code>FontConfig</code> | Fonts copy configuration group. |
+| images | <code>ImageConfig</code> | Minify and copy the images configuration. |
+| readme | <code>ReadmeConfig</code> | Build readme files configuration. |
+| rootPath | <code>StringSetting</code> | Base directory of the project. |
+| sass | <code>SassConfig</code> | Compile CSS from SASS configuration. |
+| srcPath | <code>StringSetting</code> | The directory where your source files are stored (the files you manually created). |
+| test | <code>TestConfig</code> | Run test suite configuration. |
+| typescript | <code>TsConfig</code> | Compile from typescript configuration. |
+