diff --git a/.remarkignore b/.remarkignore index 3ca7ea0fc5..c5a1b3f5e0 100644 --- a/.remarkignore +++ b/.remarkignore @@ -6,8 +6,5 @@ dist build .github -# Temporary disabled packages -# we will fix them incrementally -form-validations -# Codemods transforms directory -transforms +# Fix case of the files +MIGRATION-* diff --git a/.remarkrc.mjs b/.remarkrc.mjs index 73942cc66f..4a722f12da 100644 --- a/.remarkrc.mjs +++ b/.remarkrc.mjs @@ -37,20 +37,9 @@ export default { [ 'remark-lint-heading-capitalization', { - lowerCaseWords: [ - 'eu/spirit', - '@lmc', - 'spirit/node', - 'spirit/jsdom', - 'analytics', - 'codemods', - 'common', - 'v1', - 'v2', - 'v3', - 'v4', - 'vs', - ], + lowerCaseWords: ['v1', 'v2', 'v3', 'v4', 'vs'], + exclude: ['`web`', '`web-react`'], + ignorePattern: ['^@lmc-eu/spirit-.*', '^spirit-.*', '`.*`', '.*-config-spirit'], }, ], diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 05d486a232..7c2fed5c55 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,9 +17,9 @@ Here are some tips how to make your contributing efforts efficient and eventuall This project uses `makefile` for managing various chores, like dependency installation, testing, linting etc. Make sure you run `make` right after you clone the repository - it will set you up with everything needed to get started. Once you are done with that, have a look at what commands (targets) are available for you to run using `make` - `make install` etc. -## [Decisions](https://github.com/lmc-eu/spirit-design-system/blob/main/docs/decisions/README.md) +## Decisions -The reasoning behind various decisions made for the Spirit Design System. A good historical record. +The reasoning behind various [decisions][decisions] made for the Spirit Design System. A good historical record. ## Project Structure @@ -278,8 +278,9 @@ PR can be merged only by the appropriate group of maintainers. [act-article]: https://www.freecodecamp.org/news/how-to-run-github-actions-locally/ [conventional-commits]: https://www.conventionalcommits.org [commitlint-config]: https://github.com/lmc-eu/code-quality-tools/tree/main/packages/commitlint-config -[dictionary]: https://github.com/lmc-eu/spirit-design-system/tree/main/docs/DICTIONARIES.md +[decisions]: https://github.com/lmc-eu/spirit-design-system/blob/main/docs/decisions/README.md [developer-handbook]: https://github.com/lmc-eu/spirit-design-system/tree/main/docs/contribution/development.md +[dictionary]: https://github.com/lmc-eu/spirit-design-system/tree/main/docs/DICTIONARIES.md [docker]: https://www.docker.com/ [eslint]: https://eslint.org/ [jest]: https://jestjs.io/ diff --git a/DEPRECATIONS-v2.md b/DEPRECATIONS-v2.md index 3895ff41b9..3bf2230c96 100644 --- 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. - - - ## @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 - - - _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 index d1f7d82a87..ea15bc7d37 100644 --- 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. - - - ## @lmc-eu/spirit-web-twig v3 - - - [Deprecations][web-twig-deprecations] --- diff --git a/configs/jest-config-spirit/README.md b/configs/jest-config-spirit/README.md index 3ca4a20490..951af01035 100644 --- a/configs/jest-config-spirit/README.md +++ b/configs/jest-config-spirit/README.md @@ -1,6 +1,3 @@ - - - # jest-config-spirit > Jest configuration and preset for Spirit Design System @@ -17,16 +14,10 @@ yarn add jest-config-spirit ## ⚙️ Configurations - - - ### `jest-preset-spirit/node` The default Jest configuration for Node.js projects. - - - ### `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 index f59707097d..54649fd4e3 100644 --- a/configs/prettier-config-spirit/README.md +++ b/configs/prettier-config-spirit/README.md @@ -1,6 +1,3 @@ - - - # 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 index 57bed994d9..59c1cc6703 100644 --- a/configs/stylelint-config-spirit/README.md +++ b/configs/stylelint-config-spirit/README.md @@ -1,6 +1,3 @@ - - - # 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 index cd0ea51bbe..a93653d949 100644 --- 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. - - - #### 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. - - - #### 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: + - [ ] All components are exported through main package export file and should not be `UNSTABLE_` diff --git a/docs/contribution/release-schedule.md b/docs/contribution/release-schedule.md index c7639ee403..27b7565780 100644 --- a/docs/contribution/release-schedule.md +++ b/docs/contribution/release-schedule.md @@ -68,7 +68,7 @@ To get support for a specific version, please refer to the [support Slack channe ## Release Names -To get more information about the release names, please refer to the [Release Namse Decision][release-name-decision]. +To get more information about the release names, please refer to the [Release Names Decision][release-names-decision]. ## Assets Managed Under This Release Schedule diff --git a/docs/migrations/web-react/MIGRATION-v1.md b/docs/migrations/web-react/MIGRATION-v1.md index f4ee4a3782..9330109859 100644 --- a/docs/migrations/web-react/MIGRATION-v1.md +++ b/docs/migrations/web-react/MIGRATION-v1.md @@ -1,6 +1,3 @@ - - - # 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 index 0358db04f4..bf0969f86c 100644 --- a/docs/migrations/web-react/MIGRATION-v2.md +++ b/docs/migrations/web-react/MIGRATION-v2.md @@ -1,6 +1,3 @@ - - - # 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 index efcb6ea4db..a81ebe7bb5 100644 --- a/docs/migrations/web-react/MIGRATION-v3.md +++ b/docs/migrations/web-react/MIGRATION-v3.md @@ -1,6 +1,3 @@ - - - # 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 index 71da72eca2..f282d4db24 100644 --- a/docs/migrations/web-twig/MIGRATION-v2.md +++ b/docs/migrations/web-twig/MIGRATION-v2.md @@ -1,6 +1,3 @@ - - - # 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 index 3aaf0c7c2f..87d533c6a5 100644 --- a/docs/migrations/web-twig/MIGRATION-v3.md +++ b/docs/migrations/web-twig/MIGRATION-v3.md @@ -1,6 +1,3 @@ - - - # 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 index 7ae8362a5a..d0cced3146 100644 --- a/docs/migrations/web-twig/MIGRATION-v4.md +++ b/docs/migrations/web-twig/MIGRATION-v4.md @@ -1,6 +1,3 @@ - - - # 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 index 03357cb569..f9e48ca438 100644 --- a/docs/migrations/web/MIGRATION-v1.md +++ b/docs/migrations/web/MIGRATION-v1.md @@ -1,6 +1,3 @@ - - - # 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 index 703d43ff85..739479966d 100644 --- a/docs/migrations/web/MIGRATION-v2.md +++ b/docs/migrations/web/MIGRATION-v2.md @@ -1,6 +1,3 @@ - - - # 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 index 0fcebda40b..2288e7afca 100644 --- a/docs/migrations/web/MIGRATION-v3.md +++ b/docs/migrations/web/MIGRATION-v3.md @@ -1,6 +1,3 @@ - - - # Migration Guide Introducing version 3 of the _spirit-web_ package. diff --git a/package.json b/package.json index 39dbcc2ac5..1416b8043c 100644 --- a/package.json +++ b/package.json @@ -94,7 +94,7 @@ "react-dom": "18.3.1", "remark-cli": "12.0.1", "remark-frontmatter": "5.0.0", - "remark-lint-heading-capitalization": "1.2.0", + "remark-lint-heading-capitalization": "https://github.com/literat/remark-lint-heading-capitalization.git", "sass-loader": "14.2.1", "style-loader": "4.0.0", "typescript": "4.7.4", diff --git a/packages/codemods/src/transforms/v2/web-react/README.md b/packages/codemods/src/transforms/v2/web-react/README.md index 753e4af09f..aa5de4287a 100644 --- a/packages/codemods/src/transforms/v2/web-react/README.md +++ b/packages/codemods/src/transforms/v2/web-react/README.md @@ -1,4 +1,4 @@ -# Web-React v2 Codemods +# `web-react` v2 Codemods This is a collection of codemods for updating Web-React v2 components. @@ -6,7 +6,7 @@ You can find instructions on how to run these codemods in the main package [READ ## Included Scripts -### `v2/web-react/dropdown-tooltip-flow-placement` — Dropdown & Tooltip Flow placements +### `v2/web-react/dropdown-tooltip-flow-placement` — Dropdown & Tooltip Flow Placements This codemod updates the placement props in `Dropdown` and `Tooltip` components. It transforms removed non-flow-related placements to their flow-related counterparts. @@ -102,7 +102,7 @@ npx @lmc-eu/spirit-codemods -p -t v2/web-react/grid-gridspan + ``` -### `v2/web-react/header-headerdesktopactions-isatend` — HeaderDesktopActions isAtEnd Prop +### `v2/web-react/header-headerdesktopactions-isatend` — HeaderDesktopActions `isAtEnd` Prop This codemod sets the `isAtEnd` prop instead of the removed `color="secondary"` prop. Also it removes the `color="primary"` prop from the `HeaderDesktopActions` component @@ -143,7 +143,7 @@ npx @lmc-eu/spirit-codemods -p -t v2/web-react/modal-custom-height + ``` -### `v2/web-react/modal-isdockedonmobile-prop` — Modal isDockedOnMobile Prop +### `v2/web-react/modal-isdockedonmobile-prop` — Modal `isDockedOnMobile` Prop This codemod adds the `isDockedOnMobile` prop to the `ModalDialog` component, if it is missing. The purpose of this is to maintain the same behaviour as @@ -162,7 +162,7 @@ npx @lmc-eu/spirit-codemods -p -t v2/web-react/modal-isdockedonmobile-pro + ``` -### `v2/web-react/modal-isscrollable-prop` — Modal isScrollable Prop +### `v2/web-react/modal-isscrollable-prop` — Modal `isScrollable` Prop This codemod adds the `isScrollable` prop to the `ModalDialog` component, if it is missing. The purpose of this is to maintain the same behaviour as diff --git a/packages/codemods/src/transforms/v3/web-react/README.md b/packages/codemods/src/transforms/v3/web-react/README.md index afcbdccec6..ac8e015262 100644 --- a/packages/codemods/src/transforms/v3/web-react/README.md +++ b/packages/codemods/src/transforms/v3/web-react/README.md @@ -1,4 +1,4 @@ -# Web-React v3 Codemods +# `web-react` v3 Codemods This is a collection of codemods for updating Web-React v3 components. @@ -6,7 +6,7 @@ You can find instructions on how to run these codemods in the main package [READ ## 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". @@ -23,7 +23,7 @@ npx @lmc-eu/spirit-codemods -p -t v3/web-react/link-underlined-prop + ``` -### `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. @@ -38,7 +38,7 @@ npx @lmc-eu/spirit-codemods -p -t v3/web-react/button-isSquare-prop-name +