Table of Contents

• 🚦 Current Status
• 🖐 Installation
• 🚚 Tests Installation
• ✨ Usage
• Contributing
• License

🚦 Current Status

This package is currently under development and should be consider ALPHA in terms of state. I/We are currently accepting contributions and/or dedicated contributors to help develop and maintain this package.

For more information on contributing please see the contrib message below.

✨ Installation

1. Add plugin dependency

yarn add -D eslint @strapi-community/eslint-config

2. Add .eslintrc in the root of your project

{
  "extends": "@strapi-community"
}

Work in both strapi plugins and strapi app.

🖐 Tests Installation

1. Add plugin dependency

yarn add -D eslint @strapi-community/eslint-config-tests

2. Add .eslintrc in the tests directory

{
  "extends": "@strapi-community/tests"
}

✨ Usage

1. Add eslint script in the package.json file

{
  "scripts": {
    "eslint": "eslint ."
  }
}

2. Run yarn eslint

Contributing

I/We are actively looking for contributors, maintainers, and others to help shape this package. As this plugins sole purpose within the Strapi community is to be used by other developers and plugin maintainers to get fast responses time.

If interested please feel free to email the lead maintainer Sacha at: [email protected] or ping stf#3254 on Discord.

License

See the LICENSE file for licensing information.