eslint-config-pixelmatters

An ESLint config standard for Pixelmatters projects

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

Get Up and Running

You can install this package using either npm or yarn.

Yarn

If using Yarn:

1. Install the package as a development dependency:

yarn add @pixelmatters/eslint-config-pixelmatters --dev

1. Add all the missing peer dependencies:

yarn add @typescript-eslint/eslint-plugin eslint-plugin-prettier --dev

(This config assumes you have ESLint, Typescript and Prettier already installed; if not, run the following code: )

yarn add typescript eslint prettier --dev

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

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

NPM

If using NPM:

1. Install the package as a development dependency:

npm install @pixelmatters/eslint-config-pixelmatters --save-dev

1. Add all the missing peer dependencies:

npm install @typescript-eslint/eslint-plugin eslint-plugin-prettier --save-dev

(This config assumes you have ESLint, Typescript and Prettier already installed; if not, run the following code: )

npm install typescript eslint prettier --save-dev

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

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

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.