@lntvow/sort-package-json 1.0.0

package/package.json

@@ -0,0 +1,108 @@
+{
+  "name": "@lntvow/sort-package-json",
+  "version": "1.0.0",
+  "description": "Sort an Object or package.json based on the well-known package.json keys",
+  "keywords": [
+    "keys",
+    "object",
+    "sort"
+  ],
+  "homepage": "https://github.com/keithamus/sort-package-json#readme",
+  "bugs": {
+    "url": "https://github.com/keithamus/sort-package-json/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/keithamus/sort-package-json.git"
+  },
+  "license": "MIT",
+  "author": "Keith Cirkel <npm@keithcirkel.co.uk> (http://keithcirkel.co.uk/)",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "require": {
+        "types": "./index.d.ts",
+        "default": "./index.cjs"
+      }
+    }
+  },
+  "types": "index.d.ts",
+  "bin": "cli.js",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "cli.js",
+    "reporter.js",
+    "index.cjs"
+  ],
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "lint-staged": {
+    "package.json": [
+      "node cli.js"
+    ],
+    "*.js": [
+      "eslint --fix"
+    ],
+    "**/*": [
+      "prettier --write --ignore-unknown"
+    ]
+  },
+  "prettier": {
+    "semi": false,
+    "singleQuote": true
+  },
+  "ava": {
+    "verbose": true
+  },
+  "dependencies": {
+    "detect-indent": "^7.0.2",
+    "detect-newline": "^4.0.1",
+    "git-hooks-list": "^4.1.1",
+    "is-plain-obj": "^4.1.0",
+    "semver": "^7.7.3",
+    "sort-object-keys": "^2.0.1",
+    "tinyglobby": "^0.2.15"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^20.1.0",
+    "@commitlint/config-conventional": "^20.0.0",
+    "@eslint/js": "^9.39.1",
+    "ava": "^6.4.1",
+    "bumpp": "^11.0.1",
+    "c8": "^10.1.3",
+    "dot-prop": "^10.1.0",
+    "esbuild": "^0.27.0",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-n": "^17.23.1",
+    "eslint-plugin-promise": "^7.2.1",
+    "globals": "^16.5.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.7.1",
+    "semantic-release": "^25.0.2",
+    "tempy": "^3.1.0",
+    "tstyche": "^5.0.1"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "esbuild index.js --bundle --platform=node --outfile=index.cjs --external:semver --external:git-hooks-list",
+    "fix": "eslint . --fix && prettier . --write && node cli.js \"package.json\"",
+    "lint": "eslint . && prettier . \"!**/*.js\" --check && node cli.js \"package.json\" --check",
+    "semantic-release": "semantic-release",
+    "test": "ava && tstyche",
+    "test-coverage": "c8 npm run test",
+    "update-snapshots": "ava --update-snapshots",
+    "release": "git add . && bumpp package.json --all --no-tag --no-print-commits"
+  }
+}

package/reporter.js

@@ -0,0 +1,139 @@
+const getFilesCountText = (count) => (count === 1 ? '1 file' : `${count} files`)
+
+class Reporter {
+  #hasPrinted = false
+  #options
+  #status
+  #logger
+
+  constructor(options) {
+    this.#options = options
+    this.#status = {
+      matchedFilesCount: 0,
+      failedFilesCount: 0,
+      wellSortedFilesCount: 0,
+      changedFilesCount: 0,
+      changedFiles: [],
+    }
+
+    this.#logger = options.shouldBeQuiet
+      ? { log() {}, error() {} }
+      : {
+          log: (...args) => {
+            this.#hasPrinted = true
+            console.log(...args)
+          },
+          error: (...args) => {
+            this.#hasPrinted = true
+            console.error(...args)
+          },
+        }
+  }
+
+  reportFound(/* file */) {
+    this.#status.matchedFilesCount++
+  }
+
+  // The file is well-sorted
+  reportNotChanged(/* file */) {
+    this.#status.wellSortedFilesCount++
+  }
+
+  reportChanged(file) {
+    this.#status.changedFilesCount++
+    if (this.#options.isCheck) {
+      this.#status.changedFiles.push(file)
+      return
+    }
+
+    this.#logger.log(`${file} is sorted!`)
+  }
+
+  reportFailed(file, error) {
+    this.#status.failedFilesCount++
+
+    console.error('Error on: ' + file)
+    this.#logger.error(error.message)
+  }
+
+  printSummary() {
+    const {
+      matchedFilesCount,
+      failedFilesCount,
+      changedFilesCount,
+      wellSortedFilesCount,
+      changedFiles,
+    } = this.#status
+
+    if (matchedFilesCount === 0) {
+      console.error('No matching files.')
+      process.exitCode = 2
+      return
+    }
+
+    const { isCheck, shouldBeQuiet } = this.#options
+
+    if (isCheck && changedFilesCount) {
+      process.exitCode = 1
+    }
+
+    if (failedFilesCount) {
+      process.exitCode = 2
+    }
+
+    if (shouldBeQuiet) {
+      return
+    }
+
+    const { log } = this.#logger
+
+    if (isCheck && changedFiles.length > 0) {
+      for (const file of changedFiles.toSorted((a, b) =>
+        a.localeCompare(b, 'en'),
+      )) {
+        log(file)
+      }
+    }
+
+    // Print an empty line.
+    if (this.#hasPrinted) {
+      log()
+    }
+
+    // Matched files
+    log('Found %s.', getFilesCountText(matchedFilesCount))
+
+    // Failed files
+    if (failedFilesCount) {
+      log(
+        '%s could not be %s.',
+        getFilesCountText(failedFilesCount),
+        isCheck ? 'checked' : 'sorted',
+      )
+    }
+
+    // Changed files
+    if (changedFilesCount) {
+      if (isCheck) {
+        log(
+          '%s %s not sorted.',
+          getFilesCountText(changedFilesCount),
+          changedFilesCount === 1 ? 'was' : 'were',
+        )
+      } else {
+        log('%s successfully sorted.', getFilesCountText(changedFilesCount))
+      }
+    }
+
+    // Well-sorted files
+    if (wellSortedFilesCount) {
+      log(
+        '%s %s already sorted.',
+        getFilesCountText(wellSortedFilesCount),
+        wellSortedFilesCount === 1 ? 'was' : 'were',
+      )
+    }
+  }
+}
+
+export default Reporter