eslint-config-andrewaylett

My personal preferences for ESLint rules

Motivation

Working for Skyscanner, I'm a big fan of eslint-config-skyscanner. But there are a couple of things that make it less ideal for external projects and ones that don't use React, so this is my set of preferences for my own projects.

Feel free to use it directly if you don't mind the somewhat opinionated stance, or to copy any bits out of it if you don't want to be subject to any whimsical changes of mind.

Execution

This is a complete Typescript configuration. It's also written in Typescript, and linted using its own ruleset.

The post build test validates some constraints, most usefully it ensures that the ranges of peer dependencies are appropriate. We do this by mangling the content of package.json in a temporary directory and linting, testing, and building again.

Use

Works with eslint v9 only.

The package default export is a FlatConfig plugin, with a collection of recommended rulesets for different project types.

In your eslint.config.js:

import andrewaylett from 'eslint-config-andrewaylett';

export default [
    // Make sure you include your files
    {
        files: ['*.ts'],
    },
    // Pick a suitable config
    andrewaylett.configs.recommended,
    // ... other configs
];

The basic config is recommended, on top of that there are modifiers withJest, withReact, withTypes, and withoutTypescript. If you specify withTypes then you must configure a suitable parser:

import andrewaylett from 'eslint-config-andrewaylett';

export default [
    // Make sure you include your files
    {
        files: ['*.ts', '*.tsx'],
    },
    {
        languageOptions: {
            parserOptions: {
                project: true,
                projectService: {
                    allowDefaultProject: ['*.js', '*.mjs', 'jest.config.ts'],
                },
            },
        },
    },
    // ... any other configs, including presets from this package
    andrewaylett.configs.recommendedWithReactWithTypes,
];