feat(cli): add local runner helper and better UX for CLI

Author: skovy

examples/basic/README.md

@@ -12,6 +12,6 @@ yarn ts-node ./lib/cli.ts "examples/basic/**/*.scss" --includePaths examples/bas
 ```
 
 - The glob pattern is wrapped in quotes to pass it as a string and avoid executing.
-- `includePaths` with `examples/basic/core` so that `@import 'variables';` is found.
+- `includePaths` with `examples/basic/core` so that `@import 'variables'` is found.
 - `aliases` with `~alias: variables` meaning any `@import '~alias'` resolves to `@import 'variables'`.
 - No file will be output for `variables.scss` since there are no classes.

lib/cli.ts

@@ -6,13 +6,37 @@ import { main } from "./main";
 const nameFormatDefault: NameFormat = "camel";
 
 const { _: patterns, includePaths, aliases, nameFormat } = yargs
-  .demandOption("_")
-  .option("aliases", { coerce: (obj): Aliases => obj, alias: "a" })
+  .usage(
+    "Generate .scss.d.ts from CSS module .scss files.\nUsage: $0 <glob pattern> [options]"
+  )
+  .example(
+    "$0 src/**/*.scss",
+    "All .scss files at any level in the src directoy"
+  )
+  .example(
+    "$0 src/**/*.scss --includePaths src/core src/variables",
+    'Search the "core" and "variables" directory when resolving imports'
+  )
+  .example(
+    "$0 src/**/*.scss --aliases.~name variables",
+    'Replace all imports for "~name" with "variables"'
+  )
+  .demandCommand(1)
+  .option("aliases", {
+    coerce: (obj): Aliases => obj,
+    alias: "a",
+    describe: "Alias any import to any other value."
+  })
   .option("nameFormat", {
     choices: NAME_FORMATS,
     default: nameFormatDefault,
-    alias: "n"
+    alias: "n",
+    describe: "The name format that should be used to transform class names."
   })
-  .option("includePaths", { array: true, string: true }).argv;
+  .option("includePaths", {
+    array: true,
+    string: true,
+    describe: "Additional paths to include when trying to resolve imports."
+  }).argv;
 
 main(patterns[0], { includePaths, aliases, nameFormat });

package.json

@@ -6,7 +6,8 @@
   "author": "Spencer Miskoviak <smiskoviak@gmail.com>",
   "license": "MIT",
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "tsm": "ts-node ./lib/cli.ts"
   },
   "devDependencies": {
     "@types/camelcase": "^4.1.0",