eslint-plugin-package-json 0.56.1 β 0.56.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -2
- package/README.md +44 -44
- package/lib/rules/sort-collections.js +6 -3
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
## [0.56.
|
|
3
|
+
## [0.56.2](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.56.1...v0.56.2) (2025-09-04)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* improve sort-collections docs and error messages ([#1250](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1250)) ([1864376](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/1864376039db3db690423051b0dd8a2104395aa4)), closes [#1243](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1243) [#1243](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1243)
|
|
4
9
|
|
|
10
|
+
## [0.56.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.56.0...v0.56.1) (2025-08-31)
|
|
5
11
|
|
|
6
12
|
### Bug Fixes
|
|
7
13
|
|
|
8
|
-
|
|
14
|
+
- **deps:** update dependency package-json-validator to ~0.30.0 ([#1241](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1241)) ([c3d247c](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/c3d247cc416d4bb0eee629fde3440224fe39eb59))
|
|
9
15
|
|
|
10
16
|
# [0.56.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.55.0...v0.56.0) (2025-08-25)
|
|
11
17
|
|
package/README.md
CHANGED
|
@@ -153,50 +153,50 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
|
|
|
153
153
|
π‘ Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\
|
|
154
154
|
β Deprecated.
|
|
155
155
|
|
|
156
|
-
| NameΒ Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β | Description
|
|
157
|
-
| :------------------------------------------------------------------------- |
|
|
158
|
-
| [no-empty-fields](docs/rules/no-empty-fields.md) | Reports on unnecessary empty arrays and objects.
|
|
159
|
-
| [no-redundant-files](docs/rules/no-redundant-files.md) | Prevents adding unnecessary / redundant files.
|
|
160
|
-
| [order-properties](docs/rules/order-properties.md) | Package properties must be declared in standard order
|
|
161
|
-
| [repository-shorthand](docs/rules/repository-shorthand.md) | Enforce either object or shorthand declaration for repository.
|
|
162
|
-
| [require-author](docs/rules/require-author.md) | Requires the `author` property to be present.
|
|
163
|
-
| [require-bugs](docs/rules/require-bugs.md) | Requires the `bugs` property to be present.
|
|
164
|
-
| [require-bundleDependencies](docs/rules/require-bundleDependencies.md) | Requires the `bundleDependencies` property to be present.
|
|
165
|
-
| [require-dependencies](docs/rules/require-dependencies.md) | Requires the `dependencies` property to be present.
|
|
166
|
-
| [require-description](docs/rules/require-description.md) | Requires the `description` property to be present.
|
|
167
|
-
| [require-devDependencies](docs/rules/require-devDependencies.md) | Requires the `devDependencies` property to be present.
|
|
168
|
-
| [require-engines](docs/rules/require-engines.md) | Requires the `engines` property to be present.
|
|
169
|
-
| [require-files](docs/rules/require-files.md) | Requires the `files` property to be present.
|
|
170
|
-
| [require-keywords](docs/rules/require-keywords.md) | Requires the `keywords` property to be present.
|
|
171
|
-
| [require-name](docs/rules/require-name.md) | Requires the `name` property to be present.
|
|
172
|
-
| [require-optionalDependencies](docs/rules/require-optionalDependencies.md) | Requires the `optionalDependencies` property to be present.
|
|
173
|
-
| [require-peerDependencies](docs/rules/require-peerDependencies.md) | Requires the `peerDependencies` property to be present.
|
|
174
|
-
| [require-type](docs/rules/require-type.md) | Requires the `type` property to be present.
|
|
175
|
-
| [require-types](docs/rules/require-types.md) | Requires the `types` property to be present.
|
|
176
|
-
| [require-version](docs/rules/require-version.md) | Requires the `version` property to be present.
|
|
177
|
-
| [restrict-dependency-ranges](docs/rules/restrict-dependency-ranges.md) | Restricts the range of dependencies to allow or disallow specific types of ranges.
|
|
178
|
-
| [sort-collections](docs/rules/sort-collections.md) |
|
|
179
|
-
| [unique-dependencies](docs/rules/unique-dependencies.md) | Checks a dependency isn't specified more than once (i.e. in `dependencies` and `devDependencies`)
|
|
180
|
-
| [valid-author](docs/rules/valid-author.md) | Enforce that the `author` property is valid.
|
|
181
|
-
| [valid-bin](docs/rules/valid-bin.md) | Enforce that the `bin` property is valid.
|
|
182
|
-
| [valid-bundleDependencies](docs/rules/valid-bundleDependencies.md) | Enforce that the `bundleDependencies` (also: `bundledDependencies`) property is valid.
|
|
183
|
-
| [valid-config](docs/rules/valid-config.md) | Enforce that the `config` property is valid.
|
|
184
|
-
| [valid-cpu](docs/rules/valid-cpu.md) | Enforce that the `cpu` property is valid.
|
|
185
|
-
| [valid-dependencies](docs/rules/valid-dependencies.md) | Enforce that the `dependencies` property is valid.
|
|
186
|
-
| [valid-description](docs/rules/valid-description.md) | Enforce that the `description` property is valid.
|
|
187
|
-
| [valid-devDependencies](docs/rules/valid-devDependencies.md) | Enforce that the `devDependencies` property is valid.
|
|
188
|
-
| [valid-directories](docs/rules/valid-directories.md) | Enforce that the `directories` property is valid.
|
|
189
|
-
| [valid-exports](docs/rules/valid-exports.md) | Enforce that the `exports` property is valid.
|
|
190
|
-
| [valid-license](docs/rules/valid-license.md) | Enforce that the `license` property is valid.
|
|
191
|
-
| [valid-local-dependency](docs/rules/valid-local-dependency.md) | Checks existence of local dependencies in the package.json
|
|
192
|
-
| [valid-name](docs/rules/valid-name.md) | Enforce that package names are valid npm package names
|
|
193
|
-
| [valid-optionalDependencies](docs/rules/valid-optionalDependencies.md) | Enforce that the `optionalDependencies` property is valid.
|
|
194
|
-
| [valid-package-definition](docs/rules/valid-package-definition.md) | Enforce that package.json has all properties required by the npm spec
|
|
195
|
-
| [valid-peerDependencies](docs/rules/valid-peerDependencies.md) | Enforce that the `peerDependencies` property is valid.
|
|
196
|
-
| [valid-repository-directory](docs/rules/valid-repository-directory.md) | Enforce that if repository directory is specified, it matches the path to the package.json file
|
|
197
|
-
| [valid-scripts](docs/rules/valid-scripts.md) | Enforce that the `scripts` property is valid.
|
|
198
|
-
| [valid-type](docs/rules/valid-type.md) | Enforce that the `type` property is valid.
|
|
199
|
-
| [valid-version](docs/rules/valid-version.md) | Enforce that package versions are valid semver specifiers
|
|
156
|
+
| NameΒ Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β | Description | πΌ | π§ | π‘ | β |
|
|
157
|
+
| :------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------- | :--- | :- | :- | :- |
|
|
158
|
+
| [no-empty-fields](docs/rules/no-empty-fields.md) | Reports on unnecessary empty arrays and objects. | βοΈ β
| | π‘ | |
|
|
159
|
+
| [no-redundant-files](docs/rules/no-redundant-files.md) | Prevents adding unnecessary / redundant files. | βοΈ β
| | π‘ | |
|
|
160
|
+
| [order-properties](docs/rules/order-properties.md) | Package properties must be declared in standard order | βοΈ β
| π§ | | |
|
|
161
|
+
| [repository-shorthand](docs/rules/repository-shorthand.md) | Enforce either object or shorthand declaration for repository. | βοΈ β
| π§ | | |
|
|
162
|
+
| [require-author](docs/rules/require-author.md) | Requires the `author` property to be present. | | | | |
|
|
163
|
+
| [require-bugs](docs/rules/require-bugs.md) | Requires the `bugs` property to be present. | | | | |
|
|
164
|
+
| [require-bundleDependencies](docs/rules/require-bundleDependencies.md) | Requires the `bundleDependencies` property to be present. | | | | |
|
|
165
|
+
| [require-dependencies](docs/rules/require-dependencies.md) | Requires the `dependencies` property to be present. | | | | |
|
|
166
|
+
| [require-description](docs/rules/require-description.md) | Requires the `description` property to be present. | βοΈ β
| | | |
|
|
167
|
+
| [require-devDependencies](docs/rules/require-devDependencies.md) | Requires the `devDependencies` property to be present. | | | | |
|
|
168
|
+
| [require-engines](docs/rules/require-engines.md) | Requires the `engines` property to be present. | | | | |
|
|
169
|
+
| [require-files](docs/rules/require-files.md) | Requires the `files` property to be present. | | | | |
|
|
170
|
+
| [require-keywords](docs/rules/require-keywords.md) | Requires the `keywords` property to be present. | | | | |
|
|
171
|
+
| [require-name](docs/rules/require-name.md) | Requires the `name` property to be present. | βοΈ β
| | | |
|
|
172
|
+
| [require-optionalDependencies](docs/rules/require-optionalDependencies.md) | Requires the `optionalDependencies` property to be present. | | | | |
|
|
173
|
+
| [require-peerDependencies](docs/rules/require-peerDependencies.md) | Requires the `peerDependencies` property to be present. | | | | |
|
|
174
|
+
| [require-type](docs/rules/require-type.md) | Requires the `type` property to be present. | βοΈ β
| | | |
|
|
175
|
+
| [require-types](docs/rules/require-types.md) | Requires the `types` property to be present. | | | | |
|
|
176
|
+
| [require-version](docs/rules/require-version.md) | Requires the `version` property to be present. | βοΈ β
| | | |
|
|
177
|
+
| [restrict-dependency-ranges](docs/rules/restrict-dependency-ranges.md) | Restricts the range of dependencies to allow or disallow specific types of ranges. | | | π‘ | |
|
|
178
|
+
| [sort-collections](docs/rules/sort-collections.md) | Selected collections must be in a consistent order (lexicographical for most; lifecycle-aware for scripts). | βοΈ β
| π§ | | |
|
|
179
|
+
| [unique-dependencies](docs/rules/unique-dependencies.md) | Checks a dependency isn't specified more than once (i.e. in `dependencies` and `devDependencies`) | βοΈ β
| | π‘ | |
|
|
180
|
+
| [valid-author](docs/rules/valid-author.md) | Enforce that the `author` property is valid. | βοΈ β
| | | |
|
|
181
|
+
| [valid-bin](docs/rules/valid-bin.md) | Enforce that the `bin` property is valid. | βοΈ β
| | π‘ | |
|
|
182
|
+
| [valid-bundleDependencies](docs/rules/valid-bundleDependencies.md) | Enforce that the `bundleDependencies` (also: `bundledDependencies`) property is valid. | βοΈ β
| | | |
|
|
183
|
+
| [valid-config](docs/rules/valid-config.md) | Enforce that the `config` property is valid. | βοΈ β
| | | |
|
|
184
|
+
| [valid-cpu](docs/rules/valid-cpu.md) | Enforce that the `cpu` property is valid. | βοΈ β
| | | |
|
|
185
|
+
| [valid-dependencies](docs/rules/valid-dependencies.md) | Enforce that the `dependencies` property is valid. | βοΈ β
| | | |
|
|
186
|
+
| [valid-description](docs/rules/valid-description.md) | Enforce that the `description` property is valid. | βοΈ β
| | | |
|
|
187
|
+
| [valid-devDependencies](docs/rules/valid-devDependencies.md) | Enforce that the `devDependencies` property is valid. | βοΈ β
| | | |
|
|
188
|
+
| [valid-directories](docs/rules/valid-directories.md) | Enforce that the `directories` property is valid. | βοΈ β
| | | |
|
|
189
|
+
| [valid-exports](docs/rules/valid-exports.md) | Enforce that the `exports` property is valid. | βοΈ β
| | | |
|
|
190
|
+
| [valid-license](docs/rules/valid-license.md) | Enforce that the `license` property is valid. | βοΈ β
| | | |
|
|
191
|
+
| [valid-local-dependency](docs/rules/valid-local-dependency.md) | Checks existence of local dependencies in the package.json | | | | β |
|
|
192
|
+
| [valid-name](docs/rules/valid-name.md) | Enforce that package names are valid npm package names | βοΈ β
| | | |
|
|
193
|
+
| [valid-optionalDependencies](docs/rules/valid-optionalDependencies.md) | Enforce that the `optionalDependencies` property is valid. | βοΈ β
| | | |
|
|
194
|
+
| [valid-package-definition](docs/rules/valid-package-definition.md) | Enforce that package.json has all properties required by the npm spec | βοΈ β
| | | |
|
|
195
|
+
| [valid-peerDependencies](docs/rules/valid-peerDependencies.md) | Enforce that the `peerDependencies` property is valid. | βοΈ β
| | | |
|
|
196
|
+
| [valid-repository-directory](docs/rules/valid-repository-directory.md) | Enforce that if repository directory is specified, it matches the path to the package.json file | βοΈ β
| | π‘ | |
|
|
197
|
+
| [valid-scripts](docs/rules/valid-scripts.md) | Enforce that the `scripts` property is valid. | βοΈ β
| | | |
|
|
198
|
+
| [valid-type](docs/rules/valid-type.md) | Enforce that the `type` property is valid. | βοΈ β
| | | |
|
|
199
|
+
| [valid-version](docs/rules/valid-version.md) | Enforce that package versions are valid semver specifiers | βοΈ β
| | | |
|
|
200
200
|
|
|
201
201
|
<!-- end auto-generated rules list -->
|
|
202
202
|
<!-- prettier-ignore-end -->
|
|
@@ -47,7 +47,7 @@ const rule = createRule({
|
|
|
47
47
|
}, {}), null, 2).split("\n").join("\n "));
|
|
48
48
|
},
|
|
49
49
|
loc: collection.loc,
|
|
50
|
-
messageId: "
|
|
50
|
+
messageId: keyPartsReversed.at(-1) === "scripts" ? "unsortedScripts" : "unsortedKeys",
|
|
51
51
|
node
|
|
52
52
|
});
|
|
53
53
|
} };
|
|
@@ -56,11 +56,14 @@ const rule = createRule({
|
|
|
56
56
|
defaultOptions: [Array.from(defaultCollections)],
|
|
57
57
|
docs: {
|
|
58
58
|
category: "Best Practices",
|
|
59
|
-
description: "
|
|
59
|
+
description: "Selected collections must be in a consistent order (lexicographical for most; lifecycle-aware for scripts).",
|
|
60
60
|
recommended: true
|
|
61
61
|
},
|
|
62
62
|
fixable: "code",
|
|
63
|
-
messages: {
|
|
63
|
+
messages: {
|
|
64
|
+
unsortedKeys: "Entries in '{{ key }}' are not in lexicographical order",
|
|
65
|
+
unsortedScripts: "Entries in 'scripts' are not in lexicographical order and grouped by lifecycles"
|
|
66
|
+
},
|
|
64
67
|
schema: [{
|
|
65
68
|
description: "Array of package properties to require sorting.",
|
|
66
69
|
items: { type: "string" },
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "eslint-plugin-package-json",
|
|
3
|
-
"version": "0.56.
|
|
3
|
+
"version": "0.56.2",
|
|
4
4
|
"description": "Rules for consistent, readable, and valid package.json files. ποΈ",
|
|
5
5
|
"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
|
|
6
6
|
"bugs": {
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
"@release-it/conventional-changelog": "10.0.0",
|
|
62
62
|
"@types/eslint-plugin-markdown": "2.0.2",
|
|
63
63
|
"@types/estree": "1.0.7",
|
|
64
|
-
"@types/node": "22.
|
|
64
|
+
"@types/node": "22.18.0",
|
|
65
65
|
"@types/semver": "7.7.0",
|
|
66
66
|
"@types/sort-object-keys": "1.1.3",
|
|
67
67
|
"@types/validate-npm-package-name": "4.0.2",
|
|
@@ -93,7 +93,7 @@
|
|
|
93
93
|
"sentences-per-line": "0.3.0",
|
|
94
94
|
"tsdown": "0.14.0",
|
|
95
95
|
"typescript": "5.9.2",
|
|
96
|
-
"typescript-eslint": "8.
|
|
96
|
+
"typescript-eslint": "8.41.0",
|
|
97
97
|
"vitest": "3.2.0"
|
|
98
98
|
},
|
|
99
99
|
"peerDependencies": {
|