fixup! Style(codemods): Disable markdown heading capitalization for t…

…ransforms
lmc-eu · Dec 18, 2024 · 8c4e6bb · 8c4e6bb
1 parent bda5f9f
commit 8c4e6bb
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 15 deletions.
diff --git a/packages/codemods/src/transforms/v3/web-react/README.md b/packages/codemods/src/transforms/v3/web-react/README.md
@@ -1,15 +1,12 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint disable heading-capitalization-->
-
-# Web-React v3 Codemods
+# `web-react` v3 Codemods
 
 This is a collection of codemods for updating Web-React v3 components.
 
 You can find instructions on how to run these codemods in the main package [README](https://github.com/lmc-eu/spirit-design-system/blob/main/packages/codemods/README.md).
 
 ## Included Scripts
 
-### `v3/web-react/link-underlined-prop` — Link `isUnderlined` to `underlined` prop change
+### `v3/web-react/link-underlined-prop` — Link `isUnderlined` to `underlined` Prop Change
 
 This codemod updates the `Link` component by replacing the `isUnderlined` prop with a new `underlined` prop, setting it to "always".
 
@@ -26,7 +23,7 @@ npx @lmc-eu/spirit-codemods -p <path> -t v3/web-react/link-underlined-prop
 + <Link underlined="always" … />
 ```
 
-### `v3/web-react/button-isSquare-prop-name` — Button `isSquare` to `isSymmetrical` prop change
+### `v3/web-react/button-isSquare-prop-name` — Button `isSquare` to `isSymmetrical` Prop Change
 
 This codemod updates the `Button` component by replacing the `isSquare` prop with a `isSymmetrical` prop.
 
@@ -41,7 +38,7 @@ npx @lmc-eu/spirit-codemods -p <path> -t v3/web-react/button-isSquare-prop-name
 + <Button isSymmetrical … />
 ```
 
-### `v3/web-react/buttonLink-isSquare-prop-name` — ButtonLink `isSquare` to `isSymmetrical` prop change
+### `v3/web-react/buttonLink-isSquare-prop-name` — ButtonLink `isSquare` to `isSymmetrical` Prop Change
 
 This codemod updates the `ButtonLink` component by replacing the `isSquare` prop with a `isSymmetrical` prop.
 
@@ -56,7 +53,7 @@ npx @lmc-eu/spirit-codemods -p <path> -t v3/web-react/buttonLink-isSquare-prop-n
 + <ButtonLink isSymmetrical … />
 ```
 
-### `v3/web-react/heading-elementType-prop` — Add `elementType="div"` to Heading component
+### `v3/web-react/heading-elementType-prop` — Add `elementType="div"` to Heading Component
 
 The `elementType` prop is now mandatory in the `Heading` component.
 This codemod updates the `Heading` component by adding `elementType="div"` if the `elementType` prop is missing.
@@ -72,7 +69,7 @@ npx @lmc-eu/spirit-codemods -p <path> -t v3/web-react/heading-elementType-prop
 + <Heading elementType="div" … />
 ```
 
-### `v3/web-react/link-hasVisitedStyleAllowed-prop` — Add `hasVisitedStyleAllowed` to Link component inside Heading component
+### `v3/web-react/link-hasVisitedStyleAllowed-prop` — Add `hasVisitedStyleAllowed` to Link Component Inside Heading Component
 
 The Link component now allows to have visited state style. The `Heading` component had previously set visited state styling by default.
 This codemod updates the `Link` component inside the `Heading` component by adding `hasVisitedStyleAllowed`.
@@ -91,7 +88,7 @@ npx @lmc-eu/spirit-codemods -p <path> -t v3/web-react/link-hasVisitedStyleAllowe
 + <Heading><Link hasVisitedStyleAllowed … /></Heading>
 ```
 
-### `v3/web-react/toastbar-inverted-neutral` — Replace `inverted` with `neutral` in ToastBar component `color` prop
+### `v3/web-react/toastbar-inverted-neutral` — Replace `inverted` with `neutral` in ToastBar Component `color` Prop
 
 The `inverted` variant was removed from the `ToastBar` component.
 This codemod updates the `ToastBar` component by replacing the `inverted` value with `neutral` in the `color` prop.

diff --git a/packages/codemods/src/transforms/v4/web-react/README.md b/packages/codemods/src/transforms/v4/web-react/README.md
@@ -1,15 +1,12 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint disable heading-capitalization-->
-
-# Web-React v4 Codemods
+# `web-react` v4 Codemods
 
 This is a collection of codemods for updating Web-React v4 components.
 
 You can find instructions on how to run these codemods in the main package [README](https://github.com/lmc-eu/spirit-design-system/blob/main/packages/codemods/README.md).
 
 ## Included Scripts
 
-### `v4/web-react/collapse-isDisposable-prop` — UncontrolledCollapse `hideOnCollapse` to `isDisposable` prop change
+### `v4/web-react/collapse-isDisposable-prop` — UncontrolledCollapse `hideOnCollapse` to `isDisposable` Prop Change
 
 This codemod updates the `UncontrolledCollapse` component by replacing the `hideOnCollapse` prop with a new `isDisposable` prop.