feat: Disable inline style prop for components
#3213
Merged
+390
−12
Conversation
This file contains hidden or 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
|
View your CI Pipeline Execution ↗ for commit 95f3c4e
☁️ Nx Cloud last updated this comment at |
dreamwasp
approved these changes
Nov 24, 2025
| }, | ||
| messages: { | ||
| noInlineStyle: | ||
| 'Inline styles are not allowed. Use styled components, CSS classes, or design system utilities instead.', |
Contributor
There was a problem hiding this comment.
I think we should tone this down a little - The use of inline styles is discouraged
| @@ -0,0 +1,72 @@ | |||
| import { ESLintUtils } from '@typescript-eslint/utils'; | |||
Comment on lines
+248
to
+255
| ## Related documentation | ||
|
|
||
| - <LinkTo id="Meta/Best Practices">Best Practices</LinkTo> - Learn about Gamut styling | ||
| best practices | ||
| - <LinkTo id="Foundations/System/Props">System Props</LinkTo> - Using system props | ||
| as an alternative to inline styles | ||
| - <LinkTo id="Foundations/System/Variants">Variants</LinkTo> - Creating styled variants | ||
| with gamut-styles |
Collaborator
|
📬 Published Alpha Packages: |
Contributor
|
🚀 Styleguide deploy preview ready! Preview URL: https://6924baafb1ab8c7677e16824--gamut-preview.netlify.app |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
Added a custom ESLint rule
gamut/no-inline-styletoeslint-plugin-gamutto disallow inlinestyleprops on JSX elements. This rule encourages the use of styled components, CSS classes, or design system utilities instead of inline styles.Changes:
no-inline-stylerule with full test coverage ineslint-plugin-gamut.eslintrc.jsto use the custom rule (set to 'error' level)recommendedconfigurationgamut-illustrationspackage where inline styles are acceptableMeta/ESLint Rules)PR Checklist
Testing Instructions
Check the ESLint documentation:
Verify the rule catches inline styles locally:
<div style={{ padding: 0 }} />to any component in thegamutpackageCheck that components with disable comments still work:
Card/index.tsx,Animation/Rotation.tsx,Animation/ExpandInCollapseOut.tsx,FocusTrap/index.tsx,Popover/Popover.tsx,Video/lib/VidstackPlayer.tsx, orForm/SelectDropdown/elements/controls.tsxstylepropsPR Links and Envs