# @engrave/eslint-config-engrave

> Common eslint and prettier configuration for @engrave projects

Latest version **1.0.0** (published 2023-09-14) · MIT license · 0 weekly downloads

## Install

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

## 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.0 |
| Published | 2023-09-14 |
| First published | 2023-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Bartłomiej @engrave Górnicki |
| Maintainers | bgornicki |
| Keywords | eslint, eslintconfig, engrave, linter, config, prettier |

## Links

- npm: https://www.npmjs.com/package/@engrave/eslint-config-engrave
- npm.io page: https://npm.io/package/@engrave/eslint-config-engrave

## Dependencies (7)

- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) 2.28.1
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) 9.0.0
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) 5.0.0
- [eslint-plugin-security](https://npm.io/package/eslint-plugin-security.md) 1.7.1
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) 6.7.0
- [eslint-plugin-no-only-tests](https://npm.io/package/eslint-plugin-no-only-tests.md) 3.1.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) 6.7.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
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-09-14

## README

# @engrave/eslint-config-engrave

Common ESLint config for Engrave projects. This config is based on Airbnb's config with some modifications to fit our needs. It also includes Prettier rules to ensure code style consistency.

## Installation

Install the package together with eslint and prettier:

```bash
npm install --save-dev @engrave/eslint-config-engrave eslint prettier
```

## Config

Add the following to `.eslintrc` file:

```json
{
  "extends": "@engrave/eslint-config-engrave"
}
```

Add the following to `.prettierrc.js` file:

```javascript
module.exports = require('@engrave/eslint-config-engrave/prettier.config');
```

Add the following to `package.json` file:

```json
{
  "scripts": {
    "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
  }
}
```

## License

MIT

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