Skip to content

README suggestions #109

@brettz9

Description

@brettz9

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...

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions