Skip to content

feat: add suggestion to no-important rule to remove !important flag #217

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 2 commits into from
Jul 31, 2025
Merged

feat: add suggestion to no-important rule to remove !important flag #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
889087b
feat: add suggestion to no-important rule to remove !important flag
thecalamiity Jul 29, 2025
e55adb4
trim whitespace before !important
thecalamiity Jul 30, 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
41 changes: 38 additions & 3 deletions src/rules/no-important.js
View file
Open in desktop
Copy link
Contributor

@Tanujkanti4441 Tanujkanti4441 Jul 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now, if somehow the CSS comment before the !important flag contains the !important, then the rule reports the one inside the comment.

a { color: red /* !important flag 1 */ !important; }


/* after fix the output will be */
a { color: red /*  flag 1 */ !important; }

Copy link
Contributor Author

@thecalamiity thecalamiity Jul 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened #218 to address this.

Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,17 @@ import { findOffsets } from "../util.js";

/**
* @import { CSSRuleDefinition } from "../types.js"
* @typedef {"unexpectedImportant"} NoImportantMessageIds
* @typedef {"unexpectedImportant" | "removeImportant"} NoImportantMessageIds
* @typedef {CSSRuleDefinition<{ RuleOptions: [], MessageIds: NoImportantMessageIds }>} NoImportantRuleDefinition
*/

//-----------------------------------------------------------------------------
// Helpers
//-----------------------------------------------------------------------------

const importantPattern = /!(\s|\/\*.*?\*\/)*important/iu;
const trailingWhitespacePattern = /\s*$/u;

//-----------------------------------------------------------------------------
// Rule Definition
//-----------------------------------------------------------------------------
Expand All @@ -29,6 +36,8 @@ export default {
meta: {
type: "problem",

hasSuggestions: true,

docs: {
description: "Disallow !important flags",
recommended: true,
Expand All @@ -37,12 +46,11 @@ export default {

messages: {
unexpectedImportant: "Unexpected !important flag found.",
removeImportant: "Remove !important flag.",
},
},

create(context) {
const importantPattern = /!(\s|\/\*.*?\*\/)*important/iu;

return {
Declaration(node) {
if (node.important) {
Expand Down Expand Up @@ -86,6 +94,33 @@ export default {
},
},
messageId: "unexpectedImportant",
suggest: [
{
messageId: "removeImportant",
fix(fixer) {
const importantStart = importantMatch.index;
const importantEnd =
importantStart +
importantMatch[0].length;

// Find any trailing whitespace before the !important
const valuePart = declarationText.slice(
0,
importantStart,
);
const whitespaceEnd = valuePart.search(
trailingWhitespacePattern,
);

const start =
node.loc.start.offset + whitespaceEnd;
const end =
node.loc.start.offset + importantEnd;

return fixer.removeRange([start, end]);
},
},
],
});
}
},
Expand Down
Loading
Loading