Aproxima ESLint Config

This package provides a default ESLint configuration for ESLint v8.5 flat configurations.

Installation

Using npm

npm install --save-dev typescript prettier eslint @aproxima/eslint-config

Using yarn

yarn add --dev typescript prettier eslint @aproxima/eslint-config

Using bun

bun install --save-dev typescript prettier eslint @aproxima/eslint-config

Setup

JavaScript/TypeScript

Create an eslint.config.js file in the root of your project and add the following:

import aproximaEslintConfig from "@aproxima/eslint-config";

export default aproximaEslintConfig;

Remix

Create an eslint.config.js file in the root of your project and add the following:

import aproximaEslintConfig from "@aproxima/eslint-config/remix";

export default aproximaEslintConfig;

VSCode

Install the ESLint extension and add the following to your workspace settings.json:

{
  "editor.formatOnSave": true,
  "[javascript][javascriptreact][typescript][typescriptreact]": {
    // Turn formatOnSave off for JS and JSX, controlled by ESLint
    "editor.formatOnSave": false
  },
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "explicit"
  },
  // flat config is still experimental
  "eslint.experimental.useFlatConfig": true
}

If you are working in a monorepo, you may need to also add the eslint.workingDirectories setting to your workspace settings.json for each app/package directory:

{
  "eslint.workingDirectories": ["./packages/*"]
}