1.0.2 โข Published 3 years ago
@pixelmatters/eslint-config-pixelmatters v1.0.2
๐ Get Up and Running
You can install this package using either npm or yarn.
Yarn
If using Yarn:
- Install the package as a development dependency:
yarn add @pixelmatters/eslint-config-pixelmatters --dev
- 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
- 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:
- Install the package as a development dependency:
npm install @pixelmatters/eslint-config-pixelmatters --save-dev
- 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
- 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.
:memo: License
Licensed under the MIT License.