feat(docs): add linting #2716
Merged
feat(docs): add linting #2716
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
CollierCZ
force-pushed
the
docs/linting
branch
from
b64c517 to
fe1959e
Compare
silvenon
suggested changes
Feb 4, 2021
silvenon
reviewed
Feb 4, 2021
CollierCZ
force-pushed
the
docs/linting
branch
4 times, most recently
from
924fdf4 to
fed8689
Compare
|
Size Change: 0 B Total Size: 476 kB ℹ️ View Unchanged
|
CollierCZ
force-pushed
the
docs/linting
branch
5 times, most recently
from
9a15c6c to
c6e6b8a
Compare
silvenon
suggested changes
Feb 15, 2021
docs/src/documentation/05-development/01-guides/04-no-exporting-components.mdx
Outdated
Show resolved
Hide resolved
.../documentation/06-kiwi-use/02-content/04-specific-areas/social-media/02-visual-treatment.mdx
Outdated
Show resolved
Hide resolved
.../documentation/06-kiwi-use/02-content/04-specific-areas/social-media/02-visual-treatment.mdx
Outdated
Show resolved
Hide resolved
...src/documentation/06-kiwi-use/02-content/04-specific-areas/technical-content/04-language.mdx
Outdated
Show resolved
Hide resolved
CollierCZ
force-pushed
the
docs/linting
branch
from
c6e6b8a to
8622443
Compare
CollierCZ
force-pushed
the
docs/linting
branch
2 times, most recently
from
a129de8 to
b549b21
Compare
CollierCZ
force-pushed
the
docs/linting
branch
from
b549b21 to
cbd2c03
Compare
silvenon
approved these changes
Feb 16, 2021
JounQin
reviewed
Feb 21, 2021
| extends: ["plugin:mdx/recommended"], | ||
| rules: { | ||
| "react/jsx-filename-extension": ["error", { extensions: [".mdx"] }], | ||
| "mdx/no-unescaped-entities": "OFF", |
There was a problem hiding this comment.
Hi, I’m the author of eslint-mdx, so glad that you’re using it.
Just to confirm, is there any problem with this rule or you’d just want to ignore it?
There was a problem hiding this comment.
Hi! Thanks so much for having a look at our configuration. When the rule is turned off, I get a lot of warnings about apostrophes and the like being able to be escaped. I don't want to escape things in markdown.
These cases are markdown inside components (example). I turned it off to get only relevant warnings.
There was a problem hiding this comment.
That's interesting, I thought mdx as jsx more than md, but users like you may think oppositely. So I'm considering disable it by default in the recommended config.
There was a problem hiding this comment.
I don't want to speak for others, but in my case I definitely think of it as md with extra features. But I'm a writer first and a programmer second.
JounQin
reviewed
Feb 21, 2021
| ], | ||
| }, | ||
| settings: { | ||
| "import/resolver": { |
There was a problem hiding this comment.
eslint-import-resolver-typescript should be preferred for ts files.
There was a problem hiding this comment.
I agree even our *.ts?(x) files don't seem to have the resolver set up, I can't remember what was the problem I ran into… 🤔
JounQin
reviewed
Feb 21, 2021
| @@ -3,6 +3,10 @@ | |||
| module.exports = { | |||
| "*.{js,js.flow,ts}": "eslint --fix --report-unused-disable-directives", | |||
| "*.md": "prettier --write", | |||
| "*.mdx": [ | |||
There was a problem hiding this comment.
First of all, you're awesome for reviewing this PR. ❤️
What do you mean by this, though? We use Prettier through ESLint, so it*.mdx doesn't need to be prettified additionally, unlike *.md files which only use Prettier.
There was a problem hiding this comment.
Why remark-lint related rules are not enabled for .md files?
There was a problem hiding this comment.
That's just a temporary thing, probably. We were focusing on the new docs that we're adding, which are all .mdx. We can then go over the older docs we have and see how the rules and everything works. Didn't want to fix a bunch of errors without knowing if we liked the workflow. 🙂
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.
Added linting of markdown code, prose, and links.
Some notes:
Orbit.kiwi: https://orbit-docs-docs-linting.surge.sh
Storybook: https://orbit-docs-linting.surge.sh