flexifin/eslint-config

Code service level repo for sharing common sources through several FF projects.

Usage

Update ESlint to version 9:

npm install eslint@^9

Remove these packages from your project:

npm remove prettier \
  @typescript-eslint/parser \
  @typescript-eslint/eslint-plugin \
  eslint-plugin-prefer-arrow-functions \
  eslint-plugin-unused-imports \
  eslint-config-prettier \
  eslint-plugin-prettier \
  eslint-plugin-react \
  eslint-plugin-unicorn

Install package:

# npm
npm install -D @flexifin/eslint-config

# yarn
yarn add -D @flexifin/eslint-config

# pnpm
pnpm add -D @flexifin/eslint-config

# bun
bun install -D @flexifin/eslint-config

# deno
deno install --dev npm:@flexifin/eslint-config

Migration to FlexiFin code standard

Rename your project root ESLint config file to eslint.config.mjs and modify content to extend FlexiFin preset:

import flexiFin from '@flexifin/eslint-config';

export default flexiFin({
  tsconfigRootDir: import.meta.dirname,
  reactSupport: true, // optional (React projects)
  nestSupport: true, // optional (NestJS projects)
  experimental: {
    enablePerfectionistPlugin: true, // false by default
  },
  ignores: [
    // ignore paths
  ],
  rules: {
    // rule overrides
  },
});

Real world example:

import flexiFin from '@flexifin/eslint-config';

export default flexiFin(
  {
    reactSupport: true,
    ignores: ['src/_api'],
    rules: {
      'unicorn/no-array-reduce': 'off',
    },
  },
  {
    files: ['**/*.spec.ts'],
    rules: {
      '@typescript-eslint/no-explicit-any': 'off',
    },
  }
);

Rename your project root Prettier config file to prettier.config.mjs and modify content to extend FlexiFin preset:

import flexiFin from '@flexifin/eslint-config/prettier';

export default flexiFin();

Contributors

🤖 auto updated with automd