js-build-tools 3.0.4 → 4.0.1

package/README.md

@@ -22,92 +22,99 @@ of `node_modules/.bin/gulp`.
 
 ## Configuration
 
-In your project's root directory, create a `build-tools.config.js` file. This can contain any of the following (values
+In your project's root directory, create a `build-tools.config.json` file. This can contain any of the following (values
 provided are the defaults):
 
-```js
-module.exports = {
-  browser: {
+```json
+{
+  "browser": {
     // 'true' to generate browser bundled files; 'false' for node environment only
-    enabled: true,
+    "enabled": true,
     // The name to use for the browser-bundled output file (.js will be appended).
-    name: 'my-package',
+    "name": "my-package",
     // The search pattern used for retrieving compiled distribution files.
-    from: 'dist/**/*.js',
+    "from": "dist/**/*.js",
     // The output directory for browser-bundled files.
-    to: 'browser',
+    "to": "browser"
   },
   // The paths for directories to delete before build.
-  cleanPaths: ['dist', 'browser'],
-  dist: {
+  "cleanPaths": [
+    "dist",
+    "browser"
+  ],
+  "dist": {
     // Name of the entry the distribution file.
-    main: 'dist/main',
+    "main": "dist/main",
     // The search pattern used for gathering source files for distribution.
-    from: 'src/**/!(*.test).js',
+    "from": "src/**/!(*.test).js",
     // The output directory for the distribution files.
-    to: 'dist',
+    "to": "dist"
   },
-  fonts: {
+  "fonts": {
     // Toggle copy directory of fonts on
-    enabled: false,
+    "enabled": false,
     // Path to search for fonts
-    from: 'src/fonts/**/*',
+    "from": "src/fonts/**/*",
     // Path to output fonts
-    to: 'browser/fonts',
+    "to": "browser/fonts"
   },
-  images: {
+  "images": {
     // Toggle image minify and copy process
-    enabled: false,
+    "enabled": false,
     // Path to search for images
-    from: 'src/img/**/*.+(png|jpg|jpeg|gif|svg)',
+    "from": "src/img/**/*.+(png|jpg|jpeg|gif|svg)",
     // Path to output images
-    to: 'browser/img',
+    "to": "browser/img"
   },
-  readme: {
+  "readme": {
     // The file which will be pre-fixed to your README.md output.
-    template: 'MAIN.md',
+    "template": "MAIN.md",
     // Options for formatting the output readme.
-    options: 'utf8',
+    "options": "utf8",
     // The name of the output documentation markdown file.
-    file: 'README.md',
+    "file": "README.md",
     // Location of files to use for compiling documentation into the readme.
-    from: ['gulpfile.base.js', 'gulp.config.js', 'functions/**/!(*.test).js'],
+    "from": [
+      "src/**/!(*.test).js"
+    ],
     // The directory to output the readme file in.
-    to: './'
+    "to": "./"
   },
   // Base directory of the project.
-  rootPath: './',
-  sass: {
+  "rootPath": "./",
+  "sass": {
     // Toggle SASS to CSS process on.
-    enabled: false,
+    "enabled": false,
     // The pattern for finding all sass files.
-    from: 'sass/**/*.+(scss|sass)',
+    "from": "sass/**/*.+(scss|sass)",
     // The directory were sass files will be stored.
-    path: 'sass',
+    "path": "sass",
     // The destination path for where generated CSS (from SASS files) should go.
-    to: 'browser/css',
+    "to": "browser/css"
   },
   // The directory where your source files are stored (the files you manually created).
-  srcPath: 'src',
-  test: {
+  "srcPath": "src",
+  "test": {
     // Additional flags for programmatically running Jest Cli.
-    options: null,
+    "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'],
+    "path": [
+      "src"
+    ],
     // The search pattern for watching files for changes.
-    watch: 'src/**/*.js'
+    "watch": "src/**/*.js"
   },
-  typescript: {
+  "typescript": {
     // The path the tsconfig file for running typescript or false if no ts file given.
-    config: false,
+    "config": false,
     // Toggle usage of typescript parsing.
-    enabled: false,
+    "enabled": false,
     // Pattern for finding the TypeScript files.
-    from: 'src/**/*.ts',
+    "from": "src/**/*.ts",
     // Directory where parsed typescript files go.
-    to: 'dist',
-  },
+    "to": "dist"
+  }
 }
 ```
 
@@ -116,6 +123,8 @@ module.exports = {
 In your project's root directory, create a `gulpfile.js` file, in here you can require any of the functions you need.
 For example:
 
+#### Common JS
+
 ```js
 // Your local gulpfile.js
 const {
@@ -144,6 +153,29 @@ exports.watchFull = watchFull
 exports.watchTest = watchTest
 ```
 
+#### ES Module
+
+```js
+// Your local gulpfile.mjs
+// Everything you export will be created as a gulp task.
+export {
+  build,
+  defaultCmd,
+  partials,
+  readme,
+  sass,
+  testFull,
+  testQuick,
+  typescript,
+  watchFull,
+  watchTest
+} from 'js-build-tools'
+
+// You can build your own tasks here as well by using some of the functions `js-build-tools/functions`.
+// You can list your available tasks by running `gulp --tasks`.
+
+```
+
 Verify your tasks are available by running `gulp --tasks`.
 
 ### Configure Babel
@@ -159,6 +191,60 @@ const babelConfig = require('js-build-tools/babel.config')
 module.exports = babelConfig
 ```
 
+### Configure ES Modules (.mjs)
+
+It is not recommended to use `"type": "module"` in the `package.json` to enable ES Modules.
+This is because some dependencies still rely on common JS syntax (ex: babel, jest, jsdoc).
+So, to use ES Modules, you can use the `.mjs` extension on your files instead.
+There are different downsides to using the `.mjs` extension to consider.
+The `jsdoc` generation can only read `.js` files, and the provided test runner `Jest` will need to be configured.
+Update the test config as follows:
+
+```json
+{
+  "dist": {
+    // Use .mjs files for from and main
+    "main": "src/main.mjs",
+    "from": "src/**/!(*.test).mjs",
+    "to": "dist"
+  },
+  "readme": {
+    "template": "MAIN.md",
+    "options": "utf8",
+    "toFile": "README.md",
+    "from": [
+      // Use the dist directory files to generate the jsdocs
+      "dist/!(*.test).js"
+    ],
+    "to": "./"
+  },
+  "test": {
+    "options": {
+      // The below helps to find the .mjs files (rather than default .js files)
+      "testMatch": [
+        "**/?(*.)+(spec|test).mjs?(x)"
+      ]
+    },
+    "path": "functions",
+    // Include watching for .mjs files
+    "watch": "functions/**/*.[cm]?[jt]s"
+  }
+}
+```
+
+There is an additional file you need to get Jest working, add a `jest.config.js` file.
+While we have already added these configurations above in the "options",
+there seems to be a bug where the "transform" does not work in that context. Add the following to your `jest.config.js`:
+
+```js
+module.exports = {
+  // The transform will instruct jest to run the files through babel so it can interpret them
+  transform: {
+    '^.+\\.[cm]?[jt]sx?$': 'babel-jest'
+  }
+}
+```
+
 ### Configure HTML JS Documentation (optional)
 
 It may be desirable to generate HTML documentation for your JS files.
@@ -186,17 +272,17 @@ module.exports = jsDocBase
 
 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`:
+Add the following to the exports in your `build-tools.config.json`:
 
-```js
-module.exports = {
-  fonts: {
+```json
+{
+  "fonts": {
     // Enable fonts process
-    enabled: false,
+    "enabled": false,
     // Search pattern to find your font files
-    from: 'src/fonts/**/*',
+    "from": "src/fonts/**/*",
     // Output directory for your font files
-    to: 'browser/fonts',
+    "to": "browser/fonts"
   }
 }
 ```
@@ -205,17 +291,17 @@ module.exports = {
 
 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`:
+Add the following to the exports in your `build-tools.config.json`:
 
-```js
-module.exports = {
-  images: {
+```json
+{
+  "images": {
     // Enable image process
-    enabled: false,
+    "enabled": false,
     // Search pattern to find your images
-    from: 'src/img/**/*.+(png|jpg|jpeg|gif|svg)',
+    "from": "src/img/**/*.+(png|jpg|jpeg|gif|svg)",
     // Output directory for your images files
-    to: 'browser/img',
+    "to": "browser/img"
   }
 }
 ```
@@ -224,19 +310,19 @@ module.exports = {
 
 SASS support is built-in, this enables conversion of SASS files to CSS for web projects.
 
-Add the following to the exports in your `build-tools.config.js`:
+Add the following to the exports in your `build-tools.config.json`:
 
-```js
-module.exports = {
-  sass: {
+```json
+{
+  "sass": {
     // Enable SASS process
-    enabled: false,
+    "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)',
+    "from": "sass/**/*.+(scss|sass)",
     // Optional but nice to add (future support), add the directory where your sass files exist
-    path: 'sass',
+    "path": "sass",
     // Output directory for your compiled css files, recommend css directory within your browser output directory
-    to: 'browser/css',
+    "to": "browser/css"
   }
 }
 ```
@@ -260,27 +346,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 `'typescript.from'` setting.
+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`.
 
-Add the following to the exports in your `build-tools.config.js`:
+Add the following to the exports in your `build-tools.config.json`:
 
-```js
-module.exports = {
-  readme: {
+```json
+{
+  "readme": {
     // Location of files to use for compiling documentation into the readme.
-    from: 'dist/**/!(*.min).js',
+    "from": "dist/**/!(*.min).js"
   },
-  typescript: {
+  "typescript": {
     // The path the tsconfig file for running typescript or false if no ts file given.
-    config: 'tsconfig.json',
+    "config": "tsconfig.json",
     // Toggle usage of typescript parsing
-    enabled: true,
+    "enabled": true,
     // Pattern for finding the TypeScript files
-    from: 'src/**/*.ts',
+    "from": "src/**/*.ts",
     // Directory where parsed typescript files go
-    to: 'dist',
-  },
+    "to": "dist"
+  }
 }
 ```
 
@@ -326,146 +412,20 @@ Run any of the above commands with `gulp` or `npm run`.
 
 <dl>
 <dt><a href="#module_js-build-tools">js-build-tools</a></dt>
-<dd><p>Export these functions to your own project in order to customize your build pipeline.</p>
+<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>
-<dt><a href="#module_testHelpers">testHelpers</a></dt>
-<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>
-</dd>
 </dl>
 
 <a name="module_js-build-tools"></a>
 
 ## js-build-tools
-Export these functions to your own project in order to customize your build pipeline.
+Export these functions to your own project to customize your build pipeline.
 
 **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>
-    * [.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>
-Generate the README.md file based off of the template, then append the generated documentation.
-
-**Kind**: static constant of [<code>js-build-tools</code>](#module_js-build-tools)  
-<a name="module_js-build-tools.watchTest"></a>
-
-### js-build-tools.watchTest() ⇒ <code>\*</code>
-Watch for changes and run the tests.
-
-**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-<a name="module_js-build-tools.watchFull"></a>
-
-### 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.testQuick"></a>
-
-### js-build-tools.testQuick() ⇒ <code>Promise.&lt;\*&gt;</code>
-Run the Jest tests for files which have been modified (based on git status).
-
-**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-<a name="module_js-build-tools.testFull"></a>
-
-### 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>
-
-### js-build-tools.distMinify() ⇒ <code>\*</code>
-Creates minified versions of the dist files.
-
-**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-<a name="module_js-build-tools.distLint"></a>
-
-### js-build-tools.distLint() ⇒ <code>\*</code>
-Applies Standard code style linting to distribution files.
-
-**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-<a name="module_js-build-tools.dist"></a>
-
-### js-build-tools.dist() ⇒ <code>\*</code>
-Simplified distribution tasks which will use arguments from distFor.
-
-**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-<a name="module_js-build-tools.defaultCmd"></a>
-
-### js-build-tools.defaultCmd([done]) ⇒ <code>stream.Stream</code>
-Recommended as the default task, runs the simple dist and bundle tasks.
-
-**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| [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>
-Creates the minified bundle file.
-
-**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-<a name="module_js-build-tools.bundleLint"></a>
-
-### js-build-tools.bundleLint() ⇒ <code>stream.Stream</code>
-Applies Standard code style linting to bundled file.
-
-**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-<a name="module_js-build-tools.bundle"></a>
-
-### js-build-tools.bundle() ⇒ <code>stream.Stream</code>
-Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.
-
-**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-<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
@@ -715,223 +675,3 @@ A set of Configurations options defined by Settings.
 | test | <code>TestConfig</code> | Run test suite configuration. |
 | typescript | <code>TsConfig</code> | Compile from typescript configuration. |
 
-<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 property of [<code>testHelpers</code>](#module_testHelpers)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| [exists] | <code>boolean</code> | <code>true</code> | 
-
-<a name="module_testHelpers.exports.beforeEach"></a>
-
-### 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 property of [<code>testHelpers</code>](#module_testHelpers)  
-<a name="module_testHelpers.exports.afterEach"></a>
-
-### 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 property of [<code>testHelpers</code>](#module_testHelpers)  
-<a name="module_testHelpers.setDefaults"></a>
-
-### 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 |
-| --- | --- | --- |
-| 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**: 3.0.0  
-**Author**: Joshua Heagle <joshuaheagle@gmail.com>  
-
-* [partials](#module_partials)
-    * [.tsFor([srcPath], [distPath])](#module_partials.tsFor) ⇒ <code>function</code>
-    * [.sassFor([srcSearch], [cssPath])](#module_partials.sassFor) ⇒ <code>stream.Stream</code>
-    * [.runOnChange(path)](#module_partials.runOnChange) ⇒ <code>stream.Stream</code>
-        * [~pathRegex](#module_partials.runOnChange..pathRegex)
-    * [.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>
-
-<a name="module_partials.tsFor"></a>
-
-### partials.tsFor([srcPath], [distPath]) ⇒ <code>function</code>
-Starting at the source directory, find all the ts files and convert them into the distribution directory.
-
-**Kind**: static method of [<code>partials</code>](#module_partials)  
-**See**: `https://www.typescriptlang.org/docs/handbook/gulp.html` for more info  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| [srcPath] | <code>string</code> \| <code>array</code> | <code>&quot;&#x27;&#x27;&quot;</code> | 
-| [distPath] | <code>string</code> | <code>&quot;&#x27;&#x27;&quot;</code> | 
-
-<a name="module_partials.sassFor"></a>
-
-### partials.sassFor([srcSearch], [cssPath]) ⇒ <code>stream.Stream</code>
-Build the CSS for a given source pattern.
-
-**Kind**: static method of [<code>partials</code>](#module_partials)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| [srcSearch] | <code>string</code> \| <code>array</code> | <code>&quot;&#x27;src/config/path/sass/for&#x27;&quot;</code> | 
-| [cssPath] | <code>string</code> | <code>&quot;&#x27;css/config/path&#x27;&quot;</code> | 
-
-<a name="module_partials.runOnChange"></a>
-
-### partials.runOnChange(path) ⇒ <code>stream.Stream</code>
-Run this function when the watched files are modified.
-
-**Kind**: static method of [<code>partials</code>](#module_partials)  
-
-| Param | Type |
-| --- | --- |
-| path | <code>string</code> | 
-
-**Example**  
-```js
-// Configured paths
-```
-<a name="module_partials.runOnChange..pathRegex"></a>
-
-#### runOnChange~pathRegex
-1. The original path comes in from src and is a .ts
-
-**Kind**: inner constant of [<code>runOnChange</code>](#module_partials.runOnChange)  
-<a name="module_partials.removeDirectory"></a>
-
-### partials.removeDirectory(dirPath) ⇒ <code>Promise.&lt;\*&gt;</code>
-Return a promise to be completed once the specified directory is deleted.
-
-**Kind**: static method of [<code>partials</code>](#module_partials)  
-
-| Param | Type |
-| --- | --- |
-| dirPath | <code>string</code> | 
-
-<a name="module_partials.readmeTemplate"></a>
-
-### partials.readmeTemplate() ⇒ <code>\*</code>
-Copy a readme template into the README.md file.
-
-**Kind**: static method of [<code>partials</code>](#module_partials)  
-<a name="module_partials.minifyFor"></a>
-
-### partials.minifyFor() ⇒ <code>\*</code>
-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>
-When using TypeScript, ensure that we process the ts first then run babel (dist)
-
-**Kind**: static method of [<code>partials</code>](#module_partials)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| [srcPath] | <code>string</code> | <code>&quot;&#x27;src/config/path/dist/for&#x27;&quot;</code> | 
-| [distFinalPath] | <code>string</code> | <code>&quot;&#x27;dist/config/path&#x27;&quot;</code> | 
-| [tsSearch] | <code>string</code> | <code>&quot;&#x27;ts/search/config/path&#x27;&quot;</code> | 
-
-<a name="module_partials.distForSrc"></a>
-
-### partials.distForSrc([useTs]) ⇒ <code>string</code>
-Retrieve the correct distFor search path based on TS Config.
-
-**Kind**: static method of [<code>partials</code>](#module_partials)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| [useTs] | [<code>FlagStringSetting</code>](#module_gulpConfig..FlagStringSetting) | <code>&#x27;config/for/ts&#x27;</code> | 
-
-<a name="module_partials.distFor"></a>
-
-### partials.distFor([srcPath], [destPath]) ⇒ <code>stream.Stream</code>
-Build the distribution for a given source pattern.
-
-**Kind**: static method of [<code>partials</code>](#module_partials)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| [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>
-Deletes all the distribution and browser files (used before create a new build).
-
-**Kind**: static method of [<code>partials</code>](#module_partials)  
-<a name="module_partials.beginWatcher"></a>
-
-### partials.beginWatcher() ⇒ <code>FSWatcher</code>
-Create a chokidar instance which watches and triggers change when the globed files are modified.
-
-**Kind**: static method of [<code>partials</code>](#module_partials)  
-<a name="module_partials.addToReadme"></a>
-
-### partials.addToReadme() ⇒ <code>string</code> \| <code>Uint8Array</code>
-Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
-
-**Kind**: static method of [<code>partials</code>](#module_partials)