added --quiet flag

Bump handlebars from 4.7.6 to 4.7.7

README.md

@@ -1,7 +1,9 @@
 # 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.
 
 ```bash
@@ -15,39 +17,47 @@ yarn [global] add simple-scaffold
 
 ### Command Line Options
 
-    Scaffold Generator
+```plaintext
+Scaffold Generator
 
-      Generate scaffolds for your project based on file templates.
-      Usage: simple-scaffold scaffold-name [options]
+  Generate scaffolds for your project based on file templates.
+  Usage: simple-scaffold scaffold-name [options]
 
+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
+  -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 JSON string          A JSON string for the template to use in parsing.                             
+  -w, --overwrite Boolean           Whether to overwrite files when they are found to already exist. Default=true 
+  -q, --quiet Boolean               When set to true, logs will not output (including warnings and errors).       
+                                    Default=false                                                                 
+  -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"
+    "scaffold": "yarn simple-scaffold --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
 
@@ -55,33 +65,40 @@ Any `locals` you add in the config will populate with their names wrapped in `{{
 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 SimpleScaffold = require("simple-scaffold").default
 
 const scaffold = new SimpleScaffold({
-  name: 'component',
-  templates: [path.join(__dirname, 'scaffolds', 'component')],
-  output: path.join(__dirname, 'src', 'components'),
+  name: "component",
+  templates: [path.join(__dirname, "scaffolds", "component")],
+  output: path.join(__dirname, "src", "components"),
   createSubFolder: true,
   locals: {
-    property: 'value',
-  }
+    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:
+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)
+config.output = (fullPath, baseDir, baseName) => {
+  console.log({ fullPath, baseDir, baseName })
+  return [baseDir, baseName].join(path.sep)
+}
 ```
 
 ## Example Scaffold Input
 
-### Input Directory structure
-```
+### Input directory structure
+
+```plaintext
 - project
     - scaffold
         - {{Name}}.js
@@ -91,6 +108,7 @@ config.output = (filename, basePath) => [basePath, filename].join(path.sep)
 ```
 
 #### project/scaffold/{{Name}}.js
+
 ```js
 const React = require('react')
 
