eslint-plugin-package-json 0.29.0 → 0.30.0

package/README.md

@@ -1,20 +1,21 @@
 <h1 align="center">eslint-plugin-package-json</h1>
 
-<p align="center">Rules for consistent, readable, and valid package.json files. 🗂️</p>
+<p align="center">
+	Rules for consistent, readable, and valid package.json files.
+	🗂️
+</p>
 
 <p align="center">
-	<a href="#contributors" target="_blank">
-<!-- prettier-ignore-start -->
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-<img alt="All Contributors: 23 👪" src="https://img.shields.io/badge/all_contributors-23_👪-21bb42.svg" />
+	<!-- prettier-ignore-start -->
+	<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+	<a href="#contributors" target="_blank"><img alt="👪 All Contributors: 24" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-24-21bb42.svg" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
-<!-- prettier-ignore-end -->
-</a>
-	<a href="https://codecov.io/gh/JoshuaKGoldberg/eslint-plugin-package-json" target="_blank"><img alt="Codecov Test Coverage" src="https://codecov.io/gh/JoshuaKGoldberg/eslint-plugin-package-json/branch/main/graph/badge.svg"/></a>
-	<a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /></a>
-	<a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/LICENSE.md" target="_blank"><img alt="License: MIT" src="https://img.shields.io/github/license/JoshuaKGoldberg/eslint-plugin-package-json?color=21bb42"></a>
-	<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
-	<a href="https://www.npmjs.com/package/eslint-plugin-package-json"><img alt="npm package version" src="https://img.shields.io/npm/v/eslint-plugin-package-json?color=21bb42" /></a>
+	<!-- prettier-ignore-end -->
+	<a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
+	<a href="https://codecov.io/gh/JoshuaKGoldberg/eslint-plugin-package-json" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/eslint-plugin-package-json?label=%F0%9F%A7%AA%20coverage" /></a>
+	<a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg" /></a>
+	<a href="http://npmjs.com/package/eslint-plugin-package-json" target="_blank"><img alt="📦 npm version" src="https://img.shields.io/npm/v/eslint-plugin-package-json?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
+	<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
 </p>
 
 ## Installation
@@ -70,7 +71,7 @@ npm install jsonc-eslint-parser --save-dev
 
 Add an override to your ESLint configuration file that specifies `jsonc-eslint-parser`, this plugin, and its recommended rules for your `package.json` file:
 
