json-sort-cli 1.19.0 → 2.0.3

package/CHANGELOG.md

@@ -3,6 +3,42 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 2.0.3 (2021-11-02)
+
+### Bug Fixes
+
+- bump TS and separate ESLint plugins away from this monorepo ([b1ebce1](https://github.com/codsen/codsen/commit/b1ebce1637d8c41c2d848fc24b0ba4058865bd5d))
+
+### Features
+
+- migrate to ES Modules ([c579dff](https://github.com/codsen/codsen/commit/c579dff3b23205e383035ca10ddcec671e35d0fe))
+
+### BREAKING CHANGES
+
+- programs now are in ES Modules and won't work with Common JS require()
+
+## 2.0.1 (2021-09-13)
+
+### Bug Fixes
+
+- bump TS and separate ESLint plugins away from this monorepo ([2e07d42](https://github.com/codsen/codsen/commit/2e07d424222b6ffedf5fb45c83ad453627ec2904))
+
+## 2.0.0 (2021-09-09)
+
+### Features
+
+- correct the default "n" flag value, also reach 100% coverage ([6e323cb](https://github.com/codsen/codsen/commit/6e323cbcb67888dcc83bf1ace77c976c44173796))
+- migrate to ES Modules ([8c9d95d](https://github.com/codsen/codsen/commit/8c9d95d5dea0b769c2f070397141918a4893d575))
+
+### BREAKING CHANGES
+
+- programs now are in ES Modules and won't work with Common JS require()
+
+## 1.20.0
+
+- added more unit tests
+- "help" and "version" flags, if present, override anything else; "version" takes priority of "help" if both are present
+
 ## 1.19.0 (2021-05-24)
 
 ### Features

package/README.md

@@ -26,6 +26,8 @@
 
 ## Install
 
+This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required:
+
 ```bash
 npm i -g json-sort-cli
 ```

package/cli.js

@@ -3,24 +3,25 @@
 // VARS
 // -----------------------------------------------------------------------------
 
-const fs = require("fs-extra");
-const chalk = require("chalk");
-const globby = require("globby");
-const meow = require("meow");
-const path = require("path");
-const updateNotifier = require("update-notifier");
-const isDirectory = require("is-d");
-const pReduce = require("p-reduce");
-const pFilter = require("p-filter");
-const sortObject = require("sorted-object");
-const { traverse } = require("ast-monkey-traverse");
-const isObj = require("lodash.isplainobject");
-const sortPackageJson = require("sort-package-json");
+import fs from "fs-extra";
+import chalk from "chalk";
+import { globby } from "globby";
+import meow from "meow";
+import path from "path";
+// import updateNotifier from "update-notifier";
+import isDirectory from "is-d";
+import pReduce from "p-reduce";
+import pFilter from "p-filter";
+import sortObject from "sorted-object";
+import { traverse } from "ast-monkey-traverse";
+import isObj from "lodash.isplainobject";
+import sortPackageJson from "sort-package-json";
 
 function isStr(something) {
   return typeof something === "string";
 }
 function format(obj) {
+  /* istanbul ignore next */
   if (typeof obj !== "object") {
     return obj;
   }
@@ -54,7 +55,7 @@ const cli = meow(
   or, just type "jsonsort" and it will let you pick a file.
 
   Options
-    -n, --nodemodules      Don't ignore any node_modules folders and package-lock.json's
+    -n, --nodemodules      Don't ignore any node_modules folders
     -t, --tabs             Use tabs for JSON file indentation
     -i, --indentationCount How many spaces or tabs to use (default = 2 spaces or 1 tab)
     -s, --silent           Does not show the result per-file, only totals in the end
@@ -70,11 +71,12 @@ const cli = meow(
     will parse globs. If you put as system globs without quotes, your shell will expand them.
 `,
   {
+    importMeta: import.meta,
     flags: {
       nodemodules: {
         type: "boolean",
         alias: "n",
-        default: true,
+        default: false,
       },
       tabs: {
         type: "boolean",
@@ -123,7 +125,7 @@ const cli = meow(
     },
   }
 );
-updateNotifier({ pkg: cli.pkg }).notify();
+// updateNotifier({ pkg: cli.pkg }).notify();
 
 const nonJsonFormats = ["yml", "toml", "yaml"]; // to save time
 const badFiles = [
@@ -137,16 +139,6 @@ const badFiles = [
   "npm-shrinkwrap.json",
 ];
 
-// console.log(
-//   `120 ${`\u001b[${33}m${`cli.flags`}\u001b[${39}m`} = ${JSON.stringify(
-//     cli.flags,
-//     null,
-//     4
-//   )}`
-// );
-
-// settle indentations type and count
-
 // 1. set defaults:
 let indentationCount = 2;
 if (cli.flags.tabs) {
@@ -154,38 +146,17 @@ if (cli.flags.tabs) {
 }
 // 2. overwrite defaults with explicitly set value:
 if (cli.flags.indentationCount) {
-  indentationCount = Number.parseInt(cli.flags.indentationCount, 10);
+  indentationCount = +cli.flags.indentationCount;
 }
 
 // FUNCTIONS
 // -----------------------------------------------------------------------------
 
-function stripWhitespace(str) {
-  return str.split("").reduce((acc, curr) => {
-    return `${acc}${curr.trim().length ? curr : ""}`;
-  }, "");
-}
-
 function readSortAndWriteOverFile(oneOfPaths) {
-  // console.log("\n\n\n\n==========\n\n\n\n");
-  // console.log(
-  //   `139 PROCESSING: ${`\u001b[${33}m${`oneOfPaths`}\u001b[${39}m`} = ${JSON.stringify(
-  //     oneOfPaths,
-  //     null,
-  //     4
-  //   )}`
-  // );
   return fs
     .readFile(oneOfPaths, "utf8")
     .then((filesContent) => {
       let parsedJson;
-      // console.log(
-      //   `150 ${`\u001b[${33}m${`filesContent`}\u001b[${39}m`} = ${JSON.stringify(
-      //     filesContent,
-      //     null,
-      //     4
-      //   )}`
-      // );
       try {
         // try to parse JSON
         parsedJson = JSON.parse(filesContent);
@@ -230,7 +201,6 @@ function readSortAndWriteOverFile(oneOfPaths) {
           // input after processing, then we return an array.
           // In this function, readSortAndWriteOverFile(), path came in,
           // we read it, now we return true if result differs after processing
-          // console.log(`200 returning compared:`);
 
           const stringified = JSON.stringify(
             traverse(obj, (key, val) => {
@@ -252,19 +222,7 @@ function readSortAndWriteOverFile(oneOfPaths) {
             null,
             cli.flags.tabs ? "\t".repeat(indentationCount) : indentationCount
           );
-          // console.log(
-          //   `222 ${`\u001b[${33}m${`stringified`}\u001b[${39}m`} = ${JSON.stringify(
-          //     stringified,
-          //     null,
-          //     4
-          //   )};\n${`\u001b[${33}m${`filesContent`}\u001b[${39}m`} = ${JSON.stringify(
-          //     filesContent,
-          //     null,
-          //     4
-          //   )}`
-          // );
-
-          return stripWhitespace(stringified) !== stripWhitespace(filesContent);
+          return stringified.trimEnd() !== filesContent.trimEnd();
         }
         // ELSE,
         return fs
@@ -305,6 +263,7 @@ function readSortAndWriteOverFile(oneOfPaths) {
       });
     })
     .catch((err) => {
+      /* istanbul ignore next */
       console.log(
         `${oneOfPaths} - ${`\u001b[${31}m${`BAD`}\u001b[${39}m`} - ${err}`
       );
@@ -314,10 +273,10 @@ function readSortAndWriteOverFile(oneOfPaths) {
 // Step #0. take care of -v and -h flags that are left out in meow.
 // -----------------------------------------------------------------------------
 
-if (cli.flags.version && !cli.flags.silent) {
+if (cli.flags.version) {
   log(cli.pkg.version);
   process.exit(0);
-} else if (cli.flags.help && !cli.flags.silent) {
+} else if (cli.flags.help) {
   log(cli.help);
   process.exit(0);
 }
@@ -325,26 +284,15 @@ if (cli.flags.version && !cli.flags.silent) {
 // Step #1. set up the cli
 // -----------------------------------------------------------------------------
 
-let { input } = cli;
-// if the folder/file name follows the flag (for example "-d "templates1"),
-// that name will be put under the flag's key value, not into cli.input.
-// That's handy for certain types of CLI apps, but not this one, as in our case
-// the flags position does not matter, they don't affect the keywords that follow.
-if (cli.flags) {
-  Object.keys(cli.flags).forEach((flag) => {
-    if (typeof cli.flags[flag] === "string") {
-      input = input.concat(cli.flags[flag]);
-    }
-  });
-}
+const { input } = cli;
 
 // Step #2. query the glob and follow the pipeline
 // -----------------------------------------------------------------------------
 
 globby(input, { dot: true })
-  .then((resolvedPathsArray) => {
+  .then((paths) => {
     // flip out of the pipeline if there are no paths resolved
-    if (resolvedPathsArray.length === 0 && !cli.flags.silent) {
+    if (paths.length === 0 && !cli.flags.silent) {
       log(
         `${chalk.grey(prefix)}${chalk.red(
           "The inputs don't lead to any json files! Exiting."
@@ -352,27 +300,21 @@ globby(input, { dot: true })
       );
       process.exit(0);
     }
-    // console.log(
-    //   `331 ${`\u001b[${33}m${`resolvedPathsArray`}\u001b[${39}m`} = ${JSON.stringify(
-    //     resolvedPathsArray,
-    //     null,
-    //     4
-    //   )}`
-    // );
-    return resolvedPathsArray;
+    return paths;
   })
   // glob each directory, reduce'ing all results (in promise shape) until all are resolved
-  .then((resolvedPathsArray) =>
+  .then((paths) =>
     pReduce(
-      resolvedPathsArray,
+      paths,
       (concattedTotal, singleDirOrFilePath) =>
         concattedTotal.concat(
           isDirectory(singleDirOrFilePath).then((bool) =>
+            /* istanbul ignore next */
             bool
               ? globby(
                   cli.flags.nodemodules
-                    ? [singleDirOrFilePath, "!node_modules"]
-                    : singleDirOrFilePath,
+                    ? singleDirOrFilePath
+                    : [singleDirOrFilePath, "!**/node_modules/**"],
                   {
                     expandDirectories: {
                       files: [".*", "*.json"],
@@ -384,55 +326,29 @@ globby(input, { dot: true })
         ),
       []
       // then reduce again, now actually concatenating them all together
-    ).then((received) => {
-      // console.log(
-      //   `364 ${`\u001b[${33}m${`received`}\u001b[${39}m`} = ${JSON.stringify(
-      //     received,
-      //     null,
-      //     4
-      //   )}`
-      // );
-      return pReduce(received, (total, single) => total.concat(single), []);
-    })
+    ).then((received) =>
+      pReduce(received, (total, single) => total.concat(single), [])
+    )
+  )
+  .then((paths) =>
+    paths.filter(
+      (oneOfPaths) =>
+        !oneOfPaths.includes("package-lock.json") &&
+        !oneOfPaths.includes("yarn.lock")
+    )
   )
-  .then((res) =>
+  .then((paths) =>
     !cli.flags.nodemodules
-      ? res.filter(
-          (oneOfPaths) =>
-            !oneOfPaths.includes("node_modules") &&
-            !oneOfPaths.includes("package-lock.json")
-        )
-      : res
+      ? paths.filter((oneOfPaths) => !oneOfPaths.includes("node_modules"))
+      : paths
   )
-  .then((res) =>
+  .then((paths) =>
     cli.flags.pack
-      ? res.filter((oneOfPaths) => !oneOfPaths.includes("package.json"))
-      : res
+      ? paths.filter((oneOfPaths) => !oneOfPaths.includes("package.json"))
+      : paths
   )
-  .then((paths) => {
-    // console.log(
-    //   `389 ${`\u001b[${33}m${`paths BEFORE`}\u001b[${39}m`} = ${JSON.stringify(
-    //     paths,
-    //     null,
-    //     4
-    //   )}`
-    // );
-    const tempRez = paths.filter((singlePath) => {
-      // console.log(`---------\n396 processing: ${singlePath}`);
-      // console.log(
-      //   `${`\u001b[${33}m${`path.extname(singlePath)`}\u001b[${39}m`} = ${JSON.stringify(
-      //     path.extname(singlePath),
-      //     null,
-      //     4
-      //   )}`
-      // );
-      // console.log(
-      //   `${`\u001b[${33}m${`path.basename(singlePath)`}\u001b[${39}m`} = ${JSON.stringify(
-      //     path.basename(singlePath),
-      //     null,
-      //     4
-      //   )}`
-      // );
+  .then((paths) =>
+    paths.filter((singlePath) => {
       return (
         path.extname(singlePath) === ".json" ||
         (typeof path.basename(singlePath) === "string" &&
@@ -444,45 +360,23 @@ globby(input, { dot: true })
             path.basename(singlePath).includes(badFile)
           ))
       );
-    });
-    // console.log(
-    //   `424 ${`\u001b[${33}m${`paths AFTER`}\u001b[${39}m`} = ${JSON.stringify(
-    //     tempRez,
-    //     null,
-    //     4
-    //   )}`
-    // );
-    return tempRez;
-  })
+    })
+  )
   // eslint-disable-next-line consistent-return
-  .then((received) => {
+  .then((paths) => {
     if (cli.flags.dry && !cli.flags.silent) {
       log(
         `${chalk.grey(prefix)}${chalk.yellow(
           "We'd try to sort the following files:"
-        )}\n${received.join("\n")}`
+        )}\n${paths.join("\n")}`
       );
     } else {
       if (cli.flags.ci) {
         // CI setting
-        // console.log(
-        //   `443 ${`\u001b[${33}m${`received`}\u001b[${39}m`} = ${JSON.stringify(
-        //     received,
-        //     null,
-        //     4
-        //   )}`
-        // );
-        return pFilter(received, (currentPath) =>
+        return pFilter(paths, (currentPath) =>
           readSortAndWriteOverFile(currentPath)
         ).then((received2) => {
-          // console.log(
-          //   `453 ${`\u001b[${33}m${`received2`}\u001b[${39}m`} = ${JSON.stringify(
-          //     received2,
-          //     null,
-          //     4
-          //   )}`
-          // );
-          // if any files differ, report and exit with non-zero code:
+          /* istanbul ignore else */
           if (received2.length && !cli.flags.silent) {
             log(
               `${chalk.grey(prefix)}${chalk.red(
@@ -494,7 +388,7 @@ globby(input, { dot: true })
             log(
               `${chalk.grey(prefix)}${chalk.white(
                 "All files were already sorted:"
-              )}\n${received.join("\n")}`
+              )}\n${paths.join("\n")}`
             );
             process.exit(0);
           }
@@ -502,19 +396,9 @@ globby(input, { dot: true })
       }
       // not a CI setting
       return pReduce(
-        received,
+        paths,
         (counter, currentPath) =>
           readSortAndWriteOverFile(currentPath)
-            // .then((received2) => {
-            //   // console.log(
-            //   //   `484 ${`\u001b[${33}m${`received`}\u001b[${39}m`} = ${JSON.stringify(
-            //   //     received,
-            //   //     null,
-            //   //     4
-            //   //   )}`
-            //   // );
-            //   return received2;
-            // })
             .then((res) =>
               res
                 ? {
@@ -527,6 +411,7 @@ globby(input, { dot: true })
                   }
             )
             .catch((err) => {
+              /* istanbul ignore next */
               if (!cli.flags.silent) {
                 log(
                   `${chalk.grey(prefix)}${chalk.red(
@@ -534,17 +419,9 @@ globby(input, { dot: true })
                   )} ${err}`
                 );
               }
-              return counter;
             }),
         { good: [], bad: [] }
       ).then((counter) => {
-        // console.log(
-        //   `516 ${`\u001b[${33}m${`counter`}\u001b[${39}m`} = ${JSON.stringify(
-        //     counter,
-        //     null,
-        //     4
-        //   )}`
-        // );
         if (!cli.flags.silent) {
           log(
             `\n${chalk.grey(prefix)}${chalk.green(
@@ -568,6 +445,7 @@ globby(input, { dot: true })
     }
   })
   .catch((err) => {
+    /* istanbul ignore next */
     if (!cli.flags.silent) {
       log(`${chalk.grey(prefix)}${chalk.red("Oops!")} ${err}`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-sort-cli",
-  "version": "1.19.0",
+  "version": "2.0.3",
   "description": "Command line app to deep sort JSON files, retains package.json special key order",
   "keywords": [
     "app",
@@ -16,16 +16,17 @@
   ],
   "homepage": "https://codsen.com/os/json-sort-cli/",
   "repository": {
-    "directory": "packages/json-sort-cli",
     "type": "git",
-    "url": "https://github.com/codsen/codsen.git"
+    "url": "https://github.com/codsen/codsen.git",
+    "directory": "packages/json-sort-cli"
   },
   "license": "MIT",
   "author": {
-    "email": "roy@codsen.com",
     "name": "Roy Revelt",
+    "email": "roy@codsen.com",
     "url": "https://codsen.com"
   },
+  "type": "module",
   "bin": {
     "jsonsort": "cli.js",
     "sortjson": "cli.js"
@@ -42,16 +43,18 @@
     "republish": "npm publish || :",
     "tap": "tap",
     "test": "npm run lint && npm run unittest && npm run format",
-    "unittest": "./node_modules/.bin/tap --no-only --output-file=testStats.md --reporter=terse && npm run clean_cov"
+    "unittest": "tap --no-only --output-file=testStats.md --reporter=terse && npm run clean_cov"
   },
   "tap": {
+    "check-coverage": false,
     "coverage-report": [
       "json-summary",
       "text"
     ],
-    "nyc-arg": [
-      "--exclude=**/*.cjs.js",
-      "--exclude=**/*.umd.js"
+    "node-arg": [
+      "--no-warnings",
+      "--experimental-loader",
+      "@istanbuljs/esm-loader-hook"
     ],
     "timeout": 0
   },
@@ -69,29 +72,33 @@
     }
   },
   "dependencies": {
-    "ast-monkey-traverse": "^2.1.0",
-    "chalk": "^4.1.1",
+    "ast-monkey-traverse": "^3.0.3",
+    "chalk": "^4.1.2",
     "fs-extra": "^10.0.0",
-    "globby": "^11.0.3",
+    "globby": "^12.0.2",
     "is-d": "^1.0.0",
     "lodash.isplainobject": "^4.0.6",
-    "meow": "^9.0.0",
-    "p-filter": "^2.1.0",
-    "p-reduce": "^2.1.0",
-    "sort-package-json": "^1.50.0",
+    "meow": "^10.1.1",
+    "p-filter": "^3.0.0",
+    "p-reduce": "^3.0.0",
+    "sort-package-json": "^1.52.0",
     "sorted-object": "^2.0.1",
     "update-notifier": "^5.1.0"
   },
   "devDependencies": {
+    "@istanbuljs/esm-loader-hook": "^0.1.2",
     "@types/lodash.isplainobject": "^4.0.6",
-    "core-js": "^3.12.1",
+    "core-js": "^3.19.0",
     "cross-env": "^7.0.3",
-    "eslint": "^7.27.0",
-    "execa": "^5.0.0",
-    "lect": "^0.17.0",
-    "p-map": "^4.0.0",
-    "tap": "^14.11.0",
-    "tempy": "^1.0.1",
-    "tslib": "^2.2.0"
+    "eslint": "^8.1.0",
+    "execa": "^5.1.1",
+    "lect": "^0.18.3",
+    "p-map": "^5.2.0",
+    "tap": "^15.0.10",
+    "tempy": "^2.0.0",
+    "tslib": "^2.3.1"
+  },
+  "engines": {
+    "node": ">=12"
   }
 }