Implement yargs, add no-badges argument (#84)

* Implement yargs, add no-badges argument

* Add docs

* Fix some code style

Author: sgb-io

README.md

@@ -129,6 +129,8 @@ By default, codehawk-cli generates 2 badges (in `generated/*.svg`) when called v
 
 A higher score is better (simpler, more maintainable code).
 
+To avoid generating badges, use the `--no-badge` option.
+
 ## Complexity Metrics
 
 Codehawk gathers various complexity metrics, including:

generated/avg-maintainability.svg

@@ -36,14 +36,16 @@
     "is-dotdir": "^1.0.1",
     "is-dotfile": "^2.0.0",
     "slash": "^3.0.0",
-    "typhonjs-escomplex": "^0.1.0"
+    "typhonjs-escomplex": "^0.1.0",
+    "yargs": "^16.2.0"
   },
   "devDependencies": {
     "@types/babel__core": "^7.1.8",
     "@types/is-dotdir": "^1.0.0",
     "@types/is-dotfile": "^2.0.0",
     "@types/jest": "^26.0.19",
     "@types/node": "^14.0.11",
+    "@types/yargs": "^15.0.12",
     "@typescript-eslint/eslint-plugin": "3",
     "@typescript-eslint/parser": "^3.3.0",
     "eslint": "7",

package.json

@@ -3,22 +3,44 @@
 import { analyzeProject, generateBadge } from './codehawk'
 import { formatResultsAsTable } from './cli-util'
 
-// Sample CLI usage: `codehawk src`
-const scanDir = process.argv.slice(2)[0]
-
-if (scanDir && scanDir !== '') {
-  const output = analyzeProject(`${process.cwd()}/${scanDir}`, true)
-  const formattedAsTable = output.resultsList.slice(0, 25)
-  console.log(formatResultsAsTable(formattedAsTable))
-
-  try {
-    console.log('[codehawk-cli] Generating maintainability badge...')
-    generateBadge(output.summary)
-  } catch (e) {
-    console.warn('[codehawk-cli] Badge was not generated')
+import yargs from 'yargs'
+// @types/yargs is missing typings for yargs/helpers (see https://github.com/yargs/yargs/issues/1816)
+// @ts-expect-error
+import { hideBin } from 'yargs/helpers'
+
+const run = (scanDir: string, createBadge: boolean): void => {
+  if (scanDir && scanDir !== '') {
+    const output = analyzeProject(`${process.cwd()}/${scanDir}`, true)
+    const formattedAsTable = output.resultsList.slice(0, 25)
+    console.log(formatResultsAsTable(formattedAsTable))
+
+    if (!createBadge) {
+      return
+    }
+
+    try {
+      console.log('[codehawk-cli] Generating maintainability badge...')
+      generateBadge(output.summary)
+      console.log('[codehawk-cli] Badge was generated')
+    } catch (e) {
+      console.warn('[codehawk-cli] Badge was not generated')
+    }
+  } else {
+    console.error(
+      '[codehawk-cli] Unable to analyze project, please ensure you provide a directory e.g. "codehawk src"'
+    )
   }
-} else {
-  console.error(
-    '[codehawk-cli] Unable to analyze project, please ensure you provide a directory e.g. "codehawk src"'
-  )
 }
+
+const rawArgs = hideBin(process.argv)
+
+const argv = yargs(rawArgs)
+  .demandCommand(1, 'Please provide a directory argument')
+  .describe('no-badge', 'Exclude generated badges')
+  .usage('Usage: codehawk [dir] <options>')
+  .epilog(
+    'For help, file an issue at https://github.com/sgb-io/codehawk-cli/issues'
+  )
+  .help('help').argv
+
+run(argv._[0] as string, argv.badge !== false)

src/index.ts

@@ -756,6 +756,13 @@
   dependencies:
     "@types/yargs-parser" "*"
 
+"@types/yargs@^15.0.12":
+  version "15.0.12"
+  resolved "https://registry.yarnpkg.com/@types/yargs/-/yargs-15.0.12.tgz#6234ce3e3e3fa32c5db301a170f96a599c960d74"
+  integrity sha512-f+fD/fQAo3BCbCDlrUpznF1A5Zp9rB0noS5vnoormHSIPFKL0Z2DcUJ3Gxp5ytH4uLRNxy7AwYUC9exZzqGMAw==
+  dependencies:
+    "@types/yargs-parser" "*"
+
 "@typescript-eslint/eslint-plugin@3":
   version "3.3.0"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-3.3.0.tgz#89518e5c5209a349bde161c3489b0ec187ae5d37"
@@ -1422,6 +1429,15 @@ cliui@^6.0.0:
     strip-ansi "^6.0.0"
     wrap-ansi "^6.2.0"
 
+cliui@^7.0.2:
+  version "7.0.4"
+  resolved "https://registry.yarnpkg.com/cliui/-/cliui-7.0.4.tgz#a0265ee655476fc807aea9df3df8df7783808b4f"
+  integrity sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==
+  dependencies:
+    string-width "^4.2.0"
+    strip-ansi "^6.0.0"
+    wrap-ansi "^7.0.0"
+
 clone-response@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/clone-response/-/clone-response-1.0.2.tgz#d1dc973920314df67fbeb94223b4ee350239e96b"
@@ -1871,6 +1887,11 @@ es-to-primitive@^1.2.1:
     is-date-object "^1.0.1"
     is-symbol "^1.0.2"
 
+escalade@^3.1.1:
+  version "3.1.1"
+  resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.1.1.tgz#d8cfdc7000965c5a0174b4a82eaa5c0552742e40"
+  integrity sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==
+
 escape-goat@^2.0.0:
   version "2.1.1"
   resolved "https://registry.yarnpkg.com/escape-goat/-/escape-goat-2.1.1.tgz#1b2dc77003676c457ec760b2dc68edb648188675"
@@ -2457,7 +2478,7 @@ gensync@^1.0.0-beta.1:
   resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.1.tgz#58f4361ff987e5ff6e1e7a210827aa371eaac269"
   integrity sha512-r8EC6NO1sngH/zdD9fiRDLdcgnbayXah+mLgManTaIZJqEC1MZstmnox8KpnI2/fxQwrp5OpCOYWLp4rBl4Jcg==
 
-get-caller-file@^2.0.1:
+get-caller-file@^2.0.1, get-caller-file@^2.0.5:
   version "2.0.5"
   resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e"
   integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==
@@ -6139,6 +6160,15 @@ wrap-ansi@^6.2.0:
     string-width "^4.1.0"
     strip-ansi "^6.0.0"
 
+wrap-ansi@^7.0.0:
+  version "7.0.0"
+  resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43"
+  integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==
+  dependencies:
+    ansi-styles "^4.0.0"
+    string-width "^4.1.0"
+    strip-ansi "^6.0.0"
+
 wrappy@1:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f"
@@ -6186,6 +6216,11 @@ y18n@^4.0.0:
   resolved "https://registry.yarnpkg.com/y18n/-/y18n-4.0.0.tgz#95ef94f85ecc81d007c264e190a120f0a3c8566b"
   integrity sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==
 
+y18n@^5.0.5:
+  version "5.0.5"
+  resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.5.tgz#8769ec08d03b1ea2df2500acef561743bbb9ab18"
+  integrity sha512-hsRUr4FFrvhhRH12wOdfs38Gy7k2FFzB9qgN9v3aLykRq0dRcdcpz5C9FxdS2NuhOrI/628b/KSTJ3rwHysYSg==
+
 yallist@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72"
@@ -6196,7 +6231,7 @@ yaml@^1.10.0:
   resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.0.tgz#3b593add944876077d4d683fee01081bd9fff31e"
   integrity sha512-yr2icI4glYaNG+KWONODapy2/jDdMSDnrONSjblABjD9B4Z5LgiircSt8m8sRZFNi08kG9Sm0uSHtEmP3zaEGg==
 
-[email protected], yargs-parser@^20.2.3:
+[email protected], yargs-parser@^20.2.2, yargs-parser@^20.2.3:
   version "20.2.4"
   resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.4.tgz#b42890f14566796f85ae8e3a25290d205f154a54"
   integrity sha512-WOkpgNhPTlE73h4VFAFsOnomJVaovO8VqLDzy5saChRBFQFBoMYirowyW+Q9HB4HFF4Z7VZTiG3iSzJJA29yRA==
@@ -6226,6 +6261,19 @@ yargs@^15.4.1:
     y18n "^4.0.0"
     yargs-parser "^18.1.2"
 
+yargs@^16.2.0:
+  version "16.2.0"
+  resolved "https://registry.yarnpkg.com/yargs/-/yargs-16.2.0.tgz#1c82bf0f6b6a66eafce7ef30e376f49a12477f66"
+  integrity sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==
+  dependencies:
+    cliui "^7.0.2"
+    escalade "^3.1.1"
+    get-caller-file "^2.0.5"
+    require-directory "^2.1.1"
+    string-width "^4.2.0"
+    y18n "^5.0.5"
+    yargs-parser "^20.2.2"
+
 yocto-queue@^0.1.0:
   version "0.1.0"
   resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b"