js-build-tools 2.4.0 → 3.0.0

package/README.md

@@ -27,78 +27,87 @@ provided are the defaults):
 
 ```js
 module.exports = {
-  // The name to use for the browser-bundled output file (.js will be appended).
-  browserName: 'my-package',
-
-  // The output directory for browser-bundled files.
-  browserPath: 'browser',
-
+  browser: {
+    // 'true' to generate browser bundled files; 'false' for node environment only
+    enabled: true,
+    // The name to use for the browser-bundled output file (.js will be appended).
+    name: 'my-package',
+    // The search pattern used for retrieving compiled distribution files.
+    from: 'dist/**/*.js',
+    // The output directory for browser-bundled files.
+    to: 'browser',
+  },
   // The paths for directories to delete before build.
   cleanPaths: ['dist', 'browser'],
-
-  // The destination path for where generated CSS (from SASS files) should go
-  cssPath: 'browser/css',
-
-  // The name of entry the distribution file.
-  distMain: 'dist/main',
-
-  // The output directory for the distribution files.
-  distPath: 'dist',
-
-  // The search pattern used for retrieving compiled distribution files.
-  distSearch: 'dist/**/*.js',
-
-  // 'true' to only generate node environment files.
-  nodeOnly: false,
-
-  // The name of the output documentation markdown file.
-  readmeFile: 'README.md',
-
-  // The directory to output the readme file in.
-  readmePath: './',
-
-  // Options for formatting the output readme.
-  readmeOptions: 'utf8',
-
-  // The file which will be pre-fixed to your README.md output.
-  readmeTemplate: 'MAIN.md',
-
-  // Location of files to use for compiling documentation into the readme.
-  readmeSearch: ['gulpfile.base.js', 'gulp.config.js', 'functions/**/!(*.test).js'],
-
+  dist: {
+    // Name of the entry the distribution file.
+    main: 'dist/main',
+    // The search pattern used for gathering source files for distribution.
+    from: 'src/**/!(*.test).js',
+    // The output directory for the distribution files.
+    to: 'dist',
+  },
+  fonts: {
+    // Toggle copy directory of fonts on
+    enabled: false,
+    // Path to search for fonts
+    from: 'src/fonts/**/*',
+    // Path to output fonts
+    to: 'browser/fonts',
+  },
+  images: {
+    // Toggle image minify and copy process
+    enabled: false,
+    // Path to search for images
+    from: 'src/img/**/*.+(png|jpg|jpeg|gif|svg)',
+    // Path to output images
+    to: 'browser/img',
+  },
+  readme: {
+    // The file which will be pre-fixed to your README.md output.
+    template: 'MAIN.md',
+    // Options for formatting the output readme.
+    options: 'utf8',
+    // The name of the output documentation markdown file.
+    file: 'README.md',
+    // Location of files to use for compiling documentation into the readme.
+    from: ['gulpfile.base.js', 'gulp.config.js', 'functions/**/!(*.test).js'],
+    // The directory to output the readme file in.
+    to: './'
+  },
   // Base directory of the project.
   rootPath: './',
-
-  // The directory were sass files will be stored
-  sassPath: 'sass',
-  
-  // The pattern for finding all sass files
-  sassSearch: 'sass/**/*.+(scss|sass)',
-
+  sass: {
+    // Toggle SASS to CSS process on.
+    enabled: false,
+    // The pattern for finding all sass files.
+    from: 'sass/**/*.+(scss|sass)',
+    // The directory were sass files will be stored.
+    path: 'sass',
+    // The destination path for where generated CSS (from SASS files) should go.
+    to: 'browser/css',
+  },
   // The directory where your source files are stored (the files you manually created).
   srcPath: 'src',
-
-  // The search pattern used for gathering source files for distribution.
-  srcSearch: 'src/**/!(*.test).js',
-
-  // Additional flags for programatically running Jest Cli.
-  testOptions: null,
-
-  // The directory where Jest test files are stored.
-  // By default stored as *.test.js adjacent with the files they are testing).
-  testPath: 'src',
-
-  // Pattern for finding the TypeScript files
-  tsSearch: 'src/**/*.ts',
-  
-  // Toggle SASS to CSS process on
-  useSass: false,
-
-  // The path the tsconfig file for running typescript or false if no ts file given.
-  useTsConfig: false,
-
-  // The search pattern for watching files for changes.
-  watchSearch: 'src/**/*.js',
+  test: {
+    // Additional flags for programmatically running Jest Cli.
+    options: null,
+    // The directory where Jest test files are stored.
+    // By default, stored as *.test.js adjacent to the files they are testing.
+    path: ['src'],
+    // The search pattern for watching files for changes.
+    watch: 'src/**/*.js'
+  },
+  typescript: {
+    // The path the tsconfig file for running typescript or false if no ts file given.
+    config: false,
+    // Toggle usage of typescript parsing.
+    enabled: false,
+    // Pattern for finding the TypeScript files.
+    from: 'src/**/*.ts',
+    // Directory where parsed typescript files go.
+    to: 'dist',
+  },
 }
 ```
 
