Bancame ESLint Flat Configuration

A batteries-included, flat-config ESLint setup for TypeScript & React projects, built on top of ESLint v9. It ships with sensible defaults and plugins to cover:

• TypeScript (@typescript-eslint/parser, @typescript-eslint/eslint-plugin)
• React/JSX (eslint-plugin-react, eslint-plugin-react-hooks, eslint-plugin-react-refresh)
• Import ordering (eslint-plugin-import)
• Google Translate helper rules (eslint-plugin-react-google-translate)
• Prettier integration (eslint-config-prettier)

⚠️ Uses ESLint’s new flat config format. If you prefer classic .eslintrc.js, see the “Legacy Usage” section below.

Table of Contents

• Bancame ESLint Flat Configuration
  • Table of Contents
  • Installation
  • Basic Usage (flat config)
    • Optional: React support
  • Legacy Usage (.eslintrc.cjs)
  • Publishing to npm

Installation

1. Install the package and required peers

npm install --save-dev @bancame/eslint-config

2. Install ESLint and required plugins

npm install --save-dev eslint-import-resolver-typescript

If you use React, also install the React plugins:

npm install --save-dev eslint-plugin-react-hooks

Basic Usage (flat config)

1. Create a eslint.config.mjs file in your project root:

import { defineConfig } from 'eslint/config';
import baseConfig from '@bancame/eslint-config';

export default defineConfig(baseConfig);

2. (Optional) Create an .eslintignore file to exclude files/folders from linting, e.g.:

build/
dist/
node_modules/

3. Run ESLint:

npx eslint . --ext .js,.ts,.jsx,.tsx

Optional: React support

• The config scopes React-specific rules only to .jsx/.tsx files.
• In a non-React repo you may omit installing the React plugins; ESLint will skip those rules automatically.

Legacy Usage (.eslintrc.cjs)

If you’re not ready for flat config, import our defaults into a classic config:

module.exports = require('@bancame/eslint-config').default;

Then lint as usual:

npx eslint . --ext .js,.ts,.jsx,.tsx

Publishing to npm

To publish this package to npm, follow these steps:

1. Update the version in package.json.

2. Update the changelog in CHANGELOG.md with the new version and a summary of changes.

   • Use the format: ## [x.x.x] - YYYY-MM-DD
   • Example: ## [1.0.0] - 2025-06-02
   • Launch first release with support for eslint v9 and flat config.

3. Create a new pull request with the version change.

4. Wait for the CI to pass.

5. Merge the pull request.