1.0.5 • Published 9 months ago

@arabasta/eslint-config v1.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

@arabasta/eslint-config

NPM Version NPM License

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

Requirements

  • This config currently only works with ESLint v8
  • The optional TypeScript config requires a typescript version that satisfies the following constraint: >=4.7.4 <5.7.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-no-testing-library-without-cleanup@1.0.5
  • @arabasta/eslint-plugin-redux-use-app-functions@1.0.5
  • @arabasta/eslint-plugin-report-caught-error@1.0.6
  • @arabasta/eslint-plugin-require-useeffect-dependency-array@1.0.9
  • @eslint-community/eslint-plugin-eslint-comments@4.4.0
  • @typescript-eslint/eslint-plugin@7.18.0
  • @vitest/eslint-plugin@1.1.7
  • eslint-plugin-deprecation@3.0.0
  • eslint-plugin-es@4.1.0
  • eslint-plugin-import@2.31.0
  • eslint-plugin-jest@28.8.3
  • eslint-plugin-jsx-a11y@6.10.0
  • eslint-plugin-new-with-error@5.0.0
  • eslint-plugin-react@7.37.1
  • eslint-plugin-react-hooks@5.0.0
  • eslint-plugin-react-refresh@0.4.13
  • eslint-plugin-testing-library@6.4.0
  • eslint-plugin-unused-imports@3.2.0

License

MIT