-```js
+```ts
 module.exports = {
 	overrides: [
 		{
@@ -85,7 +86,7 @@ module.exports = {
 You may also want to individually configure rules.
 See [ESLint's _Configure Rules_ guide](https://eslint.org/docs/latest/use/configure/rules) for details on how to customize your rules.
 
-```js
+```ts
 module.exports = {
 	overrides: [
 		{
@@ -112,32 +113,34 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 <!-- begin auto-generated rules list -->
 
 💼 Configurations enabled in.\
+✔️ Set in the `legacy-recommended` configuration.\
 ✅ Set in the `recommended` configuration.\
 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
 💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\
 ❌ Deprecated.
 
-| Name                                                                   | Description                                                                                       | 💼 | 🔧 | 💡 | ❌  |
-| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------ | :- | :- | :- | :- |
-| [no-empty-fields](docs/rules/no-empty-fields.md)                       | Reports on unnecessary empty arrays and objects.                                                  | ✅  |    | 💡 |    |
-| [no-redundant-files](docs/rules/no-redundant-files.md)                 | Prevents adding unnecessary / redundant files.                                                    |    |    | 💡 |    |
-| [order-properties](docs/rules/order-properties.md)                     | Package properties must be declared in standard order                                             | ✅  | 🔧 |    |    |
-| [repository-shorthand](docs/rules/repository-shorthand.md)             | Enforce either object or shorthand declaration for repository.                                    | ✅  | 🔧 |    |    |
-| [require-author](docs/rules/require-author.md)                         | Requires the `author` property to be present.                                                     |    |    |    |    |
-| [require-engines](docs/rules/require-engines.md)                       | Requires the `engines` property to be present.                                                    |    |    |    |    |
-| [require-files](docs/rules/require-files.md)                           | Requires the `files` property to be present.                                                      |    |    |    |    |
-| [require-keywords](docs/rules/require-keywords.md)                     | Requires the `keywords` property to be present.                                                   |    |    |    |    |
-| [require-name](docs/rules/require-name.md)                             | Requires the `name` property to be present.                                                       | ✅  |    |    |    |
-| [require-types](docs/rules/require-types.md)                           | Requires the `types` property to be present.                                                      |    |    |    |    |
-| [require-version](docs/rules/require-version.md)                       | Requires the `version` property to be present.                                                    | ✅  |    |    |    |
-| [sort-collections](docs/rules/sort-collections.md)                     | Dependencies, scripts, and configuration values must be declared in alphabetical order.           | ✅  | 🔧 |    |    |
-| [unique-dependencies](docs/rules/unique-dependencies.md)               | Checks a dependency isn't specified more than once (i.e. in `dependencies` and `devDependencies`) | ✅  |    | 💡 |    |
-| [valid-local-dependency](docs/rules/valid-local-dependency.md)         | Checks existence of local dependencies in the package.json                                        | ✅  |    |    |    |
-| [valid-name](docs/rules/valid-name.md)                                 | Enforce that package names are valid npm package names                                            | ✅  |    |    |    |
-| [valid-package-def](docs/rules/valid-package-def.md)                   | Enforce that package.json has all properties required by the npm spec                             |    |    |    | ❌  |
-| [valid-package-definition](docs/rules/valid-package-definition.md)     | Enforce that package.json has all properties required by the npm spec                             | ✅  |    |    |    |
-| [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   | ✅  |    | 💡 |    |
-| [valid-version](docs/rules/valid-version.md)                           | Enforce that package versions are valid semver specifiers                                         | ✅  |    |    |    |
+| Name                                                                   | Description                                                                                       | 💼   | 🔧 | 💡 | ❌  |
+| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------ | :--- | :- | :- | :- |
+| [no-empty-fields](docs/rules/no-empty-fields.md)                       | Reports on unnecessary empty arrays and objects.                                                  | ✔️ ✅ |    | 💡 |    |
+| [no-redundant-files](docs/rules/no-redundant-files.md)                 | Prevents adding unnecessary / redundant files.                                                    |      |    | 💡 |    |
+| [order-properties](docs/rules/order-properties.md)                     | Package properties must be declared in standard order                                             | ✔️ ✅ | 🔧 |    |    |
+| [repository-shorthand](docs/rules/repository-shorthand.md)             | Enforce either object or shorthand declaration for repository.                                    | ✔️ ✅ | 🔧 |    |    |
+| [require-author](docs/rules/require-author.md)                         | Requires the `author` property to be present.                                                     |      |    |    |    |
+| [require-engines](docs/rules/require-engines.md)                       | Requires the `engines` property to be present.                                                    |      |    |    |    |
+| [require-files](docs/rules/require-files.md)                           | Requires the `files` property to be present.                                                      |      |    |    |    |
+| [require-keywords](docs/rules/require-keywords.md)                     | Requires the `keywords` property to be present.                                                   |      |    |    |    |
+| [require-name](docs/rules/require-name.md)                             | Requires the `name` property to be present.                                                       | ✔️ ✅ |    |    |    |
+| [require-types](docs/rules/require-types.md)                           | Requires the `types` property to be present.                                                      |      |    |    |    |
+| [require-version](docs/rules/require-version.md)                       | Requires the `version` property to be present.                                                    | ✔️ ✅ |    |    |    |
+| [restrict-dependency-ranges](docs/rules/restrict-dependency-ranges.md) | Restricts the range of dependencies to allow or disallow specific types of ranges.                |      |    | 💡 |    |
+| [sort-collections](docs/rules/sort-collections.md)                     | Dependencies, scripts, and configuration values must be declared in alphabetical order.           | ✔️ ✅ | 🔧 |    |    |
+| [unique-dependencies](docs/rules/unique-dependencies.md)               | Checks a dependency isn't specified more than once (i.e. in `dependencies` and `devDependencies`) | ✔️ ✅ |    | 💡 |    |
+| [valid-local-dependency](docs/rules/valid-local-dependency.md)         | Checks existence of local dependencies in the package.json                                        | ✔️ ✅ |    |    |    |
+| [valid-name](docs/rules/valid-name.md)                                 | Enforce that package names are valid npm package names                                            | ✔️ ✅ |    |    |    |
+| [valid-package-def](docs/rules/valid-package-def.md)                   | Enforce that package.json has all properties required by the npm spec                             |      |    |    | ❌  |
+| [valid-package-definition](docs/rules/valid-package-definition.md)     | Enforce that package.json has all properties required by the npm spec                             | ✔️ ✅ |    |    |    |
+| [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   | ✔️ ✅ |    | 💡 |    |
+| [valid-version](docs/rules/valid-version.md)                           | Enforce that package versions are valid semver specifiers                                         | ✔️ ✅ |    |    |    |
 
 <!-- end auto-generated rules list -->
 <!-- prettier-ignore-end -->
@@ -148,7 +151,7 @@ They can lint `package.json` files at project root and in any subfolder of the p
 ## Development
 
 See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).
-Thanks! 💖
+Thanks! 🗂
 
 ## Contributors
 
@@ -170,7 +173,7 @@ Thanks! 💖
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/zetlen"><img src="https://avatars.githubusercontent.com/u/1643758?v=4?s=100" width="100px;" alt="James Zetlen"/><br /><sub><b>James Zetlen</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=zetlen" title="Code">💻</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Azetlen" title="Bug reports">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=zetlen" title="Documentation">📖</a> <a href="#infra-zetlen" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-zetlen" title="Maintenance">🚧</a> <a href="#tool-zetlen" title="Tools">🔧</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://piranna.github.io/"><img src="https://avatars.githubusercontent.com/u/532414?v=4?s=100" width="100px;" alt="Jesús Leganés-Combarro"/><br /><sub><b>Jesús Leganés-Combarro</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=piranna" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com/"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg ✨"/><br /><sub><b>Josh Goldberg ✨</b></sub></a><br /><a href="#tool-JoshuaKGoldberg" title="Tools">🔧</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3AJoshuaKGoldberg" title="Bug reports">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=JoshuaKGoldberg" title="Code">💻</a> <a href="#infra-JoshuaKGoldberg" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=JoshuaKGoldberg" title="Documentation">📖</a> <a href="#maintenance-JoshuaKGoldberg" title="Maintenance">🚧</a> <a href="#ideas-JoshuaKGoldberg" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com/"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg ✨"/><br /><sub><b>Josh Goldberg ✨</b></sub></a><br /><a href="#tool-JoshuaKGoldberg" title="Tools">🔧</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3AJoshuaKGoldberg" title="Bug reports">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=JoshuaKGoldberg" title="Code">💻</a> <a href="#infra-JoshuaKGoldberg" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=JoshuaKGoldberg" title="Documentation">📖</a> <a href="#maintenance-JoshuaKGoldberg" title="Maintenance">🚧</a> <a href="#ideas-JoshuaKGoldberg" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-JoshuaKGoldberg" title="Content">🖋</a> <a href="#projectManagement-JoshuaKGoldberg" title="Project Management">📆</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/kendallgassner"><img src="https://avatars.githubusercontent.com/u/15275462?v=4?s=100" width="100px;" alt="Kendall Gassner"/><br /><sub><b>Kendall Gassner</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=kendallgassner" title="Code">💻</a> <a href="#maintenance-kendallgassner" title="Maintenance">🚧</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/KristjanESPERANTO"><img src="https://avatars.githubusercontent.com/u/35647502?v=4?s=100" width="100px;" alt="Kristjan ESPERANTO"/><br /><sub><b>Kristjan ESPERANTO</b></sub></a><br /><a href="#ideas-kristjanesperanto" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Akristjanesperanto" title="Bug reports">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=kristjanesperanto" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/lo1tuma"><img src="https://avatars.githubusercontent.com/u/169170?v=4?s=100" width="100px;" alt="Mathias Schreck"/><br /><sub><b>Mathias Schreck</b></sub></a><br /><a href="#ideas-lo1tuma" title="Ideas, Planning, & Feedback">🤔</a></td>
@@ -187,7 +190,8 @@ Thanks! 💖
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/chouchouji"><img src="https://avatars.githubusercontent.com/u/70570907?v=4?s=100" width="100px;" alt="chouchouji"/><br /><sub><b>chouchouji</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=chouchouji" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/michaelfaith"><img src="https://avatars.githubusercontent.com/u/8071845?v=4?s=100" width="100px;" alt="michael faith"/><br /><sub><b>michael faith</b></sub></a><br /><a href="#infra-michaelfaith" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=michaelfaith" title="Code">💻</a> <a href="#maintenance-michaelfaith" title="Maintenance">🚧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/michaelfaith"><img src="https://avatars.githubusercontent.com/u/8071845?v=4?s=100" width="100px;" alt="michael faith"/><br /><sub><b>michael faith</b></sub></a><br /><a href="#infra-michaelfaith" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=michaelfaith" title="Code">💻</a> <a href="#maintenance-michaelfaith" title="Maintenance">🚧</a> <a href="#ideas-michaelfaith" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/sunnytsang1998"><img src="https://avatars.githubusercontent.com/u/207208443?v=4?s=100" width="100px;" alt="sunnytsang1998"/><br /><sub><b>sunnytsang1998</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Asunnytsang1998" title="Bug reports">🐛</a></td>
     </tr>
   </tbody>
 </table>
@@ -202,4 +206,4 @@ Thanks! 💖
 
 Many thanks to [@zetlen](https://github.com/zetlen) for creating the initial version and core infrastructure of this package! 💖
 
-> 💙 This package was templated with [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app).
+> 💝 This package was templated with [`create-typescript-app`](https://github.com/JoshuaKGoldberg/create-typescript-app) using the [Bingo engine](https://create.bingo).

package/lib/createRule.js

@@ -37,4 +37,3 @@ function createRule(rule) {
 0 && (module.exports = {
   createRule
 });
-//# sourceMappingURL=createRule.js.map

package/lib/createRule.mjs

@@ -13,4 +13,3 @@ function createRule(rule) {
 export {
   createRule
 };
-//# sourceMappingURL=createRule.mjs.map

package/lib/index.js

@@ -32,4 +32,3 @@ var index_default = import_plugin.plugin;
   configs,
   rules
 });
-//# sourceMappingURL=index.js.map

package/lib/index.mjs

@@ -7,4 +7,3 @@ export {
   index_default as default,
   rules
 };
-//# sourceMappingURL=index.mjs.map

package/lib/plugin.js

@@ -38,6 +38,7 @@ var import_no_redundant_files = require("./rules/no-redundant-files.js");
 var import_order_properties = require("./rules/order-properties.js");
 var import_repository_shorthand = require("./rules/repository-shorthand.js");
 var import_require_properties = require("./rules/require-properties.js");
+var import_restrict_dependency_ranges = require("./rules/restrict-dependency-ranges.js");
 var import_sort_collections = require("./rules/sort-collections.js");
 var import_unique_dependencies = require("./rules/unique-dependencies.js");
 var import_valid_local_dependency = require("./rules/valid-local-dependency.js");
@@ -54,6 +55,7 @@ const rules = {
   "order-properties": import_order_properties.rule,
   ...import_require_properties.rules,
   "repository-shorthand": import_repository_shorthand.rule,
+  "restrict-dependency-ranges": import_restrict_dependency_ranges.rule,
   "sort-collections": import_sort_collections.rule,
   "unique-dependencies": import_unique_dependencies.rule,
   "valid-local-dependency": import_valid_local_dependency.rule,
@@ -108,4 +110,3 @@ const plugin = {
 0 && (module.exports = {
   plugin
 });
-//# sourceMappingURL=plugin.js.map

package/lib/plugin.mjs

@@ -5,6 +5,7 @@ import { rule as noRedundantFiles } from "./rules/no-redundant-files.js";
 import { rule as orderProperties } from "./rules/order-properties.js";
 import { rule as preferRepositoryShorthand } from "./rules/repository-shorthand.js";
 import { rules as requireRules } from "./rules/require-properties.js";
+import { rule as restrictDependencyRanges } from "./rules/restrict-dependency-ranges.js";
 import { rule as sortCollections } from "./rules/sort-collections.js";
 import { rule as uniqueDependencies } from "./rules/unique-dependencies.js";
 import { rule as validLocalDependency } from "./rules/valid-local-dependency.js";
@@ -20,6 +21,7 @@ const rules = {
   "order-properties": orderProperties,
   ...requireRules,
   "repository-shorthand": preferRepositoryShorthand,
+  "restrict-dependency-ranges": restrictDependencyRanges,
   "sort-collections": sortCollections,
   "unique-dependencies": uniqueDependencies,
   "valid-local-dependency": validLocalDependency,
@@ -73,4 +75,3 @@ const plugin = {
 export {
   plugin
 };
-//# sourceMappingURL=plugin.mjs.map

package/lib/rules/no-empty-fields.js

@@ -107,4 +107,3 @@ const rule = (0, import_createRule.createRule)({
 0 && (module.exports = {
   rule
 });
-//# sourceMappingURL=no-empty-fields.js.map

package/lib/rules/no-empty-fields.mjs

@@ -86,4 +86,3 @@ const rule = createRule({
 export {
   rule
 };
-//# sourceMappingURL=no-empty-fields.mjs.map

package/lib/rules/no-redundant-files.js

@@ -164,4 +164,3 @@ const rule = (0, import_createRule.createRule)({
 0 && (module.exports = {
   rule
 });
-//# sourceMappingURL=no-redundant-files.js.map

package/lib/rules/no-redundant-files.mjs

@@ -140,4 +140,3 @@ const rule = createRule({
 export {
   rule
 };
-//# sourceMappingURL=no-redundant-files.mjs.map

package/lib/rules/order-properties.js

@@ -155,4 +155,3 @@ const rule = (0, import_createRule.createRule)({
 0 && (module.exports = {
   rule
 });
-//# sourceMappingURL=order-properties.js.map

package/lib/rules/order-properties.mjs

@@ -121,4 +121,3 @@ const rule = createRule({
 export {
   rule
 };
-//# sourceMappingURL=order-properties.mjs.map

package/lib/rules/repository-shorthand.js

@@ -140,4 +140,3 @@ const rule = (0, import_createRule.createRule)({
 0 && (module.exports = {
   rule
 });
-//# sourceMappingURL=repository-shorthand.js.map

package/lib/rules/repository-shorthand.mjs

@@ -116,4 +116,3 @@ const rule = createRule({
 export {
   rule
 };
-//# sourceMappingURL=repository-shorthand.mjs.map

package/lib/rules/require-properties.js

@@ -46,4 +46,3 @@ const rules = properties.reduce(
 0 && (module.exports = {
   rules
 });
-//# sourceMappingURL=require-properties.js.map

package/lib/rules/require-properties.mjs

@@ -22,4 +22,3 @@ const rules = properties.reduce(
 export {
   rules
 };
-//# sourceMappingURL=require-properties.mjs.map

package/lib/rules/restrict-dependency-ranges.d.mts

@@ -0,0 +1,20 @@
+import * as eslint from 'eslint';
+import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
+import { PackageJsonRuleContext } from '../createRule.mjs';
+import 'estree';
+
+interface Option {
+    forDependencyTypes?: string[];
+    forPackages?: string[];
+    forVersions?: string;
+    rangeType: RangeType | RangeType[];
+}
+type Options = [Option | Option[] | undefined];
+declare const RANGE_TYPES: readonly ["caret", "pin", "tilde"];
+type RangeType = (typeof RANGE_TYPES)[number];
+declare const rule: {
+    create(context: PackageJsonRuleContext<Options>): jsonc_eslint_parser.RuleListener;
+    meta: eslint.Rule.RuleMetaData;
+};
+
+export { rule };

package/lib/rules/restrict-dependency-ranges.d.ts

@@ -0,0 +1,20 @@
+import * as eslint from 'eslint';
+import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
+import { PackageJsonRuleContext } from '../createRule.js';
+import 'estree';
+
+interface Option {
+    forDependencyTypes?: string[];
+    forPackages?: string[];
+    forVersions?: string;
+    rangeType: RangeType | RangeType[];
+}
+type Options = [Option | Option[] | undefined];
+declare const RANGE_TYPES: readonly ["caret", "pin", "tilde"];
+type RangeType = (typeof RANGE_TYPES)[number];
+declare const rule: {
+    create(context: PackageJsonRuleContext<Options>): jsonc_eslint_parser.RuleListener;
+    meta: eslint.Rule.RuleMetaData;
+};
+
+export { rule };

package/lib/rules/restrict-dependency-ranges.js

@@ -0,0 +1,239 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var restrict_dependency_ranges_exports = {};
+__export(restrict_dependency_ranges_exports, {
+  rule: () => rule
+});
+module.exports = __toCommonJS(restrict_dependency_ranges_exports);
+var import_semver = __toESM(require("semver"));
+var import_createRule = require("../createRule.js");
+var import_predicates = require("../utils/predicates.js");
+const DEPENDENCY_TYPES = [
+  "dependencies",
+  "devDependencies",
+  "optionalDependencies",
+  "peerDependencies"
+];
+const RANGE_TYPES = ["caret", "pin", "tilde"];
+const schemaOptions = {
+  additionalProperties: false,
+  properties: {
+    forDependencyTypes: {
+      items: {
+        enum: DEPENDENCY_TYPES
+      },
+      type: "array"
+    },
+    forPackages: {
+      items: {
+        type: "string"
+      },
+      type: "array"
+    },
+    forVersions: {
+      type: "string"
+    },
+    rangeType: {
+      oneOf: [
+        {
+          enum: RANGE_TYPES
+        },
+        {
+          items: {
+            enum: RANGE_TYPES
+          },
+          type: "array"
+        }
+      ]
+    }
+  },
+  required: ["rangeType"],
+  type: "object"
+};
+const SYMBOLS = {
+  caret: "^",
+  pin: "",
+  tilde: "~"
+};
+const changeVersionRange = (version, rangeType) => {
+  if (/^workspace:[~^*]$/.test(version)) {
+    switch (rangeType) {
+      case "caret":
+        return "workspace:^";
+      case "pin":
+        return "workspace:*";
+      case "tilde":
+      default:
+        return "workspace:~";
+    }
+  }
+  return version.replace(
+    /^(workspace:)?(\^|~|<=?|>=?)?/,
+    `$1${SYMBOLS[rangeType]}`
+  );
+};
+const isVersionSupported = (version) => {
+  if (/^workspace:[*^~]$/.test(version)) {
+    return true;
+  }
+  const rawVersion = version.replace(/^workspace:/, "");
+  return !!import_semver.default.validRange(rawVersion);
+};
+const capitalize = (str) => {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+};
+const rule = (0, import_createRule.createRule)({
+  create(context) {
+    if (!context.options[0]) {
+      return {};
+    }
+    const optionsProvided = Array.isArray(context.options[0]) ? [...context.options[0]].reverse() : [context.options[0]];
+    const optionsArray = optionsProvided.map((option) => ({
+      ...option,
+      forPackages: option.forPackages?.map(
+        (pattern) => new RegExp(pattern)
+      ),
+      rangeTypes: Array.isArray(option.rangeType) ? option.rangeType : [option.rangeType]
+    }));
+    return {
+      "Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.type=JSONLiteral][value.type=JSONObjectExpression]"(node) {
+        const dependencyType = node.key.value;
+        if (!DEPENDENCY_TYPES.includes(dependencyType)) {
+          return;
+        }
+        for (const property of node.value.properties) {
+          if (!(0, import_predicates.isJSONStringLiteral)(property.key) || !(0, import_predicates.isJSONStringLiteral)(property.value)) {
+            continue;
+          }
+          const name = property.key.value;
+          const version = property.value.value;
+          if (!isVersionSupported(version)) {
+            continue;
+          }
+          const isPinned = !!import_semver.default.parse(version) || version === "workspace:*";
+          const isTildeRange = !!import_semver.default.validRange(version) && version.startsWith("~") || version.startsWith("workspace:~");
+          const isCaretRange = !!import_semver.default.validRange(version) && version.startsWith("^") || version.startsWith("workspace:^");
+          for (const options of optionsArray) {
+            if (options.forDependencyTypes && !options.forDependencyTypes.includes(dependencyType)) {
+              continue;
+            }
+            if (options.forPackages) {
+              const isMatch = options.forPackages.some(
+                (packageNameRegex) => packageNameRegex.test(name)
+              );
+              if (!isMatch) {
+                continue;
+              }
+            }
+            if (options.forVersions && // We can't determine whether any workspace version without a numeric version to accompany it, matches this range
+            // so we'll just skip it.
+            (/^workspace:[^~*]?$/.test(version) || // * matches all
+            version !== "*" && !import_semver.default.satisfies(
+              version.replace(
+                /(?:workspace:)?[^~]?/,
+                ""
+              ),
+              options.forVersions
+            ))) {
+              continue;
+            }
+            const rangeTypes = options.rangeTypes;
+            if (version === "*") {
+              context.report({
+                data: {
+                  rangeTypes: rangeTypes.join(", ")
+                },
+                messageId: "wrongRangeType",
+                node: property.value
+              });
+              break;
+            }
+            const rangeTypeMatch = rangeTypes.find((rangeType) => {
+              switch (rangeType) {
+                case "caret":
+                  return isCaretRange;
+                case "pin":
+                  return isPinned;
+                case "tilde":
+                  return isTildeRange;
+              }
+            });
+            if (!rangeTypeMatch) {
+              context.report({
+                data: {
+                  rangeTypes: rangeTypes.join(", ")
+                },
+                messageId: "wrongRangeType",
+                node: property.value,
+                suggest: rangeTypes.map((rangeType) => ({
+                  fix(fixer) {
+                    return fixer.replaceText(
+                      property.value,
+                      `"${changeVersionRange(version, rangeType)}"`
+                    );
+                  },
+                  messageId: `changeTo${capitalize(rangeType)}`
+                }))
+              });
+            }
+            break;
+          }
+        }
+      }
+    };
+  },
+  meta: {
+    docs: {
+      description: "Restricts the range of dependencies to allow or disallow specific types of ranges."
+    },
+    hasSuggestions: true,
+    messages: {
+      changeToCaret: "Change to use a caret range.",
+      changeToPin: "Pin the version.",
+      changeToTilde: "Change to use a tilde range.",
+      wrongRangeType: "This dependency is using the wrong range type.  Acceptable range type(s): {{rangeTypes}}"
+    },
+    schema: [
+      {
+        oneOf: [
+          schemaOptions,
+          {
+            items: schemaOptions,
+            type: "array"
+          }
+        ]
+      }
+    ],
+    type: "suggestion"
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  rule
+});