https://github.com/pixelmatters/eslint-config-pixelmatters

ESLint rules for all Pixelmatters projects
https://github.com/pixelmatters/eslint-config-pixelmatters

eslint npm

Last synced: about 1 month ago
JSON representation

ESLint rules for all Pixelmatters projects

• Host: GitHub
• URL: https://github.com/pixelmatters/eslint-config-pixelmatters
• Owner: Pixelmatters
• License: mit
• Created: 2020-05-05T13:48:12.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-04T16:03:05.000Z (11 months ago)
• Last Synced: 2024-12-10T01:29:16.244Z (about 1 month ago)
• Topics: eslint, npm
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@pixelmatters/eslint-config-pixelmatters
• Size: 227 KB
• Stars: 2
• Watchers: 19
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    





    





  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 your favorite package manager. This configuration assumes that you have **ESLint**, **Typescript** and **Prettier** already installed; if not, install the following additional dependencies.

```text

typescript eslint prettier

```

### Add the new dependencies

**If you are using pnpm:**

```shell

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

```

**If you are using yarn:**

```shell

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

```

**If you are using npm:**

```shell

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

```

### Tell ESLint to use this config

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

``` js

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**](https://github.com/Pixelmatters/eslint-config-pixelmatters/blob/main/CONTRIBUTING.md) for ideas on contributing and setup steps.

## :memo: License

Licensed under the [MIT License](./LICENSE).