v0.5.0

.gitignore

@@ -57,4 +57,5 @@ typings/
 # dotenv environment variables file
 .env
 
-examples/test-output
+examples/test-output/**/*
+!examples/test-output/.gitkeep

README.md

@@ -1,47 +1,141 @@
-# scaffolder
-Scaffolder allows you to create your structured files based on templates.
+# simple-scaffold
+Simple Scaffold allows you to create your structured files based on templates.
 
 ## Install
 You can either use it as a command line tool or import into your own code and run from there.
 
-You can install simple-scaffold globally like so:
-
 ```bash
 # npm
-npm install -g simple-scaffold
+npm install [-g] simple-scaffold
 # yarn
-yarn global add simple-scaffold
+yarn [global] add simple-scaffold
 ```
 
 ## Use as a command line tool
-#### Command line options
 
+### Command Line Options
+
+    Scaffold Generator
+
+      Generate scaffolds for your project based on file templates.
+      Usage: simple-scaffold scaffold-name [options]
+
+
+      -n, --name string                 Component output name
+      -t, --templates File[]            A glob pattern of template files to load.
+                                        A template file may be of any type and extension, and supports Handlebars as
+                                        a parsing engine for the file names and contents, so you may customize both
+                                        with variables from your configuration.
+      -o, --output File                 The output directory to put the new files in. They will attempt to maintain
+                                        their regular structure as they are found, if possible.
+      -l, --locals Key=Value[]          A key-value map for the template to use in parsing.
+      -S, --create-sub-folder Boolean   Whether to create a subdirectory with {{Name}} in the output directory.
+                                        default=true
+      -h, --help                        Display this help message
+
+You can add this as a script in your `package.json`:
+
+```json
+{
+  "scripts": {
+    "scaffold": "node node_modules/simple-scaffold/dist/cmd.js --template scaffolds/component/**/* --output src/components --locals myProp=\"propname\",myVal=123"
+  }
+}
+```
+
+## Scaffolding
+Scaffolding will replace {{vars}} in both the file name and its contents and put the transformed files
+in `<output>/<{{Name}}>`, as per the Handlebars formatting rules.
+
+Your context will be pre-populated with the following:
+- `{{Name}}`: CapitalizedName of the component
+- `{{name}}`: camelCasedName of the component
+
+Any `locals` you add in the config will populate with their names wrapped in `{{` and `}}`.
+They are all stringified, so be sure to parse them accordingly by creating a script, if necessary.
+
+### Use in Node.js
+You can also build the scaffold yourself, if you want to create more complex arguments or scaffold groups.
+Simply pass a config object to the constructor, and invoke `run()` when you are ready to start.
+The config takes similar arguments to the command line:
+
+```javascript
+const SimpleScaffold = require('simple-scaffold').default
+
+const scaffold = new SimpleScaffold({
+  name: 'component',
+  templates: [path.join(__dirname, 'scaffolds', 'component')],
+  output: path.join(__dirname, 'src', 'components'),
+  createSubFolder: true,
+  locals: {
+    property: 'value',
+  }
+}).run()
+```
+
+The exception in the config is that `output`, when used in Node directly, may also be passed a function for each input file to output into a dynamic path:
+```javascript
+config.output = (filename, basePath) => [basePath, filename].join(path.sep)
+```
+
+## Example Scaffold Input
+
+### Input Directory structure
+```
+- project
+    - scaffold
+        - {{Name}}.js
+    - src
+        - components
+        - ...
+```
+
+#### project/scaffold/{{Name}}.js
+```js
+const React = require('react')
+
+module.exports = class {{Name}} extends React.Component {
+  render() {
+    <div className="{{className}}">{{Name}} Component</div>
+  }
+}
+```
+
+### Run Example
 ```bash
-simple-scaffold MyComponent --template scaffolds/component \
-    --output src/components \
-    --locals myProp="propname",myVal=123
+simple-scaffold MyComponent \
+    -t project/scaffold/**/* \
+    -o src/components \
+    -l className=my-component
 ```
 
