Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Chore: enable consistent-meta-messages internal rule (#13487)
  • Loading branch information
mdjermanovic committed Jul 18, 2020
1 parent 885a145 commit 540b1af
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 13 deletions.
8 changes: 2 additions & 6 deletions .eslintrc.js
Expand Up @@ -95,12 +95,8 @@ module.exports = {
files: ["lib/rules/*", "tools/internal-rules/*"],
excludedFiles: ["index.js"],
rules: {
"internal-rules/no-invalid-meta": "error"

/*
* TODO: enable it when all the rules using meta.messages
* "internal-rules/consistent-meta-messages": "error"
*/
"internal-rules/no-invalid-meta": "error",
"internal-rules/consistent-meta-messages": "error"
}
},
{
Expand Down
10 changes: 7 additions & 3 deletions tests/tools/internal-rules/consistent-docs-url.js
Expand Up @@ -55,7 +55,7 @@ ruleTester.run("consistent-docs-url", rule, {
"};"
].join("\n"),
errors: [{
message: "Rule is missing a meta.docs property",
messageId: "missingMetaDocs",
line: 2,
column: 5
}]
Expand All @@ -73,7 +73,7 @@ ruleTester.run("consistent-docs-url", rule, {
"};"
].join("\n"),
errors: [{
message: "Rule is missing a meta.docs.url property",
messageId: "missingMetaDocsUrl",
line: 3,
column: 9
}]
Expand All @@ -92,7 +92,11 @@ ruleTester.run("consistent-docs-url", rule, {
"};"
].join("\n"),
errors: [{
message: "Incorrect url. Expected \"https://eslint.org/docs/rules/<input>\" but got \"http://example.com/wrong-url\"",
messageId: "incorrectUrl",
data: {
expected: "https://eslint.org/docs/rules/<input>",
url: "http://example.com/wrong-url"
},
line: 4,
column: 18
}]
Expand Down
14 changes: 10 additions & 4 deletions tools/internal-rules/consistent-docs-url.js
Expand Up @@ -55,15 +55,15 @@ function checkMetaDocsUrl(context, exportsNode) {
if (!metaDocs) {
context.report({
node: metaProperty,
message: "Rule is missing a meta.docs property"
messageId: "missingMetaDocs"
});
return;
}

if (!metaDocsUrl) {
context.report({
node: metaDocs,
message: "Rule is missing a meta.docs.url property"
messageId: "missingMetaDocsUrl"
});
return;
}
Expand All @@ -75,7 +75,8 @@ function checkMetaDocsUrl(context, exportsNode) {
if (url !== expected) {
context.report({
node: metaDocsUrl.value,
message: `Incorrect url. Expected "${expected}" but got "${url}"`
messageId: "incorrectUrl",
data: { expected, url }
});
}

Expand All @@ -93,7 +94,12 @@ module.exports = {
recommended: false
},
type: "suggestion",
schema: []
schema: [],
messages: {
missingMetaDocs: "Rule is missing a meta.docs property.",
missingMetaDocsUrl: "Rule is missing a meta.docs.url property.",
incorrectUrl: 'Incorrect url. Expected "{{ expected }}" but got "{{ url }}".'
}
},

create(context) {
Expand Down

0 comments on commit 540b1af

Please sign in to comment.