Style(repo): Get rid of all heading capitalization ignore comments in…

… docs
lmc-eu · Dec 19, 2024 · 6d84490 · 6d84490
1 parent 9983836
commit 6d84490
Show file tree

Hide file tree

Showing 25 changed files with 3 additions and 93 deletions.
diff --git a/.remarkrc.mjs b/.remarkrc.mjs
@@ -39,7 +39,7 @@ export default {
       {
         lowerCaseWords: ['v1', 'v2', 'v3', 'v4', 'vs'],
         exclude: ['`web`', '`web-react`'],
-        ignorePattern: ['^@lmc-eu/spirit-.*', '^spirit-.*', '`.*`'],
+        ignorePattern: ['^@lmc-eu/spirit-.*', '^spirit-.*', '`.*`', '.*-config-spirit'],
       },
     ],
 

diff --git a/DEPRECATIONS-v2.md b/DEPRECATIONS-v2.md
@@ -6,9 +6,6 @@ Introducing deprecations and feature flags to be removed in the version 2 lists.
 
 💁 Please follow these steps to safely upgrade your Design System to Spirit Design System v2 components.
 
-<!-- @see: https://github.com/ilyatitovich/remark-lint-heading-capitalization/issues/13 -->
-<!--lint disable heading-capitalization -->
-
 ## @lmc-eu/spirit-web v2
 
 - [Deprecations][web-deprecations-v2]
@@ -19,8 +16,6 @@ Introducing deprecations and feature flags to be removed in the version 2 lists.
 
 ## @lmc-eu/spirit-web-twig v2
 
-<!--lint enable heading-capitalization -->
-
 - _spirit-web-twig_ was released as version 2 already. See the [CHANGELOG][twig-changelog] for more details or refer to the [migration guide][twig-migration-v2].
 
 ---

diff --git a/DEPRECATIONS-v3.md b/DEPRECATIONS-v3.md
@@ -6,13 +6,8 @@ Introducing deprecations and feature flags to be removed in the version 3 lists.
 
 💁 Please follow these steps to safely upgrade your Design System to Spirit Design System v3 components.
 
-<!-- @see: https://github.com/ilyatitovich/remark-lint-heading-capitalization/issues/13 -->
-<!--lint disable heading-capitalization -->
-
 ## @lmc-eu/spirit-web-twig v3
 
-<!--lint enable heading-capitalization -->
-
 - [Deprecations][web-twig-deprecations]
 
 ---

diff --git a/configs/jest-config-spirit/README.md b/configs/jest-config-spirit/README.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 # jest-config-spirit
 
 > Jest configuration and preset for Spirit Design System
@@ -17,16 +14,10 @@ yarn add jest-config-spirit
 
 ## ⚙️ Configurations
 
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 ### `jest-preset-spirit/node`
 
 The default Jest configuration for Node.js projects.
 
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 ### `jest-preset-spirit/jsdom`
 
 The extension of the default preset for projects that require a browser-like (DOM) environment.

diff --git a/configs/prettier-config-spirit/README.md b/configs/prettier-config-spirit/README.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 # prettier-config-spirit
 
 > Prettier configuration and preset for Spirit Design System

diff --git a/configs/stylelint-config-spirit/README.md b/configs/stylelint-config-spirit/README.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 # stylelint-config-spirit
 
 > Stylelint configuration and preset for Spirit Design System

diff --git a/docs/contribution/experimental-code.md b/docs/contribution/experimental-code.md
@@ -79,9 +79,6 @@ documented in each package's main README file in the section `Feature Flags`.
 
 All feature flags follow a prefix naming convention that indicates status.
 
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 #### Flags Prefixed with `enable-*`
 
 - Contain new features that we'd like consuming projects to test
@@ -95,9 +92,6 @@ All feature flags follow a prefix naming convention that indicates status.
 If you use these flags, make sure to check our release notes where we'll outline
 any changes to them across our releases.
 
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 #### Flags Prefixed with `enable-v#-*`
 
 As the usage of an existing flag increases or we determine a feature to be of high
@@ -153,6 +147,7 @@ if it can be moved (most of the time the team will initiate this move).
 The issue should contain the following criteria that need to
 be met to move a component from experimental to stable:
 
+<!-- Because of the GitHub syntax for the checkboxes -->
 <!--lint disable no-undefined-references-->
 
 - [ ] All components are exported through main package export file and should not be `UNSTABLE_`

diff --git a/docs/migrations/web-react/MIGRATION-v1.md b/docs/migrations/web-react/MIGRATION-v1.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint disable heading-capitalization-->
-
 # Migration Guide
 
 Introducing version 1 of the _spirit-web-react_ package

diff --git a/docs/migrations/web-react/MIGRATION-v2.md b/docs/migrations/web-react/MIGRATION-v2.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint disable heading-capitalization-->
-
 # Migration Guide
 
 Introducing version 2 of the _spirit-web-react_ package.

