# @pixelmatters/eslint-config-pixelmatters

> Eslint config for usage in Pixelmatters projects

Latest version **1.0.2** (published 2021-03-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @pixelmatters/eslint-config-pixelmatters
pnpm add @pixelmatters/eslint-config-pixelmatters
yarn add @pixelmatters/eslint-config-pixelmatters
bun add @pixelmatters/eslint-config-pixelmatters
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-03-25 |
| First published | 2020-08-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Pixelmatters |
| Maintainers | pixelmatters-dev, gil0mendes |
| Keywords | eslint-config, eslint |

## Links

- npm: https://www.npmjs.com/package/@pixelmatters/eslint-config-pixelmatters
- Repository: https://github.com/Pixelmatters/eslint-config-pixelmatters
- Homepage: https://github.com/Pixelmatters/eslint-config-pixelmatters#readme
- Issues: https://github.com/Pixelmatters/eslint-config-pixelmatters/issues
- npm.io page: https://npm.io/package/@pixelmatters/eslint-config-pixelmatters

## Dependencies (2)

- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) >= 6.10.0
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) >= 2.31.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2021-03-25
- 1.0.1 — 2021-02-08
- 1.0.0 — 2020-08-19
- 1.0.3 — 2020-08-18

## README

<h1 align="center">
  eslint-config-pixelmatters
</h1>

<h3 align="center">
  An ESLint config standard for Pixelmatters projects
</h3>

<p align="center">
This is a ESLint config that you can use in your projects.
</p>

<p align="center">
  <a href="https://github.com/Pixelmatters/eslint-config-pixelmatters/blob/master/LICENSE">
    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="eslint-config-pixelmatters is released under the MIT license." />
  </a>
  <a href="https://www.npmjs.com/package/@pixelmatters/eslint-config-pixelmatters">
    <img src="https://img.shields.io/npm/v/@pixelmatters/eslint-config-pixelmatters.svg" alt="Current npm package version." />
  </a>
  <a href="https://github.com/Pixelmatters/eslint-config-pixelmatters/blob/master/CONTRIBUTING.md">
    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
  </a>
  <a href="https://twitter.com/intent/follow?screen_name=pixelmatters_">
    <img src="https://img.shields.io/twitter/follow/pixelmatters_.svg?label=Follow%20@pixelmatters_" alt="Follow @pixelmatters_" />
  </a>
</p>

## 🚀 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:

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

2. Add all the missing peer dependencies:

```shell
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: )

``` shell
yarn add typescript eslint prettier --dev
```

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

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

### **NPM**

If using NPM:

1. Install the package as a development dependency:

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

2. Add all the missing peer dependencies:

```shell
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: )

``` shell
npm install typescript eslint prettier --save-dev
```

3. 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/master/CONTRIBUTING.md) for ideas on contributing and setup steps.

## :memo: License

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

---
_Source: https://npm.io/package/@pixelmatters/eslint-config-pixelmatters · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._