Skip to content
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.

Sign up for GitHub

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

Jump to bottom

README suggestions #109

Closed
brettz9 opened this issue Oct 31, 2018 · 1 comment
Closed

README suggestions #109

brettz9 opened this issue Oct 31, 2018 · 1 comment
Labels
accepted documentation

Comments

@brettz9
Copy link
Contributor

brettz9 commented Oct 31, 2018 •
edited

This tool is really awesome! (Now I just need to get linting of JS examples within JSDoc comments...)

While you mention overrides on the README, this is a cool feature in the context of avoiding or minimizing priority of rules like "no-undef" or "no-unused-vars" given how code blocks often lack full context, and also of the idea of being more tolerant or strict with styling rules like "padded-blocks". I'd suggest having a separate section for this very helpful accompanying feature.

Although it is for a different tool, it might also be worth mentioning the benefit of adding "source.gfm" to "List of scopes to run ESLint on..." setting if using with Atom linter-eslint (or also "source.embedded.js" though configuration comments and skip directives don't seem to work there), no less given that your screenshot highlights IDE use...
@btmills
Copy link
Member

btmills commented Nov 6, 2018

Thanks @brettz9 - these are great suggestions! If you're interested in submitting a pull request, I'd be happy to get these into the docs 💯

brettz9 added a commit to brettz9/eslint-plugin-markdown that referenced this issue Nov 6, 2018
@brettz9
Fixes eslint#109
85d09fa 
- Docs: Mention general applicability of `overrides` (and put the `strict` discussion as a subsection)
- Docs: Add tips for working with Atom linter-eslint
@brettz9 brettz9 mentioned this issue Nov 6, 2018
Merged
brettz9 added a commit to brettz9/eslint-plugin-markdown that referenced this issue Nov 6, 2018
@brettz9
Fix: overrides general docs and Atom linter-eslint tips (fixes esli…
88aad11 
…nt#109)

- Docs: Mention general applicability of `overrides` (and put the `strict` discussion as a subsection)
- Docs: Add tips for working with Atom linter-eslint
brettz9 added a commit to brettz9/eslint-plugin-markdown that referenced this issue Nov 6, 2018
@brettz9
Fix: overrides general docs and Atom linter-eslint tips (fixes esli…
9e8ebb6 
…nt#109)

- Docs: Mention general applicability of `overrides` (and put the `strict` discussion as a subsection)
- Docs: Add tips for working with Atom linter-eslint
brettz9 added a commit to brettz9/eslint-plugin-markdown that referenced this issue Nov 6, 2018
@brettz9
Fix: overrides general docs and Atom linter-eslint tips (fixes esli…
a167385 
…nt#109)

- Docs: Mention general applicability of `overrides` (and put the `strict` discussion as a subsection)
- Docs: Add tips for working with Atom linter-eslint
btmills pushed a commit that referenced this issue Nov 9, 2018
@brettz9 @btmills
Fix: overrides general docs and Atom linter-eslint tips (fixes #109) (
2a8482e 
#111)

- Docs: Mention general applicability of `overrides` (and put the `strict` discussion as a subsection)
- Docs: Add tips for working with Atom linter-eslint
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
accepted documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@brettz9 @btmills