diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index 3ab1b0bd..84f95ffd 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -17,24 +17,24 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -- Demonstrating empathy and kindness toward other people -- Being respectful of differing opinions, viewpoints, and experiences -- Giving and gracefully accepting constructive feedback -- Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -- Focusing on what is best not just for us as individuals, but for the overall - community +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall + community Examples of unacceptable behavior include: -- The use of sexualized language or imagery, and sexual attention or advances of - any kind -- Trolling, insulting or derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or email address, - without their explicit permission -- Other conduct which could reasonably be considered inappropriate in a - professional setting +- The use of sexualized language or imagery, and sexual attention or advances of + any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, + without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting ## Enforcement Responsibilities diff --git a/.github/DEVELOPMENT.md b/.github/DEVELOPMENT.md index 96ddecbd..1625a61a 100644 --- a/.github/DEVELOPMENT.md +++ b/.github/DEVELOPMENT.md @@ -41,11 +41,11 @@ pnpm format --write This package includes several forms of linting to enforce consistent code quality and styling. Each should be shown in VS Code, and can be run manually on the command-line: -- `pnpm lint` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files -- `pnpm lint:knip` ([knip](https://github.com/webpro/knip)): Detects unused files, dependencies, and code exports -- `pnpm lint:md` ([Markdownlint](https://github.com/DavidAnson/markdownlint)): Checks Markdown source files -- `pnpm lint:packages` ([pnpm dedupe --check](https://pnpm.io/cli/dedupe)): Checks for unnecessarily duplicated packages in the `pnpm-lock.yml` file -- `pnpm lint:spelling` ([cspell](https://cspell.org)): Spell checks across all source files +- `pnpm lint` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files +- `pnpm lint:knip` ([knip](https://github.com/webpro/knip)): Detects unused files, dependencies, and code exports +- `pnpm lint:md` ([Markdownlint](https://github.com/DavidAnson/markdownlint)): Checks Markdown source files +- `pnpm lint:packages` ([pnpm dedupe --check](https://pnpm.io/cli/dedupe)): Checks for unnecessarily duplicated packages in the `pnpm-lock.yml` file +- `pnpm lint:spelling` ([cspell](https://cspell.org)): Spell checks across all source files Read the individual documentation for each linter to understand how it can be configured and used best. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a5d7dc6a..e6bc6e9b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,9 +4,9 @@ Otherwise we may not be able to review your PR. --> ## PR Checklist -- [ ] Addresses an existing open issue: fixes #000 -- [ ] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) -- [ ] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/.github/CONTRIBUTING.md) were taken +- [ ] Addresses an existing open issue: fixes #000 +- [ ] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) +- [ ] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/.github/CONTRIBUTING.md) were taken ## Overview diff --git a/.github/SECURITY.md b/.github/SECURITY.md index c2d760d4..08678393 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -3,7 +3,7 @@ We take all security vulnerabilities seriously. If you have a vulnerability or other security issues to disclose: -- Thank you very much, please do! -- Please send them to us by emailing `git@joshuakgoldberg.com` +- Thank you very much, please do! +- Please send them to us by emailing `git@joshuakgoldberg.com` We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions. diff --git a/CHANGELOG.md b/CHANGELOG.md index 3f440d3e..b2d441b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,195 +4,195 @@ ### Bug Fixes -- bump package-json-validator dep to 0.8 ([#735](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/735)) ([29a9722](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/29a9722c15d39984ea99c2be346e20c2f4f9c76e)), closes [#734](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/734) +- bump package-json-validator dep to 0.8 ([#735](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/735)) ([29a9722](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/29a9722c15d39984ea99c2be346e20c2f4f9c76e)), closes [#734](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/734) # [0.20.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.19.0...v0.20.0) (2025-01-17) ### Features -- **no-redundant-files:** add new rule ([#721](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/721)) ([1167f5e](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/1167f5ea698bf09e2dfe77147464cc3a3d5ee6e7)), closes [#686](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/686) [#686](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/686) +- **no-redundant-files:** add new rule ([#721](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/721)) ([1167f5e](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/1167f5ea698bf09e2dfe77147464cc3a3d5ee6e7)), closes [#686](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/686) [#686](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/686) # [0.19.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.18.0...v0.19.0) (2024-12-31) ### Features -- **valid-package-definition:** rename rule from valid-package-def ([#711](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/711)) ([4f3907b](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4f3907b83ce1ddadcfbb572e70559e22b9c4a917)), closes [#132](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/132) [#132](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/132) +- **valid-package-definition:** rename rule from valid-package-def ([#711](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/711)) ([4f3907b](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4f3907b83ce1ddadcfbb572e70559e22b9c4a917)), closes [#132](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/132) [#132](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/132) # [0.18.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.17.0...v0.18.0) (2024-12-05) ### Features -- update sort-package-json to 12 ([#680](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/680)) ([566e85b](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/566e85b27ecff4997cd08e1fa00611b1b0e61db0)), closes [#679](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/679) +- update sort-package-json to 12 ([#680](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/680)) ([566e85b](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/566e85b27ecff4997cd08e1fa00611b1b0e61db0)), closes [#679](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/679) # [0.17.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.16.0...v0.17.0) (2024-11-30) ### Features -- sort alphabetically with co-located hooks for `scripts` ([#632](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/632)) ([4ccae4f](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4ccae4f58e1695b792dd3d0daf46cedc134d9541)), closes [#499](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/499) [#499](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/499) +- sort alphabetically with co-located hooks for `scripts` ([#632](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/632)) ([4ccae4f](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4ccae4f58e1695b792dd3d0daf46cedc134d9541)), closes [#499](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/499) [#499](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/499) # [0.16.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.15.6...v0.16.0) (2024-11-30) ### Features -- **sort-collections:** should sort `overrides` ([#668](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/668)) ([18129cd](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/18129cd5c4a0bf45709ea7fcb9fb316c2a639a71)), closes [#619](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/619) +- **sort-collections:** should sort `overrides` ([#668](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/668)) ([18129cd](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/18129cd5c4a0bf45709ea7fcb9fb316c2a639a71)), closes [#619](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/619) ## [0.15.6](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.15.5...v0.15.6) (2024-11-09) ### Bug Fixes -- add sorting exports field ([#615](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/615)) ([116c74b](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/116c74be65089d7cfb39f3dae2fcae18fe19a263)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000) +- add sorting exports field ([#615](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/615)) ([116c74b](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/116c74be65089d7cfb39f3dae2fcae18fe19a263)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000) ## [0.15.5](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.15.4...v0.15.5) (2024-11-06) ### Bug Fixes -- add plugin export ([#609](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/609)) ([a2c83b4](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/a2c83b42c231129efb97ec29a29f6ae361adcc26)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000) +- add plugin export ([#609](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/609)) ([a2c83b4](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/a2c83b42c231129efb97ec29a29f6ae361adcc26)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000) ## [0.15.4](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.15.3...v0.15.4) (2024-10-18) ### Bug Fixes -- update dependency package-json-validator to v0.7.0 ([#569](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/569)) ([9d44862](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/9d44862f29cef1e6e8d71facf55ac5cf907d979e)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000) +- update dependency package-json-validator to v0.7.0 ([#569](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/569)) ([9d44862](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/9d44862f29cef1e6e8d71facf55ac5cf907d979e)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000) ## [0.15.3](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.15.2...v0.15.3) (2024-09-12) ### Bug Fixes -- **valid-repository-directory:** use repository root for more accurate linting ([#498](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/498)) ([d149400](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/d1494001a7cbf3fa95041179004fa8ad03ef0d34)), closes [#252](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/252) +- **valid-repository-directory:** use repository root for more accurate linting ([#498](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/498)) ([d149400](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/d1494001a7cbf3fa95041179004fa8ad03ef0d34)), closes [#252](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/252) ## [0.15.2](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.15.1...v0.15.2) (2024-07-10) ### Bug Fixes -- skip check for name to match npm package when private is true ([#455](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/455)) ([cc10e05](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/cc10e052911688ca7cacb9761c2db7c24c826d3e)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000) +- skip check for name to match npm package when private is true ([#455](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/455)) ([cc10e05](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/cc10e052911688ca7cacb9761c2db7c24c826d3e)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000) ## [0.15.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.15.0...v0.15.1) (2024-07-10) ### Bug Fixes -- update package-json-validator ([#456](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/456)) ([1a8bda4](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/1a8bda47891c14c7434ad6242f33f9ad7c2e940f)), closes [#250](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/250) +- update package-json-validator ([#456](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/456)) ([1a8bda4](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/1a8bda47891c14c7434ad6242f33f9ad7c2e940f)), closes [#250](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/250) # [0.15.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.14.0...v0.15.0) (2024-06-17) ### Features -- **order-properties:** more precise error reporting ([#328](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/328)) ([4a3fbc8](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4a3fbc8046d4286ca950b1de9000f12bdadfa961)), closes [#320](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/320) +- **order-properties:** more precise error reporting ([#328](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/328)) ([4a3fbc8](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4a3fbc8046d4286ca950b1de9000f12bdadfa961)), closes [#320](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/320) # [0.14.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.13.1...v0.14.0) (2024-05-31) ### Features -- add name field to recommended config ([#329](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/329)) ([b7a1a37](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/b7a1a37afb35c8040fa77abaaeb669d3935e5e14)), closes [#308](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/308) +- add name field to recommended config ([#329](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/329)) ([b7a1a37](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/b7a1a37afb35c8040fa77abaaeb669d3935e5e14)), closes [#308](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/308) ## [0.13.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.13.0...v0.13.1) (2024-04-29) ### Bug Fixes -- rule order-properties not work ([#315](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/315)) ([3a477f5](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/3a477f5f9e6223bff49d0a3b3cb33633bed7b76e)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000) +- rule order-properties not work ([#315](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/315)) ([3a477f5](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/3a477f5f9e6223bff49d0a3b3cb33633bed7b76e)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000) # [0.13.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.12.1...v0.13.0) (2024-04-29) ### Bug Fixes -- correct suggestion status ([#299](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/299)) ([146e25d](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/146e25dc1f837eb3cd64d4862bf5e035dbb250e2)), closes [#255](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/255) +- correct suggestion status ([#299](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/299)) ([146e25d](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/146e25dc1f837eb3cd64d4862bf5e035dbb250e2)), closes [#255](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/255) ### Features -- sort-order rule shouldn't change sub-keys, better auto-fix ([#312](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/312)) ([a894550](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/a89455019be1a41309c7b3cab0a9acefbd7abeb2)), closes [#80](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/80) +- sort-order rule shouldn't change sub-keys, better auto-fix ([#312](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/312)) ([a894550](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/a89455019be1a41309c7b3cab0a9acefbd7abeb2)), closes [#80](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/80) ## [0.12.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.12.0...v0.12.1) (2024-03-28) ### Bug Fixes -- **valid-package-def:** ignore pnpm workspace protocol ([#258](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/258)) ([4b061e6](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4b061e6540fb914d004337bb89a90fedfb94b0f7)), closes [#251](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/251) +- **valid-package-def:** ignore pnpm workspace protocol ([#258](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/258)) ([4b061e6](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4b061e6540fb914d004337bb89a90fedfb94b0f7)), closes [#251](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/251) # [0.12.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.11.0...v0.12.0) (2024-03-25) ### Features -- switch prefer-repository-shorthand to repository-shorthand ([#248](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/248)) ([580edb3](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/580edb3957cd4d8229bf73c10b1f7f65f79dc53f)), closes [#223](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/223) +- switch prefer-repository-shorthand to repository-shorthand ([#248](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/248)) ([580edb3](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/580edb3957cd4d8229bf73c10b1f7f65f79dc53f)), closes [#223](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/223) # [0.11.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.10.4...v0.11.0) (2024-03-24) ### Features -- support flat config ([#161](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/161)) ([bf31a6c](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/bf31a6cb491afe0d43b29bc830d3b4c24bd1cf6d)), closes [#91](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/91) +- support flat config ([#161](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/161)) ([bf31a6c](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/bf31a6cb491afe0d43b29bc830d3b4c24bd1cf6d)), closes [#91](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/91) ## [0.10.4](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.10.3...v0.10.4) (2024-02-20) ### Bug Fixes -- can not import in ESM package ([#159](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/159)) ([2ce1881](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/2ce188156d0b91fdcb9606e069a45148c673e6c0)), closes [#152](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/152) [#157](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/157) +- can not import in ESM package ([#159](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/159)) ([2ce1881](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/2ce188156d0b91fdcb9606e069a45148c673e6c0)), closes [#152](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/152) [#157](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/157) ## [0.10.3](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.10.2...v0.10.3) (2024-02-20) ### Bug Fixes -- ignore npm alias version range error ([#156](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/156)) ([4436638](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4436638aba4eb727d4d09cc3e33bca04faf18620)), closes [#153](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/153) +- ignore npm alias version range error ([#156](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/156)) ([4436638](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4436638aba4eb727d4d09cc3e33bca04faf18620)), closes [#153](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/153) ## [0.10.2](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.10.1...v0.10.2) (2024-02-01) ### Bug Fixes -- support Windows paths, again ([#144](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/144)) ([27243fa](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/27243fa5e6d0d59362e19f49135f69300949d282)), closes [#142](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/142) [#30](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/30) +- support Windows paths, again ([#144](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/144)) ([27243fa](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/27243fa5e6d0d59362e19f49135f69300949d282)), closes [#142](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/142) [#30](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/30) ## [0.10.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.10.0...v0.10.1) (2024-01-25) ### Bug Fixes -- incorrect example in 'sort-collections' ([#137](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/137)) ([88a94a0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/88a94a06e0db5624f83fab22144d7096a0cd1a3a)), closes [#136](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/136) +- incorrect example in 'sort-collections' ([#137](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/137)) ([88a94a0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/88a94a06e0db5624f83fab22144d7096a0cd1a3a)), closes [#136](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/136) # [0.10.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.9.0...v0.10.0) (2024-01-20) ### Features -- added valid-version rule ([#135](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/135)) ([6e8b6fb](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/6e8b6fbe777d03731f5552c980eaad4e5f8d4dad)), closes [#130](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/130) +- added valid-version rule ([#135](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/135)) ([6e8b6fb](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/6e8b6fbe777d03731f5552c980eaad4e5f8d4dad)), closes [#130](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/130) # [0.9.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.8.1...v0.9.0) (2024-01-20) ### Features -- added valid-name rule ([#134](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/134)) ([ecf9266](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/ecf926602f760c3edf1a832615624210a90ed3ed)), closes [#131](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/131) +- added valid-name rule ([#134](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/134)) ([ecf9266](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/ecf926602f760c3edf1a832615624210a90ed3ed)), closes [#131](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/131) ## [0.8.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.8.0...v0.8.1) (2024-01-20) ### Bug Fixes -- correct order-properties key checks ([#129](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/129)) ([a635c27](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/a635c279552beea4b0e5a611321d9f92083416e4)), closes [#127](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/127) [#128](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/128) [#127](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/127) [#128](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/128) +- correct order-properties key checks ([#129](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/129)) ([a635c27](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/a635c279552beea4b0e5a611321d9f92083416e4)), closes [#127](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/127) [#128](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/128) [#127](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/127) [#128](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/128) # [0.8.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.7.0...v0.8.0) (2024-01-20) ### Features -- added unique-dependencies rule ([#126](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/126)) ([a9417d1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/a9417d1685808dd8e4c27eff9e3b9c7399be6e1b)), closes [#50](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/50) +- added unique-dependencies rule ([#126](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/126)) ([a9417d1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/a9417d1685808dd8e4c27eff9e3b9c7399be6e1b)), closes [#50](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/50) # [0.7.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.6.0...v0.7.0) (2024-01-20) ### Features -- added valid-repository-directory rule ([#123](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/123)) ([84035c3](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/84035c3f2bac376567eef767ba21f354a0d93f54)), closes [#53](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/53) +- added valid-repository-directory rule ([#123](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/123)) ([84035c3](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/84035c3f2bac376567eef767ba21f354a0d93f54)), closes [#53](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/53) # [0.6.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.5.0...v0.6.0) (2024-01-20) ### Features -- change order-properties order default to sort-package-json ([#122](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/122)) ([246261d](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/246261dff5838c42add53fd45c03a5eadc495d83)), closes [#58](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/58) +- change order-properties order default to sort-package-json ([#122](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/122)) ([246261d](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/246261dff5838c42add53fd45c03a5eadc495d83)), closes [#58](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/58) # [0.5.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.4.0...v0.5.0) (2024-01-20) ### Features -- add prefer-repository-shorthand rule ([#70](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/70)) ([0c7fb19](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/0c7fb199cdf0ba001bd996f6da2c4ba8cbbc7d0f)), closes [#71](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/71) +- add prefer-repository-shorthand rule ([#70](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/70)) ([0c7fb19](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/0c7fb199cdf0ba001bd996f6da2c4ba8cbbc7d0f)), closes [#71](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/71) # [0.4.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.1.3...v0.4.0) (2024-01-20) ### Bug Fixes -- detect package.json in Windows ([eb90172](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/eb901727c12fdd4f7a5d734c9e98f3123059bee8)) -- Missing extension in valid-package-def link ([0cd9b6b](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/0cd9b6bd462b9b801cf69b1a09d8c23d4afcedf0)) -- recommended config ([#103](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/103)) ([77dc134](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/77dc1344ea7a34abcb6c0e87d61b65149b4fe2ca)), closes [#102](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/102) -- typo ([#63](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/63)) ([3e6f6bc](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/3e6f6bc40ed8a856199082429e66c77c099210f5)) +- detect package.json in Windows ([eb90172](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/eb901727c12fdd4f7a5d734c9e98f3123059bee8)) +- Missing extension in valid-package-def link ([0cd9b6b](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/0cd9b6bd462b9b801cf69b1a09d8c23d4afcedf0)) +- recommended config ([#103](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/103)) ([77dc134](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/77dc1344ea7a34abcb6c0e87d61b65149b4fe2ca)), closes [#102](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/102) +- typo ([#63](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/63)) ([3e6f6bc](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/3e6f6bc40ed8a856199082429e66c77c099210f5)) ### Features -- converted to TypeScript ([#59](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/59)) ([c328633](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/c3286338cb98a3d5570ff95424057317a2881fa1)), closes [#60](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/60) [#35](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/35) +- converted to TypeScript ([#59](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/59)) ([c328633](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/c3286338cb98a3d5570ff95424057317a2881fa1)), closes [#60](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/60) [#35](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/35) diff --git a/docs/rules/no-redundant-files.md b/docs/rules/no-redundant-files.md index 20973999..daa23d76 100644 --- a/docs/rules/no-redundant-files.md +++ b/docs/rules/no-redundant-files.md @@ -10,10 +10,10 @@ include certain files, based on a number of circumstances. It will always include the following files, if present: -- `package.json` -- `README` - -- `LICENSE` / `LICENCE` +- `package.json` +- `README` + +- `LICENSE` / `LICENCE` Additionally, it will include any files that are declared in the `main` and `bin` fields of the `package.json`. diff --git a/docs/rules/order-properties.md b/docs/rules/order-properties.md index 60ce6718..329e5115 100644 --- a/docs/rules/order-properties.md +++ b/docs/rules/order-properties.md @@ -57,11 +57,11 @@ Examples of **correct** code for this rule: The `order` property specifies the sorting order of package properties. Pass in: -- `"legacy"` - to order properties specified by [npm documentation](https://docs.npmjs.com/cli/v10/configuring-npm/package-json). -- `"sort-package-json"` - to order properties by the default order specified in [sort-package-json](https://github.com/keithamus/sort-package-json). -- `Array` - to specify an array of top-level package properties to lint sorting on only those - properties. - All properties not in this collection will be sorted by "sort-package-json" specifications. +- `"legacy"` - to order properties specified by [npm documentation](https://docs.npmjs.com/cli/v10/configuring-npm/package-json). +- `"sort-package-json"` - to order properties by the default order specified in [sort-package-json](https://github.com/keithamus/sort-package-json). +- `Array` - to specify an array of top-level package properties to lint sorting on only those + properties. + All properties not in this collection will be sorted by "sort-package-json" specifications. ```tsx interface { diff --git a/docs/rules/repository-shorthand.md b/docs/rules/repository-shorthand.md index cb7af1d3..bbd4ae52 100644 --- a/docs/rules/repository-shorthand.md +++ b/docs/rules/repository-shorthand.md @@ -49,8 +49,8 @@ Examples of **correct** code for this rule with the default options: The `form` property specifies whether to use: -- `"object"` _(default)_: an object with `"type"` and `"url"` -- `"shorthand"`: the shorthand string equivalent. +- `"object"` _(default)_: an object with `"type"` and `"url"` +- `"shorthand"`: the shorthand string equivalent. The `object` form is generally recommended as that's what `npm publish` prefers. @@ -58,5 +58,5 @@ The `object` form is generally recommended as that's what `npm publish` prefers. ## Further Reading -- [JoshuaKGoldberg/eslint-plugin-package-json#223 🐛 Bug: prefer-repository-shorthand in conflict with npm publish requirements](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/223) -- [npm/cli#7299 [DOCS] package.json#repository should clarify normalization steps and future plans.](https://github.com/npm/cli/issues/7299) +- [JoshuaKGoldberg/eslint-plugin-package-json#223 🐛 Bug: prefer-repository-shorthand in conflict with npm publish requirements](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/223) +- [npm/cli#7299 [DOCS] package.json#repository should clarify normalization steps and future plans.](https://github.com/npm/cli/issues/7299) diff --git a/docs/rules/valid-name.md b/docs/rules/valid-name.md index a1f2c409..cf186d45 100644 --- a/docs/rules/valid-name.md +++ b/docs/rules/valid-name.md @@ -6,8 +6,8 @@ This rule applies two validations to the `"name"` property: -- It must be a string rather than any other data type -- It should pass [`validate-npm-package-name`](https://www.npmjs.com/package/validate-npm-package-name) validation +- It must be a string rather than any other data type +- It should pass [`validate-npm-package-name`](https://www.npmjs.com/package/validate-npm-package-name) validation Example of **incorrect** code for this rule: diff --git a/docs/rules/valid-version.md b/docs/rules/valid-version.md index da378475..a7f171f4 100644 --- a/docs/rules/valid-version.md +++ b/docs/rules/valid-version.md @@ -6,8 +6,8 @@ This rule applies two validations to the `"name"` property: -- It must be a string rather than any other data type -- It should pass [`semver`](https://www.npmjs.com/package/semver) validation +- It must be a string rather than any other data type +- It should pass [`semver`](https://www.npmjs.com/package/semver) validation Example of **incorrect** code for this rule: