README.md

eslint-config-react

An ESLint config standard for Pixelmatters projects that use React.

This is a ESLint config that you can use in your projects.

🚀 Get Up and Running

You can install this package using the package manger of your choice.

This package requires you to add some missing peer dependencies:

• esLint
• prettier
• typescript
• @typescript-eslint/eslint-plugin
• eslint-plugin-prettier

Add the new dependencies

If you are using pnpm:

pnpm install -D @pixelmatters/eslint-config-react @typescript-eslint/eslint-plugin eslint-plugin-prettier typescript eslint prettier

If you are using yarn:

yarn add -D @pixelmatters/eslint-config-react @typescript-eslint/eslint-plugin eslint-plugin-prettier typescript eslint prettier

If you are using npm:

npm install --save-dev @pixelmatters/eslint-config-react @typescript-eslint/eslint-plugin eslint-plugin-prettier typescript eslint prettier

Tell ESLint to use this config

Create an .eslintrc.js file in the root of your project and add the following code:

module.exports = {
  extends: ['@pixelmatters/eslint-config-react'],
};

At this point you should be good to go 👍

🤝 How to Contribute

Whether you're helping us fix bugs, improve the docs, or spread the word, thank you! 💪 🧡

Check out our Contributing Guide for ideas on contributing and setup steps.

📝 License

Licensed under the MIT License.