-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs(eslint-plugin): [explicit-module-boundary-types] fix doc & code examples #3058
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Thanks for the PR, @MrChocolatine! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks!
you'll need to format the docs appropriately using prettier
@bradzacher Yes I just saw that. I made the change on GitHub directly but I will run Prettier as soon as I can run it on my laptop. However I am surprised, I thought I kept the current code style... We will see. |
Probably just needs a new line somewhere. Easiest way to fix it without checking out is to copy paste the file into the prettier demo on their website (just gotta make sure the settings match our config) |
@bradzacher prettier executed ✅ . export const foo = () =>
({
bar: true,
} as const); vs export const foo = () => (
{
bar: true,
} as const
); |
Codecov Report
@@ Coverage Diff @@
## master #3058 +/- ##
==========================================
+ Coverage 92.65% 92.69% +0.03%
==========================================
Files 314 314
Lines 10675 10675
Branches 3027 3027
==========================================
+ Hits 9891 9895 +4
+ Misses 362 358 -4
Partials 422 422
Flags with carried forward coverage won't be shown. Click here to find out more.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah that's an issue they've recently fixed but haven't yet released.
prettier/prettier#8840
For each option of the rule, the sentences
Examples of incorrect/correct code for this rule with ...
were wrong when the option's value had to befalse
.Slight simplification of a few code examples, less confusing.
Fix and homogenise code examples.