@@ -102,6 +120,7 @@ module.exports = class {{Name}} extends React.Component {
 ```
 
 ### Run Example
+
 ```bash
 simple-scaffold MyComponent \
     -t project/scaffold/**/* \
@@ -110,8 +129,10 @@ simple-scaffold MyComponent \
 ```
 
 ## Example Scaffold Output
-#### Directory structure
-```
+
+### Output directory structure
+
+```plaintext
 - project
     - src
         - components
@@ -121,7 +142,8 @@ simple-scaffold MyComponent \
 ```
 
 With `createSubfolder = false`:
-```
+
+```plaintext
 - project
     - src
         - components
@@ -130,8 +152,9 @@ With `createSubfolder = false`:
 ```
 
 #### project/scaffold/MyComponent/MyComponent.js
+
 ```js
-const React = require('react')
+const React = require("react")
 
 module.exports = class MyComponent extends React.Component {
   render() {

cmd.ts

@@ -1,97 +1,135 @@
-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'
+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"
 
-type Def = cliArgs.OptionDefinition & { description?: string, typeLabel?: string }
+type Def = cliArgs.OptionDefinition & {
+  description?: string
+  typeLabel?: string
+}
 
 function localsParser(content: string) {
-  const [key, value] = content.split('=')
-  return { [key]: value }
+  return JSON.parse(content)
 }
 
 function filePathParser(content: string) {
-  if (content.startsWith('/')) {
+  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
+  return text && text.trim().length
+    ? ["true", "1", "on"].includes(text.trim())
+    : true
 }
 
 const defs: Def[] = [
   {
-    name: 'name',
-    alias: 'n',
+    name: "name",
+    alias: "n",
     type: String,
-    description: 'Component output name',
+    description: "Component output name",
     defaultOption: true,
   },
   {
-    name: 'templates',
-    alias: 't',
+    name: "templates",
+    alias: "t",
     type: filePathParser,
-    typeLabel: '{underline File}[]',
+    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',
+    name: "output",
+    alias: "o",
     type: filePathParser,
-    typeLabel: '{underline File}',
+    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}',
+    name: "locals",
+    alias: "l",
+    description: `A JSON string for the template to use in parsing.`,
+    typeLabel: "{underline JSON string}",
     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}',
+    name: "overwrite",
+    alias: "w",
+    description: `Whether to overwrite files when they are found to already exist. {bold Default=true}`,
+    type: booleanParser,
+    typeLabel: "{underline Boolean}",
+    defaultValue: true,
+  },
+  {
+    name: "quiet",
+    alias: "q",
+    description:
+      "When set to {bold true}, logs will not output (including warnings and errors). {bold Default=false}",
+    type: booleanParser,
+    typeLabel: "{underline Boolean}",
+    defaultValue: false,
+  },
+  {
+    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',
+    name: "help",
+    alias: "h",
     type: Boolean,
-    description: 'Display this help message',
+    description: "Display this help message",
   },
 ]
 
-const args = cliArgs(defs, { camelCase: true })
+const args = cliArgs(defs, { camelCase: true }) as Omit<
+  IScaffold.Config,
+  "createSubFolder"
+> & {
+  help: boolean
+  createSubFolder: boolean
+}
 
 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 }
+  {
+    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.quiet === null) {
+  args.quiet = true
+}
+
 if (args.help || !args.name) {
   console.log(cliUsage(help))
   process.exit(0)
 }
 
-console.info('Config:', args)
+if (!args.quiet) {
+  console.info("Config:", args)
+}
+
 new SimpleScaffold({
   name: args.name,
   templates: args.templates,
   output: args.output,
   locals: args.locals,
   createSubfolder: args.createSubFolder,
+  overwrite: args.overwrite,
+  quiet: args.quiet,
 }).run()

dist/index.d.ts

@@ -7,9 +7,13 @@ declare namespace IScaffold {
   export interface Config {
     name?: string
     templates: string[]
-    output: string | ((path: string, base: string) => string)
+    output:
+      | string
+      | ((fullPath: string, basedir: string, basename: string) => string)
     locals?: Locals
     createSubfolder?: boolean
+    overwrite?: boolean | ((path: string) => boolean)
+    quiet?: boolean
   }
 
   export interface Locals {

dist/index.js

@@ -1,2 +1,2 @@
-!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.library=e():t.library=e()}(global,(function(){return(()=>{"use strict";var t={493:function(t,e,o){var r=this&&this.__assign||function(){return(r=Object.assign||function(t){for(var e,o=1,r=arguments.length;o<r;o++)for(var i in e=arguments[o])Object.prototype.hasOwnProperty.call(e,i)&&(t[i]=e[i]);return t}).apply(this,arguments)};Object.defineProperty(e,"__esModule",{value:!0});var i=o(747),n=o(622),s=o(878),c=o(778),a=function(){function t(t){this.locals={};var e={name:"scaffold",templates:[],output:process.cwd(),createSubfolder:!0};this.config=r(r({},e),t);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=r(r({},o),t.locals)}return t.prototype.parseLocals=function(t){try{return c.compile(t,{noEscape:!0})(this.locals)}catch(e){return console.warn("Problem using Handlebars, returning unmodified content"),t}},t.prototype.fileList=function(t){for(var e=[],o=0,r=t;o<r.length;o++){var i=r[o],c=s.sync(i,{dot:!0}).map((function(t){return"/"==t[0]?t:n.join(process.cwd(),t)})),a=i.indexOf("*"),l=i;a>=0&&(l=i.slice(0,a-1));for(var f=0,u=c;f<u.length;f++){var p=u[f];e.push({base:l,file:p})}}return e},t.prototype.getFileContents=function(t){return console.log(i.readFileSync(t)),i.readFileSync(t).toString()},t.prototype.getOutputPath=function(t,e){var o;if("function"==typeof this.config.output)o=this.config.output(t,e);else{var r=this.config.output+(this.config.createSubfolder?"/"+this.config.name+"/":"/"),i=t.indexOf(e),n=t;i>=0&&(n=t.slice(i+e.length+1)),o=r+n}return this.parseLocals(o)},t.prototype.writeFile=function(t,e){var o=n.dirname(t);this.writeDirectory(o,t),console.info("Writing file:",t),i.writeFile(t,e,{encoding:"utf-8"},(function(t){if(t)throw t}))},t.prototype.run=function(){console.log("Generating scaffold: "+this.config.name+"...");var t,e=this.fileList(this.config.templates),o=0;console.log("Template files:",e);for(var r=0,n=e;r<n.length;r++){t=n[r];var s=void 0,c=void 0,a=void 0,l=void 0,f=void 0;try{if(o++,l=t.file,f=t.base,s=this.getOutputPath(l,f),i.lstatSync(l).isDirectory()){this.writeDirectory(s,l);continue}c=this.getFileContents(l),a=this.parseLocals(c),console.info("Writing:",{file:l,base:f,outputPath:s,outputContents:a.replace("\n","\\n")}),this.writeFile(s,a)}catch(t){throw console.error("Error while processing file:",{file:l,base:f,contents:c,outputPath:s,outputContents:a}),t}}if(!o)throw new Error("No files to scaffold!");console.log("Done")},t.prototype.writeDirectory=function(t,e){var o=n.dirname(t);i.existsSync(o)||this.writeDirectory(o,t),i.existsSync(t)||(console.info("Creating directory:",{file:e,outputPath:t}),i.mkdirSync(t))},t}();e.default=a},747:t=>{t.exports=require("fs")},878:t=>{t.exports=require("glob")},778:t=>{t.exports=require("handlebars")},622:t=>{t.exports=require("path")}},e={};return function o(r){if(e[r])return e[r].exports;var i=e[r]={exports:{}};return t[r].call(i.exports,i,i.exports,o),i.exports}(493)})()}));
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.library=e():t.library=e()}(global,(function(){return(()=>{"use strict";var t={493:function(t,e,o){var r=this&&this.__assign||function(){return(r=Object.assign||function(t){for(var e,o=1,r=arguments.length;o<r;o++)for(var i in e=arguments[o])Object.prototype.hasOwnProperty.call(e,i)&&(t[i]=e[i]);return t}).apply(this,arguments)},i=this&&this.__spreadArrays||function(){for(var t=0,e=0,o=arguments.length;e<o;e++)t+=arguments[e].length;var r=Array(t),i=0;for(e=0;e<o;e++)for(var n=arguments[e],s=0,a=n.length;s<a;s++,i++)r[i]=n[s];return r};Object.defineProperty(e,"__esModule",{value:!0});var n=o(747),s=o(622),a=o(878),l=o(778),f=function(){function t(t){this.locals={};var e={name:"scaffold",templates:[],output:process.cwd(),createSubfolder:!0,overwrite:!0,quiet:!1};this.config=r(r({},e),t);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=r(r({},o),t.locals)}return t.prototype.parseLocals=function(t){try{return l.compile(t,{noEscape:!0})(this.locals)}catch(e){return this.warn("Problem using Handlebars, returning unmodified content"),t}},t.prototype.fileList=function(t){for(var e=[],o=0,r=t;o<r.length;o++){var i=r[o],n=a.sync(i,{dot:!0}).map((function(t){return"/"==t[0]?t:s.join(process.cwd(),t)})),l=i.indexOf("*"),f=i;l>=0&&(f=i.slice(0,l-1));for(var c=0,p=n;c<p.length;c++){var u=p[c];e.push({base:f,file:u})}}return e},t.prototype.getFileContents=function(t){return this.log(n.readFileSync(t)),n.readFileSync(t).toString()},t.prototype.getOutputPath=function(t,e){var o;if("function"==typeof this.config.output)o=this.config.output(t,e,s.basename(t));else{var r=this.config.output+(this.config.createSubfolder?"/"+this.config.name+"/":"/"),i=t.indexOf(e),n=t;i>=0&&(n=t!==e?t.slice(i+e.length+1):s.basename(t)),o=r+n}return this.parseLocals(o)},t.prototype.writeFile=function(t,e){var o=s.dirname(t);this.writeDirectory(o,t),n.writeFile(t,e,{encoding:"utf-8"},(function(t){if(t)throw t}))},t.prototype.shouldWriteFile=function(t){var e,o,r="boolean"==typeof this.config.overwrite?this.config.overwrite:null===(o=(e=this.config).overwrite)||void 0===o?void 0:o.call(e,t);return!n.existsSync(t)||!1!==r},t.prototype.run=function(){this.log("Generating scaffold: "+this.config.name+"...");var t,e=this.fileList(this.config.templates),o=0;this.log("Template files:",e);for(var r=0,i=e;r<i.length;r++){t=i[r];var s=void 0,a=void 0,l=void 0,f=void 0,c=void 0;try{if(o++,f=t.file,c=t.base,s=this.getOutputPath(f,c),n.lstatSync(f).isDirectory()){this.writeDirectory(s,f);continue}a=this.getFileContents(f),l=this.parseLocals(a),this.shouldWriteFile(s)?(this.info("Writing:",{file:f,base:c,outputPath:s,outputContents:l.replace("\n","\\n")}),this.writeFile(s,l)):this.log("Skipping file "+s)}catch(t){throw this.error("Error while processing file:",{file:f,base:c,contents:a,outputPath:s,outputContents:l}),t}}if(!o)throw new Error("No files to scaffold!");this.log("Done")},t.prototype.writeDirectory=function(t,e){var o=s.dirname(t);n.existsSync(o)||this.writeDirectory(o,t),n.existsSync(t)||(this.info("Creating directory:",{file:e,outputPath:t}),n.mkdirSync(t))},t.prototype._log=function(t){for(var e=[],o=1;o<arguments.length;o++)e[o-1]=arguments[o];if(!this.config.quiet){var r=console[t];r.apply(void 0,e)}},t.prototype.log=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["log"],t))},t.prototype.info=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["info"],t))},t.prototype.warn=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["warn"],t))},t.prototype.error=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["error"],t))},t}();e.default=f},747:t=>{t.exports=require("fs")},878:t=>{t.exports=require("glob")},778:t=>{t.exports=require("handlebars")},622:t=>{t.exports=require("path")}},e={};return function o(r){if(e[r])return e[r].exports;var i=e[r]={exports:{}};return t[r].call(i.exports,i,i.exports,o),i.exports}(493)})()}));
 //# sourceMappingURL=index.js.map

