Nanotechnology Promises Much

    @vmo11/eslint-config-vmo

    2.0.0 • Public • Published

    ESLint + Prettier Config

    Airbnb's ESLint config with TypeScript support

    Overview

    Installation

    To install the package, run:

    $ yarn add -D @vmo11/eslint-config-vmo
    $ npx install-peerdeps -D @vmo11/eslint-config-vmo

    or

    $ npm install -D @vmo11/eslint-config-vmo
    $ npx install-peerdeps -D @vmo11/eslint-config-vmo

    Included:

    • @typescript-eslint/eslint-plugin
    • eslint-config-airbnb-typescript
    • eslint-config-prettier
    • eslint-plugin-import
    • eslint-plugin-jest
    • eslint-plugin-jsx-a11y
    • eslint-plugin-prettier
    • eslint-plugin-react
    • eslint-plugin-react-hooks
    • eslint-plugin-simple-import-sort
    • eslint-plugin-testing-library
    • eslint
    • prettier

    Usage

    // .eslintrc
    {
      "extends": ["@vmo11/eslint-config-vmo"]
    }

    Without React

    // .eslintrc
    {
      "extends": ["@vmo11/eslint-config-vmo/base"]
    }

    With Jest

    // .eslintrc
    {
      "extends": ["@vmo11/eslint-config-vmo", "@vmo11/eslint-config-vmo/jest"]
    }

    Just javascript

    // .eslintrc
    {
      "extends": ["@vmo11/eslint-config-vmo/base-js"]
    }
    // .eslintrc
    {
      "extends": ["@vmo11/eslint-config-vmo/react-js"]
    }

    Prettier

    This config supports Prettier integration out of the box. Rules that may conflict with ESLint are disabled via recommended configuration in eslint-plugin-prettier.

    If you wish to override any Prettier options, you can do so by specifying them under prettier/prettier rule in your ESLint config file. For example:

    // .eslintrc
    {
      "extends": "@vmo11/eslint-config-vmo",
      "rules": {
        "prettier/prettier": [
          "error",
          {
            "printWidth": 110
          }
        ]
      }
    }

    Make sure that these rules match the options specified in your .prettierrc file.

    Adding Scripts

    Add the following to your package.json file to define a script that will lint all known files and output the results:

    "scripts": {
      // ..
      "lint": "eslint --ignore-path .gitignore ."
      // ..
    }

    To fix all automatically-fixable issues, you can add the following script to your package.json as well (in addition to above):

    "scripts": {
      // ..
      "lint:fix": "eslint --ignore-path .gitignore --fix ."
      // ..
    }

    Note that you can update the above scripts as you see fit, this is just an example. See ESLint CLI reference for more details.

    Install

    npm i @vmo11/eslint-config-vmo

    DownloadsWeekly Downloads

    2

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    10.5 kB

    Total Files

    11

    Last publish

    Collaborators

    • huyhavmodev