@sweetlikepete/eslint-config

This package provides a shared config for eslint and several of its plugins.

Optionally, it also includes support for eslinting typescript.

Usage

A single ESLint configuration is exported.

Our default export contains all of our ESLint rules, including ECMAScript 6+ and several plugins. It requires the following peer dependencies:

    @typescript-eslint/eslint-plugin
    @typescript-eslint/parser
    eslint
    eslint-plugin-array-func
    eslint-plugin-async-await
    eslint-plugin-compat
    eslint-plugin-css-modules
    eslint-plugin-es
    eslint-plugin-eslint-comments
    eslint-plugin-filenames
    eslint-plugin-format-message
    eslint-plugin-import
    eslint-plugin-jsx-control-statements
    eslint-plugin-lean-imports
    eslint-plugin-more
    eslint-plugin-no-loops
    eslint-plugin-no-unsanitized
    eslint-plugin-no-useless-assign
    eslint-plugin-node
    eslint-plugin-optimize-regex
    eslint-plugin-prefer-object-spread
    eslint-plugin-promise
    eslint-plugin-react
    eslint-plugin-react-filenames
    eslint-plugin-react-hooks
    eslint-plugin-react-native
    eslint-plugin-react-perf
    eslint-plugin-react-redux
    eslint-plugin-react-ssr
    eslint-plugin-security
    eslint-plugin-sort-keys-fix
    eslint-plugin-unicorn
    eslint-plugin-webassembly
    eslint-plugin-you-dont-need-lodash-underscore
    eslint-plugin-you-dont-need-momentjs
    typescript

Installation

1. Install the shared configuration:

yarn add --dev @sweetlikepete/eslint-config

2. Install the shared configuration peer dependencies (npm 5+):

npx install-peerdeps --dev @sweetlikepete/eslint-config

3. Add this to your .eslintrc.

  "extends": "@sweetlikepete"

4. If you want to lint typescript, add this to your .eslintrc instead.

  "extends": "@sweetlikepete/eslint-config/lib/configs/typescript"

Maintenance

You can run tests with npm test.

You can make sure this module lints with itself using npm run lint.