# eslint-config-egg

> Node.js Style Guide for EggJS

Latest version **14.1.0** (published 2025-01-21) · 0 weekly downloads

## Install

```sh
npm install eslint-config-egg
pnpm add eslint-config-egg
yarn add eslint-config-egg
bun add eslint-config-egg
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities; has provenance.

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

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 14.1.0 |
| Published | 2025-01-21 |
| First published | 2015-11-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 18.19.0 |
| Dependencies | 6 |
| Unpacked size | 67.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| Author | popomore |
| Maintainers | gxkl, eggjs-admin, fengmk2, atian25, dead_horse, wanghx, hyj1991, killagu, coolme200, mansonchor.zzw, hubcarl, gemwuu, akitasummer, popomore |

## Links

- npm: https://www.npmjs.com/package/eslint-config-egg
- Repository: https://github.com/eggjs/eslint-config-egg
- Issues: https://github.com/eggjs/eslint-config-egg/issues
- npm.io page: https://npm.io/package/eslint-config-egg

## Dependencies (6)

- [eslint-plugin-node](https://npm.io/package/eslint-plugin-node.md) ^11.1.0
- [eslint-plugin-jsdoc](https://npm.io/package/eslint-plugin-jsdoc.md) ^46.9.1
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.29.1
- [eslint-plugin-eggache](https://npm.io/package/eslint-plugin-eggache.md) ^2.0.0
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^7.14.1
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^7.14.1

## Recent versions

- 14.1.0 (latest) — 2025-01-21
- 13.1.0 (release-13.x) — 2023-12-18
- 12.3.1 (release-12.x) — 2023-09-17
- 14.0.0 — 2024-06-29
- 13.0.0 — 2023-09-17
- 12.3.0 — 2023-09-16
- 12.2.1 — 2023-03-25
- 12.2.0 — 2023-03-24
- 12.1.0 — 2022-09-29
- 12.0.0 — 2022-06-04
- 11.1.0 — 2022-05-07
- 11.0.1 — 2022-02-21
- 11.0.0 — 2022-02-15
- 10.0.0 — 2021-11-24
- 9.0.0 — 2020-11-11
- … 33 more at https://npm.io/package/eslint-config-egg/versions

## README

# eslint-config-egg

[![NPM version][npm-image]][npm-url]
[![build status][ci-image]][ci-url]
[![Test coverage][codecov-image]][codecov-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/eslint-config-egg.svg?style=flat-square
[npm-url]: https://npmjs.org/package/eslint-config-egg
[ci-image]: https://github.com/eggjs/eslint-config-egg/actions/workflows/nodejs.yml/badge.svg
[ci-url]: https://github.com/eggjs/eslint-config-egg/actions/workflows/nodejs.yml
[codecov-image]: https://codecov.io/gh/eggjs/eslint-config-egg/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/eggjs/eslint-config-egg
[snyk-image]: https://snyk.io/test/npm/eslint-config-egg/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/eslint-config-egg
[download-image]: https://img.shields.io/npm/dm/eslint-config-egg.svg?style=flat-square
[download-url]: https://npmjs.org/package/eslint-config-egg

Node.js Style Guide for EggJS

## Install

```bash
npm i eslint eslint-config-egg --save-dev
```

## Usage

### Use with JavaScript project

- `package.json`

```json
{
  "devDependencies": {
    "eslint-config-egg": "14",
    "eslint": "8"
  }
}
```

- `.eslintrc`

```json
{
  "extends": [
    "eslint-config-egg"
  ]
}
```

### Use with TypeScript project

- `package.json`

```json
{
  "devDependencies": {
    "eslint-config-egg": "13",
    "typescript": "5"
  }
}
```

- `.eslintrc`

```json
{
  "extends": [
    "eslint-config-egg/typescript"
  ]
}
```

- `scripts`

```json
{
  "lint": "eslint . --ext .ts"
}
```

- `settings.json` in vscode

```json
{
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    {
      "language": "typescript",
      "autoFix": true
    }
  ]
}
```

## License

[MIT](LICENSE)

## Contributors

[![Contributors](https://contrib.rocks/image?repo=eggjs/eslint-config-egg)](https://github.com/eggjs/eslint-config-egg/graphs/contributors)

Made with [contributors-img](https://contrib.rocks).

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