feat(options): Group command specific options (#147)

jcs090218 · web-flow · commit 90cedc556261 · 2023-03-06T15:10:57.000-08:00
* feat(options): Group command specific options

* push rest
diff --git a/cmds/checker/check-eask.js b/cmds/checker/check-eask.js
@@ -26,15 +26,18 @@ exports.builder = {
     description: 'specify Eask-files for checker to lint',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
   output: {
     description: 'Output result to a file',
     alias: 'o',
     type: 'string',
+    group: TITLE_CMD_OPTION,
   },
   json: {
     description: 'Output lint result in JSON format',
     type: 'boolean',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/clean/dist.js b/cmds/clean/dist.js
@@ -27,6 +27,7 @@ exports.builder = {
     requiresArg: false,
     alias: 'dest',
     type: 'string',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/compile.js b/cmds/core/compile.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'specify files to byte-compile',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/concat.js b/cmds/core/concat.js
@@ -26,17 +26,20 @@ exports.builder = {
     description: 'specify files to concatenate',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
   destination: {
     description: 'optional output destination',
     requiresArg: true,
     alias: 'dest',
     type: 'string',
+    group: TITLE_CMD_OPTION,
   },
   output: {
     description: 'Output result to a file',
     alias: 'o',
     type: 'string',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/eval.js b/cmds/core/eval.js
@@ -29,6 +29,7 @@ exports.builder = {
     description: 'lisp form',
     requiresArg: false,
     type: 'string',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/exec-path.js b/cmds/core/exec-path.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'patterns you want to search (regex)',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/files.js b/cmds/core/files.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'patterns you want to search (wildcard)',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/init.js b/cmds/core/init.js
@@ -30,11 +30,13 @@ exports.builder = {
     description: 'build from an existing package',
     requiresArg: true,
     type: 'string',
+    group: TITLE_CMD_OPTION,
   },
   files: {
     description: 'files to use with `from` flag',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/install.js b/cmds/core/install.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'packages to install',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/list.js b/cmds/core/list.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'dependency depth level to print',
     requiresArg: true,
     type: 'number',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/load-path.js b/cmds/core/load-path.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'patterns you want to search (regex)',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/load.js b/cmds/core/load.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'files to load',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/package.js b/cmds/core/package.js
@@ -27,6 +27,7 @@ exports.builder = {
     requiresArg: false,
     alias: 'dest',
     type: 'string',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/reinstall.js b/cmds/core/reinstall.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'packages to reinstall',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/run.js b/cmds/core/run.js
@@ -29,6 +29,7 @@ exports.builder = {
     description: 'specify scripts to run',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/search.js b/cmds/core/search.js
@@ -26,11 +26,13 @@ exports.builder = {
     description: 'queries to search packages',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
   depth: {
     description: 'dependency depth level to print',
     requiresArg: true,
     type: 'number',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/uninstall.js b/cmds/core/uninstall.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'packages to uninstall',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/core/upgrade.js b/cmds/core/upgrade.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'packages to upgrade',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/create/elpa.js b/cmds/create/elpa.js
@@ -30,6 +30,7 @@ exports.builder = {
     description: 'new ELPA name',
     requiresArg: false,
     type: 'string',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/create/package.js b/cmds/create/package.js
@@ -30,6 +30,7 @@ exports.builder = {
     description: 'new project name',
     requiresArg: false,
     type: 'string',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/generate/workflow/github.js b/cmds/generate/workflow/github.js
@@ -23,9 +23,10 @@ exports.command = ['github [file]'];
 exports.desc = 'Generate GitHub Actions workflow yaml file';
 exports.builder = {
   file: {
-    description: 'name of the test file, default is set to test.yml',
+    description: 'name of the test file; the default is `test.yml`',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/link/add.js b/cmds/link/add.js
@@ -26,11 +26,13 @@ exports.builder = {
     description: 'name of the link',
     requiresArg: true,
     type: 'string',
+    group: TITLE_CMD_OPTION,
   },
   path: {
     description: 'location (target package) where you want to link',
     requiresArg: true,
     type: 'string',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/link/delete.js b/cmds/link/delete.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'name of the link, accept array',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/lint/checkdoc.js b/cmds/lint/checkdoc.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'files you want checkdoc to run on',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/lint/declare.js b/cmds/lint/declare.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'files you want check-declare to run on',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/lint/elint.js b/cmds/lint/elint.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'files you want elint to run on',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/lint/elisp-lint.js b/cmds/lint/elisp-lint.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'files you want elisp-lint to run on',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/lint/elsa.js b/cmds/lint/elsa.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'files you want elsa to run on',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/lint/indent.js b/cmds/lint/indent.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'files you want indent-lint to run on',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/lint/package.js b/cmds/lint/package.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'specify files to do package lint',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/lint/regexps.js b/cmds/lint/regexps.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'files you want relint to run on',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/test/activate.js b/cmds/test/activate.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'files to load after package activation',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/test/buttercup.js b/cmds/test/buttercup.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'files you want buttercup to run on',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/test/ert-runner.js b/cmds/test/ert-runner.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'specify files to do ert tests',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/cmds/test/ert.js b/cmds/test/ert.js
@@ -26,6 +26,7 @@ exports.builder = {
     description: 'specify files to do ert tests',
     requiresArg: false,
     type: 'array',
+    group: TITLE_CMD_OPTION,
   },
 };
 
diff --git a/src/env.js b/src/env.js
@@ -28,3 +28,6 @@ global.IS_PKG = path.basename(process.execPath).startsWith('eask');
 global.GITHUB_ACTIONS = (process.env.GITHUB_WORKSPACE !== undefined);
 
 global.EASK_HOMEDIR = os.homedir().replace(/\\/g, '/') + '/.eask/';
+
+/* Global Variables */
+global.TITLE_CMD_OPTION = 'Command Options:';