-##### `--template`
-A glob pattern of template files to load.
-
-
-A template file may be of any type and extension, and supports [Handlebars](https://handlebarsjs.com) as a parsing engine for the file names and contents, so you may customize both with variables from your configuration.
-
-You may load more than one template list by simple adding more `--template` arguments.
-
-##### `--output`
-The output directory to put the new files in. They will attempt to maintain their regular structure as they are found, if possible.
-
-Your new scaffold will be placed under a directory with the scaffold name from the argumemts.
-
-You may also pass a function to transform the output path for each file individually.
-This function takes 2 arguments: filename, and base glob path
-
-##### `--locals`
-You may set local variables to be pushed into the template and replaced.
-The format for the value of this argument is:
-
+## Example Scaffold Output
+#### Directory structure
 ```
-property=value[,property=value[,...]]
+- project
+    - src
+        - components
+            - MyComponent
+                - MyComponent.js
+        - ...
+```
+
+With `createSubfolder = false`:
+```
+- project
+    - src
+        - components
+            - MyComponent.js
+        - ...
+```
+
+#### project/scaffold/MyComponent/MyComponent.js
+```js
+const React = require('react')
+
+module.exports = class MyComponent extends React.Component {
+  render() {
+    <div className="my-component">MyComponent Component</div>
+  }
+}
 ```

cmd.ts

@@ -1,86 +1,97 @@
 import SimpleScaffold from './scaffold'
 import * as fs from 'fs'
 import IScaffold from './index'
+import * as cliArgs from 'command-line-args'
+import * as cliUsage from 'command-line-usage'
+import * as path from 'path'
 
-const args = process.argv.slice(2)
+type Def = cliArgs.OptionDefinition & { description?: string, typeLabel?: string }
 
-class ScaffoldCmd {
-  private config: IScaffold.IConfig
-
-  constructor() {
-    this.config = this.getOptionsFromArgs()
-  }
-
-  private getOptionsFromArgs(): IScaffold.IConfig {
-    let skipNext = false
-    const options = {} as any
-
-    args.forEach((arg, i) => {
-      if (skipNext) {
-        skipNext = false
-        return
-      }
-
-      if (arg.slice(0, 2) == '--') {
-        skipNext = true
-        let value: string
-
-        if (arg.indexOf('=') >= 0) {
-          value = arg.split('=').slice(1).join('')
-        } else if (args.length >= i + 1 && args[i + 1] && args[i + 1].slice(0, 2) !== '--') {
-          value = args[i + 1]
-        } else {
-          value = 'true'
-        }
-
-        const argName = arg.slice(2)
-        options[argName] = this.getArgValue(argName, value, options)
-      } else {
-        if (!options.name) {
-          options.name = arg
-        } else {
-          throw new TypeError(`Invalid argument: ${arg}`)
-        }
-      }
-    })
-
-    if (!['name', 'templates', 'output'].every(o => options[o] !== undefined)) {
-      throw new Error(`Config is missing keys: ${JSON.stringify(options)}`)
-    }
-
-    return options
-  }
-
-  private getArgValue(arg: string, value: string, options: IScaffold.IConfig) {
-    switch (arg) {
-      case 'templates':
-        return (options.templates || []).concat([value])
-      case 'output':
-        return value
-      case 'locals':
-        const split = value.split(',')
-        const locals = options.locals || {}
-        for (const item of split) {
-          const [k, v] = item.split('=')
-          locals[k] = v
-        }
-        return locals
-      default:
-        throw TypeError(`arguments invalid for config: arg=\`${arg}\`, value=\`${value}\``)
-    }
-  }
-
-  public run() {
-    const config: IScaffold.IConfig = this.config
-    console.info('Config:', config)
-
-    const scf = new SimpleScaffold({
-      name: config.name,
-      templates: config.templates,
-      output: config.output,
-      locals: config.locals,
-    }).run()
-  }
+function localsParser(content: string) {
+  const [key, value] = content.split('=')
+  return { [key]: value }
 }
 
-new ScaffoldCmd().run()
+function filePathParser(content: string) {
+  if (content.startsWith('/')) {
+    return content
+  }
+  return [process.cwd(), content].join(path.sep)
+}
+
+function booleanParser(text: string) {
+  return text && text.trim().length ? ['true', '1', 'on'].includes(text.trim()) : true
+}
+
+const defs: Def[] = [
+  {
+    name: 'name',
+    alias: 'n',
+    type: String,
+    description: 'Component output name',
+    defaultOption: true,
+  },
+  {
+    name: 'templates',
+    alias: 't',
+    type: filePathParser,
+    typeLabel: '{underline File}[]',
+    description: `A glob pattern of template files to load.\nA template file may be of any type and extension, and supports Handlebars as a parsing engine for the file names and contents, so you may customize both with variables from your configuration.`,
+    multiple: true,
+  },
+  {
+    name: 'output',
+    alias: 'o',
+    type: filePathParser,
+    typeLabel: '{underline File}',
+    description: `The output directory to put the new files in. They will attempt to maintain their regular structure as they are found, if possible.`,
+  },
+  {
+    name: 'locals',
+    alias: 'l',
+    description: `A key-value map for the template to use in parsing.`,
+    multiple: true,
+    typeLabel: '{underline Key=Value}',
+    type: localsParser,
+  },
+  {
+    name: 'create-sub-folder',
+    alias: 'S',
+    typeLabel: '{underline Boolean}',
+    description: 'Whether to create a subdirectory with \\{\\{Name\\}\\} in the {underline output} directory. {bold default=true}',
+    type: booleanParser,
+    defaultValue: true,
+  },
+  {
+    name: 'help',
+    alias: 'h',
+    type: Boolean,
+    description: 'Display this help message',
+  },
+]
+
+const args = cliArgs(defs, { camelCase: true })
+
+const help = [
+  { header: 'Scaffold Generator', content: `Generate scaffolds for your project based on file templates.\nUsage: {bold simple-scaffold} {underline scaffold-name} {underline [options]}` },
+  { header: 'Options', optionList: defs }
+]
+
+args.locals = (args.locals || []).reduce((all: object, cur: object) => ({ ...all, ...cur }), {} as IScaffold.Config['locals'])
+if (args.createSubFolder === null) {
+  args.createSubFolder = true
+}
+
+if (args.help || !args.name) {
+  console.log(cliUsage(help))
+  process.exit(0)
+}
+
+console.info('Config:', args)
+new SimpleScaffold({
+  name: args.name,
+  templates: args.templates,
+  output: args.output,
+  locals: args.locals,
+  createSubfolder: args.createSubFolder,
+}).run()

dist/dist/cmd.d.ts

@@ -0,0 +1 @@
+export {};

dist/dist/scaffold.d.ts

@@ -1,13 +1,13 @@
 import IScaffold from './index';
 declare class SimpleScaffold {
-    private config;
-    private locals;
-    constructor(config: IScaffold.IConfig);
-    private parseLocals(text);
-    private fileList(input);
-    private getFileContents(filePath);
-    private getOutputPath(file, basePath);
-    private writeFile(filePath, fileContents);
+    config: IScaffold.Config;
+    locals: IScaffold.Config['locals'];
+    constructor(config: IScaffold.Config);
+    private parseLocals;
+    private fileList;
+    private getFileContents;
+    private getOutputPath;
+    private writeFile;
     run(): void;
 }
 export default SimpleScaffold;

dist/dist/test.d.ts

@@ -0,0 +1 @@
+export {};

dist/main.js

@@ -0,0 +1,96 @@
+(function webpackUniversalModuleDefinition(root, factory) {
+	if(typeof exports === 'object' && typeof module === 'object')
+		module.exports = factory();
+	else if(typeof define === 'function' && define.amd)
+		define([], factory);
+	else if(typeof exports === 'object')
+		exports["library"] = factory();
+	else
+		root["library"] = factory();
+})(this, function() {
+return /******/ (function(modules) { // webpackBootstrap
+/******/ 	// The module cache
+/******/ 	var installedModules = {};
+/******/
+/******/ 	// The require function
+/******/ 	function __webpack_require__(moduleId) {
+/******/
+/******/ 		// Check if module is in cache
+/******/ 		if(installedModules[moduleId]) {
+/******/ 			return installedModules[moduleId].exports;
+/******/ 		}
+/******/ 		// Create a new module (and put it into the cache)
+/******/ 		var module = installedModules[moduleId] = {
+/******/ 			i: moduleId,
+/******/ 			l: false,
+/******/ 			exports: {}
+/******/ 		};
+/******/
+/******/ 		// Execute the module function
+/******/ 		modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
+/******/
+/******/ 		// Flag the module as loaded
+/******/ 		module.l = true;
+/******/
+/******/ 		// Return the exports of the module
+/******/ 		return module.exports;
+/******/ 	}
+/******/
+/******/
+/******/ 	// expose the modules object (__webpack_modules__)
+/******/ 	__webpack_require__.m = modules;
+/******/
+/******/ 	// expose the module cache
+/******/ 	__webpack_require__.c = installedModules;
+/******/
+/******/ 	// define getter function for harmony exports
+/******/ 	__webpack_require__.d = function(exports, name, getter) {
+/******/ 		if(!__webpack_require__.o(exports, name)) {
+/******/ 			Object.defineProperty(exports, name, {
+/******/ 				configurable: false,
+/******/ 				enumerable: true,
+/******/ 				get: getter
+/******/ 			});
+/******/ 		}
+/******/ 	};
+/******/
+/******/ 	// getDefaultExport function for compatibility with non-harmony modules
+/******/ 	__webpack_require__.n = function(module) {
+/******/ 		var getter = module && module.__esModule ?
+/******/ 			function getDefault() { return module['default']; } :
+/******/ 			function getModuleExports() { return module; };
+/******/ 		__webpack_require__.d(getter, 'a', getter);
+/******/ 		return getter;
+/******/ 	};
+/******/
+/******/ 	// Object.prototype.hasOwnProperty.call
+/******/ 	__webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
+/******/
+/******/ 	// __webpack_public_path__
+/******/ 	__webpack_require__.p = "";
+/******/
+/******/ 	// Load entry module and return exports
+/******/ 	return __webpack_require__(__webpack_require__.s = 7);
+/******/ })
+/************************************************************************/
+/******/ ({
+
+/***/ 7:
+/***/ (function(module, exports, __webpack_require__) {
+
+(function webpackMissingModule() { throw new Error("Cannot find module \"add\""); }());
+module.exports = __webpack_require__(8);
+
+
+/***/ }),
+
+/***/ 8:
+/***/ (function(module, exports) {
+
+module.exports = require("jest");
+
+/***/ })
+
+/******/ });
+});
+//# sourceMappingURL=main.js.map

dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["webpack/universalModuleDefinition","webpack/bootstrap c994c2c400fa1fc61abe","external \"jest\""],"names":[],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;AACD,O;ACVA;AACA;;AAEA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;;AAEA;AACA;;AAEA;AACA;AACA;;;AAGA;AACA;;AAEA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,aAAK;AACL;AACA;;AAEA;AACA;AACA;AACA,mCAA2B,0BAA0B,EAAE;AACvD,yCAAiC,eAAe;AAChD;AACA;AACA;;AAEA;AACA,8DAAsD,+DAA+D;;AAErH;AACA;;AAEA;AACA;;;;;;;;;;;;;;;;;AC7DA,iC","file":"main.js","sourcesContent":["(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"library\"] = factory();\n\telse\n\t\troot[\"library\"] = factory();\n})(this, function() {\nreturn \n\n\n// WEBPACK FOOTER //\n// webpack/universalModuleDefinition"," \t// The module cache\n \tvar installedModules = {};\n\n \t// The require function\n \tfunction __webpack_require__(moduleId) {\n\n \t\t// Check if module is in cache\n \t\tif(installedModules[moduleId]) {\n \t\t\treturn installedModules[moduleId].exports;\n \t\t}\n \t\t// Create a new module (and put it into the cache)\n \t\tvar module = installedModules[moduleId] = {\n \t\t\ti: moduleId,\n \t\t\tl: false,\n \t\t\texports: {}\n \t\t};\n\n \t\t// Execute the module function\n \t\tmodules[moduleId].call(module.exports, module, module.exports, __webpack_require__);\n\n \t\t// Flag the module as loaded\n \t\tmodule.l = true;\n\n \t\t// Return the exports of the module\n \t\treturn module.exports;\n \t}\n\n\n \t// expose the modules object (__webpack_modules__)\n \t__webpack_require__.m = modules;\n\n \t// expose the module cache\n \t__webpack_require__.c = installedModules;\n\n \t// define getter function for harmony exports\n \t__webpack_require__.d = function(exports, name, getter) {\n \t\tif(!__webpack_require__.o(exports, name)) {\n \t\t\tObject.defineProperty(exports, name, {\n \t\t\t\tconfigurable: false,\n \t\t\t\tenumerable: true,\n \t\t\t\tget: getter\n \t\t\t});\n \t\t}\n \t};\n\n \t// getDefaultExport function for compatibility with non-harmony modules\n \t__webpack_require__.n = function(module) {\n \t\tvar getter = module && module.__esModule ?\n \t\t\tfunction getDefault() { return module['default']; } :\n \t\t\tfunction getModuleExports() { return module; };\n \t\t__webpack_require__.d(getter, 'a', getter);\n \t\treturn getter;\n \t};\n\n \t// Object.prototype.hasOwnProperty.call\n \t__webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };\n\n \t// __webpack_public_path__\n \t__webpack_require__.p = \"\";\n\n \t// Load entry module and return exports\n \treturn __webpack_require__(__webpack_require__.s = 7);\n\n\n\n// WEBPACK FOOTER //\n// webpack/bootstrap c994c2c400fa1fc61abe","module.exports = require(\"jest\");\n\n\n//////////////////\n// WEBPACK FOOTER\n// external \"jest\"\n// module id = 8\n// module chunks = 3"],"sourceRoot":""}

dist/scaffold.js

@@ -1,2 +1,2 @@
-!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.library=t():e.library=t()}(this,function(){return function(e){function t(o){if(n[o])return n[o].exports;var r=n[o]={i:o,l:!1,exports:{}};return e[o].call(r.exports,r,r.exports,t),r.l=!0,r.exports}var n={};return t.m=e,t.c=n,t.d=function(e,n,o){t.o(e,n)||Object.defineProperty(e,n,{configurable:!1,enumerable:!0,get:o})},t.n=function(e){var n=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(n,"a",n),n},t.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},t.p="",t(t.s=1)}([function(e,t){e.exports=require("path")},function(e,t,n){"use strict";var o=this&&this.__generator||function(e,t){function n(e){return function(t){return o([e,t])}}function o(n){if(r)throw new TypeError("Generator is already executing.");for(;c;)try{if(r=1,i&&(s=i[2&n[0]?"return":n[0]?"throw":"next"])&&!(s=s.call(i,n[1])).done)return s;switch(i=0,s&&(n=[0,s.value]),n[0]){case 0:case 1:s=n;break;case 4:return c.label++,{value:n[1],done:!1};case 5:c.label++,i=n[1],n=[0];continue;case 7:n=c.ops.pop(),c.trys.pop();continue;default:if(s=c.trys,!(s=s.length>0&&s[s.length-1])&&(6===n[0]||2===n[0])){c=0;continue}if(3===n[0]&&(!s||n[1]>s[0]&&n[1]<s[3])){c.label=n[1];break}if(6===n[0]&&c.label<s[1]){c.label=s[1],s=n;break}if(s&&c.label<s[2]){c.label=s[2],c.ops.push(n);break}s[2]&&c.ops.pop(),c.trys.pop();continue}n=t.call(e,c)}catch(e){n=[6,e],i=0}finally{r=s=0}if(5&n[0])throw n[1];return{value:n[0]?n[1]:void 0,done:!0}}var r,i,s,a,c={label:0,sent:function(){if(1&s[0])throw s[1];return s[1]},trys:[],ops:[]};return a={next:n(0),throw:n(1),return:n(2)},"function"==typeof Symbol&&(a[Symbol.iterator]=function(){return this}),a};Object.defineProperty(t,"__esModule",{value:!0});var r=n(2),i=n(0),s=n(3),a=n(4),c=function(){function e(e){this.locals={};var t={name:"scaffold",templates:[],output:process.cwd()};this.config=Object.assign({},t,e);var n={Name:this.config.name[0].toUpperCase()+this.config.name.slice(1),name:this.config.name[0].toLowerCase()+this.config.name.slice(1)};this.locals=Object.assign({},n,e.locals)}return e.prototype.parseLocals=function(e){return a.compile(e,{noEscape:!0})(this.locals)},e.prototype.fileList=function(e){var t,n,r,a,c,u,l,f,p;return o(this,function(o){switch(o.label){case 0:t=0,n=e,o.label=1;case 1:if(!(t<n.length))return[3,6];r=n[t],a=s.sync(r).map(function(e){return"/"==e[0]?e:i.join(process.cwd(),e)}),c=r.indexOf("*"),u=r,c>=0&&(u=r.slice(0,c-1)),l=0,f=a,o.label=2;case 2:return l<f.length?(p=f[l],[4,{base:u,file:p}]):[3,5];case 3:o.sent(),o.label=4;case 4:return l++,[3,2];case 5:return t++,[3,1];case 6:return[2]}})},e.prototype.getFileContents=function(e){return r.readFileSync(e).toString()},e.prototype.getOutputPath=function(e,t){var n;if("function"==typeof this.config.output)n=this.config.output(e,t);else{var o=this.config.output+"/"+this.config.name+"/",r=e.indexOf(t),i=e;r>=0&&(i=e.slice(r+t.length+1)),n=o+i}return this.parseLocals(n)},e.prototype.writeFile=function(e,t){r.existsSync(i.dirname(e))||r.mkdirSync(i.dirname(e)),console.info("Writing file:",e),r.writeFileSync(e,t,{encoding:"utf-8"})},e.prototype.run=function(){console.log("Generating scaffold: "+this.config.name+"...");for(var e,t=this.fileList(this.config.templates),n=0;e=t.next().value;){n++;var o=e.file,r=e.base,i=this.getOutputPath(o,r),s=this.getFileContents(o),a=this.parseLocals(s);this.writeFile(i,a),console.info("Parsing:",{file:o,base:r,outputPath:i,outputContents:a.replace("\n","\\n")})}if(!n)throw new Error("No files to scaffold!");console.log("Done")},e}();t.default=c},function(e,t){e.exports=require("fs")},function(e,t){e.exports=require("glob")},function(e,t){e.exports=require("handlebars")}])});
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.library=t():e.library=t()}("undefined"!=typeof self?self:this,function(){return function(e){function t(n){if(o[n])return o[n].exports;var r=o[n]={i:n,l:!1,exports:{}};return e[n].call(r.exports,r,r.exports,t),r.l=!0,r.exports}var o={};return t.m=e,t.c=o,t.d=function(e,o,n){t.o(e,o)||Object.defineProperty(e,o,{configurable:!1,enumerable:!0,get:n})},t.n=function(e){var o=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(o,"a",o),o},t.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},t.p="",t(t.s=1)}([function(e,t){e.exports=require("path")},function(e,t,o){"use strict";var n=this&&this.__assign||Object.assign||function(e){for(var t,o=1,n=arguments.length;o<n;o++){t=arguments[o];for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])}return e};Object.defineProperty(t,"__esModule",{value:!0});var r=o(2),i=o(0),s=o(3),c=o(4),f=function(){function e(e){this.locals={};var t={name:"scaffold",templates:[],output:process.cwd(),createSubfolder:!0};this.config=n({},t,e);var o={Name:this.config.name[0].toUpperCase()+this.config.name.slice(1),name:this.config.name[0].toLowerCase()+this.config.name.slice(1)};this.locals=n({},o,e.locals)}return e.prototype.parseLocals=function(e){return c.compile(e,{noEscape:!0})(this.locals)},e.prototype.fileList=function(e){for(var t=[],o=0,n=e;o<n.length;o++){var r=n[o],c=s.sync(r,{dot:!0}).map(function(e){return"/"==e[0]?e:i.join(process.cwd(),e)}),f=r.indexOf("*"),a=r;f>=0&&(a=r.slice(0,f-1));for(var u=0,l=c;u<l.length;u++){var p=l[u];t.push({base:a,file:p})}}return t},e.prototype.getFileContents=function(e){return console.log(r.readFileSync(e)),r.readFileSync(e).toString()},e.prototype.getOutputPath=function(e,t){var o;if("function"==typeof this.config.output)o=this.config.output(e,t);else{var n=this.config.output+(this.config.createSubfolder?"/"+this.config.name+"/":"/"),r=e.indexOf(t),i=e;r>=0&&(i=e.slice(r+t.length+1)),o=n+i}return this.parseLocals(o)},e.prototype.writeFile=function(e,t){r.existsSync(i.dirname(e))||r.mkdirSync(i.dirname(e)),console.info("Writing file:",e),r.writeFile(e,t,{encoding:"utf-8"},function(e){if(e)throw e})},e.prototype.run=function(){console.log("Generating scaffold: "+this.config.name+"...");for(var e,t=this.fileList(this.config.templates),o=0,n=0,r=t;n<r.length;n++){e=r[n],o++;var i=e.file,s=e.base,c=this.getOutputPath(i,s),f=this.getFileContents(i),a=this.parseLocals(f);this.writeFile(c,a),console.info("Parsing:",{file:i,base:s,outputPath:c,outputContents:a.replace("\n","\\n")})}if(!o)throw new Error("No files to scaffold!");console.log("Done")},e}();t.default=f},function(e,t){e.exports=require("fs")},function(e,t){e.exports=require("glob")},function(e,t){e.exports=require("handlebars")}])});
 //# sourceMappingURL=scaffold.js.map

