Skip to content

feat: split no-static-styles-assignment messages #160

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

Open
saberzero1 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat: split no-static-styles-assignment messages #160

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
e25a0c6
feat: split no-static-styles-assignment messages
saberzero1 Jun 8, 2026
df0041b
fix: removed redundant check on setCssStyles()
saberzero1 Jun 15, 2026
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
29 changes: 10 additions & 19 deletions lib/rules/noStaticStylesAssignment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@ const ruleCreator = ESLintUtils.RuleCreator(
// - element.style.setProperty('color', 'red')
// - element.style.cssText = 'color: red;'
// - element.setAttribute('style', 'color: red;')
// - element.setCssProps({ 'color': 'blue' }) (non-custom-property key in setCssProps)
//
// This rule will not flag:
//
// - element.style.width = myWidth; (assignment from a variable)
// - element.style.transform = `translateX(${offset}px)`; (assignment from a template literal with expressions)
// - element.setCssProps({ '--my-var': 'blue' }) (custom property in setCssProps is correct usage)
// - element.setCssStyles({ 'color': 'blue' }) (standard property in setCssStyles is correct usage)

// Checks if a node is a MemberExpression accessing the 'style' property.
// e.g., `el.style` or `this.containerEl.style`
Expand All @@ -41,7 +44,10 @@ export default ruleCreator({
schema: [],
messages: {
avoidStyleAssignment:
"Avoid setting styles directly via `{{property}}`. Use CSS classes for better theming and maintainability. Use the `setCssProps` function if the CSS properties need to change dynamically.",
"Avoid setting styles directly via `{{property}}`. Use CSS classes for better theming and maintainability. Use `setCssProps` for dynamic CSS custom properties or `setCssStyles` for dynamic standard properties.",
avoidNonCustomPropertyInSetCssProps:
"`setCssProps` should only be used for CSS custom properties (prefixed with `--`). Use `setCssStyles` for standard CSS properties, or CSS classes for static styles.",

},
},
defaultOptions: [],
Expand Down Expand Up @@ -113,37 +119,22 @@ export default ruleCreator({
}
}

// Case 3: `el.style.setCssProps({ 'color': 'blue' })`
// Case 3: `el.setCssProps({ 'color': 'blue' })` — only custom properties (--*) belong here
if (
propertyName === "setCssProps" && node.arguments[0].type === TSESTree.AST_NODE_TYPES.ObjectExpression
) {
for (const property of node.arguments[0].properties) {
if (property.type === TSESTree.AST_NODE_TYPES.Property && property.key.type === TSESTree.AST_NODE_TYPES.Literal && typeof property.key.value === 'string' && !property.key.value.startsWith('--')) {
context.report({
node,
messageId: "avoidStyleAssignment",
data: { property: "el.setCssProps" },
messageId: "avoidNonCustomPropertyInSetCssProps",
});
break;
}
}
}

// Case 4: `el.style.setCssStyles({ 'color': 'blue' })`
if (
propertyName === "setCssStyles" && node.arguments[0].type === TSESTree.AST_NODE_TYPES.ObjectExpression
) {
for (const property of node.arguments[0].properties) {
if (property.type === TSESTree.AST_NODE_TYPES.Property && property.key.type === TSESTree.AST_NODE_TYPES.Literal && typeof property.key.value === 'string' && !property.key.value.startsWith('--')) {
context.report({
node,
messageId: "avoidStyleAssignment",
data: { property: "el.setCssStyles" },
});
break;
}
}
}

},
};
},
Expand Down
24 changes: 11 additions & 13 deletions tests/noStaticStylesAssignment.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ ruleTester.run("no-static-styles-assignment", noInlineStylesRule, {
name: "setCssProps with computed key is allowed",
code: "el.setCssProps({ [someKey]: someValue });",
},
{
name: "setCssStyles with standard property is allowed",
code: "el.setCssStyles({ 'color': 'blue' });",
},
{
name: "setCssStyles with computed key is allowed",
code: "el.setCssStyles({ [someKey]: someValue });",
},
],
invalid: [
{
Expand Down Expand Up @@ -90,24 +98,14 @@ ruleTester.run("no-static-styles-assignment", noInlineStylesRule, {
],
},
{
name: "setCssProps with non-variable property is forbidden",
name: "setCssProps with non-custom-property key is forbidden",
code: "el.setCssProps({ 'color': 'blue' });",
errors: [
{
messageId: "avoidStyleAssignment",
data: { property: "el.setCssProps" },
messageId: "avoidNonCustomPropertyInSetCssProps",
}
]
},
{
name: "setCssStyles with non-variable property is forbidden",
code: "el.setCssStyles({ 'color': 'blue' });",
errors: [
{
messageId: "avoidStyleAssignment",
data: { property: "el.setCssStyles" },
}
]
}

],
});
Loading