es-check 6.2.0 → 7.0.1

package/README.md

@@ -20,7 +20,13 @@ Ensuring that JavaScript files can pass ES Check is important in a [modular and
 
 ---
 
-**Known issue:** cli argument vs. option order. There is a small issue with cli's option ordering. If an argument is passed **after** a boolean option, the boolean option will default to `falsy` as if the argument was not added. This will create weirdness in checks. A fix for this issue is in the works! 👌
+## Version 7 🎉
+
+Thanks to the efforts of [Anders Kaseorg](https://github.com/andersk), ES Check has switched to [Commander](https://www.npmjs.com/package/commander)! There appears to be no breaking issues but this update is being published as a major release for your ease-of-use. Please reach out with observations or pull requests features/fixes!
+
+This update was made for security purposes—dependencies not being maintained.
+
+Thanks to Anders for this deeper fix, to [Pavel Starosek](https://github.com/StudioMaX) for the initial issue and support, and to [Alexander Pepper](https://github.com/apepper) for digging into this issue more!
 
 ---
 
@@ -33,6 +39,7 @@ Ensuring that JavaScript files can pass ES Check is important in a [modular and
   <a href="#debugging">Debugging</a>&nbsp;&nbsp;
   <a href="#contributing">Contributing</a>&nbsp;&nbsp;
   <a href="/issues">Issues</a>
+  <a href="#roadmap">Roadmap</a>
 </p>
 
 ---
@@ -207,3 +214,14 @@ ES Check has 3 main dependencies: [acorn](https://github.com/ternjs/acorn/), [gl
 - [Ben Junya](https://github.com/MrBenJ)
 - [Jeff Barczewski](https://github.com/jeffbski)
 - [Brandon Casey](https://github.com/BrandonOCasey)
+
+### Roadmap
+
+- Provide compilation step to support esm
+  - non-user-facing
+  - required to keep package dependencies up-to-date as more dependencies are ESM-only
+- Provide checks for _theoretical_ keywork words
+  - Things like `Map` and `Object.assign` are not keywords that fail ECMAScript
+    compilation depending on specific versions of ECMAScript. However, they hint at additions to ECMAScript that previous version did not support.
+  - This feature will enhance an already built-in confiration feature to provide more out-of-the-box support for ECMAScript checking.
+  - If enabled, this feature will warn (or fail) based on _theoretical_ ECMAScript keywords.

package/index.js

@@ -2,14 +2,15 @@
 
 'use strict'
 
-const { program } = require('@caporal/core')
+const { program } = require('commander')
 const acorn = require('acorn')
 const glob = require('fast-glob')
 const fs = require('fs')
 const path = require('path')
+const supportsColor = require('supports-color')
+const winston = require('winston')
 
 const pkg = require('./package.json')
-const argsArray = process.argv.slice(2)
 
 /**
  * es-check 🏆
@@ -24,21 +25,32 @@ program
   .version(pkg.version)
   .argument(
     '[ecmaVersion]',
-    'ecmaVersion to check files against. Can be: es3, es4, es5, es6/es2015, es7/es2016, es8/es2017, es9/es2018, es10/es2019'
-  )
-  .argument(
-    '[files...]',
-    'a glob of files to to test the EcmaScript version against'
+    'ecmaVersion to check files against. Can be: es3, es4, es5, es6/es2015, es7/es2016, es8/es2017, es9/es2018, es10/es2019',
   )
+  .argument('[files...]', 'a glob of files to to test the EcmaScript version against')
   .option('--module', 'use ES modules')
+  .option('--allow-hash-bang', 'if the code starts with #! treat it as a comment')
+  .option('--not <files>', 'folder or file names to skip')
+  .option('--no-color', 'disable use of colors in output')
+  .option('-v, --verbose', 'verbose mode: will also output debug messages')
+  .option('--quiet', 'quiet mode: only displays warn and error messages')
   .option(
-    '--allow-hash-bang',
-    'if the code starts with #! treat it as a comment'
+    '--silent',
+    'silent mode: does not output anything, giving no indication of success or failure other than the exit code',
   )
-  .option('--not', 'folder or file names to skip', {
-    validator: program.ARRAY
-  })
-  .action(({ logger, args, options }) => {
+  .action((ecmaVersionArg, filesArg, options) => {
+    const logger = winston.createLogger()
+    logger.add(
+      new winston.transports.Console({
+        silent: options.silent,
+        level: options.verbose ? 'silly' : options.quiet ? 'warn' : 'info',
+        format: winston.format.combine(
+          ...(supportsColor.stdout ? [winston.format.colorize()] : []),
+          winston.format.simple(),
+        ),
+      }),
+    )
+
     const configFilePath = path.resolve(process.cwd(), '.escheckrc')
 
     /**
@@ -47,34 +59,22 @@ program
      * - If one exists, default to those options
      * - If no command line arguments are passed in
      */
-    const config = fs.existsSync(configFilePath)
-      ? JSON.parse(fs.readFileSync(configFilePath))
-      : {}
-    const expectedEcmaVersion = args.ecmaVersion
-      ? args.ecmaVersion
-      : config.ecmaVersion
-    const files =
-      args.files && args.files.length ? args.files : [].concat(config.files)
+    const config = fs.existsSync(configFilePath) ? JSON.parse(fs.readFileSync(configFilePath)) : {}
+    const expectedEcmaVersion = ecmaVersionArg ? ecmaVersionArg : config.ecmaVersion
+    const files = filesArg && filesArg.length ? filesArg : [].concat(config.files)
     const esmodule = options.module ? options.module : config.module
-    const allowHashBang = options.allowHashBang
-      ? options.allowHashBang
-      : config.allowHashBang
-    const pathsToIgnore =
-      options.not && options.not.length
-        ? options.not
-        : [].concat(config.not || [])
+    const allowHashBang = options.allowHashBang ? options.allowHashBang : config.allowHashBang
+    const pathsToIgnore = options.not ? options.not.split(',') : [].concat(config.not || [])
 
     if (!expectedEcmaVersion) {
       logger.error(
-        'No ecmaScript version passed in or found in .escheckrc. Please set your ecmaScript version in the CLI or in .escheckrc'
+        'No ecmaScript version passed in or found in .escheckrc. Please set your ecmaScript version in the CLI or in .escheckrc',
       )
       process.exit(1)
     }
 
     if (!files || !files.length) {
-      logger.error(
-        'No files were passed in please pass in a list of files to es-check!'
-      )
+      logger.error('No files were passed in please pass in a list of files to es-check!')
       process.exit(1)
     }
 
@@ -135,9 +135,7 @@ program
         ecmaVersion = '2021'
         break
       default:
-        logger.error(
-          'Invalid ecmaScript version, please pass a valid version, use --help for help'
-        )
+        logger.error('Invalid ecmaScript version, please pass a valid version, use --help for help')
         process.exit(1)
     }
 
@@ -156,10 +154,7 @@ program
     const filterForIgnore = (globbedFiles) => {
       if (expandedPathsToIgnore && expandedPathsToIgnore.length > 0) {
         const filtered = globbedFiles.filter(
-          (filePath) =>
-            !expandedPathsToIgnore.some((ignoreValue) =>
-              filePath.includes(ignoreValue)
-            )
+          (filePath) => !expandedPathsToIgnore.some((ignoreValue) => filePath.includes(ignoreValue)),
         )
         return filtered
       }
@@ -182,9 +177,7 @@ program
       const globbedFiles = glob.sync(pattern, globOpts)
 
       if (globbedFiles.length === 0) {
-        logger.error(
-          `ES-Check: Did not find any files to check for ${pattern}.`
-        )
+        logger.error(`ES-Check: Did not find any files to check for ${pattern}.`)
         process.exit(1)
       }
 
@@ -192,18 +185,15 @@ program
 
       filteredFiles.forEach((file) => {
         const code = fs.readFileSync(file, 'utf8')
-
         logger.debug(`ES-Check: checking ${file}`)
         try {
           acorn.parse(code, acornOpts)
         } catch (err) {
-          logger.debug(
-            `ES-Check: failed to parse file: ${file} \n - error: ${err}`
-          )
+          logger.debug(`ES-Check: failed to parse file: ${file} \n - error: ${err}`)
           const errorObj = {
             err,
             stack: err.stack,
-            file
+            file,
           }
           errArray.push(errorObj)
         }
@@ -211,9 +201,7 @@ program
     })
 
     if (errArray.length > 0) {
-      logger.error(
-        `ES-Check: there were ${errArray.length} ES version matching errors.`
-      )
+      logger.error(`ES-Check: there were ${errArray.length} ES version matching errors.`)
       errArray.forEach((o) => {
         logger.info(`
           ES-Check Error:
@@ -230,4 +218,4 @@ program
     logger.info(`ES-Check: there were no ES version matching errors!  🎉`)
   })
 
-program.run(argsArray)
+program.parse()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "es-check",
-  "version": "6.2.0",
+  "version": "7.0.1",
   "description": "Checks the ECMAScript version of .js glob against a specified version of ECMAScript with a shell command",
   "main": "index.js",
   "license": "MIT",
@@ -10,21 +10,21 @@
   "bin": {
     "es-check": "index.js"
   },
-  "resolutions": {
-    "ansi-regex": "5.0.1"
-  },
   "scripts": {
-    "chore:delete-branch": "if git show-ref --quiet refs/heads/chore-changelog; then git branch -D chore-changelog; fi",
-    "chore:branch": "git checkout -b chore-changelog",
-    "chore:changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
-    "chore:pr": "git add . && git commit -m '[chore] updates changelog' --no-verify && git push origin chore-changelog -f",
-    "chore": "pnpm run chore:delete-branch && pnpm run chore:branch && pnpm run chore:changelog && pnpm run chore:pr",
+    "commit": "git-cz",
+    "commit-msg": "commitlint --edit $1",
+    "husky-setup": "path-exists .husky/commit-msg || (husky install && pnpm husky-setup:commit-msg && pnpm husky-setup:post-merge && pnpm husky-setup:pre-commit)",
+    "husky-setup:commit-msg": "npx husky add .husky/commit-msg 'pnpm run commit-msg'",
+    "husky-setup:post-merge": "npx husky add .husky/post-merge 'pnpm run setup'",
+    "husky-setup:pre-commit": "npx husky add .husky/pre-commit 'pnpm run pre-commit'",
     "lint": "eslint index.js --fix",
     "lint:ci": "eslint index.js",
-    "prepush": "pnpm run lint && pnpm test",
-    "postpublish": "git tag $npm_package_version && git push origin --tags && pnpm run chore",
-    "preinstall": "npx only-allow pnpm",
+    "pre-commit": "pnpm lint && pnpm test",
+    "prepare": "is-ci || pnpm husky-setup",
+    "prepublishOnly": "pnpm test",
+    "release": "release-it",
     "report:coverage": "nyc report --reporter=lcov > coverage.lcov && codecov",
+    "setup": "pnpm install --reporter=silent",
     "test": "nyc mocha test.js --timeout 10s --coverage"
   },
   "repository": {
@@ -37,24 +37,28 @@
   },
   "homepage": "https://github.com/yowainwright/es-check#readme",
   "devDependencies": {
-    "@commitlint/cli": "^16.1.0",
-    "@commitlint/config-conventional": "^16.0.0",
-    "@commitlint/prompt": "^16.1.0",
+    "@commitlint/cli": "^17.0.3",
+    "@commitlint/config-conventional": "^17.0.3",
+    "@commitlint/prompt": "^17.0.3",
     "assert": "^2.0.0",
     "codecov": "^3.8.3",
     "commitizen": "^4.2.4",
     "conventional-changelog-cli": "^2.2.2",
     "eslint": "^8.7.0",
     "eslint-config-prettier": "^8.3.0",
-    "husky": "^7.0.4",
-    "mocha": "^9.2.0",
+    "husky": "^8.0.1",
+    "mocha": "^10.0.0",
     "nyc": "^15.1.0",
-    "prettier": "^2.5.1"
+    "path-exists-cli": "^2.0.0",
+    "prettier": "^2.5.1",
+    "release-it": "^15.1.3"
   },
   "dependencies": {
-    "@caporal/core": "^2.0.2",
     "acorn": "^8.7.0",
-    "fast-glob": "^3.2.11"
+    "commander": "^9.4.0",
+    "fast-glob": "^3.2.11",
+    "supports-color": "^8.1.1",
+    "winston": "^3.2.1"
   },
   "engines": {
     "node": ">= 4"
@@ -89,13 +93,9 @@
       ]
     }
   },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "post-checkout": "if [[ $HUSKY_GIT_PARAMS =~ 1$ ]]; then pnpm i -r; fi",
-      "post-merge": "pnpm i -r",
-      "post-rewrite": "pnpm i -r",
-      "pre-commit": "pnpm test && pnpm lint"
+  "release-it": {
+    "github": {
+      "release": true
     }
   }
 }