remove types from package.json

README.md

@@ -22,6 +22,8 @@ npx simple-scaffold <...args>
 ```plaintext
 Usage: simple-scaffold [options]
 
+Create structured files based on templates.
+
 Options:
 
   --help|-h                 Display help information
@@ -35,7 +37,8 @@ Options:
 
   --templates|-t            Template files to use as input. You may provide multiple
                             files, each of which can be a relative or absolute path, or a glob
-                            pattern for multiple file matching easily.
+                            pattern for multiple file matching easily. (default:
+                            )
 
   --overwrite|-w            Enable to override output files, even if they already exist.
                             (default: false)
@@ -43,25 +46,30 @@ Options:
   --data|-d                 Add custom data to the templates. By default, only your app
                             name is included.
 
-  --create-sub-folder|-s    Create subfolder with the input name (default: false)
+  --create-sub-folder|-s    Create subfolder with the input name (default:
+                            false)
 
-  --quiet|-q                Suppress output logs (Same as --verbose 0) (default: false)
+  --quiet|-q                Suppress output logs (Same as --verbose 0)
+                            (default: false)
 
-  --verbose|-v              Determine amount of logs to display. The values are: 0 (none)
-                            | 1 (debug) | 2 (info) | 3 (warn) | 4 (error). The provided level
-                            will display messages of the same level or higher.
+  --verbose|-v              Determine amount of logs to display. The values are: 0
+                            (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error). The
+                            provided level will display messages of the same level or higher.
                             (default: 2)
 
   --dry-run|-dr             Don't emit files. This is good for testing your scaffolds and
                             making sure they don't fail, without having to write actual file
-                            contents or create directories. (default: false)
+                            contents or create directories. (default:
+                            false)
 ```
 
 You can also add this as a script in your `package.json`:
 
 ```json
 {
+  ...
   "scripts": {
+    ...
     "scaffold": "yarn simple-scaffold --templates scaffolds/component/**/* --output src/components --data '{\"myProp\": \"propName\", \"myVal\": \"123\"}'"
   }
 }
@@ -93,7 +101,7 @@ function for each input file to output into a dynamic path:
 ```javascript
 config.output = (fullPath, baseDir, baseName) => {
   console.log({ fullPath, baseDir, baseName })
-  return [baseDir, baseName].join(path.sep)
+  return path.resolve(baseDir, baseName)
 }
 ```
 
@@ -121,6 +129,8 @@ Your `data` will be pre-populated with the following:
 > Any `data` you add in the config will be available for use with their names wrapped in
 > `{{` and `}}`.
 
+#### Helpers
+
 Simple-Scaffold provides some built-in text transformation filters usable by handleBars.
 
 For example, you may use `{{ snakeCase name }}` inside a template file or filename, and it will
@@ -147,7 +157,8 @@ Here are the built-in helpers available for use:
 simple-scaffold MyComponent \
     -t project/scaffold/**/* \
     -o src/components \
-    -d '{"className":"myClassName"}'
+    -d '{"className": "myClassName"}'
+    MyComponent
 ```
 
 ### Example Scaffold Input
