Neoanthropic Preternatural Murmurings

    eslint-config-zenflow

    3.0.0 • Public • Published

    eslint-config-zenflow

    A good eslint configuration

    npm version CI status dependencies status devDependencies status Code Climate maintainability LGTM alerts Known Vulnerabilities

    Features

    Install

    Install packages:

    npm install --save-dev eslint eslint-config-zenflow
    
    # optional
    npm install --save-dev typescript

    Add .eslintrc file:

    {
      "extends": ["zenflow"],
      "rules": { /* custom rule configs here */ }
    }

    Add package "scripts":

    "lint": "eslint . --ext .js,.ts,.jsx,.tsx",
    "lint-fix": "npm run lint -- --fix",
    

    Optional Configure Prettier to your taste.

    Optional Copy the companion .editorconfig file to the root of your project.

    Recommended Enable eslint integration in your IDE of choice

    How Plugins Are Bundled

    Because of the way eslint resolves plugin modules, its documentation tells us that a shareable config should include its plugin dependencies in "peerDependencies", meaning users of the config need to install and depend on each plugin package themselves. Parsers work the same way. This is the essence of eslint issue #3458.

    For the sake of convenience, here we are ignoring that instruction, instead including plugins and parsers as regular "dependencies", and relying on the project to not have any additional versions of these packages installed. This should normally not be a problem, since you should only ever really need one version of eslint-plugin-whatever. If you have (for some reason) an alternate version as a dependency of a dependency, eslint will fail to resolve the module to either version. That error can be easily corrected by adding the plugin or parser package as a direct dependency with the version matching the version used by this package.

    Keywords

    none

    Install

    npm i eslint-config-zenflow

    DownloadsWeekly Downloads

    2

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    9.41 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar