json-sort-cli 3.0.12 → 3.1.1

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.1.1](https://github.com/codsen/codsen/compare/json-sort-cli@3.1.0...json-sort-cli@3.1.1) (2023-04-18)
+
+### Bug Fixes
+
+- fix `-c` flag to correctly recognise different EOLs as per `-l` ([5af3ba1](https://github.com/codsen/codsen/commit/5af3ba16962c2dd001005780a3843ecf675389f4)), closes [#73](https://github.com/codsen/codsen/issues/73)
+
+# [3.1.0](https://github.com/codsen/codsen/compare/json-sort-cli@3.0.12...json-sort-cli@3.1.0) (2023-04-16)
+
+### Features
+
+- `-l` or `--lineEnding` flag to override the default - the EOL format found in file (or LF) ([1788a77](https://github.com/codsen/codsen/commit/1788a7701629713a1b9ad9b992ad01aa7d456068))
+
 ## 3.0.7 (2023-01-06)
 
 ### Bug Fixes

package/cli.js

@@ -12,7 +12,7 @@ import pReduce from "p-reduce";
 import pFilter from "p-filter";
 import { globby } from "globby";
 import { createRequire } from "module";
-import { isPlainObject } from "codsen-utils";
+import { isPlainObject, resolveEolSetting } from "codsen-utils";
 import updateNotifier from "update-notifier";
 import { traverse } from "ast-monkey-traverse";
 import sortPackageJson, { sortOrder } from "sort-package-json";
@@ -66,7 +66,7 @@ const cli = meow(
   Options
     -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)
+    -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
@@ -74,6 +74,8 @@ const cli = meow(
     -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
@@ -131,6 +133,10 @@ const cli = meow(
         type: "number",
         alias: "i",
       },
+      lineEnding: {
+        type: "string",
+        alias: "l",
+      },
     },
   }
 );
@@ -165,6 +171,8 @@ function readSortAndWriteOverFile(oneOfPaths) {
   return fs
     .readFile(oneOfPaths, "utf8")
     .then((filesContent) => {
+      let eolChar = resolveEolSetting(filesContent, cli.flags.lineEnding);
+
       let parsedJson;
       try {
         // try to parse JSON
@@ -194,6 +202,7 @@ function readSortAndWriteOverFile(oneOfPaths) {
             spaces: cli.flags.tabs
               ? "\t".repeat(indentationCount)
               : indentationCount,
+            EOL: eolChar,
           }
         );
       } else {
@@ -212,6 +221,8 @@ function readSortAndWriteOverFile(oneOfPaths) {
           // we read it, now we return true if result differs after processing
 
           let stringified = JSON.stringify(
+            // The traversal below will mutate, not just traverse, -
+            // whatever you return from the callback below, gets written
             traverse(obj, (key, val) => {
               let current = val !== undefined ? val : key;
               if (isPlainObject(current)) {
@@ -223,7 +234,7 @@ function readSortAndWriteOverFile(oneOfPaths) {
                 current.length > 1 &&
                 current.every(isStr)
               ) {
-                // alphabetical sort
+                // alphabetical sort, this value gets written
                 return current.sort((a, b) => a.localeCompare(b));
               }
               return current;
@@ -231,7 +242,25 @@ function readSortAndWriteOverFile(oneOfPaths) {
             null,
             cli.flags.tabs ? "\t".repeat(indentationCount) : indentationCount
           );
-          return stringified.trimEnd() !== filesContent.trimEnd();
+
+          if (eolChar === "\r\n") {
+            // CRLF
+            stringified = stringified
+              .replaceAll(/(?<!\r)\n/g, "\r\n")
+              .replaceAll(/\r(?!\n)/g, "\n");
+          } else {
+            // LF or CR
+            stringified = stringified.replaceAll(/(?:\r?\n)|\r/g, eolChar);
+          }
+
+          return (
+            stringified
+              .replaceAll(
+                /\r\n/g,
+                resolveEolSetting(filesContent, cli.flags.lineEnding)
+              )
+              .trimEnd() !== filesContent.trimEnd()
+          );
         }
 
         // ELSE,
@@ -258,6 +287,7 @@ function readSortAndWriteOverFile(oneOfPaths) {
               spaces: cli.flags.tabs
                 ? "\t".repeat(indentationCount)
                 : indentationCount,
+              EOL: resolveEolSetting(filesContent, cli.flags.lineEnding),
             }
           )
           .then(() => {
@@ -318,8 +348,8 @@ globby(input, { dot: true })
   .then((paths) =>
     pReduce(
       paths,
-      (concattedTotal, singleDirOrFilePath) =>
-        concattedTotal.concat(
+      (concatTotal, singleDirOrFilePath) =>
+        concatTotal.concat(
           isDirectory(singleDirOrFilePath).then((bool) =>
             bool
               ? globby(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-sort-cli",
-  "version": "3.0.12",
+  "version": "3.1.1",
   "description": "Command line app to deep sort JSON files, retains package.json special key order",
   "keywords": [
     "app",
@@ -67,9 +67,9 @@
     }
   },
   "dependencies": {
-    "ast-monkey-traverse": "^4.0.8",
+    "ast-monkey-traverse": "^4.0.9",
     "chalk": "^5.2.0",
-    "codsen-utils": "^1.3.1",
+    "codsen-utils": "^1.4.0",
     "fs-extra": "^11.1.1",
     "globby": "^13.1.4",
     "is-d": "^1.0.0",