Nostradamus Predicting Maelstroms

    @mink-agency/eslint-config

    1.5.1 • Public • Published

    eslint-config

    Build Status

    Quick start

    1. Install the following dev-dependencies:

      yarn add -D \
        @mink-agency/eslint-config \
        eslint \
        eslint-plugin-node
      
    2. Extend the @mink-agency/eslint-config config in your .eslintrc (or eslintConfig key in your package.json):

      "eslintConfig": {
        "extends": "@mink-agency/eslint-config"
      }
    3. Specify the version of Node.js your project uses by setting .engines.node in your package.json.

      "engines": {
        "node": ">=8"
      }
    4. Run eslint on your project as part of your lint:js scripts:

      "scripts": {
        "lint:js": "yarn run eslint --cache --ext .js --ignore-path .gitignore ./resources/",
      }

    Usage

    The "Quick start" above exemplifies usage of this package with standard Node.js code.

    Depending on the ECMAScript version of your code, whether you are using non-standard syntax like Flow and React's JSX, or other considerations, you may want to extend a variety of configurations provided by this package. @mink-agency/eslint-config exposes several configurations targeting specific ESLint plugins, each named after the plugin it targets.

    To use each plugin-specific configuration, you'll need to do the following:

    • Install as dev-dependencies @mink-agency/eslint-config, eslint, and any plugins that are used by the configuration(s) you are extending, such as @mink-agency/eslint-plugin-node or @mink-agency/eslint-plugin-promise.

    • Add the configuration(s) you are using to the "extends" array in your project's ESLint configuration, like this:

      {
        "extends": [
          "@mink-agency/eslint-config/import",
          "@mink-agency/eslint-config/promise"
        ]
      }

    Plugin-specific configurations

    With Prettier

    If you are using Prettier to format your JS, install eslint-config-prettier and add it at the end of your "extends" array. It will turn off all ESLint rules related to the code-style preferences that Prettier already addresses.

    Install

    npm i @mink-agency/eslint-config

    DownloadsWeekly Downloads

    2

    Version

    1.5.1

    License

    BSD-2-Clause

    Unpacked Size

    12.9 kB

    Total Files

    20

    Last publish

    Collaborators

    • kevindesousa
    • benjamin-3-mink
    • benjaminmink
    • minkagency