dist/test.js

@@ -1,2 +1,2 @@
-!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.library=t():e.library=t()}(this,function(){return function(e){function t(o){if(n[o])return n[o].exports;var r=n[o]={i:o,l:!1,exports:{}};return e[o].call(r.exports,r,r.exports,t),r.l=!0,r.exports}var n={};return t.m=e,t.c=n,t.d=function(e,n,o){t.o(e,n)||Object.defineProperty(e,n,{configurable:!1,enumerable:!0,get:o})},t.n=function(e){var n=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(n,"a",n),n},t.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},t.p="",t(t.s=5)}([function(e,t){e.exports=require("path")},function(e,t,n){"use strict";var o=this&&this.__generator||function(e,t){function n(e){return function(t){return o([e,t])}}function o(n){if(r)throw new TypeError("Generator is already executing.");for(;u;)try{if(r=1,i&&(s=i[2&n[0]?"return":n[0]?"throw":"next"])&&!(s=s.call(i,n[1])).done)return s;switch(i=0,s&&(n=[0,s.value]),n[0]){case 0:case 1:s=n;break;case 4:return u.label++,{value:n[1],done:!1};case 5:u.label++,i=n[1],n=[0];continue;case 7:n=u.ops.pop(),u.trys.pop();continue;default:if(s=u.trys,!(s=s.length>0&&s[s.length-1])&&(6===n[0]||2===n[0])){u=0;continue}if(3===n[0]&&(!s||n[1]>s[0]&&n[1]<s[3])){u.label=n[1];break}if(6===n[0]&&u.label<s[1]){u.label=s[1],s=n;break}if(s&&u.label<s[2]){u.label=s[2],u.ops.push(n);break}s[2]&&u.ops.pop(),u.trys.pop();continue}n=t.call(e,u)}catch(e){n=[6,e],i=0}finally{r=s=0}if(5&n[0])throw n[1];return{value:n[0]?n[1]:void 0,done:!0}}var r,i,s,a,u={label:0,sent:function(){if(1&s[0])throw s[1];return s[1]},trys:[],ops:[]};return a={next:n(0),throw:n(1),return:n(2)},"function"==typeof Symbol&&(a[Symbol.iterator]=function(){return this}),a};Object.defineProperty(t,"__esModule",{value:!0});var r=n(2),i=n(0),s=n(3),a=n(4),u=function(){function e(e){this.locals={};var t={name:"scaffold",templates:[],output:process.cwd()};this.config=Object.assign({},t,e);var n={Name:this.config.name[0].toUpperCase()+this.config.name.slice(1),name:this.config.name[0].toLowerCase()+this.config.name.slice(1)};this.locals=Object.assign({},n,e.locals)}return e.prototype.parseLocals=function(e){return a.compile(e,{noEscape:!0})(this.locals)},e.prototype.fileList=function(e){var t,n,r,a,u,c,l,f,p;return o(this,function(o){switch(o.label){case 0:t=0,n=e,o.label=1;case 1:if(!(t<n.length))return[3,6];r=n[t],a=s.sync(r).map(function(e){return"/"==e[0]?e:i.join(process.cwd(),e)}),u=r.indexOf("*"),c=r,u>=0&&(c=r.slice(0,u-1)),l=0,f=a,o.label=2;case 2:return l<f.length?(p=f[l],[4,{base:c,file:p}]):[3,5];case 3:o.sent(),o.label=4;case 4:return l++,[3,2];case 5:return t++,[3,1];case 6:return[2]}})},e.prototype.getFileContents=function(e){return r.readFileSync(e).toString()},e.prototype.getOutputPath=function(e,t){var n;if("function"==typeof this.config.output)n=this.config.output(e,t);else{var o=this.config.output+"/"+this.config.name+"/",r=e.indexOf(t),i=e;r>=0&&(i=e.slice(r+t.length+1)),n=o+i}return this.parseLocals(n)},e.prototype.writeFile=function(e,t){r.existsSync(i.dirname(e))||r.mkdirSync(i.dirname(e)),console.info("Writing file:",e),r.writeFileSync(e,t,{encoding:"utf-8"})},e.prototype.run=function(){console.log("Generating scaffold: "+this.config.name+"...");for(var e,t=this.fileList(this.config.templates),n=0;e=t.next().value;){n++;var o=e.file,r=e.base,i=this.getOutputPath(o,r),s=this.getFileContents(o),a=this.parseLocals(s);this.writeFile(i,a),console.info("Parsing:",{file:o,base:r,outputPath:i,outputContents:a.replace("\n","\\n")})}if(!n)throw new Error("No files to scaffold!");console.log("Done")},e}();t.default=u},function(e,t){e.exports=require("fs")},function(e,t){e.exports=require("glob")},function(e,t){e.exports=require("handlebars")},function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});var o=n(1),r=n(0),i=r.join(process.cwd(),"examples");new o.default({templates:[i+"/test-input/Component/**/*"],output:i+"/test-output",locals:{property:"myProp",value:'"value"'}}).run()}])});
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.library=t():e.library=t()}("undefined"!=typeof self?self:this,function(){return function(e){function t(n){if(o[n])return o[n].exports;var r=o[n]={i:n,l:!1,exports:{}};return e[n].call(r.exports,r,r.exports,t),r.l=!0,r.exports}var o={};return t.m=e,t.c=o,t.d=function(e,o,n){t.o(e,o)||Object.defineProperty(e,o,{configurable:!1,enumerable:!0,get:n})},t.n=function(e){var o=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(o,"a",o),o},t.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},t.p="",t(t.s=5)}([function(e,t){e.exports=require("path")},function(e,t,o){"use strict";var n=this&&this.__assign||Object.assign||function(e){for(var t,o=1,n=arguments.length;o<n;o++){t=arguments[o];for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])}return e};Object.defineProperty(t,"__esModule",{value:!0});var r=o(2),i=o(0),s=o(3),u=o(4),c=function(){function e(e){this.locals={};var t={name:"scaffold",templates:[],output:process.cwd(),createSubfolder:!0};this.config=n({},t,e);var o={Name:this.config.name[0].toUpperCase()+this.config.name.slice(1),name:this.config.name[0].toLowerCase()+this.config.name.slice(1)};this.locals=n({},o,e.locals)}return e.prototype.parseLocals=function(e){return u.compile(e,{noEscape:!0})(this.locals)},e.prototype.fileList=function(e){for(var t=[],o=0,n=e;o<n.length;o++){var r=n[o],u=s.sync(r,{dot:!0}).map(function(e){return"/"==e[0]?e:i.join(process.cwd(),e)}),c=r.indexOf("*"),a=r;c>=0&&(a=r.slice(0,c-1));for(var f=0,l=u;f<l.length;f++){var p=l[f];t.push({base:a,file:p})}}return t},e.prototype.getFileContents=function(e){return console.log(r.readFileSync(e)),r.readFileSync(e).toString()},e.prototype.getOutputPath=function(e,t){var o;if("function"==typeof this.config.output)o=this.config.output(e,t);else{var n=this.config.output+(this.config.createSubfolder?"/"+this.config.name+"/":"/"),r=e.indexOf(t),i=e;r>=0&&(i=e.slice(r+t.length+1)),o=n+i}return this.parseLocals(o)},e.prototype.writeFile=function(e,t){r.existsSync(i.dirname(e))||r.mkdirSync(i.dirname(e)),console.info("Writing file:",e),r.writeFile(e,t,{encoding:"utf-8"},function(e){if(e)throw e})},e.prototype.run=function(){console.log("Generating scaffold: "+this.config.name+"...");for(var e,t=this.fileList(this.config.templates),o=0,n=0,r=t;n<r.length;n++){e=r[n],o++;var i=e.file,s=e.base,u=this.getOutputPath(i,s),c=this.getFileContents(i),a=this.parseLocals(c);this.writeFile(u,a),console.info("Parsing:",{file:i,base:s,outputPath:u,outputContents:a.replace("\n","\\n")})}if(!o)throw new Error("No files to scaffold!");console.log("Done")},e}();t.default=c},function(e,t){e.exports=require("fs")},function(e,t){e.exports=require("glob")},function(e,t){e.exports=require("handlebars")},function(e,t,o){"use strict";Object.defineProperty(t,"__esModule",{value:!0});var n=o(1),r=o(0),i=r.join(process.cwd(),"examples");new n.default({templates:[i+"/test-input/Component/**/*"],output:i+"/test-output/no-create-subpath",createSubfolder:!1,locals:{property:"myProp",value:'"value"'}}).run(),new n.default({templates:[i+"/test-input/Component/**/*"],output:i+"/test-output",locals:{property:"myProp",value:'"value"'}}).run()}])});
 //# sourceMappingURL=test.js.map