diff --git a/docs/migrations/web-react/MIGRATION-v3.md b/docs/migrations/web-react/MIGRATION-v3.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint disable heading-capitalization-->
-
 # Migration Guide
 
 Introducing version 3 of the _spirit-web-react_ package.

diff --git a/docs/migrations/web-twig/MIGRATION-v2.md b/docs/migrations/web-twig/MIGRATION-v2.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint disable heading-capitalization-->
-
 # Migration Guide
 
 Introducing version 2 of the _spirit-web-twig_ package

diff --git a/docs/migrations/web-twig/MIGRATION-v3.md b/docs/migrations/web-twig/MIGRATION-v3.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint disable heading-capitalization-->
-
 # Migration Guide
 
 Introducing version 3 of the _spirit-web-twig_ package.

diff --git a/docs/migrations/web-twig/MIGRATION-v4.md b/docs/migrations/web-twig/MIGRATION-v4.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint disable heading-capitalization-->
-
 # Migration Guide
 
 Introducing version 4 of the _spirit-web-twig_ package.

diff --git a/docs/migrations/web/MIGRATION-v1.md b/docs/migrations/web/MIGRATION-v1.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint disable heading-capitalization-->
-
 # Migration Guide
 
 Introducing version 1 of the _spirit-web_ package

diff --git a/docs/migrations/web/MIGRATION-v2.md b/docs/migrations/web/MIGRATION-v2.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint disable heading-capitalization-->
-
 # Migration Guide
 
 Introducing version 2 of the _spirit-web_ package.

diff --git a/docs/migrations/web/MIGRATION-v3.md b/docs/migrations/web/MIGRATION-v3.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint disable heading-capitalization-->
-
 # Migration Guide
 
 Introducing version 3 of the _spirit-web_ package.

diff --git a/packages/demo/README.md b/packages/demo/README.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 # @lmc-eu/spirit-demo
 
 > Scripts, Styles and Partials for showcase apps of Spirit Design System.

diff --git a/packages/design-tokens/README.md b/packages/design-tokens/README.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 # @lmc-eu/spirit-design-tokens
 
 > Design tokens for Spirit Design System.
@@ -157,9 +154,6 @@ module: {
 
 </details>
 
-<!-- https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 #### Using the `sass-embedded` Library
 
 If you're using `sass-embedded`, you can specify the API as `legacy`, `modern`, or `modern-compiler`. More information can be found in [sass documentation][sass-embedded].

diff --git a/packages/icons/README.md b/packages/icons/README.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 # @lmc-eu/spirit-icons
 
 > Icons of Spirit Design System.

diff --git a/packages/web-react/DEPRECATIONS.md b/packages/web-react/DEPRECATIONS.md
@@ -8,9 +8,6 @@ This document lists all deprecations that will be removed in the next major vers
 
 👉 [What are deprecations?][readme-deprecations]
 
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 ### UncontrolledCollapse `isDisposable`
 
 The `hideOnCollapse` prop was removed, please use `isDisposable` instead.

diff --git a/packages/web-react/README.md b/packages/web-react/README.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 # @lmc-eu/spirit-web-react
 
 [![minified](https://badgen.net/bundlephobia/min/@lmc-eu/spirit-web-react)](https://bundlephobia.com/package/@lmc-eu/spirit-web-react)

diff --git a/packages/web-react/src/components/Toast/README.md b/packages/web-react/src/components/Toast/README.md
@@ -361,10 +361,7 @@ const { show } = useToast(); // must be inside ToastProvider
 </ToastProvider>;
 ```
 
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
-### useToast Hook
+### `useToast` Hook
 
 Hook that provides information on `UncontrolledToast` and functions for opening and closing.
 What is uncontrolled component you can find [here][react-uncontrolled]
@@ -382,9 +379,6 @@ This hook returns:
 | `message`  | \[`string` \| `ReactNode`]                                   | null      | Message inside UncontrolledToast                    |
 | `show`     | `(message, toastId, options?) => void`                       | () => {}  | Function that will show UncontrolledToast           |
 
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 #### How to Use `show` Function
 
 This function has two required parameters: message and ID.

diff --git a/packages/web-twig/DEPRECATIONS.md b/packages/web-twig/DEPRECATIONS.md
@@ -6,9 +6,6 @@ This document lists all deprecations that will be removed in the next major vers
 
 ## Deprecations
 
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 ## Collapse `data-spirit-is-disposable`
 
 The `data-spirit-more` attribute was removed, please use `data-spirit-is-disposable` instead.

diff --git a/packages/web/DEPRECATIONS.md b/packages/web/DEPRECATIONS.md
@@ -6,9 +6,6 @@ This document lists all deprecations that will be removed in the next major vers
 
 ## Deprecations
 
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization-->
-
 ### Collapse `data-spirit-is-disposable`
 
 The `data-spirit-more` attribute was removed, please use `data-spirit-is-disposable` instead.

diff --git a/packages/web/README.md b/packages/web/README.md
@@ -1,6 +1,3 @@
-<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
-<!--lint ignore heading-capitalization -->
-
 # @lmc-eu/spirit-web
 
 > CSS implementation of Spirit Design System.