@@ -173,6 +182,44 @@ const jsDocBase = require('js-build-tools/jsdoc.base')
 module.exports = jsDocBase
 ```
 
+### Configure move fonts (optional)
+
+Be able to copy a source directory of fonts into the distribution path.
+
+Add the following to the exports in your `build-tools.config.js`:
+
+```js
+module.exports = {
+  fonts: {
+    // Enable fonts process
+    enabled: false,
+    // Search pattern to find your font files
+    from: 'src/fonts/**/*',
+    // Output directory for your font files
+    to: 'browser/fonts',
+  }
+}
+```
+
+### Configure move and minify images (optional)
+
+Be able to copy and reduce the file size of images into an output path.
+
+Add the following to the exports in your `build-tools.config.js`:
+
+```js
+module.exports = {
+  images: {
+    // Enable image process
+    enabled: false,
+    // Search pattern to find your images
+    from: 'src/img/**/*.+(png|jpg|jpeg|gif|svg)',
+    // Output directory for your images files
+    to: 'browser/img',
+  }
+}
+```
+
 ### Configure SASS (optional)
 
 SASS support is built-in, this enables conversion of SASS files to CSS for web projects.
@@ -181,14 +228,16 @@ Add the following to the exports in your `build-tools.config.js`:
 
 ```js
 module.exports = {
-  // Output directory for your compiled css files, recommend css directory within your browser output directory
-  css: 'browser/css',
-  // Optional but nice to add (future support), add the directory where your sass files exist
-  sassPath: 'sass',
-  // Search pattern to find your SASS files (the below would be files ending in .scss or .sass in a directory called 'sass')
-  sassSearch: 'sass/**/*.+(scss|sass)',
-  // Enable SASS process
-  useSass: true,
+  sass: {
+    // Enable SASS process
+    enabled: false,
+    // Search pattern to find your SASS files (the below would be files ending in .scss or .sass in a directory called 'sass')
+    from: 'sass/**/*.+(scss|sass)',
+    // Optional but nice to add (future support), add the directory where your sass files exist
+    path: 'sass',
+    // Output directory for your compiled css files, recommend css directory within your browser output directory
+    to: 'browser/css',
+  }
 }
 ```
 
@@ -211,15 +260,27 @@ Create a `tsconfig.json` file in your project root with the following:
 ```
 
 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.js` as `'tsSearch'` setting. In order to create the ts declaration
-files you must add the `"declaration": true`.
+The actual pattern used comes from `build-tools.config.js` as `'typescript.from'` setting.
+To create the ts declaration files, you must add the `"declaration": true`.
 
 Add the following to the exports in your `build-tools.config.js`:
 
 ```js
 module.exports = {
-  readmeSearch: 'dist/**/!(*.min).js',
-  useTsConfig: 'tsconfig.json',
+  readme: {
+    // Location of files to use for compiling documentation into the readme.
+    from: 'dist/**/!(*.min).js',
+  },
+  typescript: {
+    // The path the tsconfig file for running typescript or false if no ts file given.
+    config: 'tsconfig.json',
+    // Toggle usage of typescript parsing
+    enabled: true,
+    // Pattern for finding the TypeScript files
+    from: 'src/**/*.ts',
+    // Directory where parsed typescript files go
+    to: 'dist',
+  },
 }
 ```
 
@@ -271,7 +332,7 @@ Run any of the above commands with `gulp` or `npm run`.
 <dd><p>Modify these configurations to match your project specifications.</p>
 </dd>
 <dt><a href="#module_testHelpers">testHelpers</a></dt>
-<dd><p>An assortment of objects that can be used in tests and some functions to help debug and write tests.</p>
+<dd><p>Export the setUp helper.</p>
 </dd>
 <dt><a href="#module_partials">partials</a></dt>
 <dd><p>Micro-functions used as components for the main gulp functions.</p>
@@ -283,25 +344,33 @@ Run any of the above commands with `gulp` or `npm run`.
 ## js-build-tools
 Export these functions to your own project in order to customize your build pipeline.
 
-**Version**: 2.0.0  
+**Version**: 3.0.0  
 **Author**: Joshua Heagle <joshuaheagle@gmail.com>  
 
 * [js-build-tools](#module_js-build-tools)
+    * [.typeScript](#module_js-build-tools.typeScript) ⇒ <code>function</code>
     * [.compileReadme](#module_js-build-tools.compileReadme) ⇒ <code>stream.Stream</code>
     * [.watchTest()](#module_js-build-tools.watchTest) ⇒ <code>\*</code>
     * [.watchFull()](#module_js-build-tools.watchFull) ⇒ <code>FSWatcher</code>
-    * [.typeScript()](#module_js-build-tools.typeScript) ⇒ <code>function</code>
     * [.testQuick()](#module_js-build-tools.testQuick) ⇒ <code>Promise.&lt;\*&gt;</code>
     * [.testFull()](#module_js-build-tools.testFull) ⇒ <code>Promise.&lt;\*&gt;</code>
+    * [.images()](#module_js-build-tools.images) ⇒ <code>stream.Stream</code>
     * [.distMinify()](#module_js-build-tools.distMinify) ⇒ <code>\*</code>
     * [.distLint()](#module_js-build-tools.distLint) ⇒ <code>\*</code>
     * [.dist()](#module_js-build-tools.dist) ⇒ <code>\*</code>
     * [.defaultCmd([done])](#module_js-build-tools.defaultCmd) ⇒ <code>stream.Stream</code>
+    * [.copyFonts()](#module_js-build-tools.copyFonts) ⇒ <code>stream.Stream</code>
     * [.bundleMinify()](#module_js-build-tools.bundleMinify) ⇒ <code>\*</code>
     * [.bundleLint()](#module_js-build-tools.bundleLint) ⇒ <code>stream.Stream</code>
     * [.bundle()](#module_js-build-tools.bundle) ⇒ <code>stream.Stream</code>
     * [.build()](#module_js-build-tools.build) ⇒ <code>stream.Stream</code>
 
+<a name="module_js-build-tools.typeScript"></a>
+
+### js-build-tools.typeScript ⇒ <code>function</code>
+Simplified typescript task using tsFor.
+
+**Kind**: static constant of [<code>js-build-tools</code>](#module_js-build-tools)  
 <a name="module_js-build-tools.compileReadme"></a>
 
 ### js-build-tools.compileReadme ⇒ <code>stream.Stream</code>
@@ -319,12 +388,6 @@ Watch for changes and run the tests.
 ### js-build-tools.watchFull() ⇒ <code>FSWatcher</code>
 Watch for changes and run the distribution for the changed files, then bundle and test the changed files.
 
-**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-<a name="module_js-build-tools.typeScript"></a>
-
-### js-build-tools.typeScript() ⇒ <code>function</code>
-Simplified typescript task using tsFor.
-
 **Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
 <a name="module_js-build-tools.testQuick"></a>
 
@@ -337,6 +400,12 @@ Run the Jest tests for files which have been modified (based on git status).
 ### js-build-tools.testFull() ⇒ <code>Promise.&lt;\*&gt;</code>
 Run all tests with jest.
 
+**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
+<a name="module_js-build-tools.images"></a>
+
+### js-build-tools.images() ⇒ <code>stream.Stream</code>
+Move and optimize the images into the browser folder using configured settings.
+
 **Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
 <a name="module_js-build-tools.distMinify"></a>
 
@@ -367,6 +436,12 @@ Recommended as the default task, runs the simple dist and bundle tasks.
 | --- | --- | --- |
 | [done] | <code>function</code> | <code></code> | 
 
+<a name="module_js-build-tools.copyFonts"></a>
+
+### js-build-tools.copyFonts() ⇒ <code>stream.Stream</code>
+Move the font files into the browser directory.
+
+**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
 <a name="module_js-build-tools.bundleMinify"></a>
 
 ### js-build-tools.bundleMinify() ⇒ <code>\*</code>
@@ -396,12 +471,11 @@ Runs several processes to build and validate the project.
 ## gulpConfig
 Modify these configurations to match your project specifications.
 
-**Version**: 2.0.0  
+**Version**: 3.0.0  
 **Author**: Joshua Heagle <joshuaheagle@gmail.com>  
 
 * [gulpConfig](#module_gulpConfig)
     * _static_
-        * [.defaultConfig([config], [path], [defaultValue])](#module_gulpConfig.defaultConfig) ⇒ <code>\*</code> \| <code>null</code>
         * [.get(path, defaultValue)](#module_gulpConfig.get) ⇒ <code>\*</code> \| <code>null</code>
         * [.set(path, value)](#module_gulpConfig.set) ⇒ <code>\*</code>
     * _inner_
@@ -412,25 +486,20 @@ Modify these configurations to match your project specifications.
         * [~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.defaultConfig"></a>
-
-### gulpConfig.defaultConfig([config], [path], [defaultValue]) ⇒ <code>\*</code> \| <code>null</code>
-Retrieve a value from an object with the path (key), return a given default if the key is not found.
-
-**Kind**: static method of [<code>gulpConfig</code>](#module_gulpConfig)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| [config] | <code>Object.&lt;string, \*&gt;</code> | <code>[]</code> | 
-| [path] | <code>string</code> \| <code>null</code> | <code>null</code> | 
-| [defaultValue] | <code>\*</code> | <code></code> | 
-
 <a name="module_gulpConfig.get"></a>
 
 ### gulpConfig.get(path, defaultValue) ⇒ <code>\*</code> \| <code>null</code>
-Retrieve a value from teh configurations, default may be returned.
+Retrieve a value from the configurations, default may be returned.
 
 **Kind**: static method of [<code>gulpConfig</code>](#module_gulpConfig)  
 
@@ -507,117 +576,165 @@ A setting that may only be a string.
 Any single configuration option is a Setting.
 
 **Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
-<a name="module_gulpConfig..Configurations"></a>
+<a name="module_gulpConfig..BrowserConfig"></a>
 
-### gulpConfig~Configurations : <code>Object.&lt;string, Setting&gt;</code>
-A set of Configurations options defined by Settings.
+### 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 |
-| --- | --- |
-| browserName | <code>StringSetting</code> | 
-| browserPath | <code>StringSetting</code> | 
-| distMain | <code>StringSetting</code> | 
-| distPath | <code>StringSetting</code> | 
-| distSearch | <code>ArrayableSetting</code> | 
-| nodeOnly | <code>BooleanSetting</code> | 
-| readmeTemplate | <code>StringSetting</code> | 
-| readmeOptions | <code>ArrayableSetting</code> | 
-| readmeFile | <code>StringSetting</code> | 
-| readmePath | <code>StringSetting</code> | 
-| readmeSearch | <code>ArrayableSetting</code> | 
-| rootPath | <code>StringSetting</code> | 
-| srcPath | <code>StringSetting</code> | 
-| srcSearch | <code>ArrayableSetting</code> | 
-| testOptions | <code>JestTestFlags</code> | 
-| testPath | <code>ArrayableSetting</code> | 
-| useTsConfig | <code>FlagStringSetting</code> | 
-| watchSearch | <code>ArrayableSetting</code> | 
+| 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_testHelpers"></a>
+<a name="module_gulpConfig..DistConfig"></a>
 
-## testHelpers
-An assortment of objects that can be used in tests and some functions to help debug and write tests.
+### gulpConfig~DistConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations for building the node distribution files.
 
-**Version**: 2.0.0  
-**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
 
-* [testHelpers](#module_testHelpers)
-    * [.nodeTree](#module_testHelpers.nodeTree) : <code>Object.&lt;string, (string\|Object\|Array)&gt;</code>
-    * [.multiReferenceObject](#module_testHelpers.multiReferenceObject) : <code>Object.&lt;string, (string\|number\|Object)&gt;</code>
-    * [.linkedList](#module_testHelpers.linkedList) : <code>Object.&lt;string, (string\|Object)&gt;</code>
-    * [.jsonDom](#module_testHelpers.jsonDom) : <code>Object.&lt;string, (string\|number\|Array\|Object)&gt;</code>
-    * [.domItem](#module_testHelpers.domItem) : <code>Object.&lt;string, (string\|number\|Array\|Object)&gt;</code>
-    * [.deepReferenceObject](#module_testHelpers.deepReferenceObject) : <code>Object.&lt;string, (string\|number\|Object)&gt;</code>
-    * [.circularObject](#module_testHelpers.circularObject) : <code>Object.&lt;string, (string\|Object\|Array)&gt;</code>
-    * [.setDefaults(testDir)](#module_testHelpers.setDefaults)
-    * [.createTempDir([exists])](#module_testHelpers.createTempDir) ⇒ <code>Promise.&lt;(\*\|void)&gt;</code>
-    * [.exports.beforeEach()](#module_testHelpers.exports.beforeEach) ⇒ <code>Promise.&lt;(\*\|void)&gt;</code>
-    * [.exports.afterEach()](#module_testHelpers.exports.afterEach) ⇒ <code>Promise.&lt;\*&gt;</code>
-    * [.logObject(object, [label], [outputType])](#module_testHelpers.logObject) ⇒ <code>string</code> \| <code>undefined</code>
-    * [.countMatches(content, search)](#module_testHelpers.countMatches) ⇒ <code>number</code>
+| 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_testHelpers.nodeTree"></a>
+<a name="module_gulpConfig..FontConfig"></a>
 
-### testHelpers.nodeTree : <code>Object.&lt;string, (string\|Object\|Array)&gt;</code>
-Sample NodeTree for testing circular references and arrays.
+### gulpConfig~FontConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations for copying the font files.
 
-**Kind**: static constant of [<code>testHelpers</code>](#module_testHelpers)  
-<a name="module_testHelpers.multiReferenceObject"></a>
+**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. |
 
-### testHelpers.multiReferenceObject : <code>Object.&lt;string, (string\|number\|Object)&gt;</code>
-Sample of object containing multiple references.
+<a name="module_gulpConfig..ImageConfig"></a>
 
-**Kind**: static constant of [<code>testHelpers</code>](#module_testHelpers)  
-<a name="module_testHelpers.linkedList"></a>
+### gulpConfig~ImageConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations to minify and copy the images.
 
-### testHelpers.linkedList : <code>Object.&lt;string, (string\|Object)&gt;</code>
-Sample LinkedList for testing circular references.
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
 
-**Kind**: static constant of [<code>testHelpers</code>](#module_testHelpers)  
-<a name="module_testHelpers.jsonDom"></a>
+| 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. |
 
-### testHelpers.jsonDom : <code>Object.&lt;string, (string\|number\|Array\|Object)&gt;</code>
-Sample of jsonDom object containing empty nested array and objects
+<a name="module_gulpConfig..ReadmeConfig"></a>
 
-**Kind**: static constant of [<code>testHelpers</code>](#module_testHelpers)  
-<a name="module_testHelpers.domItem"></a>
+### gulpConfig~ReadmeConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations to compile and generate the Readme file.
 
-### testHelpers.domItem : <code>Object.&lt;string, (string\|number\|Array\|Object)&gt;</code>
-Sample of domItem child with nested child and optional details
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
 
-**Kind**: static constant of [<code>testHelpers</code>](#module_testHelpers)  
-<a name="module_testHelpers.deepReferenceObject"></a>
+| 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. |
 
-### testHelpers.deepReferenceObject : <code>Object.&lt;string, (string\|number\|Object)&gt;</code>
-Sample object with deep references.
+<a name="module_gulpConfig..SassConfig"></a>
 
-**Kind**: static constant of [<code>testHelpers</code>](#module_testHelpers)  
-<a name="module_testHelpers.circularObject"></a>
+### gulpConfig~SassConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations to compile and copy the sass files into css.
 
-### testHelpers.circularObject : <code>Object.&lt;string, (string\|Object\|Array)&gt;</code>
-Multilayered node tree-like structure with parent references
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
 
-**Kind**: static constant of [<code>testHelpers</code>](#module_testHelpers)  
-<a name="module_testHelpers.setDefaults"></a>
+| 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. |
 
-### testHelpers.setDefaults(testDir)
-Update the gulp configurations with the test data. Set the test directory where temp files will be created for testing.
+<a name="module_gulpConfig..TestConfig"></a>
 
-**Kind**: static method of [<code>testHelpers</code>](#module_testHelpers)  
+### gulpConfig~TestConfig : <code>Object.&lt;string, Setting&gt;</code>
+Configurations for running the test suite.
 
-| Param | Type | Default |
+**Kind**: inner typedef of [<code>gulpConfig</code>](#module_gulpConfig)  
+**Properties**
+
+| Name | Type | Description |
 | --- | --- | --- |
-| testDir | <code>string</code> | <code>&quot;test-temp&quot;</code> | 
+| 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_testHelpers.createTempDir"></a>
+<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. |
 
-### testHelpers.createTempDir([exists]) ⇒ <code>Promise.&lt;(\*\|void)&gt;</code>
+<a name="module_testHelpers"></a>
+
+## testHelpers
+Export the setUp helper.
+
+**Version**: 3.0.0  
+**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
+
+* [testHelpers](#module_testHelpers)
+    * [.exports.createTempDir](#module_testHelpers.exports.createTempDir) ⇒ <code>Promise.&lt;(\*\|void)&gt;</code>
+    * [.exports.beforeEach](#module_testHelpers.exports.beforeEach) ⇒ <code>Promise.&lt;(\*\|void)&gt;</code>
+    * [.exports.afterEach](#module_testHelpers.exports.afterEach) ⇒ <code>Promise.&lt;\*&gt;</code>
+    * [.setDefaults(testDir)](#module_testHelpers.setDefaults)
+
+<a name="module_testHelpers.exports.createTempDir"></a>
+
+### testHelpers.exports.createTempDir ⇒ <code>Promise.&lt;(\*\|void)&gt;</code>
 Ensure that the del has completed, recursively attempt to delete and recreate
 
-**Kind**: static method of [<code>testHelpers</code>](#module_testHelpers)  
+**Kind**: static property of [<code>testHelpers</code>](#module_testHelpers)  
 
 | Param | Type | Default |
 | --- | --- | --- |
@@ -625,47 +742,33 @@ Ensure that the del has completed, recursively attempt to delete and recreate
 
 <a name="module_testHelpers.exports.beforeEach"></a>
 
-### testHelpers.exports.beforeEach() ⇒ <code>Promise.&lt;(\*\|void)&gt;</code>
+### testHelpers.exports.beforeEach ⇒ <code>Promise.&lt;(\*\|void)&gt;</code>
 In the Jest.beforeEach function call this one to set up the temp directory.
 
-**Kind**: static method of [<code>testHelpers</code>](#module_testHelpers)  
+**Kind**: static property of [<code>testHelpers</code>](#module_testHelpers)  
 <a name="module_testHelpers.exports.afterEach"></a>
 
-### testHelpers.exports.afterEach() ⇒ <code>Promise.&lt;\*&gt;</code>
+### testHelpers.exports.afterEach ⇒ <code>Promise.&lt;\*&gt;</code>
 In the Jest.afterEach function call this one to clean up and remove the temp directory.
 
-**Kind**: static method of [<code>testHelpers</code>](#module_testHelpers)  
-<a name="module_testHelpers.logObject"></a>
+**Kind**: static property of [<code>testHelpers</code>](#module_testHelpers)  
+<a name="module_testHelpers.setDefaults"></a>
 
-### testHelpers.logObject(object, [label], [outputType]) ⇒ <code>string</code> \| <code>undefined</code>
-Log out an object in a nicely formatted way.
+### testHelpers.setDefaults(testDir)
+Update the gulp configurations with the test data. Set the test directory where temp files will be created for testing.
 
 **Kind**: static method of [<code>testHelpers</code>](#module_testHelpers)  
 
 | Param | Type | Default |
 | --- | --- | --- |
-| object | <code>Object</code> |  | 
-| [label] | <code>string</code> | <code>&quot;logging&quot;</code> | 
-| [outputType] | <code>string</code> | <code>&quot;log&quot;</code> | 
-
-<a name="module_testHelpers.countMatches"></a>
-
-### testHelpers.countMatches(content, search) ⇒ <code>number</code>
-Simple way to count string occurrences for testing.
-
-**Kind**: static method of [<code>testHelpers</code>](#module_testHelpers)  
-
-| Param | Type |
-| --- | --- |
-| content | <code>string</code> | 
-| search | <code>string</code> | 
+| testDir | <code>string</code> | <code>&quot;test-temp&quot;</code> | 
 
 <a name="module_partials"></a>
 
 ## partials
 Micro-functions used as components for the main gulp functions.
 
-**Version**: 2.0.0  
+**Version**: 3.0.0  
 **Author**: Joshua Heagle <joshuaheagle@gmail.com>  
 
 * [partials](#module_partials)
@@ -676,9 +779,11 @@ Micro-functions used as components for the main gulp functions.
     * [.removeDirectory(dirPath)](#module_partials.removeDirectory) ⇒ <code>Promise.&lt;\*&gt;</code>
     * [.readmeTemplate()](#module_partials.readmeTemplate) ⇒ <code>\*</code>
     * [.minifyFor()](#module_partials.minifyFor) ⇒ <code>\*</code>
+    * [.imagesFor([imageSrc], [imageDest])](#module_partials.imagesFor) ⇒ <code>stream.Stream</code>
     * [.distSeries([srcPath], [distFinalPath], [tsSearch])](#module_partials.distSeries) ⇒ <code>function</code>
     * [.distForSrc([useTs])](#module_partials.distForSrc) ⇒ <code>string</code>
     * [.distFor([srcPath], [destPath])](#module_partials.distFor) ⇒ <code>stream.Stream</code>
+    * [.copyFor(srcPath, destPath)](#module_partials.copyFor) ⇒ <code>stream.Stream</code>
     * [.clean()](#module_partials.clean) ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> \| <code>\*</code>
     * [.beginWatcher()](#module_partials.beginWatcher) ⇒ <code>FSWatcher</code>
     * [.addToReadme()](#module_partials.addToReadme) ⇒ <code>string</code> \| <code>Uint8Array</code>
@@ -752,6 +857,18 @@ Copy a readme template into the README.md file.
 Minify files and rename the output with '.min' extension.
 
 **Kind**: static method of [<code>partials</code>](#module_partials)  
+<a name="module_partials.imagesFor"></a>
+
+### partials.imagesFor([imageSrc], [imageDest]) ⇒ <code>stream.Stream</code>
+Move and optimize images into the browser directory.
+
+**Kind**: static method of [<code>partials</code>](#module_partials)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| [imageSrc] | <code>string</code> \| <code>array</code> | <code>&quot;src/images/pattern&quot;</code> | 
+| [imageDest] | <code>string</code> | <code>&quot;dest/image/folder&quot;</code> | 
+
 <a name="module_partials.distSeries"></a>
 
 ### partials.distSeries([srcPath], [distFinalPath], [tsSearch]) ⇒ <code>function</code>
@@ -788,6 +905,18 @@ Build the distribution for a given source pattern.
 | [srcPath] | <code>string</code> \| <code>array</code> | <code>&quot;&#x27;src/config/path/dist/for&#x27;&quot;</code> | 
 | [destPath] | <code>string</code> | <code>&quot;&#x27;dist/config/path&#x27;&quot;</code> | 
 
+<a name="module_partials.copyFor"></a>
+
+### partials.copyFor(srcPath, destPath) ⇒ <code>stream.Stream</code>
+Copy some files to a different location.
+
+**Kind**: static method of [<code>partials</code>](#module_partials)  
+
+| Param | Type |
+| --- | --- |
+| srcPath | <code>string</code> \| <code>array</code> | 
+| destPath | <code>string</code> | 
+
 <a name="module_partials.clean"></a>
 
 ### partials.clean() ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> \| <code>\*</code>