ESLint Configuration

This is a group of shareable ESLint configurations.

Usage

Install the npm package in your repository

npm install --save-dev --save-exact @ostermann/eslint-config

Install dependencies in your repository

These should be installed automatically with the package installation, but it is useful to have @eslint/js and eslint installed to allow for overriding the configuration.

npm install --save-dev @eslint/js eslint

Use the base config

Create an eslint.config.js file in your project:

import { defineConfig } from "eslint/config";

import { baseConfig } from "@ostermann/eslint-config";

export default defineConfig({
  extends: [baseConfig],
});

Or using a specific configuration:

import { defineConfig } from "eslint/config";

import { baseConfig, tanstackRouterConfig } from "@ostermann/eslint-config";

export default defineConfig({
  extends: [baseConfig, tanstackRouterConfig],
});

Override the base config in your own project

import { defineConfig } from "eslint/config";

import { baseConfig } from "@ostermann/eslint-config";

export default defineConfig(
  {
    extends: [baseConfig],
  },
  // Your overrides here
  {
    files: ["**/*"],
    rules: {
      // import
      "import/no-default-export": "off",
    },
  },
);

Contributing

Get started

1. Install dependencies

npm install --workspace @ostermann/eslint-config

2. Build the project

npm run build --workspace @ostermann/eslint-config

Creating or updating a config

1. Create or update the eslint configuration
2. Run the npm run codegen:barrel --workspace @ostermann/eslint-config command. This will update the index.js to export the updated configuration.
3. Update the version in package.json
4. Update the CHANGELOG
5. Deploy the package with npm run publish-eslint-config

External Links

• ESLint