Add missing rule for BodyLarge deprecation

sumup-oss · Oct 17, 2024 · c8c0121 · c8c0121
1 parent e9e0209
commit c8c0121
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/packages/circuit-ui/components/BodyLarge/BodyLarge.tsx b/packages/circuit-ui/components/BodyLarge/BodyLarge.tsx
@@ -20,7 +20,7 @@ import { Body, type BodyProps } from '../Body/Body.js';
 
 export type BodyLargeProps = Omit<BodyProps, 'size'>;
 /**
- * @deprecated Use the Body component in size `l` instead.
+ * @deprecated Use the Body component with `size="l"` instead.
  */
 export const BodyLarge = forwardRef<HTMLParagraphElement, BodyLargeProps>(
   (props, ref) => {

diff --git a/packages/circuit-ui/components/SubHeadline/SubHeadline.tsx b/packages/circuit-ui/components/SubHeadline/SubHeadline.tsx
@@ -28,7 +28,7 @@ export interface SubHeadlineProps extends HTMLAttributes<HTMLHeadingElement> {
 }
 
 /**
- * @deprecated Use the Headline component in size `s` instead.
+ * @deprecated Use the Headline component with `size="s"` instead.
  */
 export const SubHeadline = forwardRef<HTMLHeadingElement, SubHeadlineProps>(
   (props, ref) => {

diff --git a/packages/eslint-plugin-circuit-ui/no-deprecated-components/index.ts b/packages/eslint-plugin-circuit-ui/no-deprecated-components/index.ts
@@ -33,12 +33,16 @@ const components = [
   },
   {
     name: 'SubHeadline',
-    alternative: 'Use the Headline component in size `s` instead.',
+    alternative: 'Use the Headline component with `size="s"` instead.',
   },
   {
     name: 'Title',
     alternative: 'Use the new Display component instead.',
   },
+  {
+    name: 'BodyLarge',
+    alternative: 'Use the Body component with `size="l"` instead.',
+  },
 ];
 
 export const noDeprecatedComponents = createRule({