dist/scaffold.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { IScaffold } from "./index.d";
 declare class SimpleScaffold {
     config: IScaffold.Config;
@@ -8,7 +9,13 @@ declare class SimpleScaffold {
     private getFileContents;
     private getOutputPath;
     private writeFile;
+    private shouldWriteFile;
     run(): void;
     private writeDirectory;
+    _log(method: keyof typeof console, ...args: any[]): void;
+    log(...args: any[]): void;
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
 }
 export default SimpleScaffold;

dist/test.js

@@ -1,2 +1,2 @@
-!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.library=e():t.library=e()}(global,(function(){return(()=>{"use strict";var t={493:function(t,e,o){var r=this&&this.__assign||function(){return(r=Object.assign||function(t){for(var e,o=1,r=arguments.length;o<r;o++)for(var n in e=arguments[o])Object.prototype.hasOwnProperty.call(e,n)&&(t[n]=e[n]);return t}).apply(this,arguments)};Object.defineProperty(e,"__esModule",{value:!0});var n=o(747),i=o(622),s=o(878),a=o(778),c=function(){function t(t){this.locals={};var e={name:"scaffold",templates:[],output:process.cwd(),createSubfolder:!0};this.config=r(r({},e),t);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=r(r({},o),t.locals)}return t.prototype.parseLocals=function(t){try{return a.compile(t,{noEscape:!0})(this.locals)}catch(e){return console.warn("Problem using Handlebars, returning unmodified content"),t}},t.prototype.fileList=function(t){for(var e=[],o=0,r=t;o<r.length;o++){var n=r[o],a=s.sync(n,{dot:!0}).map((function(t){return"/"==t[0]?t:i.join(process.cwd(),t)})),c=n.indexOf("*"),l=n;c>=0&&(l=n.slice(0,c-1));for(var u=0,p=a;u<p.length;u++){var f=p[u];e.push({base:l,file:f})}}return e},t.prototype.getFileContents=function(t){return console.log(n.readFileSync(t)),n.readFileSync(t).toString()},t.prototype.getOutputPath=function(t,e){var o;if("function"==typeof this.config.output)o=this.config.output(t,e);else{var r=this.config.output+(this.config.createSubfolder?"/"+this.config.name+"/":"/"),n=t.indexOf(e),i=t;n>=0&&(i=t.slice(n+e.length+1)),o=r+i}return this.parseLocals(o)},t.prototype.writeFile=function(t,e){var o=i.dirname(t);this.writeDirectory(o,t),console.info("Writing file:",t),n.writeFile(t,e,{encoding:"utf-8"},(function(t){if(t)throw t}))},t.prototype.run=function(){console.log("Generating scaffold: "+this.config.name+"...");var t,e=this.fileList(this.config.templates),o=0;console.log("Template files:",e);for(var r=0,i=e;r<i.length;r++){t=i[r];var s=void 0,a=void 0,c=void 0,l=void 0,u=void 0;try{if(o++,l=t.file,u=t.base,s=this.getOutputPath(l,u),n.lstatSync(l).isDirectory()){this.writeDirectory(s,l);continue}a=this.getFileContents(l),c=this.parseLocals(a),console.info("Writing:",{file:l,base:u,outputPath:s,outputContents:c.replace("\n","\\n")}),this.writeFile(s,c)}catch(t){throw console.error("Error while processing file:",{file:l,base:u,contents:a,outputPath:s,outputContents:c}),t}}if(!o)throw new Error("No files to scaffold!");console.log("Done")},t.prototype.writeDirectory=function(t,e){var o=i.dirname(t);n.existsSync(o)||this.writeDirectory(o,t),n.existsSync(t)||(console.info("Creating directory:",{file:e,outputPath:t}),n.mkdirSync(t))},t}();e.default=c},743:(t,e,o)=>{Object.defineProperty(e,"__esModule",{value:!0});var r=o(493),n=o(622).join(process.cwd(),"examples");new r.default({templates:[n+"/test-input/Component/**/*"],output:n+"/test-output/no-create-subpath",createSubfolder:!1,locals:{property:"myProp",value:'"value"'}}).run(),new r.default({templates:[n+"/test-input/Component/**/*"],output:n+"/test-output",locals:{property:"myProp",value:'"value"'}}).run()},747:t=>{t.exports=require("fs")},878:t=>{t.exports=require("glob")},778:t=>{t.exports=require("handlebars")},622:t=>{t.exports=require("path")}},e={};return function o(r){if(e[r])return e[r].exports;var n=e[r]={exports:{}};return t[r].call(n.exports,n,n.exports,o),n.exports}(743)})()}));
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.library=e():t.library=e()}(global,(function(){return(()=>{"use strict";var t={493:function(t,e,o){var r=this&&this.__assign||function(){return(r=Object.assign||function(t){for(var e,o=1,r=arguments.length;o<r;o++)for(var i in e=arguments[o])Object.prototype.hasOwnProperty.call(e,i)&&(t[i]=e[i]);return t}).apply(this,arguments)},i=this&&this.__spreadArrays||function(){for(var t=0,e=0,o=arguments.length;e<o;e++)t+=arguments[e].length;var r=Array(t),i=0;for(e=0;e<o;e++)for(var n=arguments[e],s=0,a=n.length;s<a;s++,i++)r[i]=n[s];return r};Object.defineProperty(e,"__esModule",{value:!0});var n=o(747),s=o(622),a=o(878),l=o(778),p=function(){function t(t){this.locals={};var e={name:"scaffold",templates:[],output:process.cwd(),createSubfolder:!0,overwrite:!0,quiet:!1};this.config=r(r({},e),t);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=r(r({},o),t.locals)}return t.prototype.parseLocals=function(t){try{return l.compile(t,{noEscape:!0})(this.locals)}catch(e){return this.warn("Problem using Handlebars, returning unmodified content"),t}},t.prototype.fileList=function(t){for(var e=[],o=0,r=t;o<r.length;o++){var i=r[o],n=a.sync(i,{dot:!0}).map((function(t){return"/"==t[0]?t:s.join(process.cwd(),t)})),l=i.indexOf("*"),p=i;l>=0&&(p=i.slice(0,l-1));for(var u=0,c=n;u<c.length;u++){var f=c[u];e.push({base:p,file:f})}}return e},t.prototype.getFileContents=function(t){return this.log(n.readFileSync(t)),n.readFileSync(t).toString()},t.prototype.getOutputPath=function(t,e){var o;if("function"==typeof this.config.output)o=this.config.output(t,e,s.basename(t));else{var r=this.config.output+(this.config.createSubfolder?"/"+this.config.name+"/":"/"),i=t.indexOf(e),n=t;i>=0&&(n=t!==e?t.slice(i+e.length+1):s.basename(t)),o=r+n}return this.parseLocals(o)},t.prototype.writeFile=function(t,e){var o=s.dirname(t);this.writeDirectory(o,t),n.writeFile(t,e,{encoding:"utf-8"},(function(t){if(t)throw t}))},t.prototype.shouldWriteFile=function(t){var e,o,r="boolean"==typeof this.config.overwrite?this.config.overwrite:null===(o=(e=this.config).overwrite)||void 0===o?void 0:o.call(e,t);return!n.existsSync(t)||!1!==r},t.prototype.run=function(){this.log("Generating scaffold: "+this.config.name+"...");var t,e=this.fileList(this.config.templates),o=0;this.log("Template files:",e);for(var r=0,i=e;r<i.length;r++){t=i[r];var s=void 0,a=void 0,l=void 0,p=void 0,u=void 0;try{if(o++,p=t.file,u=t.base,s=this.getOutputPath(p,u),n.lstatSync(p).isDirectory()){this.writeDirectory(s,p);continue}a=this.getFileContents(p),l=this.parseLocals(a),this.shouldWriteFile(s)?(this.info("Writing:",{file:p,base:u,outputPath:s,outputContents:l.replace("\n","\\n")}),this.writeFile(s,l)):this.log("Skipping file "+s)}catch(t){throw this.error("Error while processing file:",{file:p,base:u,contents:a,outputPath:s,outputContents:l}),t}}if(!o)throw new Error("No files to scaffold!");this.log("Done")},t.prototype.writeDirectory=function(t,e){var o=s.dirname(t);n.existsSync(o)||this.writeDirectory(o,t),n.existsSync(t)||(this.info("Creating directory:",{file:e,outputPath:t}),n.mkdirSync(t))},t.prototype._log=function(t){for(var e=[],o=1;o<arguments.length;o++)e[o-1]=arguments[o];if(!this.config.quiet){var r=console[t];r.apply(void 0,e)}},t.prototype.log=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["log"],t))},t.prototype.info=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["info"],t))},t.prototype.warn=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["warn"],t))},t.prototype.error=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["error"],t))},t}();e.default=p},743:(t,e,o)=>{Object.defineProperty(e,"__esModule",{value:!0});var r=o(493),i=o(622).join(process.cwd(),"examples");new r.default({templates:[i+"/test-input/Component/**/*"],output:i+"/test-output/no-create-subpath",createSubfolder:!1,locals:{property:"myProp",value:'"value"'}}).run(),new r.default({templates:[i+"/test-input/Component/**/*"],output:i+"/test-output",locals:{property:"myProp",value:'"value"'}}).run(),new r.default({templates:[i+"/test-input/Component/**/*"],output:function(t,e,o){return console.log({file:t,basedir:e,basename:o}),t},locals:{property:"myProp",value:'"value"'}}).run()},747:t=>{t.exports=require("fs")},878:t=>{t.exports=require("glob")},778:t=>{t.exports=require("handlebars")},622:t=>{t.exports=require("path")}},e={};return function o(r){if(e[r])return e[r].exports;var i=e[r]={exports:{}};return t[r].call(i.exports,i,i.exports,o),i.exports}(743)})()}));
 //# sourceMappingURL=test.js.map

