Skip to content

feat: add url and recommended field to existing rules #104

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.

Sign up for GitHub

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
snitin315 merged 5 commits into from
May 28, 2025
Merged

feat: add url and recommended field to existing rules #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2b97727
refactor: add url field to existing docs
lumirlumir May 22, 2025
8f70b95
Merge branch 'main' into docs-add-url-field-to-existing-rules
lumirlumir May 22, 2025
0f87b78
wip: add recommended
lumirlumir May 22, 2025
e9c4e44
Merge branch 'docs-add-url-field-to-existing-rules' of https://github…
lumirlumir May 22, 2025
85b1ea1
wip: address reviews
lumirlumir May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions eslint.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ export default defineConfig([
"error",
{ pattern: "^(Enforce|Require|Disallow) .+[^. ]$" },
],
"eslint-plugin/require-meta-docs-url": [
"error",
{
pattern: "https://github.com/eslint/json#rules",
},
],
},
},
{
Expand Down
2 changes: 2 additions & 0 deletions src/rules/no-duplicate-keys.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ const rule = {
type: "problem",

docs: {
recommended: true,
description: "Disallow duplicate keys in JSON objects",
url: "https://github.com/eslint/json#rules",
},

messages: {
Expand Down
2 changes: 2 additions & 0 deletions src/rules/no-empty-keys.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ const rule = {
type: "problem",

docs: {
recommended: true,
description: "Disallow empty keys in JSON objects",
url: "https://github.com/eslint/json#rules",
},

messages: {
Expand Down
2 changes: 2 additions & 0 deletions src/rules/no-unnormalized-keys.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ const rule = {
type: "problem",

docs: {
recommended: true,
description: "Disallow JSON keys that are not normalized",
url: "https://github.com/eslint/json#rules",
},

messages: {
Expand Down
2 changes: 2 additions & 0 deletions src/rules/no-unsafe-values.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ const rule = {
type: "problem",

docs: {
recommended: true,
description: "Disallow JSON values that are unsafe for interchange",
url: "https://github.com/eslint/json#rules",
},

messages: {
Expand Down
2 changes: 2 additions & 0 deletions src/rules/sort-keys.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,9 @@ const rule = {
],

docs: {
recommended: false,
description: `Require JSON object keys to be sorted`,
url: "https://github.com/eslint/json#rules",
},

messages: {
Expand Down
2 changes: 2 additions & 0 deletions src/rules/top-level-interop.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ const rule = {
type: "problem",

docs: {
recommended: false,
description:
"Require the JSON top-level value to be an array or object",
url: "https://github.com/eslint/json#rules",
},

messages: {
Expand Down