The Unicorns ESLint Shareable Config

An ESLint Shareable Config for Javascript based projects

Installation

Use the package manager npm or yarn to install it.

This project includes 2 packages:

• @the-unicorns/eslint-config-base: Contains the basic ESLint shareable config, for projects not using React.
• @the-unicorns/eslint-config-react: Extends the base configuration and includes some React rules. For projects using React.

Peer Dependencies

Check each peer dependecy for each package:

• @the-unicorns/eslint-config-base
• @the-unicorns/eslint-config-react

yarn add -D @the-unicorns/eslint-config-base
yarn add -D @the-unicorns/eslint-config-react

Usage

Once the @the-unicorns/eslint-config-* package is installed, you can use it by specifying @the-unicorns/eslint-config-* in the extends section of your ESLint configuration.

{
  "extends": "@the-unicorns/eslint-config-base",
  "rules": {
    // Additional, per-project rules...
  }
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Contributors

• View Contributors

License

MIT