examples/test-input/Component/Scaffold.tsx

@@ -0,0 +1,19 @@
+import * as React from 'react'
+import * as css from './Scaffold.css'
+
+class Scaffold extends React.Component<any> {
+  private myProp
+
+  constructor(props: any) {
+    super(props)
+    this.myProp = "value"
+  }
+
+  public render() {
+    return (
+      <div className={ css.Scaffold } />
+    )
+  }
+}
+
+export default Scaffold

index.d.ts

@@ -7,9 +7,13 @@ declare namespace IScaffold {
   export interface Config {
     name?: string
     templates: string[]
-    output: string | ((path: string, base: string) => string)
+    output:
+      | string
+      | ((fullPath: string, basedir: string, basename: string) => string)
     locals?: Locals
     createSubfolder?: boolean
+    overwrite?: boolean | ((path: string) => boolean)
+    quiet?: boolean
   }
 
   export interface Locals {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-scaffold",
-  "version": "0.6.1",
+  "version": "0.7.2",
   "description": "Create files based on templates",
   "repository": "https://github.com/chenasraf/simple-scaffold.git",
   "author": "Chen Asraf <inbox@casraf.com>",

scaffold.ts

@@ -14,11 +14,14 @@ class SimpleScaffold {
       templates: [],
       output: process.cwd(),
       createSubfolder: true,
+      overwrite: true,
+      quiet: false,
     }
 
     this.config = { ...DefaultConfig, ...config }
 
     const DefaultLocals = {
+      // TODO improve
       Name: this.config.name![0].toUpperCase() + this.config.name!.slice(1),
       name: this.config.name![0].toLowerCase() + this.config.name!.slice(1),
     }
@@ -33,7 +36,7 @@ class SimpleScaffold {
       })
       return template(this.locals)
     } catch (e) {
-      console.warn("Problem using Handlebars, returning unmodified content")
+      this.warn("Problem using Handlebars, returning unmodified content")
       return text
     }
   }
