Skip to content

Fix: Fix false positive with empty array variable in require-meta-has-suggestions rule #171

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
merged 1 commit into from
Jul 27, 2021
Merged

Fix: Fix false positive with empty array variable in require-meta-has-suggestions rule #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 1 deletion lib/rules/require-meta-has-suggestions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,11 @@ module.exports = {
const suggestProp = node.arguments[0].properties.find(prop => utils.getKeyName(prop) === 'suggest');
if (suggestProp) {
const staticValue = getStaticValue(suggestProp.value, context.getScope());
if (!staticValue || (Array.isArray(staticValue.value) && staticValue.value.length > 0)) {
if (
!staticValue ||
(Array.isArray(staticValue.value) && staticValue.value.length > 0) ||
(Array.isArray(staticValue.value) && staticValue.value.length === 0 && suggestProp.value.type === 'Identifier') // Array variable can have suggestions pushed to it.
) {
// These are all considered reporting suggestions:
// suggest: [{...}]
// suggest: getSuggestions()
Expand Down
29 changes: 25 additions & 4 deletions tests/lib/rules/require-meta-has-suggestions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,14 @@ ruleTester.run('require-meta-has-suggestions', rule, {
}
};
`,
// No suggestions reported (empty suggest array in variable), no suggestion property.
// Suggestions reported (pushing to an array variable), suggestion property.
`
const SUGGESTIONS = [];
const suggest = [];
suggest.push({});
module.exports = {
meta: {},
meta: { hasSuggestions: true },
create(context) {
context.report({node, message, suggest: SUGGESTIONS});
context.report({node, message, suggest});
}
};
`,
Expand Down Expand Up @@ -235,6 +236,26 @@ ruleTester.run('require-meta-has-suggestions', rule, {
`,
errors: [{ messageId: 'shouldBeSuggestable', type: 'ObjectExpression', line: 4, column: 17, endLine: 4, endColumn: 19 }],
},
{
// Reports suggestions (in variable, with pushing), no hasSuggestions property, violation should be on `meta` object.
code: `
const suggest = [];
suggest.push({});
module.exports = {
meta: {},
create(context) { context.report({node, message, suggest}); }
};
`,
output: `
const suggest = [];
suggest.push({});
module.exports = {
meta: { hasSuggestions: true },
create(context) { context.report({node, message, suggest}); }
};
`,
errors: [{ messageId: 'shouldBeSuggestable', type: 'ObjectExpression', line: 5, column: 17, endLine: 5, endColumn: 19 }],
},
{
// Reports suggestions, hasSuggestions property set to false, violation should be on `false`
code: `
Expand Down