@neynar/eslint-plugin/README.md

ESLint plugin with opinionated rules and configurations for Neynar's development standards

# @neynar/eslint-plugin

A comprehensive ESLint plugin providing opinionated rules and configurations for Neynar's development standards, specifically tailored for React and Next.js applications.

## Installation

```bash
npm install @neynar/eslint-plugin
# or
yarn add @neynar/eslint-plugin
```

## Usage

### Recommended Configuration

For the most comprehensive setup, use the recommended configuration:

```js
// eslint.config.js
import neynar from '@neynar/eslint-plugin';

export default [
  neynar.configs.recommended,
  // your other configs...
];
```

### Framework-Specific Configurations

#### React Projects

```js
// eslint.config.js
import neynar from '@neynar/eslint-plugin';

export default [
  neynar.configs.react,
  // your other configs...
];
```

#### Next.js Projects

```js
// eslint.config.js
import neynar from '@neynar/eslint-plugin';

export default [
  neynar.configs.next,
  // your other configs...
];
```

## Available Rules

### `@neynar/no-process-env`

Prevents direct usage of `process.env` variables, encouraging the use of environment variable validation and configuration patterns.

```js
// ❌ Bad
const apiKey = process.env.API_KEY;

// ✅ Good
import { env } from './config/env';
const apiKey = env.API_KEY;
```

### `@neynar/next-prefer-named-exports`

Enforces the use of named exports over default exports in Next.js applications for better tree-shaking and refactoring support.

```js
// ❌ Bad
export default function HomePage() {
  return <div>Home</div>;
}

// ✅ Good
export function HomePage() {
  return <div>Home</div>;
}
```

## Configurations

### `recommended`

The recommended configuration includes:
- TypeScript support
- React best practices
- Import/export rules
- Code quality rules
- Neynar-specific patterns

### `react`

Optimized for React applications with:
- React hooks rules
- JSX best practices
- Component patterns
- Performance optimizations

### `next`

Tailored for Next.js applications including:
- Next.js specific rules
- App Router patterns
- Performance optimizations
- SEO best practices

## License

Copyright (c) 2025 Neynar Inc. All rights reserved.

This software is proprietary and confidential. See LICENSE file for details.