@arabasta/eslint-config

Custom ESLint config to share between my projects. Originally extracted from vite-workshop.

Requirements

• This config currently only works with ESLint v9

• The optional TypeScript config requires a typescript version that satisfies the following constraint: >=4.8.4 <6.1.0

Installation

Assuming you already have ESLint installed, run:

# npm
npm install --save-dev @arabasta/eslint-config

# yarn
yarn add --dev @arabasta/eslint-plugin-config

# pnpm
pnpm add --save-dev @arabasta/eslint-config

Usage

Usage with ESM

// ...
import { baseConfig } from '@arabasta/eslint-config';

export default [
  // ...
  ...baseConfig,
];

A complete ESM example including React, TypeScript and Vitest can be found here: ESM Example

Usage with CommonJS

// ...
const { baseConfig } = require('@arabasta/eslint-config');

module.exports = [
  // ...
  ...baseConfig,
];

A complete CJS example including React, TypeScript and Jest can be found here: CJS Example

Available configs

• baseConfig - Base config.
• typescriptConfig - Additional config for TypeScript.
• typescriptDefinitionsConfig - Additional config for TypeScript definitions (.d.ts).
• configFilesConfig - Additional config with adjustments for configuration files like tailwind.config.js and jest.config.js.
• reactConfig - Additional config for React.
• reactTypescriptConfig - Additional config for React when using TypeScript.
• reduxConfig - Additional config for Redux and Redux Toolkit when using React.
• jestConfig - Additional config for Jest.
• rtlJestConfig - Additional config for Testing Library when using Jest.
• vitestConfig - Additional config for Vitest.
• rtlVitestConfig - Additional config for Testing Library when using Vitest.

Plugins

Plugin packages included in this ESLint config:

• @arabasta/eslint-plugin-javascript
• @arabasta/eslint-plugin-react
• @arabasta/eslint-plugin-testing-library
• @arabasta/eslint-plugin-tsoa
• @arabasta/eslint-plugin-typescript
• @eslint-community/eslint-plugin-eslint-comments
• @typescript-eslint/eslint-plugin
• @vitest/eslint-plugin
• eslint-plugin-es
• eslint-plugin-import
• eslint-plugin-jest
• eslint-plugin-jsdoc
• eslint-plugin-jsx-a11y
• eslint-plugin-new-with-error
• eslint-plugin-react
• eslint-plugin-react-hooks
• eslint-plugin-react-refresh
• eslint-plugin-testing-library
• eslint-plugin-unused-imports

License

MIT