-
-
Notifications
You must be signed in to change notification settings - Fork 964
feat(lint): add noReactNativeLiteralColors
#10012
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| "@biomejs/biome": patch | ||
| --- | ||
|
|
||
| Added the nursery rule [`noReactNativeLiteralColors`](https://biomejs.dev/linter/rules/no-react-native-literal-colors/), which disallows color literals inside React Native styles. | ||
|
|
||
| The rule belongs to the `reactNative` domain. It reports properties whose name contains `color` and whose value is a string literal when they appear inside a `StyleSheet.create(...)` call or inside a JSX attribute whose name contains `style`. | ||
|
|
||
| ```jsx | ||
| // Invalid | ||
| const Hello = () => <Text style={{ backgroundColor: '#FFFFFF' }}>hi</Text>; | ||
|
|
||
| const styles = StyleSheet.create({ | ||
| text: { color: 'red' } | ||
| }); | ||
| ``` | ||
|
|
||
| ```jsx | ||
| // Valid | ||
| const red = '#f00'; | ||
| const styles = StyleSheet.create({ | ||
| text: { color: red } | ||
| }); | ||
| ``` |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| use crate::frameworks::is_framework_api_reference; | ||
| use crate::services::semantic::Semantic; | ||
| use biome_analyze::{ | ||
| Rule, RuleDiagnostic, RuleDomain, RuleSource, context::RuleContext, declare_lint_rule, | ||
| }; | ||
| use biome_console::markup; | ||
| use biome_js_syntax::{ | ||
| AnyJsExpression, AnyJsLiteralExpression, JsCallExpression, JsPropertyObjectMember, JsxAttribute, | ||
| }; | ||
| use biome_rowan::{AstNode, TextRange, declare_node_union}; | ||
| use biome_rule_options::no_react_native_literal_colors::NoReactNativeLiteralColorsOptions; | ||
| use biome_string_case::StrLikeExtension; | ||
|
|
||
| declare_lint_rule! { | ||
| /// Disallow color literals in React Native styles. | ||
| /// | ||
| /// Hard-coding colors inside styles makes it harder to keep them consistent | ||
| /// across components and to swap the palette when the design system evolves. | ||
| /// Extracting colors into named constants or a shared theme module produces | ||
| /// more maintainable code. | ||
| /// | ||
| /// This rule reports properties whose name contains `color` (case-insensitive) | ||
| /// and whose value is a string literal, when they appear inside a | ||
| /// `StyleSheet.create` call or inside a JSX attribute whose name contains | ||
| /// `style` (case-insensitive). A ternary expression is also reported when | ||
| /// either branch is a string literal. | ||
| /// | ||
| /// ## Examples | ||
| /// | ||
| /// ### Invalid | ||
| /// | ||
| /// ```jsx,expect_diagnostic | ||
| /// const Hello = () => <Text style={{ backgroundColor: '#FFFFFF' }}>hi</Text>; | ||
| /// ``` | ||
| /// | ||
| /// ```jsx,expect_diagnostic | ||
| /// const styles = StyleSheet.create({ | ||
| /// text: { color: 'red' } | ||
| /// }); | ||
| /// ``` | ||
| /// | ||
| /// ```jsx,expect_diagnostic | ||
| /// const Hello = (flag) => ( | ||
| /// <Text style={{ backgroundColor: flag ? '#fff' : '#000' }}>hi</Text> | ||
| /// ); | ||
| /// ``` | ||
| /// | ||
| /// ### Valid | ||
| /// | ||
| /// ```jsx | ||
| /// const red = '#f00'; | ||
| /// const styles = StyleSheet.create({ | ||
| /// text: { color: red } | ||
| /// }); | ||
| /// ``` | ||
| /// | ||
| /// ```jsx | ||
| /// const Hello = () => ( | ||
| /// <Text style={{ backgroundColor: theme.background }}>hi</Text> | ||
| /// ); | ||
| /// ``` | ||
| /// | ||
| pub NoReactNativeLiteralColors { | ||
| version: "next", | ||
| name: "noReactNativeLiteralColors", | ||
| language: "js", | ||
| sources: &[RuleSource::EslintReactNative("no-color-literals").same()], | ||
| domains: &[RuleDomain::ReactNative], | ||
| recommended: false, | ||
| } | ||
| } | ||
|
|
||
| impl Rule for NoReactNativeLiteralColors { | ||
| type Query = Semantic<AnyStyleSink>; | ||
| type State = TextRange; | ||
| type Signals = Vec<Self::State>; | ||
| type Options = NoReactNativeLiteralColorsOptions; | ||
|
|
||
| fn run(ctx: &RuleContext<Self>) -> Self::Signals { | ||
| let node = ctx.query(); | ||
| match node { | ||
| AnyStyleSink::JsxAttribute(attribute) => { | ||
| if !is_style_attribute(attribute) { | ||
| return Vec::new(); | ||
| } | ||
| node.collect_color_literal_properties() | ||
| } | ||
| AnyStyleSink::JsCallExpression(call) => { | ||
| if !is_stylesheet_create(call, ctx.model()) { | ||
| return Vec::new(); | ||
| } | ||
| node.collect_color_literal_properties() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fn diagnostic(_ctx: &RuleContext<Self>, range: &Self::State) -> Option<RuleDiagnostic> { | ||
| Some( | ||
| RuleDiagnostic::new( | ||
| rule_category!(), | ||
| range, | ||
| markup! { | ||
| "Color literals are not allowed inside styles." | ||
| }, | ||
| ) | ||
| .note(markup! { | ||
| "Inline colors are hard to keep consistent across screens and to adapt when the design palette changes." | ||
| }) | ||
| .note(markup! { | ||
| "Extract the color into a named constant or a shared theme module, and reference it from the style." | ||
| }), | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| declare_node_union! { | ||
| /// The two places where React Native style objects can appear: a JSX | ||
| /// attribute like `style={...}` or a call like `StyleSheet.create(...)`. | ||
| pub AnyStyleSink = JsxAttribute | JsCallExpression | ||
| } | ||
|
|
||
| impl AnyStyleSink { | ||
| /// Walks all descendant `JsPropertyObjectMember` nodes and returns the text | ||
| /// range of each one whose name contains `color` and whose value is a color | ||
| /// literal (a string, or a ternary where at least one branch is a string). | ||
| fn collect_color_literal_properties(&self) -> Vec<TextRange> { | ||
| self.syntax() | ||
| .descendants() | ||
| .filter_map(JsPropertyObjectMember::cast) | ||
| .filter(|property| { | ||
| property | ||
| .name() | ||
| .ok() | ||
| .and_then(|name| name.name()) | ||
| .is_some_and(|name| name.contains_ignore_ascii_case("color")) | ||
| }) | ||
| .filter(|property| { | ||
| property | ||
| .value() | ||
| .ok() | ||
| .is_some_and(|value| has_color_literal_value(&value)) | ||
| }) | ||
| .map(|property| property.range()) | ||
| .collect() | ||
| } | ||
| } | ||
|
|
||
| fn has_color_literal_value(value: &AnyJsExpression) -> bool { | ||
| match value { | ||
| AnyJsExpression::AnyJsLiteralExpression( | ||
| AnyJsLiteralExpression::JsStringLiteralExpression(_), | ||
| ) => true, | ||
| AnyJsExpression::JsConditionalExpression(conditional) => { | ||
| conditional | ||
| .consequent() | ||
| .ok() | ||
| .is_some_and(|consequent| consequent.is_string_literal()) | ||
| || conditional | ||
| .alternate() | ||
| .ok() | ||
| .is_some_and(|alternate| alternate.is_string_literal()) | ||
| } | ||
| _ => false, | ||
| } | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| } | ||
|
|
||
| fn is_style_attribute(attribute: &JsxAttribute) -> bool { | ||
| attribute | ||
| .name() | ||
| .ok() | ||
| .and_then(|name| name.name().ok()) | ||
| .is_some_and(|token| token.text_trimmed().contains_ignore_ascii_case("style")) | ||
| } | ||
|
|
||
| /// Returns `true` when `call` is a call to `StyleSheet.create` where | ||
| /// `StyleSheet` is either imported from `react-native`/`react-native-web` or | ||
| /// is an unresolved global with that name. A `StyleSheet` identifier bound to | ||
| /// a user declaration (local variable, import from another package, …) is | ||
| /// rejected, so the rule only fires on the real React Native API. | ||
| fn is_stylesheet_create(call: &JsCallExpression, model: &biome_js_semantic::SemanticModel) -> bool { | ||
| let Ok(callee) = call.callee() else { | ||
| return false; | ||
| }; | ||
| is_framework_api_reference( | ||
| &callee, | ||
| model, | ||
| "create", | ||
| REACT_NATIVE_PACKAGE_NAMES, | ||
| Some("StyleSheet"), | ||
| ) | ||
|
ematipico marked this conversation as resolved.
|
||
| } | ||
|
|
||
| const REACT_NATIVE_PACKAGE_NAMES: &[&str] = &["react-native", "react-native-web"]; | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /* should generate diagnostics */ | ||
|
|
||
| const Inline = () => <Text style={{ backgroundColor: '#FFFFFF', opacity: 0.5 }}>hello</Text>; | ||
|
|
||
| const stylesBasic = StyleSheet.create({ | ||
| text: { fontColor: '#000' }, | ||
| }); | ||
|
|
||
| const MultipleInSheet = StyleSheet.create({ | ||
| primary: { color: 'red' }, | ||
| secondary: { borderBottomColor: 'blue' }, | ||
| }); | ||
|
|
||
| const InArray = () => ( | ||
| <Text style={[styles.text, { backgroundColor: '#FFFFFF' }]}>hello</Text> | ||
| ); | ||
|
|
||
| const InLogical = ({ active }) => ( | ||
| <Text style={[styles.text, active && { backgroundColor: '#FFFFFF' }]}>hello</Text> | ||
| ); | ||
|
|
||
| const TernaryBothLiterals = ({ active }) => ( | ||
| <Text style={{ backgroundColor: active ? '#fff' : '#000' }}>hello</Text> | ||
| ); | ||
|
|
||
| const TernaryOneLiteral = ({ active }) => ( | ||
| <Text style={{ backgroundColor: active ? '#fff' : theme.background }}>hello</Text> | ||
| ); | ||
|
|
||
| const CustomStyleAttribute = () => ( | ||
| <Text contentContainerStyle={{ color: 'red' }}>hello</Text> | ||
| ); |
Uh oh!
There was an error while loading. Please reload this page.