@@ -57,7 +60,7 @@ class SimpleScaffold {
   }
 
   private getFileContents(filePath: string): string {
-    console.log(fs.readFileSync(filePath))
+    this.log(fs.readFileSync(filePath))
     return fs.readFileSync(filePath).toString()
   }
 
@@ -65,7 +68,7 @@ class SimpleScaffold {
     let out: string
 
     if (typeof this.config.output === "function") {
-      out = this.config.output(file, basePath)
+      out = this.config.output(file, basePath, path.basename(file))
     } else {
       const outputDir =
         this.config.output +
@@ -73,7 +76,11 @@ class SimpleScaffold {
       const idx = file.indexOf(basePath)
       let relativeFilePath = file
       if (idx >= 0) {
-        relativeFilePath = file.slice(idx + basePath.length + 1)
+        if (file !== basePath) {
+          relativeFilePath = file.slice(idx + basePath.length + 1)
+        } else {
+          relativeFilePath = path.basename(file)
+        }
       }
       out = outputDir + relativeFilePath
     }
@@ -84,7 +91,6 @@ class SimpleScaffold {
   private writeFile(filePath: string, fileContents: string): void {
     const baseDir = path.dirname(filePath)
     this.writeDirectory(baseDir, filePath)
-    console.info("Writing file:", filePath)
     fs.writeFile(filePath, fileContents, { encoding: "utf-8" }, (err) => {
       if (err) {
         throw err
@@ -92,14 +98,24 @@ class SimpleScaffold {
     })
   }
 
+  private shouldWriteFile(filePath: string) {
+    const overwrite =
+      typeof this.config.overwrite === "boolean"
+        ? this.config.overwrite
+        : this.config.overwrite?.(filePath)
+    const exists = fs.existsSync(filePath)
+
+    return !exists || overwrite !== false
+  }
+
   public run(): void {
-    console.log(`Generating scaffold: ${this.config.name}...`)
+    this.log(`Generating scaffold: ${this.config.name}...`)
     const templates = this.fileList(this.config.templates)
 
     let fileConf,
       count = 0
 
-    console.log("Template files:", templates)
+    this.log("Template files:", templates)
     for (fileConf of templates) {
       let outputPath, contents, outputContents, file, base
       try {
@@ -113,16 +129,19 @@ class SimpleScaffold {
         }
         contents = this.getFileContents(file)
         outputContents = this.parseLocals(contents)
-
-        console.info("Writing:", {
-          file,
-          base,
-          outputPath,
-          outputContents: outputContents.replace("\n", "\\n"),
-        })
-        this.writeFile(outputPath, outputContents)
+        if (this.shouldWriteFile(outputPath)) {
+          this.info("Writing:", {
+            file,
+            base,
+            outputPath,
+            outputContents: outputContents.replace("\n", "\\n"),
+          })
+          this.writeFile(outputPath, outputContents)
+        } else {
+          this.log(`Skipping file ${outputPath}`)
+        }
       } catch (e) {
-        console.error("Error while processing file:", {
+        this.error("Error while processing file:", {
           file,
           base,
           contents,
@@ -137,7 +156,7 @@ class SimpleScaffold {
       throw new Error("No files to scaffold!")
     }
 
-    console.log("Done")
+    this.log("Done")
   }
 
   private writeDirectory(outputPath: string, file: any): void {
@@ -146,13 +165,34 @@ class SimpleScaffold {
       this.writeDirectory(parent, outputPath)
     }
     if (!fs.existsSync(outputPath)) {
-      console.info("Creating directory:", {
+      this.info("Creating directory:", {
         file,
         outputPath,
       })
       fs.mkdirSync(outputPath)
     }
   }
+
+  _log(method: keyof typeof console, ...args: any[]): void {
+    if (this.config.quiet) {
+      return
+    }
+    const fn = console[method] as (...a: any[]) => void
+    fn(...args)
+  }
+
+  log(...args: any[]): void {
+    this._log("log", ...args)
+  }
+  info(...args: any[]): void {
+    this._log("info", ...args)
+  }
+  warn(...args: any[]): void {
+    this._log("warn", ...args)
+  }
+  error(...args: any[]): void {
+    this._log("error", ...args)
+  }
 }
 
 export default SimpleScaffold

test.ts

@@ -1,23 +1,35 @@
-import SimpleScaffold from './scaffold'
-import * as path from 'path'
+import SimpleScaffold from "./scaffold"
+import * as path from "path"
 
-const templateDir = path.join(process.cwd(), 'examples')
+const templateDir = path.join(process.cwd(), "examples")
 
 new SimpleScaffold({
-  templates: [templateDir + '/test-input/Component/**/*'],
-  output: templateDir + '/test-output/no-create-subpath',
+  templates: [templateDir + "/test-input/Component/**/*"],
+  output: templateDir + "/test-output/no-create-subpath",
   createSubfolder: false,
   locals: {
-    property: 'myProp',
-    value: '"value"'
-  }
+    property: "myProp",
+    value: '"value"',
+  },
 }).run()
 
 new SimpleScaffold({
-  templates: [templateDir + '/test-input/Component/**/*'],
-  output: templateDir + '/test-output',
+  templates: [templateDir + "/test-input/Component/**/*"],
+  output: templateDir + "/test-output",
   locals: {
-    property: 'myProp',
-    value: '"value"'
-  }
+    property: "myProp",
+    value: '"value"',
+  },
+}).run()
+
+new SimpleScaffold({
+  templates: [templateDir + "/test-input/Component/**/*"],
+  output: (file, basedir, basename) => {
+    console.log({ file, basedir, basename })
+    return file
+  },
+  locals: {
+    property: "myProp",
+    value: '"value"',
+  },
 }).run()

yarn.lock

@@ -2454,9 +2454,9 @@ handle-thing@^2.0.0:
   integrity sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==
 
 handlebars@^4.1.0:
-  version "4.7.6"
-  resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.6.tgz#d4c05c1baf90e9945f77aa68a7a219aa4a7df74e"
-  integrity sha512-1f2BACcBfiwAfStCKZNrUCgqNZkGsAT7UM3kkYtXuLo0KnaVfjKOyf7PRzB6++aK9STyT1Pd2ZCPe3EGOXleXA==
+  version "4.7.7"
+  resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.7.tgz#9ce33416aad02dbd6c8fafa8240d5d98004945a1"
+  integrity sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==
   dependencies:
     minimist "^1.2.5"
     neo-async "^2.6.0"
@@ -2532,9 +2532,9 @@ has@^1.0.3:
     function-bind "^1.1.1"
 
 hosted-git-info@^2.1.4:
-  version "2.8.8"
-  resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-2.8.8.tgz#7539bd4bc1e0e0a895815a2e0262420b12858488"
-  integrity sha512-f/wzC2QaWBs7t9IYqB4T3sR1xviIViXJRJTWBlx2Gf3g0Xi5vI7Yy4koXQ1c9OYDGHN9sBy1DQ2AB8fqZBWhUg==
+  version "2.8.9"
+  resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-2.8.9.tgz#dffc0bf9a21c02209090f2aa69429e1414daf3f9"
+  integrity sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==
 
 hpack.js@^2.1.6:
   version "2.1.6"
@@ -3591,9 +3591,9 @@ lodash.sortby@^4.7.0:
   integrity sha1-7dFMgk4sycHgsKG0K7UhBRakJDg=
 
 lodash@^4.17.11, lodash@^4.17.14, lodash@^4.17.19:
-  version "4.17.20"
-  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.20.tgz#b44a9b6297bcb698f1c51a3545a2b3b368d59c52"
-  integrity sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA==
+  version "4.17.21"
+  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c"
+  integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==
 
 loglevel@^1.6.8:
   version "1.7.1"
@@ -5351,9 +5351,9 @@ urix@^0.1.0:
   integrity sha1-2pN/emLiH+wf0Y1Js1wpNQZ6bHI=
 
 url-parse@^1.4.3, url-parse@^1.4.7:
-  version "1.4.7"
-  resolved "https://registry.yarnpkg.com/url-parse/-/url-parse-1.4.7.tgz#a8a83535e8c00a316e403a5db4ac1b9b853ae278"
-  integrity sha512-d3uaVyzDB9tQoSXFvuSUNFibTd9zxd2bkVrDRvF5TmvWWQwqE4lgYJ5m+x1DbecWkw+LK4RNl2CU1hHuOKPVlg==
+  version "1.5.1"
+  resolved "https://registry.yarnpkg.com/url-parse/-/url-parse-1.5.1.tgz#d5fa9890af8a5e1f274a2c98376510f6425f6e3b"
+  integrity sha512-HOfCOUJt7iSYzEx/UqgtwKRMC6EU91NFhsCHMv9oM03VJcVo2Qrp8T8kI9D7amFf1cu+/3CEhgb3rF9zL7k85Q==
   dependencies:
     querystringify "^2.1.1"
     requires-port "^1.0.0"