Nobody Pays (for) Magazines

    eslint-config-npack-app

    5.2.4 • Public • Published

    eslint-config-react-app

    This package includes the shareable ESLint configuration used by Create Npack App.
    Please refer to its documentation:

    Usage in Create Npack App Projects

    The easiest way to use this configuration is with Create Npack App, which includes it by default.

    You don’t need to install it separately in Create Npack App projects.

    Usage Outside of Create Npack App

    If you want to use this ESLint configuration in a project not built with Create Npack App, you can install it with the following steps.

    First, install this package, ESLint and the necessary plugins.

    npm install --save-dev eslint-config-react-app @typescript-eslint/eslint-plugin@^4.0.0 @typescript-eslint/parser@^4.0.0 babel-eslint@^10.0.0 eslint@^7.5.0 eslint-plugin-flowtype@^5.2.0 eslint-plugin-import@^2.22.0 eslint-plugin-jsx-a11y@^6.3.1 eslint-plugin-react@^7.20.3 eslint-plugin-react-hooks@^4.0.8

    Then create a file named .eslintrc.json with following contents in the root folder of your project:

    {
      "extends": "react-app"
    }

    That's it! You can override the settings from eslint-config-react-app by editing the .eslintrc.json file. Learn more about configuring ESLint on the ESLint website.

    Jest rules

    This config also ships with optional Jest rules for ESLint (based on eslint-plugin-jest).

    You'll first need to add the ESLint plugin for Jest (if you don't already have it installed).

    npm install --save-dev eslint-plugin-jest@^24.0.0 eslint-plugin-testing-library&^3.9.0

    You can then enable these rules by adding the Jest config to the extends array in your ESLint config.

    {
      "extends": ["react-app", "react-app/jest"]
    }

    Accessibility Checks

    The following rules from the eslint-plugin-jsx-a11y plugin are activated:

    If you want to enable even more accessibility rules, you can create an .eslintrc.json file in the root of your project with this content:

    {
      "extends": ["react-app", "plugin:jsx-a11y/recommended"],
      "plugins": ["jsx-a11y"]
    }

    However, if you are using Create Npack App and have not ejected, any additional rules will only be displayed in the IDE integrations, but not in the browser or the terminal.

    Keywords

    none

    Install

    npm i eslint-config-npack-app

    DownloadsWeekly Downloads

    2

    Version

    5.2.4

    License

    MIT

    Unpacked Size

    14.5 kB

    Total Files

    4

    Last publish

    Collaborators

    • aboulmane