fix(documentation): Styles docs has MDX p #2128
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
imagoiq
requested review from
b1aserlu,
davidritter-dotcom and
a team
as code owners
|
|
Kudos, SonarCloud Quality Gate passed!
|
|
Preview environment ready: https://preview-2128--swisspost-design-system-next.netlify.app |
imagoiq
added a commit
that referenced
this pull request
Oct 31, 2023
### What
Commit essential linting and formatting config from our favourite IDE to
the repository. The aim is to have the same config across the team and
across IDE so we avoid dealing with changes that shouldn't be part of
our PR.
* Add config for Intellij and vscode
- Remove gitignore on .idea config
- Disable prettier on MDX files
- Use LF as default line separator
- Enable format on save
* Run `prettier --write
"**/*.{**/*,*}.{js,ts,jsx,tsx,scss,css,html,json}"`
* Remove prettier-ignore in mdx files
About MDX:
Disable formatting totally, as the maximum printWidth rule conflicts
with MDX syntax about new line = `<p>`.
Latest issue that we had:
#2128 . Issue on Prettier
repository: prettier/prettier#12209
If this wouldn't be enough, the second option is to ensure that our
files are checked before committed with a git hook:
https://github.com/lint-staged/lint-staged
For review: you can do it commit by commit.
---------
Co-authored-by: Philipp Gfeller <1659006+gfellerph@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix bug introduced with #1952