index.d.ts

@@ -1,19 +1,18 @@
 declare namespace IScaffold {
 
-  export interface IConfig {
+  export interface Config {
     name?: string
     templates: string[]
     output: string | ((path: string, base: string) => string)
-    locals?: any
+    locals?: Locals
+    createSubfolder?: boolean
   }
 
-  export interface IReplacement {
-    find: string | RegExp
-    replace(): string
-    [other: string]: any
+  export interface Locals {
+    [k: string]: string
   }
 
-  export interface IFileRepr {
+  export interface FileRepr {
     base: string
     file: string
   }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-scaffold",
-  "version": "0.2.0",
+  "version": "0.5.0",
   "description": "Create files based on templates",
   "repository": "https://github.com/chenasraf/simple-scaffold.git",
   "author": "Chen Asraf <inbox@casraf.com>",
@@ -10,6 +10,7 @@
   "types": "index.d.ts",
   "scripts": {
     "build": "NODE_ENV=${NODE_ENV:-production} webpack -p && chmod -R +x ./dist",
+    "prepublishOnly": "yarn build",
     "dev": "webpack --watch",
     "start": "node dist/scaffold.js",
     "test": "node dist/test.js",
@@ -18,15 +19,30 @@
     "build-cmd": "yarn build && yarn cmd"
   },
   "dependencies": {
-    "@types/glob": "^5.0.34",
-    "@types/handlebars": "^4.0.36",
-    "@types/node": "^8.0.50",
-    "glob": "^7.1.2",
-    "handlebars": "^4.0.11",
-    "ts-loader": "^3.1.1",
-    "typescript": "^2.6.1",
-    "webpack": "^3.8.1",
-    "webpack-dev-server": "^2.9.4",
-    "webpack-node-externals": "^1.6.0"
+    "command-line-args": "^5.0.2",
+    "command-line-usage": "^5.0.5",
+    "glob": "^7.1.3",
+    "handlebars": "^4.1.0"
+  },
+  "devDependencies": {
+    "@types/command-line-args": "^5.0.0",
+    "@types/command-line-usage": "^5.0.1",
+    "@types/glob": "^7.1.1",
+    "@types/handlebars": "^4.0.40",
+    "@types/node": "^11.9.5",
+    "copy-webpack-plugin": "^5.0.0",
+    "jest": "^24.1.0",
+    "ts-loader": "^5.3.3",
+    "typescript": "^3.3.3333",
+    "webpack": "^4.29.5",
+    "webpack-cli": "^3.2.3",
+    "webpack-dev-server": "^3.2.1",
+    "webpack-node-externals": "^1.7.2"
+  },
+  "jest": {
+    "testPathIgnorePatterns": [
+      "node_modules",
+      "dist"
+    ]
   }
 }

scaffold.ts

@@ -5,24 +5,25 @@ import * as glob from 'glob'
 import * as handlebars from 'handlebars'
 
 class SimpleScaffold {
-  private config: IScaffold.IConfig
-  private locals = {} as any
+  public config: IScaffold.Config
+  public locals: IScaffold.Config['locals'] = {} as any
 
-  constructor(config: IScaffold.IConfig) {
-    const DefaultConfig: IScaffold.IConfig = {
+  constructor(config: IScaffold.Config) {
+    const DefaultConfig: IScaffold.Config = {
       name: 'scaffold',
       templates: [],
       output: process.cwd(),
+      createSubfolder: true,
     }
 
-    this.config = (Object as any).assign({}, DefaultConfig, config)
+    this.config = { ...DefaultConfig, ...config }
 
     const DefaultLocals = {
       Name: this.config.name![0].toUpperCase() + this.config.name!.slice(1),
       name: this.config.name![0].toLowerCase() + this.config.name!.slice(1)
     }
 
-    this.locals = (Object as any).assign({}, DefaultLocals, config.locals)
+    this.locals = { ...DefaultLocals, ...config.locals }
   }
 
   private parseLocals(text: string): string {
@@ -32,31 +33,35 @@ class SimpleScaffold {
     return template(this.locals)
   }
 
-  private *fileList(input: string[]): IterableIterator<IScaffold.IFileRepr> {
+  private fileList(input: string[]): IScaffold.FileRepr[] {
+    const output: IScaffold.FileRepr[] = []
     for (const checkPath of input) {
-      const files = glob.sync(checkPath).map(g => g[0] == '/' ? g : path.join(process.cwd(), g))
+      const files = glob.sync(checkPath, { dot: true })
+        .map(g => g[0] == '/' ? g : path.join(process.cwd(), g))
       const idx = checkPath.indexOf('*')
       let cleanCheckPath = checkPath
       if (idx >= 0) {
         cleanCheckPath = checkPath.slice(0, idx - 1)
       }
       for (const file of files) {
-        yield {base: cleanCheckPath, file}
+        output.push({ base: cleanCheckPath, file })
       }
     }
+    return output
   }
 
   private getFileContents(filePath: string): string {
+    console.log(fs.readFileSync(filePath))
     return fs.readFileSync(filePath).toString()
   }
 
   private getOutputPath(file: string, basePath: string): string {
-    let out
+    let out: string
 
     if (typeof this.config.output === 'function') {
       out = this.config.output(file, basePath)
     } else {
-      const outputDir = this.config.output + `/${this.config.name}/`
+      const outputDir = this.config.output + (this.config.createSubfolder ? `/${this.config.name}/` : '/')
       const idx = file.indexOf(basePath)
       let relativeFilePath = file
       if (idx >= 0) {
@@ -73,7 +78,11 @@ class SimpleScaffold {
       fs.mkdirSync(path.dirname(filePath))
     }
     console.info('Writing file:', filePath)
-    fs.writeFileSync(filePath, fileContents, { encoding: 'utf-8' })
+    fs.writeFile(filePath, fileContents, { encoding: 'utf-8' }, (err) => {
+      if (err) {
+        throw err
+      }
+    })
   }
 
   public run(): void {
@@ -81,15 +90,15 @@ class SimpleScaffold {
     const templates = this.fileList(this.config.templates)
 
     let fileConf, count = 0
-    while (fileConf = templates.next().value) {
+    for (fileConf of templates) {
       count++
-      const {file, base} = fileConf
+      const { file, base } = fileConf
       const outputPath = this.getOutputPath(file, base)
       const contents = this.getFileContents(file)
       const outputContents = this.parseLocals(contents)
 
       this.writeFile(outputPath, outputContents)
-      console.info('Parsing:', {file, base, outputPath, outputContents: outputContents.replace("\n", "\\n")})
+      console.info('Parsing:', { file, base, outputPath, outputContents: outputContents.replace("\n", "\\n") })
     }
 
     if (!count) {

test.ts

@@ -3,6 +3,16 @@ import * as path from 'path'
 
 const templateDir = path.join(process.cwd(), 'examples')
 
+new SimpleScaffold({
+  templates: [templateDir + '/test-input/Component/**/*'],
+  output: templateDir + '/test-output/no-create-subpath',
+  createSubfolder: false,
+  locals: {
+    property: 'myProp',
+    value: '"value"'
+  }
+}).run()
+
 new SimpleScaffold({
   templates: [templateDir + '/test-input/Component/**/*'],
   output: templateDir + '/test-output',