Skip to content

Commit

Permalink
Merge branch 'main'
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaKGoldberg committed Jan 20, 2024
2 parents 32bef47 + de68f50 commit 06099b8
Show file tree
Hide file tree
Showing 9 changed files with 81 additions and 18 deletions.
39 changes: 38 additions & 1 deletion .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
"code",
"infra",
"doc",
"maintenance"
"maintenance",
"ideas"
]
},
{
Expand Down Expand Up @@ -94,6 +95,42 @@
"contributions": [
"ideas"
]
},
{
"login": "andreaslindbergpaf",
"name": "Andreas Lindberg",
"avatar_url": "https://avatars.githubusercontent.com/u/59874563?v=4",
"profile": "https://github.com/AndreasLindbergPAF",
"contributions": [
"bug"
]
},
{
"login": "azat-io",
"name": "Azat S.",
"avatar_url": "https://avatars.githubusercontent.com/u/5698350?v=4",
"profile": "https://azat.io",
"contributions": [
"ideas"
]
},
{
"login": "kristjanesperanto",
"name": "Kristjan ESPERANTO",
"avatar_url": "https://avatars.githubusercontent.com/u/35647502?v=4",
"profile": "https://github.com/KristjanESPERANTO",
"contributions": [
"ideas"
]
},
{
"login": "ota-meshi",
"name": "Yosuke Ota",
"avatar_url": "https://avatars.githubusercontent.com/u/16508807?v=4",
"profile": "https://ota-meshi.github.io/",
"contributions": [
"bug"
]
}
],
"contributorsPerLine": 7,
Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# [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))

### 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)
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<a href="#contributors" target="_blank">
<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<img alt="All Contributors: 9 👪" src="https://img.shields.io/badge/all_contributors-9_👪-21bb42.svg" />
<img alt="All Contributors: 13 👪" src="https://img.shields.io/badge/all_contributors-13_👪-21bb42.svg" />
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- prettier-ignore-end -->
</a>
Expand Down Expand Up @@ -73,14 +73,16 @@ module.exports = {
<!-- prettier-ignore-start -->
<!-- begin auto-generated rules list -->

💼 Configurations enabled in.\
✅ Set in the `recommended` configuration.\
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).

| Name                   | Description | 🔧 |
| :------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | :- |
| [order-properties](docs/rules/order-properties.md) | Package properties must be declared in standard order | 🔧 |
| [sort-collections](docs/rules/sort-collections.md) | Dependencies, scripts, and configuration values must be declared in alphabetical order. | 🔧 |
| [valid-local-dependency](docs/rules/valid-local-dependency.md) | Checks existence of local dependencies in the package.json | |
| [valid-package-def](docs/rules/valid-package-def.md) | Enforce that package.json has all properties required by NPM spec | |
| Name                   | Description | 💼 | 🔧 |
| :------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | :- | :- |
| [order-properties](docs/rules/order-properties.md) | Package properties must be declared in standard order | | 🔧 |
| [sort-collections](docs/rules/sort-collections.md) | Dependencies, scripts, and configuration values must be declared in alphabetical order. | | 🔧 |
| [valid-local-dependency](docs/rules/valid-local-dependency.md) | Checks existence of local dependencies in the package.json | | |
| [valid-package-def](docs/rules/valid-package-def.md) | Enforce that package.json has all properties required by NPM spec | | |

<!-- end auto-generated rules list -->
<!-- prettier-ignore-end -->
Expand All @@ -96,16 +98,20 @@ These rules only run on `package.json` files; they will ignore all other files b
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/AndreasLindbergPAF"><img src="https://avatars.githubusercontent.com/u/59874563?v=4?s=100" width="100px;" alt="Andreas Lindberg"/><br /><sub><b>Andreas Lindberg</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Aandreaslindbergpaf" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://technotes.khitrenovich.com/"><img src="https://avatars.githubusercontent.com/u/3424762?v=4?s=100" width="100px;" alt="Anton Khitrenovich"/><br /><sub><b>Anton Khitrenovich</b></sub></a><br /><a href="#ideas-khitrenovich" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://azat.io"><img src="https://avatars.githubusercontent.com/u/5698350?v=4?s=100" width="100px;" alt="Azat S."/><br /><sub><b>Azat S.</b></sub></a><br /><a href="#ideas-azat-io" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Zamiell"><img src="https://avatars.githubusercontent.com/u/5511220?v=4?s=100" width="100px;" alt="James"/><br /><sub><b>James</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=Zamiell" title="Code">💻</a></td>
<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></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/nschonni"><img src="https://avatars.githubusercontent.com/u/1297909?v=4?s=100" width="100px;" alt="Nick Schonning"/><br /><sub><b>Nick Schonning</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=nschonni" 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>
</tr>
<tr>
<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></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nschonni"><img src="https://avatars.githubusercontent.com/u/1297909?v=4?s=100" width="100px;" alt="Nick Schonning"/><br /><sub><b>Nick Schonning</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=nschonni" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sirugh"><img src="https://avatars.githubusercontent.com/u/1278869?v=4?s=100" width="100px;" alt="Stephen"/><br /><sub><b>Stephen</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=sirugh" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://ota-meshi.github.io/"><img src="https://avatars.githubusercontent.com/u/16508807?v=4?s=100" width="100px;" alt="Yosuke Ota"/><br /><sub><b>Yosuke Ota</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Aota-meshi" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/b3rnhard"><img src="https://avatars.githubusercontent.com/u/10774404?v=4?s=100" width="100px;" alt="b3rnhard"/><br /><sub><b>b3rnhard</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Ab3rnhard" title="Bug reports">🐛</a></td>
</tr>
</tbody>
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/order-properties.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Package properties must be declared in standard order (`package-json/order-properties`)

💼 This rule is enabled in the ✅ `recommended` config.

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/sort-collections.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Dependencies, scripts, and configuration values must be declared in alphabetical order (`package-json/sort-collections`)

💼 This rule is enabled in the ✅ `recommended` config.

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/valid-local-dependency.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Checks existence of local dependencies in the package.json (`package-json/valid-local-dependency`)

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

## Rule Details
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/valid-package-def.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Enforce that package.json has all properties required by NPM spec (`package-json/valid-package-def`)

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

NPM issues warnings after install if the `package.json` has a missing or
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "eslint-plugin-package-json",
"version": "0.3.2",
"version": "0.4.0",
"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
"homepage": "https://github.com/zetlen/eslint-plugin-package-json#readme",
"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
"bugs": {
"url": "https://github.com/zetlen/eslint-plugin-package-json/issues"
"url": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues"
},
"repository": {
"type": "git",
Expand Down
8 changes: 4 additions & 4 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 06099b8

Please sign in to comment.