check-examples rule
#119
Merged
check-examples rule
#119
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
|
Looks good. Can you please contribute the documentation for this rule? |
brettz9
force-pushed
the
checkExamples
branch
2 times, most recently
from
b4066aa to
4dceaeb
Compare
|
I've made one small change in my amendment (in addition to the document additions) to ensure |
…gajus#101); with settings to: 1. require JSDoc-spec'd `<caption>` at beginning of `@example` 2. regex settings to whitelist and blacklist lintable examples 3. setting for a dummy file name to trigger specific rules defined in one's config; usable with ESLint `overrides`->`files` globs, to apply a desired subset of rules with `@example` (besides allowing for rules specific to examples, can be useful for using same rules within `@example` as with JavaScript Markdown lintable by other plugins) 4. Other settings for specifying config (base config object or an `.eslintrc` config file; checks normal `.eslintrc` by default unless `eslintrcForExamples` setting is set to `false`) 5. Provides some defaults for suppressing reporting of rules which are likely to be troublesome in example files unless `noDefaultExampleRules` setting is `true` - Report column (for checkExamples and any that report it)
brettz9
force-pushed
the
checkExamples
branch
from
4dceaeb to
90e5a48
Compare
|
🎉 This PR is included in version 3.13.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This was referenced Mar 14, 2020
Closed
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.
check-examplesrule to lint JavaScript within@example(fixes Full ESLint on JavaScript within @example #101);with settings to:
<caption>at beginning of@exampleconfig; usable with ESLint
overrides->filesglobs, to apply a desiredsubset of rules with
@example(besides allowing for rules specific toexamples, can be useful for using same rules within
@exampleaswith JavaScript Markdown lintable by other plugins)
.eslintrcconfig file; checks normal
.eslintrcby default unlesseslintrcForExamplessetting is set tofalse)likely to be troublesome in example files unless
noDefaultExampleRulessetting istrueRegarding your comment about being open to a PR but the need being esoteric, in my opinion, this could actually be the single most important doc item to lint for, in order to ensure the examples indicated for users of the library do not have inadvertent bugs.
Thanks!