Skip to content

Commit

Permalink
feat: adds es version checks + notes
Browse files Browse the repository at this point in the history
  • Loading branch information
@yowainwright
yowainwright committed Jan 11, 2021
1 parent 47a5355 commit d909f54
Show file tree
Hide file tree
Showing 2 changed files with 131 additions and 115 deletions.
244 changes: 130 additions & 114 deletions index.js
View file
Original file line number Diff line number Diff line change
@@ -1,192 +1,208 @@
#!/usr/bin/env node

'use strict'
"use strict";

const prog = require('caporal')
const acorn = require('acorn')
const glob = require('glob')
const fs = require('fs')
const path = require('path')
const prog = require("caporal");
const acorn = require("acorn");
const glob = require("glob");
const fs = require("fs");
const path = require("path");

const pkg = require('./package.json')
const argsArray = process.argv
const pkg = require("./package.json");
const argsArray = process.argv;

/**
* es-check 🏆
* ----
* @description
* - define the EcmaScript version to check for against a glob of JavaScript files
* - match the EcmaScript version option against a glob of files
* to to test the EcmaScript version of each file
* - error failures
*/
*/
prog
.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]",
"ecmaVersion to check files against. Can be: es3, es4, es5, es6/es2015, es7/es2016, es8/es2017, es9/es2018, es10/es2019"
)
.option('--module', 'use ES modules')
.option('--allow-hash-bang', 'if the code starts with #! treat it as a comment')
.option('--not', 'folder or file names to skip', prog.LIST)
.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", "folder or file names to skip", prog.LIST)
.action((args, options, logger) => {
const configFilePath = path.resolve(process.cwd(), ".escheckrc");

const configFilePath = path.resolve(process.cwd(), '.escheckrc')

let v, files, e, esmodule, allowHashBang, pathsToIgnore
let config = {}
let v, files, e, esmodule, allowHashBang, pathsToIgnore;
let config = {};

/**
* Check for a configuration file. If one exists, default to those options
* if no command line arguments are passed in
* @note Check for a configuration file.
* - If one exists, default to those options
* - If no command line arguments are passed in
*/
if (fs.existsSync(configFilePath)) {
config = JSON.parse(fs.readFileSync(configFilePath))
config = JSON.parse(fs.readFileSync(configFilePath));
}

v = args.ecmaVersion
? args.ecmaVersion
: config.ecmaVersion
v = args.ecmaVersion ? args.ecmaVersion : config.ecmaVersion;

files = args.files.length
? args.files
: [].concat(config.files)
files = args.files.length ? args.files : [].concat(config.files);

esmodule = options.module
? options.module
: config.module
esmodule = options.module ? options.module : config.module;

allowHashBang = options.allowHashBang
? options.allowHashBang
: config.allowHashBang
: config.allowHashBang;

pathsToIgnore = options.not
? options.not
: config.not
pathsToIgnore = options.not ? options.not : config.not;

if (!v) {
logger.error(
'No ecmaScript version passed in or found in .escheckrc. Please set your ecmaScript version in the CLI or in .escheckrc'
)
process.exit(1)
"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!'
)
process.exit(1)

"No files were passed in please pass in a list of files to es-check!"
);
process.exit(1);
}

/**
* define ecmaScript version
* - Default ecmaScript version is '5'
* @note currently latest is not defined
*/
switch (v) {
case 'es3':
e = '3'
break
case 'es4':
e = '4'
break
case 'es5':
e = '5'
break
case 'es6':
e = '6'
break
case 'es7':
e = '7'
break
case 'es8':
e = '8'
break
case 'es9':
e = '9'
break
case 'es10':
e = '10'
break
case 'es2015':
e = '6'
break
case 'es2016':
e = '7'
break
case 'es2017':
e = '8'
break
case 'es2018':
e = '9'
break
case 'es2019':
e = '10'
break
case "es3":
e = "3";
break;
case "es4":
e = "4";
break;
case "es5":
e = "5";
break;
case "es6":
e = "6";
break;
case "es7":
e = "7";
break;
case "es8":
e = "8";
break;
case "es9":
e = "9";
break;
case "es10":
e = "10";
break;
case "es11":
e = "11";
case "es12":
e = "12";
case "es2015":
e = "6";
break;
case "es2016":
e = "7";
break;
case "es2017":
e = "8";
break;
case "es2018":
e = "9";
break;
case "es2019":
e = "10";
break;
case "es2020":
e = "2020";
break;
case "es2021":
e = "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);
}

const errArray = []
const globOpts = { nodir: true }
const acornOpts = { ecmaVersion: e, silent: true }
const errArray = [];
const globOpts = { nodir: true };
const acornOpts = { ecmaVersion: e, silent: true };
const filterForIgnore = (globbedFiles) => {
if (pathsToIgnore && pathsToIgnore.length > 0) {
const filtered = globbedFiles.filter((filePath) => !pathsToIgnore
.some(ignoreValue => filePath.includes(ignoreValue)))
const filtered = globbedFiles.filter(
(filePath) =>
!pathsToIgnore.some((ignoreValue) => filePath.includes(ignoreValue))
);
return filtered;
}
return globbedFiles;
}
};

logger.debug(`ES-Check: Going to check files using version ${e}`)
logger.debug(`ES-Check: Going to check files using version ${e}`);

if (esmodule) {
acornOpts.sourceType = 'module'
logger.debug('ES-Check: esmodule is set')
acornOpts.sourceType = "module";
logger.debug("ES-Check: esmodule is set");
}

if (allowHashBang) {
acornOpts.allowHashBang = true
logger.debug('ES-Check: allowHashBang is set')
acornOpts.allowHashBang = true;
logger.debug("ES-Check: allowHashBang is set");
}

files.forEach((pattern) => {
/**
* pattern => glob or array
* @note pattern => glob or array
*/
const globbedFiles = glob.sync(pattern, globOpts)
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);
}

const filteredFiles = filterForIgnore(globbedFiles);

filteredFiles.forEach((file) => {
const code = fs.readFileSync(file, 'utf8')
const code = fs.readFileSync(file, "utf8");

logger.debug(`ES-Check: checking ${file}`)
logger.debug(`ES-Check: checking ${file}`);
try {
acorn.parse(code, acornOpts)
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,
}
errArray.push(errorObj)
};
errArray.push(errorObj);
}
})
})
});
});

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:
Expand All @@ -196,11 +212,11 @@ prog
· see the printed err.stack below for context
----\n
${o.stack}
`)
})
process.exit(1)
`);
});
process.exit(1);
}
logger.error(`ES-Check: there were no ES version matching errors! 🎉`)
})
logger.info(`ES-Check: there were no ES version matching errors! 🎉`);
});

prog.parse(argsArray)
prog.parse(argsArray);
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "es-check",
"version": "5.1.4",
"version": "5.2.0",
"description": "Checks the EcamScript version of .js glob against a specified version of EcamScript with a shell command",
"main": "index.js",
"files": [
Expand Down

0 comments on commit d909f54

Please sign in to comment.