Skip to content
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

Jump to bottom

Better error output for --report-needless-disables #4071

Merged
merged 3 commits into from
May 30, 2019
Merged

Better error output for --report-needless-disables #4071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9d5985
Return unused rule for range
muan May 3, 2019
999eca7
Update tests to expect unusedRule
muan May 3, 2019
60df786
Update formatter to output unused rule
muan May 3, 2019
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
1 change: 1 addition & 0 deletions flow-typed/stylelint.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ export type stylelint$cssSyntaxError = {
export type stylelint$needlessDisablesReport = Array<{
source: string,
ranges: Array<{
unusedRule: string,
start: number,
end?: number
}>
Expand Down
22 changes: 13 additions & 9 deletions lib/__tests__/needlessDisables.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ it("needlessDisables simple case", () => {

expect(report).toHaveLength(1);
expect(report[0].ranges).toEqual([
{ start: 7, end: 9 },
{ start: 11, end: 11 }
{ start: 7, end: 9, unusedRule: "all" },
{ start: 11, end: 11, unusedRule: "block-no-empty" }
]);
});
});
Expand All @@ -66,14 +66,18 @@ it("needlessDisables complex case", () => {
{
source: fixture("disabled-ranges-1.css"),
ranges: [
{ start: 1, end: 3 },
{ start: 5, end: 7 },
{ start: 10, end: 10 }
{ start: 1, end: 3, unusedRule: "color-named" },
{ start: 5, end: 7, unusedRule: "block-no-empty" },
{ start: 10, end: 10, unusedRule: "block-no-empty" }
]
},
{
source: fixture("disabled-ranges-2.css"),
ranges: [{ start: 5, end: 5 }, { start: 6, end: 6 }, { start: 8 }]
ranges: [
{ start: 5, end: 5, unusedRule: "color-named" },
{ start: 6, end: 6, unusedRule: "block-no-empty" },
{ start: 8, unusedRule: "block-no-empty" }
]
}
]);
});
Expand All @@ -96,9 +100,9 @@ it("needlessDisables ignored case", () => {
{
source: fixture("disabled-ranges-1.css"),
ranges: [
{ start: 1, end: 3 },
{ start: 5, end: 7 },
{ start: 10, end: 10 }
{ start: 1, end: 3, unusedRule: "color-named" },
{ start: 5, end: 7, unusedRule: "block-no-empty" },
{ start: 10, end: 10, unusedRule: "all" }
]
}
]);
Expand Down
6 changes: 4 additions & 2 deletions lib/__tests__/standalone-needlessDisables.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ it("standalone with input css and `reportNeedlessDisables`", () => {
expect(needlessDisables).toHaveLength(1);
expect(needlessDisables[0].ranges).toHaveLength(1);
expect(needlessDisables[0].ranges[0]).toEqual({
start: 1
start: 1,
unusedRule: "color-named"
});
});
});
Expand All @@ -52,7 +53,8 @@ it("standalone with input file(s) and `reportNeedlessDisables`", () => {
path.join(fixturesPath, "empty-block-with-disables.css")
);
expect(needlessDisables[0].ranges[0]).toEqual({
start: 1
start: 1,
unusedRule: "color-named"
});
});
});
18 changes: 12 additions & 6 deletions lib/formatters/__tests__/needlessDisablesStringFormatter.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,17 @@ describe("needlessDisablesStringFormatter", () => {
needlessDisablesStringFormatter([
{
source: "foo",
ranges: [{ start: 1, end: 3 }, { start: 7 }]
ranges: [
{ start: 1, end: 3, unusedRule: "baz" },
{ start: 7, unusedRule: "all" }
]
},
{
source: "bar",
ranges: [{ start: 19, end: 33 }, { start: 99, end: 102 }]
ranges: [
{ start: 19, end: 33, unusedRule: "all" },
{ start: 99, end: 102, unusedRule: "baz" }
]
},
{
sourc: "baz",
Expand All @@ -25,12 +31,12 @@ describe("needlessDisablesStringFormatter", () => {

let expected = stripIndent`
foo
start: 1, end: 3
start: 7
unused rule: baz, start line: 1, end line: 3
unused rule: all, start line: 7

bar
start: 19, end: 33
start: 99, end: 102`;
unused rule: all, start line: 19, end line: 33
unused rule: baz, start line: 99, end line: 102`;

expected = `\n${expected}\n`;

Expand Down
4 changes: 2 additions & 2 deletions lib/formatters/needlessDisablesStringFormatter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ module.exports = function(
output += "\n";
output += chalk.underline(logFrom(sourceReport.source)) + "\n";
sourceReport.ranges.forEach(range => {
output += `start: ${range.start}`;
output += `unused rule: ${range.unusedRule}, start line: ${range.start}`;

if (range.end !== undefined) {
output += `, end: ${range.end}`;
output += `, end line: ${range.end}`;
}

output += "\n";
Expand Down
2 changes: 2 additions & 0 deletions lib/needlessDisables.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ const _ = require("lodash");
*/

/*:: type rangeType = {
unusedRule: string,
end?: number,
start: number,
used?: boolean,
Expand Down Expand Up @@ -78,6 +79,7 @@ module.exports = function(
// If this range is unused and no equivalent is marked,
// mark this range as unused
if (!range.used && !alreadyMarkedUnused) {
range.unusedRule = rule;
unused.ranges.push(range);
}

Expand Down