29 lines
884 B
Markdown
29 lines
884 B
Markdown
# @mintel/eslint-config
|
|
|
|
Shared ESLint configurations for Mintel projects, enforcing code quality and consistent style across Next.js and TypeScript codebases.
|
|
|
|
## 📦 Configurations
|
|
|
|
### `next`
|
|
A comprehensive configuration for Next.js projects.
|
|
- **Extends**: `next/core-web-vitals` and `next/typescript`.
|
|
- **Custom Rules**:
|
|
- `_` prefix for unused variables is allowed.
|
|
- `any` type is permitted (for rapid migration/prototyping).
|
|
- React unescaped entities check is disabled.
|
|
- Image element warnings are enabled (prefer `next/image`).
|
|
|
|
## 🚀 Usage
|
|
|
|
### In a Next.js App
|
|
Create an `eslint.config.mjs` in your project root:
|
|
|
|
```javascript
|
|
import { nextConfig } from "@mintel/eslint-config/next";
|
|
|
|
export default nextConfig;
|
|
```
|
|
|
|
## 🛠 Development
|
|
To add new rules, modify `packages/eslint-config/next.js`. Remember to create a changeset if you make breaking changes.
|