Add support for custom commands

Author: devowhippit

bin/util/_sample.js renamed to bin/_sample.js

@@ -9,17 +9,19 @@
 const fs = require('fs');
 const path = require('path');
 const chokidar = require('chokidar');
-const alerts = require(`${process.env.PWD}/config/alerts`);
-// Create a config file for this script
-// const config = require(`${process.env.PWD}/config/sample`);
+
+const cnsl = require(`${process.env.PWD}/node_modules/nycopportunity/pttrn/bin/util/console`);
+const global = require(`${process.env.PWD}/node_modules/nycopportunity/pttrn/config/global`);
+const alerts = require(`${process.env.PWD}/node_modules/nycopportunity/pttrn/config/alerts`);
+const config = resolve(`${process.env.PWD}/config/sample`);
 
 /**
  * Constants
  */
 
-const SOURCE = path.join(process.env.PWD, opts.src);
-const DIST = path.join(process.env.PWD, opts.dist);
-const BASE_PATH = `${SOURCE}/${opts.views}`;
+const SOURCE = path.join(global.base, global.src);
+const DIST = path.join(global.base, global.dist);
+const BASE_PATH = path.join(SOURCE, global.entry.views);
 
 const EXT = '.ext';
 const GLOBS = [
@@ -48,6 +50,7 @@ const watcher = chokidar.watch(GLOBS, {
  *
  * @param   {String}    file   The file source
  * @param   {Object}    data   The data to pass to the file
+ *
  * @return  {undefined}        The result of fs.writeFileSync()
  */
 const write = async (file, data) => {

bin/cli.js

@@ -1,14 +1,28 @@
 #!/usr/bin/env node
 
+/**
+ * Dependencies
+ */
+
+const resolve = require(`${__dirname}/util/resolve`);
+
+/**
+ * Args
+ */
+
 let script = process.argv[2];
 
+/**
+ * Main
+ */
+
 if (undefined === script || script[0] === '-') {
   process.argv.splice(2, 0, 'default');
 
-  require(`${__dirname}/default`).run();
+  resolve('bin/default').run();
 } else {
   try {
-    require(`${__dirname}/${script}`).run();
+    resolve(`bin/${script}`).run();
   } catch (error) {
     console.log(`"${script}" is not a supported command.`);
   }

readme.md

@@ -387,11 +387,11 @@ Each major feature uses a [configuration file](https://github.com/CityOfNewYork/
   * [Flags](#flags)
   * [Alerts](#alerts)
   * [ES Configuration](#es-configuration)
+  * [Custom Commands](#custom-commands)
   * [NPM Scripts](#npm-scripts)
 
 * [Guide: Creating a new `make` command template](#creating-a-new-make-command-template)
 * [Optional dependencies](#optional-dependencies)
-* [Documentation](#documentation)
 
 ## Installation
 
@@ -954,6 +954,8 @@ Optional [flags](#flags) can be passed to the commands for signaling watching an
 - [`serve`](#serve)
 - [`publish`](#publish)
 
+[Custom commands](#custom-commands) have been newly introduced and are described below.
+
 ---
 
 #### Default
@@ -1217,13 +1219,13 @@ A custom `publish` configuration could be used to push to different remote GitHu
 
 ### Flags
 
-Flag                                                             | Description
------------------------------------------------------------------|-
-<span style="white-space:nowrap">`-w` or `--watch`</span>        | Use Chokidar to watch for changes on concerned source files and run their scripts when changes are detected.
-<span style="white-space:nowrap">`-nd` or `--nondescript`</span> | Silence detailed logging (such as file writing writing) for commands. All other logs (such as script start and success) will display. **This can be used on all commands**.
-<span style="white-space:nowrap">`-s` or `--silent`</span>       | Disable all logging output. Note, some output will always log such as linting and errors. **This can be used on all commands**.
-<span style="white-space:nowrap">`-nl` or `--no-lint`</span>     | Disable ESLint and stylelint. This only works the `rollup` and `sass` command respectively. Running `npx pttrn lint -nl` will have no effect.
-<span style="white-space:nowrap">`-np` or `--no-pa11y`</span>    | Disable Pa11y linting. This only works for the `slm` command. Running `npx pttrn pa11y -np` command will have no effect.
+Flag                                                           | Description
+---------------------------------------------------------------|-
+<div style="white-space:nowrap">`-w` or `--watch`</div>        | Use Chokidar to watch for changes on concerned source files and run their scripts when changes are detected.
+<div style="white-space:nowrap">`-nd` or `--nondescript`</div> | Silence detailed logging (such as file writing writing) for commands. All other logs (such as script start and success) will display. **This can be used on all commands**.
+<div style="white-space:nowrap">`-s` or `--silent`</div>       | Disable all logging output. Note, some output will always log such as linting and errors. **This can be used on all commands**.
+<div style="white-space:nowrap">`-nl` or `--no-lint`</div>     | Disable ESLint and stylelint. This only works the `rollup` and `sass` command respectively. Running `npx pttrn lint -nl` will have no effect.
+<div style="white-space:nowrap">`-np` or `--no-pa11y`</div>    | Disable Pa11y linting. This only works for the `slm` command. Running `npx pttrn pa11y -np` command will have no effect.
 
 ### Alerts
 
@@ -1233,6 +1235,18 @@ Flag                                                             | Description
 
 You may have noticed the `scaffold` command will create a `.config/rollup.mjs` configuration file. [Node.js has stable support of the ECMAScript module spec](https://nodejs.org/api/esm.html) and they can be imported into CommonJS (Node modules). The configuration script will resolve ES modules with the **.mjs** extension over **.js** files, however, use of ES module configuration hasn't been fully tested with all of the commands.
 
+### Custom Commands
+
+As the commands above will look for a custom configuration file for each command in the **./config** directory of your project the CLI will also resolve custom command scripts in the **./bin** directory of your project. A [sample script](bin/_sample.js) is included in this repo and can be used to start the creation of a custom command. The bare minimum a command script should include is a `run()` method.
+
+```javascript
+module.exports = {
+  run: () => {
+    console.log('My custom command');
+  }
+};
+```
+
 ### NPM Scripts
 
 The recommended [npm scripts](https://docs.npmjs.com/misc/scripts) below create shortcuts for using the cli and hook into other npm methods to make starting, versioning, and publishing more convenient. They can be modified to suit the needs of a particular project. Add them to your project's *package.json* file.