Merge branch 'main' into cli_improvments

# Conflicts:
#	cli.js
#	tests/snapshots/cli.js.snap

Author: fisker

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/pr.yml

@@ -8,38 +8,29 @@ jobs:
       fail-fast: false
       matrix:
         os:
-          - "ubuntu-latest"
-          # - "macos-latest"
-          # - "windows-latest"
+          - 'ubuntu-latest'
+          # - 'macos-latest'
+          # - 'windows-latest'
         node_version:
-          - "18"
-          - "16"
-          - "14"
-          - "12"
+          - '22'
+          - '20'
     name: Node.js ${{ matrix.node_version }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node_version }}
 
-      # https://github.com/bahmutov/npm-install/issues/103#issuecomment-931226602
-      - name: Update NPM
-        run: npm install --global npm@8
-
       - name: Install Dependencies
         run: npm ci
 
-      - name: Run ESLint
-        if: matrix.node_version == '18'
+      - name: Lint
+        if: matrix.node_version == '22'
         run: npm run lint
 
-      - name: Check package.json
-        run: npm run sort-package-json
-
       - name: Run Tests
         run: npm run test-coverage

.github/workflows/release.yml

@@ -9,17 +9,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node.js
-        uses: actions/setup-node@v3
-
-      # https://github.com/bahmutov/npm-install/issues/103#issuecomment-931226602
-      - name: Update NPM
-        run: npm install --global npm
+        uses: actions/setup-node@v4
 
       - name: Install dependencies
-        run: npm ci
+        run: npm i
 
       - name: Release
         env:

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 /.nyc_output
-/coverage
+/cjs
+/coverage

.prettierignore

@@ -0,0 +1 @@
+tests/snapshots/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2015 Keith Cirkel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -59,6 +59,8 @@ CLI also supports multi file paths or [`glob`](https://github.com/sindresorhus/g
 $ sort-package-json "my-package/package.json" "other-package/package.json"
 
 $ sort-package-json "package.json" "packages/*/package.json"
+
+$ sort-package-json "package.json" "packages/*/package.json" --ignore "packages/one-package"
 ```
 
 #### `--check` flag
@@ -89,6 +91,20 @@ $ sort-package-json "**/package.json" --check --quiet
 $ sort-package-json "**/package.json" --quiet
 ```
 
+#### `--stdin` flag
+
+To read from `stdin` and output the result to `stdout` use the `--stdin` flag.
+
+```bash
+$ cat package.json | sort-package-json --stdin
+```
+
+This can, for instance, be used to generate a diff before changing `package.json`.
+
+```bash
+$ ( PKG="./package.json" ; cat "${PKG?}" | sort-package-json --stdin | diff "${PKG?}" - ; )
+```
+
 ## API
 
 ### Install
@@ -157,7 +173,7 @@ If an array, sort keys in ordering of `options.sortOrder`.
 
 ```js
 const sorted = sortPackageJson(packageJsonObject, {
-  sortOrder: ['version']
+  sortOrder: ['version'],
 })
 
 console.log(Object.keys(sorted))
@@ -173,7 +189,7 @@ If a function, sort fields by [Array#sort(options.sortOrder)](https://developer.
 const sorted = sortPackageJson(packageJsonObject, {
   sortOrder(left, right) {
     return left.localeCompare(right)
-  }
+  },
 })
 
 console.log(Object.keys(sorted))
@@ -202,6 +218,8 @@ console.log(Object.keys(sorted))
 - [Mocha](https://mochajs.org/)
 - [node-pre-gyp](https://github.com/mapbox/node-pre-gyp)
 - [npm-package-json-lint](https://npmpackagejsonlint.org/)
+- [oclif](https://oclif.io/)
+- [pnpm](https://pnpm.io/)
 - [Prettier](https://prettier.io/)
 - [remark](https://remark.js.org/)
 - [semantic-release](https://github.com/semantic-release/semantic-release)
@@ -258,6 +276,152 @@ The lack of configuration here is a feature, not a bug. The intent of this tool
 
 A lot of people who ask for configuration cite the use case that they simply don't like the given order that exists and want to make sweeping changes. To me this seems far better suited to simply making a fork of this project as then you can go far further than specifying configuration.
 
+### What is the order this package defaults to?
+
+The default order is exported as a `sortOrder` object.
+
+<details>
+<summary>Properties mentioned in the npm docs</summary>
+
+1. `name`
+1. `version`
+1. `private`
+1. `description`
+1. `keywords`
+1. `homepage`
+1. `bugs`
+1. `repository`
+1. `funding`
+1. `license`
+1. `author`
+1. `contributors`
+1. `main`
+1. `browser`
+1. `bin`
+1. `man`
+1. `directories`
+1. `files`
+1. `workspaces`
+1. `scripts`
+1. `config`
+1. `dependencies`
+1. `engines`
+1. `os`
+1. `cpu`
+
+</details>
+
+<details>
+<summary>Full list of recognized properties</summary>
+
+1. `$schema`
+1. `name`
+1. `displayName`
+1. `version`
+1. `private`
+1. `description`
+1. `categories`
+1. `keywords`
+1. `homepage`
+1. `bugs`
+1. `repository`
+1. `funding`
+1. `license`
+1. `qna`
+1. `author`
+1. `maintainers`
+1. `contributors`
+1. `publisher`
+1. `sideEffects`
+1. `type`
+1. `imports`
+1. `exports`
+1. `main`
+1. `svelte`
+1. `umd:main`
+1. `jsdelivr`
+1. `unpkg`
+1. `module`
+1. `source`
+1. `jsnext:main`
+1. `browser`
+1. `react-native`
+1. `types`
+1. `typesVersions`
+1. `typings`
+1. `style`
+1. `example`
+1. `examplestyle`
+1. `assets`
+1. `bin`
+1. `man`
+1. `directories`
+1. `files`
+1. `workspaces`
+1. `binary`
+1. `scripts`
+1. `betterScripts`
+1. `contributes`
+1. `activationEvents`
+1. `husky`
+1. `simple-git-hooks`
+1. `pre-commit`
+1. `commitlint`
+1. `lint-staged`
+1. `nano-staged`
+1. `config`
+1. `nodemonConfig`
+1. `browserify`
+1. `babel`
+1. `browserslist`
+1. `xo`
+1. `prettier`
+1. `eslintConfig`
+1. `eslintIgnore`
+1. `npmpkgjsonlint`
+1. `npmPackageJsonLintConfig`
+1. `npmpackagejsonlint`
+1. `release`
+1. `remarkConfig`
+1. `stylelint`
+1. `ava`
+1. `jest`
+1. `jest-junit`
+1. `jest-stare`
+1. `mocha`
+1. `nyc`
+1. `c8`
+1. `tap`
+1. `resolutions`
+1. `dependencies`
+1. `devDependencies`
+1. `dependenciesMeta`
+1. `peerDependencies`
+1. `peerDependenciesMeta`
+1. `optionalDependencies`
+1. `bundledDependencies`
+1. `bundleDependencies`
+1. `extensionPack`
+1. `extensionDependencies`
+1. `flat`
+1. `packageManager`
+1. `engines`
+1. `engineStrict`
+1. `volta`
+1. `languageName`
+1. `os`
+1. `cpu`
+1. `preferGlobal`
+1. `publishConfig`
+1. `icon`
+1. `badges`
+1. `galleryBanner`
+1. `preview`
+1. `markdown`
+1. `pnpm`
+
+</details>
+
 ### What?! Why would you want to do this?!
 
 Well, it's nice to have the keys of a package.json in a well sorted order. Almost everyone would agree having "name" at the top of a package.json is sensible (rather than sorted alphabetically or somewhere silly like the bottom), so why not the rest of the package.json?

cli.js

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
-import { globbySync } from 'globby'
+import { globSync } from 'tinyglobby'
 import fs from 'node:fs'
+// eslint-disable-next-line n/no-unsupported-features/node-builtins
 import { parseArgs } from 'node:util'
+import getStdin from 'get-stdin'
 import sortPackageJson from './index.js'
 import Reporter from './reporter.js'
 
@@ -23,7 +25,9 @@ If file/glob is omitted, './package.json' file will be processed.
   -c, --check   Check if files are sorted
   -q, --quiet   Don't output success messages
   -h, --help    Display this help
+  -i, --ignore  An array of glob patterns to ignore
   -v, --version Display the package version
+  --stdin       Read package.json from stdin
   `,
   )
 }
