pedantic - npm Package Compare versions

Comparing version 1.2.1 to 2.0.0

CHANGELOG.md

@@ -6,2 +6,18 @@ # Change Log
 
+# [2.0.0](https://github.com/4Catalyzer/cli/compare/pedantic@1.2.1...pedantic@2.0.0) (2019-03-05)
+
+
+### Features
+
+* add lint command ([5e1e1eb](https://github.com/4Catalyzer/cli/commit/5e1e1eb))
+
+
+### BREAKING CHANGES
+
+* split pedantic into two commands
+
+
+
+
+
 ## [1.2.1](https://github.com/4Catalyzer/cli/compare/pedantic@1.2.0...pedantic@1.2.1) (2019-02-26)
@@ -8,0 +24,0 @@

cli.js

 #!/usr/bin/env node
 
-require('@4c/cli-core/createCliFromCommand')(require('./command'));
+const yargs = require('yargs');
+
+yargs
+  .help()
+  .alias('h', 'help')
+  .version()
+  .alias(`v`, `version`)
+  .wrap(yargs.terminalWidth())
+  .strict()
+  .command(require('./format'))
+  .command(require('./lint'))
+  .parse(process.argv.slice(2));

lib.js

 const path = require('path');
-const chalk = require('chalk');
 const { promises: fs } = require('fs');
-const { default: sortImports } = require('import-sort');
 const { debuglog } = require('util');
-const prettier = require('prettier');
-const { getConfig } = require('import-sort-config');
 
-const ConsoleUtilities = require('@4c/cli-core/ConsoleUtilities');
+const {
+  spinner,
+  chalk,
+  stripAnsi,
+  table,
+} = require('@4c/cli-core/ConsoleUtilities');
 const ArgUtilities = require('@4c/cli-core/ArgUtilities');
 
+const sortImports = require('./sort-imports');
+const runPrettier = require('./prettier');
+const Linter = require('./Linter');
+
 const debug = debuglog('pedantic');
 
-const DEFAULT_SORT_CONFIGS = {
-  '.js, .jsx, .mjs, .ts, .tsx': {
-    parser: require.resolve('import-sort-parser-babylon'),
-    style: require.resolve('@4c/import-sort/style'),
-  },
-};
-
-function sortFileImports(content, filePath, includeTypeDefs = false) {
-  if (!includeTypeDefs && filePath.endsWith('.d.ts')) {
-    debug('Not attempting to sort imports in type def file:', filePath);
-    return content;
-  }
-
-  const resolvedConfig = getConfig(
-    path.extname(filePath),
-    path.dirname(filePath),
-    DEFAULT_SORT_CONFIGS,
-  );
-
-  if (!resolvedConfig || !resolvedConfig.parser || !resolvedConfig.style) {
-    debug('could not resolve import sort config for:', filePath);
-    return content;
-  }
-
-  const { parser, style, options } = resolvedConfig;
-  const result = sortImports(content, parser, style, filePath, options);
-
-  return result.code;
-}
-
-async function runPrettier(content, filePath, ignorePath = '.prettierignore') {
-  const { ignored } = await prettier.getFileInfo(filePath, { ignorePath });
-  if (ignored) return content;
-  const options = await prettier.resolveConfig(filePath);
-
-  return prettier.format(content, { filepath: filePath, ...options });
-}
-
+/**
+ * possible combinations are:
+ *  - fix: fix errors, don't report non-fixable errors
+ *  - fix & check: fix anything that's fixable and report non-fixable errors
+ *  - check: report fixable and non-fixable errors
+ */
 module.exports = async (
   filePatterns,
-  { cwd = process.cwd(), ignorePath, ignoreNodeModules, write, check },
+  { cwd = process.cwd(), ignorePath, ignoreNodeModules, fix, check },
 ) => {
-  debug('patterns:', filePatterns, 'write:', write, 'cwd', cwd);
-  const spinner = ConsoleUtilities.spinner('Checking formatting…');
+  debug('patterns:', filePatterns, 'fix:', fix, 'cwd', cwd);
+  const progress = spinner('Checking formatting…');
+  const linter = new Linter({ cwd, fix, check });
 
   const filePaths = await ArgUtilities.resolveFilePatterns(filePatterns, {
+    cwd,
     ignoreNodeModules,
-    cwd,
+    absolute: true,
   });
@@ -66,3 +41,3 @@
     process.exitCode = 1;
-    spinner.fail(
+    progress.fail(
       "The provided file patterns didn't match any files: ",
@@ -72,3 +47,6 @@ filePatterns.join(', '),
   }
+
   let numDifferent = 0;
+  const needsFormatting = [];
+
   try {
@@ -80,7 +58,19 @@ await Promise.all(
 
+        // Prettier has the largest pool of files it can format so if
+        // it can't parse it assume nothing else can and move on
+        const canParse = await runPrettier.canParse(filePath);
+        if (!canParse) {
+          return;
+        }
+
         try {
           content = await fs.readFile(filePath, 'utf8');
 
-          code = sortFileImports(content, filePath);
+          code = sortImports(content, filePath);
+
           code = await runPrettier(code, filePath, ignorePath);
+
+          if (code !== content) needsFormatting.push(filePath);
+
+          code = linter.check(code, filePath);
         } catch (err) {
@@ -93,15 +83,13 @@ // Don't exit the process if one file failed
 
-        if (content === code) return;
+        if (content === code) {
+          return;
+        }
 
         numDifferent++;
 
-        if (check) {
-          // we don't want these to replace each other
-          if (spinner.isSpinning) spinner.stopAndPersist();
-          console.log(`  -> ${chalk.dim(filePath)}`);
-        } else if (write) {
-          spinner.text = chalk.dim(path.relative(cwd, filePath));
+        progress.text = chalk.dim(path.relative(cwd, filePath));
+
+        if (fix) {
           await fs.writeFile(filePath, code, 'utf8');
-        } else {
-          spinner.stopAndPersist();
+        } else if (!check) {
           process.stdout.write(code);
@@ -112,28 +100,54 @@ }
   } catch (err) {
-    spinner.stop();
+    progress.stop();
     throw err;
   }
 
-  if (!numDifferent) {
-    spinner.succeed(
-      `All ${filePaths.length} of matched files are properly formatted`,
+  if (!numDifferent && !linter.hasChanges) {
+    progress.succeed(
+      `All ${
+        filePaths.length
+      } of matched files are properly formatted and linted`,
     );
+
     return;
   }
 
-  if (check) {
-    process.exitCode = 1;
+  const files = `file${numDifferent === 1 ? '' : 's'}`;
+  progress.stop();
+
+  if (!check) {
+    if (fix) {
+      progress.succeed(
+        `Code style issues fixed in ${numDifferent} of ${
+          filePaths.length
+        } ${files} checked.`,
+      );
+    }
+    return;
   }
-  const files = `file${numDifferent === 1 ? '' : 's'}`;
-  if (check) {
-    spinner.fail(
-      `Code style issues found in the above ${numDifferent} ${files}`,
+
+  process.exitCode = 1;
+
+  console.log(linter.output());
+
+  if (!fix) {
+    let output = '\n';
+    output += `${table(
+      needsFormatting.map(filePath => [
+        '',
+        path.relative(cwd, filePath).trim(),
+      ]),
+      {
+        align: ['', 'l'],
+        stringLength: str => stripAnsi(str).length,
+      },
+    )}
+
+  `;
+
+    output += chalk.red.bold(
+      `\u2716 ${needsFormatting.length} Formatting issues`,
     );
-  } else if (write) {
-    spinner.succeed(
-      `Code style issues fixed in ${numDifferent} of ${
-        filePaths.length
-      } ${files} checked.`,
-    );
+    console.log(output);
   }
 };

package.json

 {
   "name": "pedantic",
-  "version": "1.2.1",
+  "version": "2.0.0",
   "main": "lib.js",
@@ -10,2 +10,5 @@ "repository": {
   },
+  "scripts": {
+    "test": "jest"
+  },
   "author": "4Catalyzer",
@@ -28,11 +31,13 @@ "license": "MIT",
   "dependencies": {
-    "@4c/cli-core": "^1.3.0",
+    "@4c/cli-core": "^1.4.0",
     "@4c/import-sort": "^4.3.1",
     "chalk": "^2.4.2",
+    "eslint": "^5.14.1",
     "import-sort": "^6.0.0",
     "import-sort-config": "^6.0.0",
     "import-sort-parser-babylon": "^6.0.0",
-    "prettier": "^1.16.4"
+    "prettier": "^1.16.4",
+    "yargs": "^13.2.1"
   },
-  "gitHead": "99f72ccba79d5c364e68489388db8e3d0c3e001c"
+  "gitHead": "cd60e4a713d47497146ebbc5449755d0fc05d2b3"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

343370

increased by3755.92%

Number of package files

14

increased by100%

Lines of code

314

increased by68.82%

Worsened metrics

Dependency count

9

increased by28.57%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedeslint@^5.14.1

• + Addedyargs@^13.2.1

• + Addedacorn@6.4.2(transitive)

• + Addedacorn-jsx@5.3.2(transitive)

• + Addedajv@6.12.6(transitive)

• + Addedastral-regex@1.0.0(transitive)

• + Addedcallsites@3.1.0(transitive)

• + Addeddeep-is@0.1.4(transitive)

• + Addeddoctrine@3.0.0(transitive)

• + Addedeslint@5.16.0(transitive)

• + Addedeslint-scope@4.0.3(transitive)

• + Addedeslint-utils@1.4.3(transitive)

• + Addedeslint-visitor-keys@1.3.0(transitive)

• + Addedespree@5.0.1(transitive)

• + Addedesquery@1.6.0(transitive)

• + Addedesrecurse@4.3.0(transitive)

• + Addedestraverse@4.3.05.3.0(transitive)

• + Addedesutils@2.0.3(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-json-stable-stringify@2.1.0(transitive)

• + Addedfast-levenshtein@2.0.6(transitive)

• + Addedfile-entry-cache@5.0.1(transitive)

• + Addedflat-cache@2.0.1(transitive)

• + Addedflatted@2.0.2(transitive)

• + Addedfunctional-red-black-tree@1.0.1(transitive)

• + Addedimport-fresh@3.3.0(transitive)

• + Addedimurmurhash@0.1.4(transitive)

• + Addedjson-schema-traverse@0.4.1(transitive)

• + Addedjson-stable-stringify-without-jsonify@1.0.1(transitive)

• + Addedlevn@0.3.0(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addednatural-compare@1.4.0(transitive)

• + Addedoptionator@0.8.3(transitive)

• + Addedparent-module@1.0.1(transitive)

• + Addedpath-is-inside@1.0.2(transitive)

• + Addedprelude-ls@1.1.2(transitive)

• + Addedprogress@2.0.3(transitive)

• + Addedpunycode@2.3.1(transitive)

• + Addedregexpp@2.0.1(transitive)

• + Addedrimraf@2.6.3(transitive)

• + Addedslice-ansi@2.1.0(transitive)

• + Addedstrip-json-comments@2.0.1(transitive)

• + Addedtable@5.4.6(transitive)

• + Addedtype-check@0.3.2(transitive)

• + Addeduri-js@4.4.1(transitive)

• + Addedword-wrap@1.2.5(transitive)

• + Addedwrite@1.0.3(transitive)

• Updated@4c/cli-core@^1.4.0