-
Notifications
You must be signed in to change notification settings - Fork 35
feat!: add require-repository rule #1491
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
michaelfaith
merged 4 commits into
michaelfaith:main
from
marcalexiei:require-repository
Jan 3, 2026
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
568cee8
feat: add require-repository rule
marcalexiei 002b8c3
fix: remove repository from recommended configs
marcalexiei 56fa889
feat: add require-repository to `recommended-publishable` config
marcalexiei 79de3e0
feat: add ignorePrivateDefault to require-repository
marcalexiei File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| # require-repository | ||
|
|
||
| 💼 This rule is enabled in the 📦 `recommended-publishable` config. | ||
|
|
||
| <!-- end auto-generated rule header --> | ||
|
|
||
| This rule checks for the existence of the `"repository"` property in a package.json, and reports a violation if it doesn't exist. | ||
|
|
||
| Example of **incorrect** code for this rule: | ||
|
|
||
| ```json | ||
| { | ||
| "name": "thee-silver-mt-zion", | ||
| "version": "13.0.0" | ||
| } | ||
| ``` | ||
|
|
||
| Examples of **correct** code for this rule: | ||
|
|
||
| ```json | ||
| { | ||
| "name": "thee-silver-mt-zion", | ||
| "version": "13.0.0", | ||
| "repository": "github:owner/project" | ||
| } | ||
| ``` | ||
|
|
||
| ```json | ||
| { | ||
| "name": "thee-silver-mt-zion", | ||
| "version": "13.0.0", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/owner/project" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| <!-- begin auto-generated rule options list --> | ||
|
|
||
| | Name | Description | Type | Default | | ||
| | :-------------- | :------------------------------------------------------------------------------------------ | :------ | :------ | | ||
| | `ignorePrivate` | Determines if this rule should be enforced when the package's `private` property is `true`. | Boolean | `false` | | ||
|
|
||
| <!-- end auto-generated rule options list --> | ||
|
|
||
| You can set the `ignorePrivate` option to `true` to ignore package.json files with `"private": true` (default: `false`). | ||
|
|
||
| ```json | ||
| { | ||
| "package-json/require-repository": [ | ||
| "error", | ||
| { | ||
| "ignorePrivate": false | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Example of **incorrect** code for this rule with the `{ "ignorePrivate": false }` option: | ||
|
|
||
| ```json | ||
| { | ||
| "private": true | ||
| } | ||
| ``` | ||
|
|
||
| Example of **correct** code for this rule with the `{ "ignorePrivate": false }` option: | ||
|
|
||
| ```json | ||
| { | ||
| "private": true, | ||
| "repository": "github:owner/project" | ||
| } | ||
| ``` | ||
|
|
||
| Example of **incorrect** code for this rule with the `{ "ignorePrivate": true }` option: | ||
|
|
||
| ```json | ||
| { | ||
| "private": false | ||
| } | ||
| ``` | ||
|
|
||
| ```json | ||
| {} | ||
| ``` | ||
|
|
||
| Example of **correct** code for this rule with the `{ "ignorePrivate": true }` option: | ||
|
|
||
| ```json | ||
| { | ||
| "private": true | ||
| } | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.