@@ -33,14 +37,21 @@ function parseCliArguments() {
     options: {
       check: { type: 'boolean', short: 'c', default: false },
       quiet: { type: 'boolean', short: 'q', default: false },
+      stdin: { type: 'boolean', default: false },
+      ignore: {
+        type: 'string',
+        short: 'i',
+        multiple: true,
+        default: ['node_modules/**'],
+      },
       version: { type: 'boolean', short: 'v', default: false },
       help: { type: 'boolean', short: 'h', default: false },
     },
     allowPositionals: true,
     strict: true,
   })
 
-  if (!patterns.length) {
+  if (patterns.length === 0) {
     patterns[0] = 'package.json'
   }
 
@@ -61,8 +72,9 @@ function sortPackageJsonFile(file, reporter, isCheck) {
   reporter.reportChanged(file)
 }
 
-function sortPackageJsonFiles(patterns, options) {
-  const files = globbySync(patterns)
+function sortPackageJsonFiles(patterns, { ignore, ...options }) {
+  const files = globSync(patterns, { ignore })
+
   const reporter = new Reporter(files, options)
   const { isCheck } = options
 
@@ -73,10 +85,13 @@ function sortPackageJsonFiles(patterns, options) {
       reporter.reportFailed(file, error)
     }
   }
-
   reporter.printSummary()
 }
 
+async function sortPackageJsonFromStdin() {
+  process.stdout.write(sortPackageJson(await getStdin()))
+}
+
 function run() {
   let options, patterns
   try {
@@ -101,7 +116,12 @@ function run() {
     return showVersion()
   }
 
+  if (options.stdin) {
+    return sortPackageJsonFromStdin()
+  }
+
   sortPackageJsonFiles(patterns, {
+    ignore: options.ignore,
     isCheck: options.check,
     shouldBeQuiet: options.quiet,
   })