es-check 8.0.1 → 8.0.2

package/README.md

@@ -177,15 +177,14 @@ es-check es6 './dist/**/*.js' --checkFeatures
 Options:
   -V, --version                       output the version number
   --module                            use ES modules
-  --allow-hash-bang, --allowHashBang  if the code starts with #! treat it as a comment (default: false)
+  --allowHashBang                     if the code starts with #! treat it as a comment (default: false)
   --files <files>                     a glob of files to to test the EcmaScript version against (alias for [files...])
   --not <files>                       folder or file names to skip
-  --no-color, --noColor               disable use of colors in output (default: false)
+  --noColor                           disable use of colors in output (default: false)
   -v, --verbose                       verbose mode: will also output debug messages (default: false)
   --quiet                             quiet mode: only displays warn and error messages (default: false)
   --looseGlobMatching                 doesn't fail if no files are found in some globs/files (default: false)
-  --silent                            silent mode: does not output anything, giving no indication of success or
-  failure other than the exit code (default: false)
+  --silent                            silent mode: does not output anything, giving no indication of success or failure     other than the exit code (default: false)
   --checkFeatures                     check for actual ES version specific features (default: false)
   -h, --help                          display help for command
 

package/detectFeatures.js

@@ -68,10 +68,14 @@ const detectFeatures = (code, ecmaVersion, sourceType) => {
    * @note Fail if any unsupported features were used.
    */
   if (unsupportedFeatures.length > 0) {
-    throw new Error(
+    const error = new Error(
       `Unsupported features detected: ${unsupportedFeatures.join(', ')}. ` +
       `These require a higher ES version than ${ecmaVersion}.`
     );
+    error.type = 'ES-Check';
+    error.features = unsupportedFeatures;
+    error.ecmaVersion = ecmaVersion;
+    throw error;
   }
 
   return {

package/index.js

@@ -2,7 +2,7 @@
 
 'use strict'
 
-const { program } = require('commander')
+const { program, Option } = require('commander')
 const acorn = require('acorn')
 const glob = require('fast-glob')
 const fs = require('fs')
@@ -10,6 +10,7 @@ const path = require('path')
 const supportsColor = require('supports-color')
 const winston = require('winston')
 const detectFeatures = require('./detectFeatures')
+const { formatError } = require('./utils')
 const pkg = require('./package.json')
 
 /**
@@ -29,10 +30,12 @@ program
   )
   .argument('[files...]', 'a glob of files to to test the EcmaScript version against')
   .option('--module', 'use ES modules')
-  .option('--allow-hash-bang, --allowHashBang', 'if the code starts with #! treat it as a comment', false)
+  .addOption(new Option('--allow-hash-bang', 'if the code starts with #! treat it as a comment').default(false).hideHelp())
+  .option('--allowHashBang', 'if the code starts with #! treat it as a comment', false)
   .option('--files <files>', 'a glob of files to to test the EcmaScript version against (alias for [files...])')
   .option('--not <files>', 'folder or file names to skip')
-  .option('--no-color, --noColor', 'disable use of colors in output', false)
+  .addOption(new Option('--no-color', 'disable use of colors in output').default(false).hideHelp())
+  .option('--noColor', 'disable use of colors in output', false)
   .option('-v, --verbose', 'verbose mode: will also output debug messages', false)
   .option('--quiet', 'quiet mode: only displays warn and error messages', false)
   .option('--looseGlobMatching', 'doesn\'t fail if no files are found in some globs/files', false)
@@ -224,13 +227,11 @@ program
       logger.debug(`Features found in ${file}: ${stringifiedFeatures}`);
       const isSupported = unsupportedFeatures.length === 0;
       if (!isSupported) {
-        logger.error(
-          `ES-Check: The file "${file}" uses these unsupported features: ${unsupportedFeatures.join(', ')}
-          but your target is ES${ecmaVersion}.`
-        );
+        const error = new Error(`Unsupported features used: ${unsupportedFeatures.join(', ')} but your target is ES${ecmaVersion}.`);
         errArray.push({
-          err: new Error(`Unsupported features used: ${unsupportedFeatures.join(', ')}`),
+          err: error,
           file,
+          stack: error.stack
         });
       }
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "es-check",
-  "version": "8.0.1",
+  "version": "8.0.2",
   "description": "Checks the ECMAScript version of .js glob against a specified version of ECMAScript with a shell command",
   "main": "index.js",
   "license": "MIT",
@@ -41,30 +41,30 @@
   },
   "homepage": "https://github.com/yowainwright/es-check#readme",
   "devDependencies": {
-    "@commitlint/cli": "19.6.1",
-    "@commitlint/config-conventional": "19.6.0",
+    "@commitlint/cli": "19.7.1",
+    "@commitlint/config-conventional": "19.7.1",
     "@commitlint/format": "^19.3.0",
-    "@commitlint/prompt": "19.6.1",
+    "@commitlint/prompt": "19.7.1",
     "assert": "^2.1.0",
     "codecov": "^3.8.3",
     "codependence": "^0.3.1",
     "commitizen": "4.3.1",
     "conventional-changelog-cli": "^5.0.0",
-    "eslint": "9.17.0",
-    "eslint-config-prettier": "9.1.0",
+    "eslint": "9.21.0",
+    "eslint-config-prettier": "10.0.2",
     "husky": "9.1.7",
     "is-ci": "^3.0.1",
-    "mocha": "11.0.1",
+    "mocha": "11.1.0",
     "nyc": "^17.1.0",
     "path-exists-cli": "^2.0.0",
-    "prettier": "3.4.2",
-    "release-it": "17.11.0"
+    "prettier": "3.5.3",
+    "release-it": "18.1.2"
   },
   "dependencies": {
     "acorn": "8.14.0",
     "acorn-walk": "^8.3.4",
-    "commander": "12.1.0",
-    "fast-glob": "^3.3.2",
+    "commander": "13.1.0",
+    "fast-glob": "^3.3.3",
     "supports-color": "8.1.1",
     "winston": "3.17.0"
   },

package/utils.js

@@ -38,37 +38,40 @@ const checkDefault = () => {
  *   - objectMethod => object: 'Object', property: 'fromEntries', etc.
  */
 const checkCallExpression = (node, astInfo) => {
-  // Must be `CallExpression`
   if (node.type !== 'CallExpression') return false;
-
-  // We might check if node.callee is a MemberExpression, e.g. array.includes(...)
-  // or if node.callee is an Identifier, e.g. Symbol(...).
   if (node.callee.type === 'MemberExpression') {
     const { object, property } = astInfo;
-    // e.g. object: 'Object', property: 'entries'
-    // => node.callee.object.name === 'Object' && node.callee.property.name === 'entries'
-    if (object) {
-      if (
-        !node.callee.object ||
-        node.callee.object.type !== 'Identifier' ||
-        node.callee.object.name !== object
-      ) {
-        return false;
+
+    if (object || property) {
+
+      if (object) {
+        if (
+          !node.callee.object ||
+          node.callee.object.type !== 'Identifier' ||
+          node.callee.object.name !== object
+        ) {
+          return false;
+        }
       }
-    }
-    if (property) {
-      // e.g. property: 'includes'
-      if (!node.callee.property || node.callee.property.name !== property) {
-        return false;
+
+      if (property) {
+        if (
+          !node.callee.property || 
+          node.callee.property.type !== 'Identifier' ||
+          node.callee.property.name !== property
+        ) {
+          return false;
+        }
       }
+      return true;
     }
-    return true;
-  } else if (node.callee.type === 'Identifier') {
-    // e.g. Symbol("desc")
+    return false;
+  } 
+  
+  if (node.callee.type === 'Identifier') {
     const { callee } = astInfo;
-    // If astInfo.callee is "Symbol", check node.callee.name
-    if (callee && node.callee.name === callee) {
-      return true;
+    if (callee && !astInfo.object && !astInfo.property) {
+      return node.callee.name === callee;
     }
   }
 
@@ -155,10 +158,25 @@ const checkMap = {
   default: () => false,
 };
 
+const formatError = (filePath, error) => {
+  console.error('error: ES-Check: there were 1 ES version matching errors.');
+  console.info(`
+          ES-Check Error:
+          ----
+          · erroring file: ${filePath}
+          · error: ${error.message}
+          · see the printed err.stack below for context
+          ----
+          
+          ${error.stack}
+  `);
+};
+
 module.exports = {
   checkVarKindMatch,
   checkCalleeMatch,
   checkOperatorMatch,
   checkDefault,
   checkMap,
+  formatError,
 };