@@ -188,7 +199,7 @@ module.exports = class {{Name}} extends React.Component {
     - ...
 ```
 
-With `createSubfolder = false`:
+With `createSubFolder = false`:
 
 ```plaintext
 - project

package.json

@@ -1,13 +1,12 @@
 {
   "name": "simple-scaffold",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-alpha.9",
   "description": "Create files based on templates",
   "repository": "https://github.com/chenasraf/simple-scaffold.git",
   "author": "Chen Asraf <inbox@casraf.com>",
   "license": "MIT",
   "main": "index.js",
   "bin": "cmd.js",
-  "types": "types.d.ts",
   "scripts": {
     "clean": "rm -rf dist/",
     "build": "yarn clean && tsc && chmod -R +x ./dist && cp ./package.json ./dist/ && cp ./README.md ./dist/",
@@ -20,10 +19,11 @@
   },
   "dependencies": {
     "args": "^5.0.1",
+    "chalk": "^4.1.2",
     "glob": "^7.1.3",
     "handlebars": "^4.7.7",
     "lodash": "^4.17.21",
-    "massarg": "^0.1.2",
+    "massarg": "^1.0.3",
     "util.promisify": "^1.1.1"
   },
   "devDependencies": {

src/cmd.ts

@@ -1,84 +1,2 @@
-import Scaffold from "./scaffold"
-import massarg from "massarg"
-import { ScaffoldCmdConfig } from "./types"
-import { LogLevel } from "."
-
-massarg<ScaffoldCmdConfig & { help: boolean; extras: string[] }>()
-  .main(Scaffold)
-  .option({
-    name: "name",
-    aliases: ["n"],
-    isDefault: true,
-    description:
-      "Name to be passed to the generated files. {{name}} and {{Name}} inside contents and file names will be replaced accordingly.",
-  })
-  .option({
-    name: "output",
-    aliases: ["o"],
-    description:
-      "Path to output to. If --create-sub-folder is enabled, the subfolder will be created inside this path.",
-  })
-  .option({
-    name: "templates",
-    aliases: ["t"],
-    description:
-      "Template files to use as input. You may provide multiple files, each of which can be a relative or absolute path, " +
-      "or a glob pattern for multiple file matching easily.",
-    defaultValue: [],
-    array: true,
-  })
-  .option({
-    aliases: ["w"],
-    name: "overwrite",
-    description: "Enable to override output files, even if they already exist.",
-    defaultValue: false,
-    boolean: true,
-  })
-  .option({
-    aliases: ["d"],
-    name: "data",
-    description: "Add custom data to the templates. By default, only your app name is included.",
-    parse: (v) => JSON.parse(v),
-  })
-  .option({
-    aliases: ["s"],
-    name: "create-sub-folder",
-    description: "Create subfolder with the input name",
-    defaultValue: false,
-    boolean: true,
-  })
-  .option({
-    aliases: ["q"],
-    name: "quiet",
-    description: "Suppress output logs (Same as --verbose 0)",
-    defaultValue: false,
-    boolean: true,
-  })
-  .option({
-    aliases: ["v"],
-    name: "verbose",
-    description:
-      "Determine amount of logs to display. The values are: 0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error). The provided level will display messages of the same level or higher.",
-    defaultValue: LogLevel.Info,
-    parse: Number,
-  })
-  .option({
-    aliases: ["dr"],
-    name: "dry-run",
-    description:
-      "Don't emit files. This is good for testing your scaffolds and making sure they " +
-      "don't fail, without having to write actual file contents or create directories.",
-    defaultValue: false,
-    boolean: true,
-  })
-  // .example({
-  //   input: `yarn cmd -t examples/test-input/Component -o examples/test-output -d '{"property":"myProp","value":"10"}'`,
-  //   description: "Usage",
-  //   output: "",
-  // })
-  .help({
-    binName: "simple-scaffold",
-    useGlobalColumns: true,
-    usageExample: "[options]",
-  })
-  .parse()
+import { parseCliArgs } from "./cmd_util"
+parseCliArgs()

src/cmd_util.ts

@@ -0,0 +1,89 @@
+import massarg from "massarg"
+import chalk from "chalk"
+import { LogLevel, ScaffoldCmdConfig } from "./types"
+import { Scaffold } from "./scaffold"
+
+export function parseCliArgs(args = process.argv.slice(2)) {
+  return (
+    massarg<ScaffoldCmdConfig & { help: boolean; extras: string[] }>()
+      .main(Scaffold)
+      .option({
+        name: "name",
+        aliases: ["n"],
+        isDefault: true,
+        description:
+          "Name to be passed to the generated files. {{name}} and {{Name}} inside contents and file names will be replaced accordingly.",
+      })
+      .option({
+        name: "output",
+        aliases: ["o"],
+        description:
+          "Path to output to. If --create-sub-folder is enabled, the subfolder will be created inside this path.",
+      })
+      .option({
+        name: "templates",
+        aliases: ["t"],
+        description:
+          "Template files to use as input. You may provide multiple files, each of which can be a relative or absolute path, " +
+          "or a glob pattern for multiple file matching easily.",
+        defaultValue: [],
+        array: true,
+      })
+      .option({
+        aliases: ["w"],
+        name: "overwrite",
+        description: "Enable to override output files, even if they already exist.",
+        defaultValue: false,
+        boolean: true,
+      })
+      .option({
+        aliases: ["d"],
+        name: "data",
+        description: "Add custom data to the templates. By default, only your app name is included.",
+        parse: (v) => JSON.parse(v),
+      })
+      .option({
+        aliases: ["s"],
+        name: "create-sub-folder",
+        description: "Create subfolder with the input name",
+        defaultValue: false,
+        boolean: true,
+      })
+      .option({
+        aliases: ["q"],
+        name: "quiet",
+        description: "Suppress output logs (Same as --verbose 0)",
+        defaultValue: false,
+        boolean: true,
+      })
+      .option({
+        aliases: ["v"],
+        name: "verbose",
+        description: `Determine amount of logs to display. The values are: ${chalk.bold`0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error)`}. The provided level will display messages of the same level or higher.`,
+        defaultValue: LogLevel.Info,
+        parse: Number,
+      })
+      .option({
+        aliases: ["dr"],
+        name: "dry-run",
+        description:
+          "Don't emit files. This is good for testing your scaffolds and making sure they " +
+          "don't fail, without having to write actual file contents or create directories.",
+        defaultValue: false,
+        boolean: true,
+      })
+      // .example({
+      //   input: `yarn cmd -t examples/test-input/Component -o examples/test-output -d '{"property":"myProp","value":"10"}'`,
+      //   description: "Usage",
+      //   output: "",
+      // })
+      .help({
+        binName: "simple-scaffold",
+        useGlobalColumns: true,
+        usageExample: "[options]",
+        header: "Create structured files based on templates.",
+        footer: `Copyright © Chen Asraf 2021\nNPM: ${chalk.underline`https://npmjs.com/package/massarg`}\nGitHub: ${chalk.underline`https://github.com/chenasraf/massarg`}`,
+      })
+      .parse(args)
+  )
+}

src/utils.ts

@@ -28,7 +28,7 @@ export function handleErr(err: NodeJS.ErrnoException | null) {
 }
 
 export function log(options: ScaffoldConfig, level: LogLevel, ...obj: any[]) {
-  if (options.quiet || (options.verbose ?? LogLevel.Info) > level) {
+  if (options.quiet || options.verbose === LogLevel.None || (options.verbose ?? LogLevel.Info) > level) {
     return
   }
   const levelColor: Record<LogLevel, keyof typeof chalk> = {

yarn.lock

@@ -940,6 +940,14 @@ chalk@^4.0.0, chalk@^4.1.1:
     ansi-styles "^4.1.0"
     supports-color "^7.1.0"
 
+chalk@^4.1.2:
+  version "4.1.2"
+  resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01"
+  integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==
+  dependencies:
+    ansi-styles "^4.1.0"
+    supports-color "^7.1.0"
+
 char-regex@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/char-regex/-/char-regex-1.0.2.tgz#d744358226217f981ed58f479b1d6bcc29545dcf"
@@ -2153,10 +2161,10 @@ makeerror@1.0.x:
   dependencies:
     tmpl "1.0.x"
 
-massarg@^0.1.2:
-  version "0.1.2"
-  resolved "https://registry.yarnpkg.com/massarg/-/massarg-0.1.2.tgz#f298741318172be14f3d2b701329fbe10eff41bb"
-  integrity sha512-gpFIjsvOoqyQnrqNDytQXPljOGlX5lvJFGYzAIqjxDqiSZwHOvz+/YfjtzrFvokfYsk0uZbE/XOH4LVRiu/1cg==
+massarg@^1.0.3:
+  version "1.0.3"
+  resolved "https://registry.yarnpkg.com/massarg/-/massarg-1.0.3.tgz#228cf2d84896924b6b12021ea23ed9a9077e15b7"
+  integrity sha512-LYb4XvAQ+PbBClyfkn9B4JtfwycfpnOnGIznALt9YLnrmQaCcXXJBQsG5SA/2w+bmLOeYRoR9GqqFLyaniCn9g==
   dependencies:
     chalk "^4.1.1"
     lodash "^4.17.21"