feat: implement rfc 2021-suppression-support #15459
There are no files selected for viewing
This file contains 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 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 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 |
|---|---|---|
|
|
@@ -197,11 +197,10 @@ function processUnusedDisableDirectives(allDirectives) { | |
| * for the exported function, except that `reportUnusedDisableDirectives` is not supported | ||
| * (this function always reports unused disable directives). | ||
| * @returns {{problems: Problem[], unusedDisableDirectives: Problem[]}} An object with a list | ||
| * of problems (including suppressed ones) and unused eslint-disable directives | ||
| */ | ||
Yiwei-Ding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| function applyDirectives(options) { | ||
| const problems = []; | ||
| let currentGlobalDisableDirective = null; | ||
| const disabledRuleMap = new Map(); | ||
|
|
||
|
|
@@ -210,35 +209,61 @@ function applyDirectives(options) { | |
| const usedDisableDirectives = new Set(); | ||
|
|
||
| for (const problem of options.problems) { | ||
mdjermanovic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| let nextDirectiveIndex = 0; | ||
mdjermanovic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // isProblemSuppressedBefore indicates whether the problem is suppressed by block directives. | ||
| const isProblemSuppressedBefore = problem.suppressions ? true : false; // eslint-disable-line no-unneeded-ternary -- problem.suppressions might be changed afterwards. | ||
|
|
||
| while ( | ||
| nextDirectiveIndex < options.directives.length && | ||
| compareLocations(options.directives[nextDirectiveIndex], problem) <= 0 | ||
| ) { | ||
| const directive = options.directives[nextDirectiveIndex++]; | ||
| const suppression = { kind: "directive", justification: directive.unprocessedDirective.justification }; | ||
|
There was a problem hiding this comment. Would it make sense to add location information to the suppression to show where the directive is? There was a problem hiding this comment. It's a good idea. The location info can be leveraged for auditing purposes as well. I also find a location property in But I'd like to add location info to the suppressions in another PR because:
|
||
|
|
||
| switch (directive.type) { | ||
| case "disable": | ||
| if (!isProblemSuppressedBefore) { | ||
mdjermanovic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (directive.ruleId === null) { | ||
| currentGlobalDisableDirective = directive; | ||
| disabledRuleMap.clear(); | ||
| enabledRules.clear(); | ||
| } else if (currentGlobalDisableDirective) { | ||
| enabledRules.delete(directive.ruleId); | ||
| disabledRuleMap.set(directive.ruleId, directive); | ||
| } else { | ||
| disabledRuleMap.set(directive.ruleId, directive); | ||
| } | ||
| } | ||
|
|
||
| if (directive.ruleId === null || directive.ruleId === problem.ruleId) { | ||
Yiwei-Ding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (problem.suppressions) { | ||
| problem.suppressions.push(suppression); | ||
| } else { | ||
| problem.suppressions = [suppression]; | ||
| } | ||
| } | ||
| break; | ||
|
|
||
| case "enable": | ||
| if (!isProblemSuppressedBefore) { | ||
| if (directive.ruleId === null) { | ||
| currentGlobalDisableDirective = null; | ||
| disabledRuleMap.clear(); | ||
| } else if (currentGlobalDisableDirective) { | ||
| enabledRules.add(directive.ruleId); | ||
| disabledRuleMap.delete(directive.ruleId); | ||
| } else { | ||
| disabledRuleMap.delete(directive.ruleId); | ||
| } | ||
| } | ||
|
|
||
| if (directive.ruleId === null || directive.ruleId === problem.ruleId) { | ||
| if (problem.suppressions && directive.unprocessedDirective.type === "disable-line" && compareLocations(directive.unprocessedDirective, problem) <= 0) { | ||
| problem.suppressions.pop(); | ||
| } else { | ||
| problem.suppressions = []; | ||
| } | ||
| } | ||
mdjermanovic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| break; | ||
|
|
||
|
|
@@ -250,9 +275,9 @@ function applyDirectives(options) { | |
| usedDisableDirectives.add(disabledRuleMap.get(problem.ruleId)); | ||
| } else if (currentGlobalDisableDirective && !enabledRules.has(problem.ruleId)) { | ||
| usedDisableDirectives.add(currentGlobalDisableDirective); | ||
| } | ||
|
|
||
| problems.push(problem); | ||
| } | ||
|
|
||
| const unusedDisableDirectivesToReport = options.directives | ||
|
|
@@ -280,24 +305,47 @@ function applyDirectives(options) { | |
| return { problems, unusedDisableDirectives }; | ||
| } | ||
|
|
||
| /** | ||
| * Given a list of reported problems, distinguish problems between normal messages and suppressed messages. | ||
| * @param {Problem[]} problems A list of reported problems. | ||
| * @returns {{messages: LintMessage[], suppressedMessages: SuppressedLintMessage[]}} | ||
| * An object with a list of LintMessage and a list of SuppressLintMessage. | ||
| */ | ||
| function distinguishSuppressedMessages(problems) { | ||
| const messages = []; | ||
| const suppressedMessages = []; | ||
|
|
||
| for (const problem of problems) { | ||
| if (typeof problem.suppressions === "undefined" || problem.suppressions.length === 0) { | ||
| delete problem.suppressions; | ||
| messages.push(problem); | ||
| } else { | ||
| suppressedMessages.push(problem); | ||
| } | ||
| } | ||
|
|
||
| return { messages, suppressedMessages }; | ||
| } | ||
|
|
||
| /** | ||
| * Given a list of directive comments (i.e. metadata about eslint-disable and eslint-enable comments) and a list | ||
| * of reported problems, determines whether problems should be reported or suppressed. | ||
| * @param {Object} options Information about directives and problems | ||
| * @param {{ | ||
| * type: ("disable"|"enable"|"disable-line"|"disable-next-line"), | ||
| * ruleId: (string|null), | ||
| * line: number, | ||
| * column: number, | ||
| * justification: string | ||
| * }} options.directives Directive comments found in the file, with one-based columns. | ||
| * Two directive comments can only have the same location if they also have the same type (e.g. a single eslint-disable | ||
| * comment for two different rules is represented as two directives). | ||
| * @param {{ruleId: (string|null), line: number, column: number}[]} options.problems | ||
| * A list of problems reported by rules, sorted by increasing location in the file, with one-based columns. | ||
| * @param {"off" | "warn" | "error"} options.reportUnusedDisableDirectives If `"warn"` or `"error"`, adds additional problems for unused directives | ||
| * @param {boolean} options.disableFixes If true, it doesn't make `fix` properties. | ||
| * @returns {{messages: LintMessage[], suppressedMessages: SuppressedLintMessage[]}} | ||
| * An object with a list of LintMessage and a list of SuppressLintMessage. | ||
| */ | ||
| module.exports = ({ directives, disableFixes, problems, reportUnusedDisableDirectives = "off" }) => { | ||
| const blockDirectives = directives | ||
|
|
@@ -341,10 +389,12 @@ module.exports = ({ directives, disableFixes, problems, reportUnusedDisableDirec | |
| reportUnusedDisableDirectives | ||
| }); | ||
|
|
||
| const reportedProblems = reportUnusedDisableDirectives !== "off" | ||
| ? lineDirectivesResult.problems | ||
| .concat(blockDirectivesResult.unusedDisableDirectives) | ||
| .concat(lineDirectivesResult.unusedDisableDirectives) | ||
| .sort(compareLocations) | ||
| : lineDirectivesResult.problems; | ||
|
|
||
| return distinguishSuppressedMessages(reportedProblems); | ||
| }; | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link is broken as there's no
getsuppressedmessagessection in the document.