Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: migrate eslint config to flat style #913

Merged
merged 4 commits into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 0 additions & 60 deletions .eslintrc

This file was deleted.

103 changes: 103 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
import tseslint from 'typescript-eslint';
import globals from 'globals';
import tsParser from '@typescript-eslint/parser';
import jest from 'eslint-plugin-jest';
import js from '@eslint/js';

export default [
// using .mjs for module support as TypeScript Eslint configs are still experimental
{
name: 'Eslint config file',
files: ['eslint.config.mjs'],
// ...tseslint.configs.disableTypeChecked,
// ...js.configs.recommended,

languageOptions: {
sourceType: 'module',
parserOptions: {
// project: 'package.json'
}
}
},

{
name: 'general project rules',
files: ['**/*.ts'],

plugins: {
'@typescript-eslint': tseslint.plugin
},

languageOptions: {
globals: {
...globals.node
},

parser: tsParser,
ecmaVersion: 5,
sourceType: 'module',

parserOptions: {
project: 'tsconfig.json'
}
},

rules: {
// contains all of recommended, recommended-type-checked, and strict
...tseslint.configs.strictTypeChecked.rules,
'@typescript-eslint/no-unused-vars': [
'warn',
{
argsIgnorePattern: '^_'
}
],

'@typescript-eslint/naming-convention': [
'warn',
{
selector: ['typeLike'],
format: ['PascalCase']
},
{
selector: ['variableLike', 'function'],
format: ['camelCase'],
leadingUnderscore: 'allow'
},
{
selector: ['variable'],
format: ['camelCase', 'UPPER_CASE']
},
{
selector: 'variable',
types: ['boolean'],
format: ['PascalCase'],
prefix: ['is', 'should', 'has', 'can', 'did', 'was', 'will']
}
],
// this is set to warn because it wasn't caught before the eslint migration in 11/2024
'@typescript-eslint/restrict-template-expressions': 'warn'
}
},

{
name: 'test rules',
files: ['tests/**/*.ts'],

...jest.configs['flat/recommended'],
...jest.configs['flat/style'],

plugins: {
jest
},

rules: {
'@typescript-eslint/no-empty-function': 'off',
'@typescript-eslint/unbound-method': 'off',
'jest/no-done-callback': 'off'
}
},

// Prettier plugin which should be last
eslintPluginPrettierRecommended
];
Loading