json-sort-cli 4.2.1 → 4.2.3

package/cli.js

@@ -1,121 +1,16 @@
 #!/usr/bin/env node
 
-// VARS
-// -----------------------------------------------------------------------------
-
 import { createRequire } from "node:module";
 import path from "node:path";
 import { glob } from "codsen-glob";
-import { codsenCLI } from "codsen-utils";
 import updateNotifier from "update-notifier";
 import { ProcessingError, processFiles } from "./process-files.js";
 
 const require1 = createRequire(import.meta.url);
 const pkg = require1("./package.json");
-
-const colours = {
-  green: 32,
-  grey: 90,
-  red: 31,
-  white: 37,
-  yellow: 33,
-};
-
-function colour(str, colourCode) {
-  return `\u001b[${colourCode}m${str}\u001b[39m`;
-}
-
 const prefix = "✨ json-sort-cli: ";
-const { log } = console;
-const cli = codsenCLI(
-  `
-  Usage
-    $ jsonsort YOURFILE.json
-    $ sortjson YOURFILE.json
-    $ sortjson templatesfolder1 templatesfolder2 package.json
-  or, just type "jsonsort" and it will let you pick a file.
-
-  Options
-    -n, --nodemodules      Don't ignore any node_modules folders
-    -t, --tabs             Use tabs for JSON file indentation
-    -i, --indentationCount How many spaces/tabs to use (default: 2 for spaces or 1 for tabs)
-    -s, --silent           Does not show the result per-file, only totals in the end
-    -h, --help             Shows this help
-    -v, --version          Shows the current version
-    -a, --arrays           Also sort any arrays if they contain only string elements
-    -d, --dry              Only list all the files about to be processed
-    -p, --pack             Exclude all package.json files
-    -c, --ci               Only exits with non-zero code if files COULD BE sorted
-    -l, --lineEnding       Set to "cr", "crlf" or "lf" to override the default
-                           (which is either EOL format used in the file, or Mac LF)
-
-  Example
-    Call anywhere using glob patterns. If you put them as string, this library
-    will parse globs. If you put as system globs without quotes, your shell will expand them.
-`,
-  {
-    pkg,
-    flags: {
-      nodemodules: {
-        type: "boolean",
-        shortFlag: "n",
-        default: false,
-      },
-      tabs: {
-        type: "boolean",
-        shortFlag: "t",
-        default: false,
-      },
-      silent: {
-        type: "boolean",
-        shortFlag: "s",
-        default: false,
-      },
-      arrays: {
-        type: "boolean",
-        shortFlag: "a",
-        default: false,
-      },
-      pack: {
-        type: "boolean",
-        shortFlag: "p",
-        default: false,
-      },
-      dry: {
-        type: "boolean",
-        shortFlag: "d",
-        default: false,
-      },
-      ci: {
-        type: "boolean",
-        shortFlag: "c",
-        default: false,
-      },
-      help: {
-        type: "boolean",
-        shortFlag: "h",
-        default: false,
-      },
-      version: {
-        type: "boolean",
-        shortFlag: "v",
-        default: false,
-      },
-      indentationCount: {
-        type: "number",
-        shortFlag: "i",
-      },
-      lineEnding: {
-        type: "string",
-        shortFlag: "l",
-      },
-    },
-  },
-);
-updateNotifier({ pkg }).notify();
-
-const nonJsonFormats = ["yml", "toml", "yaml"]; // to save time
-const badFiles = [
+const nonJsonFormats = new Set([".yml", ".toml", ".yaml"]);
+const ignoredBasenames = new Set([
   ".DS_Store",
   "npm-debug.log",
   ".svn",
@@ -124,236 +19,408 @@ const badFiles = [
   ".lock-wscript",
   "package-lock.json",
   "npm-shrinkwrap.json",
-];
+  "yarn.lock",
+]);
+const flagDefinitions = {
+  arrays: { short: "a", type: "boolean" },
+  ci: { short: "c", type: "boolean" },
+  dry: { short: "d", type: "boolean" },
+  help: { short: "h", type: "boolean" },
+  indentationCount: { short: "i", type: "value" },
+  lineEnding: { short: "l", type: "value" },
+  nodemodules: { short: "n", type: "boolean" },
+  pack: { short: "p", type: "boolean" },
+  silent: { short: "s", type: "boolean" },
+  tabs: { short: "t", type: "boolean" },
+  version: { short: "v", type: "boolean" },
+};
+const shortToLong = new Map(
+  Object.entries(flagDefinitions).map(([long, definition]) => [
+    definition.short,
+    long,
+  ]),
+);
+
+const help = `
+Usage
+  $ jsonsort YOURFILE.json
+  $ sortjson templatesfolder1 templatesfolder2 package.json
+  $ jsonsort
+
+With no arguments, jsonsort recursively sorts JSON files below the current
+directory. Discovered symbolic links are not followed. An explicitly selected
+symbolic-link directory is resolved as the selected root; symbolic-link files
+are rejected before reading.
+
+Options
+  -n, --nodemodules      Include JSON files inside node_modules; lockfiles remain excluded
+  -t, --tabs             Use tabs for indentation
+  -i, --indentationCount Use 0-10 spaces or tabs (default: 2 spaces or 1 tab)
+  -s, --silent           Suppress all terminal output; use the exit code for the result
+  -h, --help             Show this help
+  -v, --version          Show the current version
+  -a, --arrays           Sort arrays that contain only strings
+  -d, --dry              List candidate files without reading or writing them
+  -p, --pack             Exclude package.json files
+  -c, --ci               Check without writing; exit 9 when canonical output differs
+  -l, --lineEnding       Use "cr", "crlf", or "lf" instead of the detected line ending
+
+Use -- before a path that begins with a dash. Invalid options exit 1 before
+file discovery. Processing failures exit 1 and don't stop independent files.
+
+Example
+  $ jsonsort "templates/**/*.json" --arrays --lineEnding lf
+`;
 
-// 1. set defaults:
-let indentationCount = 2;
-if (cli.flags.tabs) {
-  indentationCount = 1;
+function argumentError(message) {
+  throw new TypeError(
+    `json-sort-cli/parseArguments(): [THROW_ID_01] ${message}`,
+  );
 }
-// 2. overwrite defaults with explicitly set value:
-if (cli.flags.indentationCount) {
-  indentationCount = +cli.flags.indentationCount;
+
+function requestsSilent(rawArguments) {
+  let optionsEnded = false;
+  for (const argument of rawArguments) {
+    if (optionsEnded) {
+      continue;
+    }
+    if (argument === "--") {
+      optionsEnded = true;
+    } else if (argument === "--silent") {
+      return true;
+    } else if (argument.startsWith("-") && !argument.startsWith("--")) {
+      for (const short of argument.slice(1)) {
+        const name = shortToLong.get(short);
+        if (!name) {
+          break;
+        }
+        if (name === "silent") {
+          return true;
+        }
+        if (flagDefinitions[name].type === "value") {
+          break;
+        }
+      }
+    }
+  }
+  return false;
 }
 
-// Step #0. take care of the short -v and -h flags, which codsenCLI leaves
-// to us (it answers the long --version and --help on its own).
-// -----------------------------------------------------------------------------
+function parseArguments(rawArguments) {
+  const expanded = rawArguments.flatMap((argument) => {
+    const match = argument.match(/^-(i|l)\s+(.+)$/u);
+    return match ? [`-${match[1]}`, match[2]] : [argument];
+  });
+  const flags = Object.fromEntries(
+    Object.keys(flagDefinitions).map((name) => [name, false]),
+  );
+  flags.indentationCount = undefined;
+  flags.lineEnding = undefined;
+  const input = [];
+  const seen = new Set();
+  let optionsEnded = false;
+
+  function setFlag(name, value = true) {
+    if (seen.has(name)) {
+      argumentError(`Option --${name} was provided more than once`);
+    }
+    seen.add(name);
+    flags[name] = value;
+  }
+
+  for (let index = 0; index < expanded.length; index += 1) {
+    const argument = expanded[index];
+    if (optionsEnded) {
+      input.push(argument);
+      continue;
+    }
+    if (argument === "--") {
+      optionsEnded = true;
+      continue;
+    }
+    if (!argument.startsWith("-") || argument === "-") {
+      input.push(argument);
+      continue;
+    }
 
-if (cli.flags.version) {
-  log(pkg.version);
-  process.exit(0);
-} else if (cli.flags.help) {
-  log(cli.help);
-  process.exit(0);
+    if (argument.startsWith("--")) {
+      const equalsIndex = argument.indexOf("=");
+      const name = argument.slice(
+        2,
+        equalsIndex === -1 ? undefined : equalsIndex,
+      );
+      const definition = flagDefinitions[name];
+      if (!definition) {
+        argumentError(`Unknown option --${name}`);
+      }
+      if (definition.type === "boolean") {
+        if (equalsIndex !== -1) {
+          argumentError(`Option --${name} doesn't accept a value`);
+        }
+        setFlag(name);
+        continue;
+      }
+
+      let value =
+        equalsIndex === -1 ? undefined : argument.slice(equalsIndex + 1);
+      if (value === undefined) {
+        value = expanded[index + 1];
+        const flagShapedValue =
+          value?.startsWith("-") &&
+          !(name === "indentationCount" && /^-\d/u.test(value));
+        if (value === undefined || flagShapedValue) {
+          argumentError(`Option --${name} requires a value`);
+        }
+        index += 1;
+      }
+      if (value === "") {
+        argumentError(`Option --${name} requires a value`);
+      }
+      setFlag(name, value);
+      continue;
+    }
+
+    let shortFlags = argument.slice(1);
+    while (shortFlags.length) {
+      const short = shortFlags[0];
+      const name = shortToLong.get(short);
+      if (!name) {
+        argumentError(`Unknown option -${short}`);
+      }
+      const definition = flagDefinitions[name];
+      shortFlags = shortFlags.slice(1);
+      if (definition.type === "boolean") {
+        setFlag(name);
+        continue;
+      }
+
+      let value = shortFlags.replace(/^=/u, "");
+      shortFlags = "";
+      if (!value) {
+        value = expanded[index + 1];
+        const flagShapedValue =
+          value?.startsWith("-") &&
+          !(name === "indentationCount" && /^-\d/u.test(value));
+        if (value === undefined || flagShapedValue) {
+          argumentError(`Option -${short} requires a value`);
+        }
+        index += 1;
+      }
+      setFlag(name, value);
+    }
+  }
+
+  const defaultIndentation = flags.tabs ? 1 : 2;
+  const indentationCount =
+    flags.indentationCount === undefined
+      ? defaultIndentation
+      : Number(flags.indentationCount);
+  if (
+    !Number.isInteger(indentationCount) ||
+    indentationCount < 0 ||
+    indentationCount > 10
+  ) {
+    argumentError("indentationCount must be an integer from 0 to 10");
+  }
+  if (
+    flags.lineEnding !== undefined &&
+    !["cr", "crlf", "lf"].includes(flags.lineEnding)
+  ) {
+    argumentError('lineEnding must be "cr", "crlf", or "lf"');
+  }
+  if (
+    input.length === 0 &&
+    expanded.length > 0 &&
+    !flags.help &&
+    !flags.version
+  ) {
+    argumentError(
+      "Provide at least one path, or run jsonsort with no arguments",
+    );
+  }
+
+  return {
+    flags,
+    indentationCount,
+    input: input.length ? input : ["**/*.json"],
+  };
 }
 
-// Step #1. set up the cli
-// -----------------------------------------------------------------------------
+function isCandidate(filePath) {
+  const basename = path.basename(filePath);
+  if (ignoredBasenames.has(basename)) {
+    return false;
+  }
 
-const { input } = cli;
-if (Array.isArray(input) && !input.length) {
-  input.push("**/*.json");
+  const extension = path.extname(filePath).toLowerCase();
+  return (
+    extension === ".json" ||
+    (basename.startsWith(".") && !nonJsonFormats.has(extension))
+  );
 }
 
-// Step #2. query the glob and follow the pipeline
-// -----------------------------------------------------------------------------
+function createPrinter() {
+  const useColour = Boolean(process.stdout.isTTY && !process.env.NO_COLOR);
+  const colours = { green: 32, grey: 90, red: 31, white: 37, yellow: 33 };
+  const colour = (value, name) =>
+    useColour ? `\u001b[${colours[name]}m${value}\u001b[39m` : value;
+  return { colour };
+}
 
-glob(
-  [
-    ...input,
-    "!**/package-lock.json",
-    "!**/yarn.lock",
-    ...(cli.flags.nodemodules ? [] : ["!**/node_modules/**"]),
-    ...(cli.flags.pack ? ["!**/package.json"] : []),
-  ],
-  {
-    dot: true,
-    expandDirectories: { files: [".*", "*.json"] },
-  },
-)
-  .then((paths) => {
-    // flip out of the pipeline if there are no paths resolved
-    if (paths.length === 0 && !cli.flags.silent) {
-      log(
-        `${colour(prefix, colours.grey)}${colour(
-          "The inputs don't lead to any json files! Exiting.",
-          colours.red,
-        )}`,
-      );
-      process.exit(0);
+async function main() {
+  const rawArguments = process.argv.slice(2);
+  const silentRequested = requestsSilent(rawArguments);
+  let parsed;
+  try {
+    parsed = parseArguments(rawArguments);
+  } catch (error) {
+    if (!silentRequested) {
+      console.error(error.message);
     }
-    return paths;
-  })
-  .then((paths) =>
-    paths.filter(
-      (oneOfPaths) =>
-        !oneOfPaths.includes("package-lock.json") &&
-        !oneOfPaths.includes("yarn.lock"),
-    ),
-  )
-  .then((paths) =>
-    !cli.flags.nodemodules
-      ? paths.filter((oneOfPaths) => !oneOfPaths.includes("node_modules"))
-      : paths,
-  )
-  .then((paths) =>
-    cli.flags.pack
-      ? paths.filter((oneOfPaths) => !oneOfPaths.includes("package.json"))
-      : paths,
-  )
-  .then((paths) =>
-    paths.filter((singlePath) => {
-      return (
-        path.extname(singlePath) === ".json" ||
-        (typeof path.basename(singlePath) === "string" &&
-          path.basename(singlePath).startsWith(".") &&
-          !nonJsonFormats.some((badExtension) =>
-            path.extname(singlePath).includes(badExtension),
-          ) &&
-          !badFiles.some((badFile) =>
-            path.basename(singlePath).includes(badFile),
-          ))
-      );
-    }),
-  )
+    process.exitCode = 1;
+    return;
+  }
+
+  const { flags, indentationCount, input } = parsed;
+  if (flags.version) {
+    console.log(pkg.version);
+    return;
+  }
+  if (flags.help) {
+    console.log(help);
+    return;
+  }
+
+  if (!flags.silent && !flags.ci && process.stdout.isTTY) {
+    try {
+      updateNotifier({ pkg }).notify();
+    } catch {}
+  }
+
+  const { colour } = createPrinter();
+  let paths;
+  try {
+    paths = await glob(
+      [
+        ...input,
+        "!**/package-lock.json",
+        "!**/npm-shrinkwrap.json",
+        "!**/yarn.lock",
+        ...(flags.nodemodules ? [] : ["!**/node_modules/**"]),
+        ...(flags.pack ? ["!**/package.json"] : []),
+      ],
+      {
+        dot: true,
+        expandDirectories: { files: [".*", "*.json", "*.JSON"] },
+        followSymbolicLinks: false,
+      },
+    );
+    paths = paths.filter(isCandidate);
+  } catch (error) {
+    if (!flags.silent) {
+      console.error(`${prefix}${error}`);
+    }
+    process.exitCode = 1;
+    return;
+  }
+
+  if (!paths.length) {
+    if (!flags.silent) {
+      console.log(`${prefix}The inputs don't lead to any JSON files. Exiting.`);
+    }
+    return;
+  }
 
-  .then((paths) => {
-    if (cli.flags.dry && !cli.flags.silent) {
-      log(
-        `${colour(prefix, colours.grey)}${colour(
-          "We'd try to sort the following files:",
-          colours.yellow,
-        )}\n${paths.join("\n")}`,
+  if (flags.dry) {
+    if (!flags.silent) {
+      console.log(
+        `${prefix}We'd try to sort the following files:\n${paths.join("\n")}`,
       );
-      return;
     }
+    return;
+  }
 
-    const options = {
-      arrays: cli.flags.arrays,
-      ci: cli.flags.ci,
+  try {
+    const { successful, unsorted } = await processFiles(paths, {
+      arrays: flags.arrays,
+      ci: flags.ci,
       indentationCount,
-      lineEnding: cli.flags.lineEnding,
-      pack: cli.flags.pack,
-      tabs: cli.flags.tabs,
+      lineEnding: flags.lineEnding || undefined,
+      pack: flags.pack,
+      tabs: flags.tabs,
       onOutcome(outcome) {
-        if (cli.flags.silent) {
+        if (flags.silent) {
           return;
         }
         if (outcome.status === "failure") {
-          log(
-            `${colour(prefix, colours.grey)}${outcome.path} - ${colour(
-              "BAD",
-              colours.red,
-            )} (${outcome.stage}) - ${outcome.error}`,
-          );
-        } else if (!cli.flags.ci) {
-          log(
-            `${colour(prefix, colours.grey)}${outcome.path} - ${colour(
-              "OK",
-              colours.green,
-            )}`,
+          console.error(
+            `${prefix}${outcome.path} - BAD (${outcome.stage}) - ${outcome.error}`,
           );
+        } else if (!flags.ci) {
+          console.log(`${prefix}${outcome.path} - OK`);
         }
       },
-    };
+    });
 
-    return processFiles(paths, options)
-      .then(({ successful, unsorted }) => {
-        if (cli.flags.silent) {
-          if (cli.flags.ci && unsorted.length) {
-            process.exitCode = 9;
-          }
-          return;
-        }
-        if (cli.flags.ci) {
-          if (unsorted.length) {
-            log(
-              `${colour(prefix, colours.grey)}${colour(
-                "Unsorted files:",
-                colours.red,
-              )}\n${unsorted.join("\n")}`,
-            );
-            process.exitCode = 9;
-          } else {
-            log(
-              `${colour(prefix, colours.grey)}${colour(
-                "All files were already sorted:",
-                colours.white,
-              )}\n${successful.join("\n")}`,
-            );
-          }
-          return;
-        }
-        log(
-          `\n${colour(prefix, colours.grey)}${colour(
-            `All ${successful.length} file${
-              successful.length === 1 ? "" : "s"
-            } sorted`,
-            colours.green,
-          )}`,
+    if (flags.silent) {
+      if (flags.ci && unsorted.length) {
+        process.exitCode = 9;
+      }
+      return;
+    }
+    if (flags.ci) {
+      if (unsorted.length) {
+        console.log(
+          `${prefix}${colour("Unsorted files:", "red")}\n${unsorted.join("\n")}`,
         );
-      })
-      .catch((error) => {
-        if (!(error instanceof ProcessingError)) {
-          throw error;
-        }
-        if (!cli.flags.silent) {
-          if (cli.flags.ci) {
-            const unsorted = new Set(error.unsorted);
-            const alreadySorted = error.successful.filter(
-              (filePath) => !unsorted.has(filePath),
-            );
-            if (alreadySorted.length) {
-              log(
-                `${colour(prefix, colours.grey)}${colour(
-                  `${alreadySorted.length} file${
-                    alreadySorted.length === 1 ? "" : "s"
-                  } already sorted:`,
-                  colours.green,
-                )}\n${alreadySorted.join("\n")}`,
-              );
-            }
-            if (error.unsorted.length) {
-              log(
-                `${colour(prefix, colours.grey)}${colour(
-                  "Unsorted files:",
-                  colours.red,
-                )}\n${error.unsorted.join("\n")}`,
-              );
-            }
-          } else if (error.successful.length) {
-            log(
-              `\n${colour(prefix, colours.grey)}${colour(
-                `${error.successful.length} file${
-                  error.successful.length === 1 ? "" : "s"
-                } sorted`,
-                colours.green,
-              )}`,
-            );
-          }
-          log(
-            `${colour(prefix, colours.grey)}${colour(
-              `${error.failures.length} file${
-                error.failures.length === 1 ? "" : "s"
-              } could not be ${cli.flags.ci ? "checked" : "sorted"}`,
-              colours.red,
-            )} ${colour(
-              ` - ${error.failures
-                .map(({ path: failedPath }) => failedPath)
-                .join(" - ")}`,
-              colours.grey,
-            )}`,
+        process.exitCode = 9;
+      } else {
+        console.log(
+          `${prefix}${colour("All files were already sorted:", "white")}\n${successful.join("\n")}`,
+        );
+      }
+      return;
+    }
+    console.log(
+      `\n${prefix}${colour(
+        `All ${successful.length} file${successful.length === 1 ? "" : "s"} sorted`,
+        "green",
+      )}`,
+    );
+  } catch (error) {
+    if (!(error instanceof ProcessingError)) {
+      if (!flags.silent) {
+        console.error(`${prefix}${error}`);
+      }
+      process.exitCode = 1;
+      return;
+    }
+
+    if (!flags.silent) {
+      if (flags.ci) {
+        const unsorted = new Set(error.unsorted);
+        const alreadySorted = error.successful.filter(
+          (filePath) => !unsorted.has(filePath),
+        );
+        if (alreadySorted.length) {
+          console.log(
+            `${prefix}${alreadySorted.length} file${alreadySorted.length === 1 ? "" : "s"} already sorted:\n${alreadySorted.join("\n")}`,
           );
         }
-        process.exitCode = 1;
-      });
-  })
-  .catch((err) => {
-    if (!cli.flags.silent) {
-      log(
-        `${colour(prefix, colours.grey)}${colour("Oops!", colours.red)} ${err}`,
+        if (error.unsorted.length) {
+          console.log(`${prefix}Unsorted files:\n${error.unsorted.join("\n")}`);
+        }
+      } else if (error.successful.length) {
+        console.log(
+          `\n${prefix}${error.successful.length} file${error.successful.length === 1 ? "" : "s"} sorted`,
+        );
+      }
+      console.error(
+        `${prefix}${error.failures.length} file${error.failures.length === 1 ? "" : "s"} could not be ${flags.ci ? "checked" : "sorted"} - ${error.failures.map(({ path: failedPath }) => failedPath).join(" - ")}`,
       );
     }
     process.exitCode = 1;
-  });
+  }
+}
+
+await main();