563 lines
15 KiB
JavaScript
563 lines
15 KiB
JavaScript
// TODO: switch to typescript https://github.com/eslint/eslint/pull/18134
|
|
|
|
import eslint from '@eslint/js';
|
|
|
|
import tseslint from 'typescript-eslint';
|
|
import tsPlugin from '@typescript-eslint/eslint-plugin';
|
|
|
|
import stylistic from '@stylistic/eslint-plugin';
|
|
// import stylisticRules from '@stylistic/eslint-plugin/rule-options';
|
|
|
|
import jsdoc from 'eslint-plugin-jsdoc';
|
|
|
|
|
|
export default tseslint.config(
|
|
{
|
|
// @ts-expect-error this works
|
|
languageOptions: {
|
|
parserOptions: {
|
|
project: true,
|
|
tsconfigRootDir: import.meta.dirname,
|
|
},
|
|
},
|
|
|
|
extends: [
|
|
eslint.configs.recommended,
|
|
jsdoc.configs['flat/recommended-typescript'],
|
|
],
|
|
|
|
plugins: {
|
|
jsdoc,
|
|
'@stylistic': stylistic, // as typeof stylisticRules,
|
|
'@typescript-eslint': tsPlugin,
|
|
},
|
|
|
|
rules: {
|
|
// JSDoc settings
|
|
'jsdoc/tag-lines': ['warn', 'any', { startLines: 1 }],
|
|
'jsdoc/check-line-alignment': ['warn', 'always', {
|
|
tags: ['param', 'arg', 'argument', 'property', 'prop'],
|
|
}],
|
|
|
|
// Naming Conventions
|
|
'camelcase': 'off',
|
|
'@typescript-eslint/naming-convention': [
|
|
'error',
|
|
{
|
|
selector: 'default',
|
|
format: ['camelCase'],
|
|
},
|
|
|
|
// Variable names
|
|
{
|
|
selector: 'variable',
|
|
format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
|
|
},
|
|
{
|
|
selector: 'variable',
|
|
types: ['function'],
|
|
format: ['camelCase', 'PascalCase'],
|
|
},
|
|
{
|
|
selector: 'variable',
|
|
modifiers: ['const'],
|
|
types: ['number', 'string'],
|
|
format: ['UPPER_CASE'],
|
|
},
|
|
{
|
|
selector: 'variable',
|
|
types: ['boolean'],
|
|
format: ['PascalCase'],
|
|
prefix: ['is', 'should', 'has', 'can', 'did', 'will'],
|
|
},
|
|
|
|
// Readonly in UPPER_CASE
|
|
{
|
|
selector: [
|
|
'classProperty',
|
|
'parameterProperty',
|
|
'typeProperty',
|
|
],
|
|
modifiers: ['readonly'],
|
|
format: ['UPPER_CASE'],
|
|
leadingUnderscore: 'allow',
|
|
},
|
|
|
|
// Force an underscore before a private prop
|
|
{
|
|
selector: 'memberLike',
|
|
modifiers: ['private'],
|
|
format: ['camelCase'],
|
|
leadingUnderscore: 'require',
|
|
},
|
|
|
|
// Force PascalCase
|
|
{
|
|
selector: [
|
|
'typeLike',
|
|
'class',
|
|
],
|
|
format: ['PascalCase'],
|
|
},
|
|
|
|
// Don't format:
|
|
{
|
|
selector: [
|
|
'import',
|
|
'objectLiteralProperty',
|
|
'objectLiteralMethod',
|
|
'typeProperty',
|
|
],
|
|
format: null,
|
|
},
|
|
{
|
|
selector: [
|
|
'variable',
|
|
'parameter',
|
|
],
|
|
modifiers: ['unused'],
|
|
format: null,
|
|
},
|
|
|
|
// Don't format when inside quotes
|
|
{
|
|
selector: [
|
|
'classProperty',
|
|
'typeProperty',
|
|
'classMethod',
|
|
'typeMethod',
|
|
'accessor',
|
|
'enumMember',
|
|
],
|
|
format: null,
|
|
modifiers: ['requiresQuotes'],
|
|
},
|
|
],
|
|
|
|
// Newer settings
|
|
'@typescript-eslint/no-extraneous-class': ['off'],
|
|
'@typescript-eslint/no-implied-eval': ['off'],
|
|
|
|
// Pre-flat config
|
|
'@typescript-eslint/no-unused-vars': [
|
|
'error',
|
|
{
|
|
args: 'all',
|
|
argsIgnorePattern: '^_',
|
|
caughtErrors: 'all',
|
|
caughtErrorsIgnorePattern: '^_',
|
|
destructuredArrayIgnorePattern: '^_',
|
|
varsIgnorePattern: '^_',
|
|
ignoreRestSiblings: true,
|
|
},
|
|
],
|
|
|
|
'array-callback-return': [
|
|
'error',
|
|
{
|
|
allowImplicit: true,
|
|
checkForEach: true,
|
|
},
|
|
],
|
|
'no-constructor-return': [
|
|
'error',
|
|
],
|
|
'no-unreachable-loop': [
|
|
'error',
|
|
{
|
|
ignore: [
|
|
'ForInStatement',
|
|
'ForOfStatement',
|
|
],
|
|
},
|
|
],
|
|
'no-use-before-define': [
|
|
'error',
|
|
{
|
|
functions: false,
|
|
},
|
|
],
|
|
'block-scoped-var': [
|
|
'error',
|
|
],
|
|
'class-methods-use-this': [
|
|
'error',
|
|
],
|
|
'curly': [
|
|
'warn',
|
|
],
|
|
'default-case-last': [
|
|
'warn',
|
|
],
|
|
'default-param-last': [
|
|
'error',
|
|
],
|
|
'eqeqeq': [
|
|
'error',
|
|
'smart',
|
|
],
|
|
'func-names': [
|
|
'warn',
|
|
'never',
|
|
],
|
|
'func-style': [
|
|
'warn',
|
|
'expression',
|
|
],
|
|
'logical-assignment-operators': [
|
|
'warn',
|
|
'always',
|
|
],
|
|
'no-array-constructor': [
|
|
'error',
|
|
],
|
|
'no-empty-function': [
|
|
'warn',
|
|
],
|
|
'no-empty-static-block': [
|
|
'warn',
|
|
],
|
|
'no-extend-native': [
|
|
'error',
|
|
],
|
|
'no-extra-bind': [
|
|
'warn',
|
|
],
|
|
'no-implicit-coercion': [
|
|
'warn',
|
|
],
|
|
'no-iterator': [
|
|
'error',
|
|
],
|
|
'no-labels': [
|
|
'error',
|
|
],
|
|
'no-lone-blocks': [
|
|
'error',
|
|
],
|
|
'no-lonely-if': [
|
|
'error',
|
|
],
|
|
'no-loop-func': [
|
|
'error',
|
|
],
|
|
'no-magic-numbers': [
|
|
'error',
|
|
{
|
|
ignore: [
|
|
-1,
|
|
0.1,
|
|
0,
|
|
1,
|
|
2,
|
|
3,
|
|
4,
|
|
5,
|
|
10,
|
|
12,
|
|
33,
|
|
66,
|
|
100,
|
|
255,
|
|
360,
|
|
450,
|
|
500,
|
|
1000,
|
|
],
|
|
ignoreDefaultValues: true,
|
|
ignoreClassFieldInitialValues: true,
|
|
},
|
|
],
|
|
'no-multi-assign': [
|
|
'error',
|
|
],
|
|
'no-new-wrappers': [
|
|
'error',
|
|
],
|
|
'no-object-constructor': [
|
|
'error',
|
|
],
|
|
'no-proto': [
|
|
'error',
|
|
],
|
|
'no-return-assign': [
|
|
'error',
|
|
],
|
|
'no-sequences': [
|
|
'error',
|
|
],
|
|
'no-shadow': [
|
|
'error',
|
|
{
|
|
builtinGlobals: true,
|
|
allow: [
|
|
'Window',
|
|
],
|
|
},
|
|
],
|
|
'no-undef-init': [
|
|
'warn',
|
|
],
|
|
'no-undefined': [
|
|
'error',
|
|
],
|
|
'no-useless-constructor': [
|
|
'warn',
|
|
],
|
|
'no-useless-escape': [
|
|
'off',
|
|
],
|
|
'no-useless-return': [
|
|
'error',
|
|
],
|
|
'no-var': [
|
|
'error',
|
|
],
|
|
'no-void': [
|
|
'off',
|
|
],
|
|
'no-with': [
|
|
'error',
|
|
],
|
|
'object-shorthand': [
|
|
'error',
|
|
'always',
|
|
],
|
|
'one-var': [
|
|
'error',
|
|
'never',
|
|
],
|
|
'operator-assignment': [
|
|
'warn',
|
|
'always',
|
|
],
|
|
'prefer-arrow-callback': [
|
|
'error',
|
|
],
|
|
'prefer-const': [
|
|
'error',
|
|
],
|
|
'prefer-object-has-own': [
|
|
'error',
|
|
],
|
|
'prefer-regex-literals': [
|
|
'error',
|
|
],
|
|
'prefer-template': [
|
|
'warn',
|
|
],
|
|
'no-prototype-builtins': 'off',
|
|
'@typescript-eslint/no-var-requires': [
|
|
'off',
|
|
],
|
|
'@stylistic/array-bracket-newline': [
|
|
'warn',
|
|
'consistent',
|
|
],
|
|
'@stylistic/array-bracket-spacing': [
|
|
'warn',
|
|
'never',
|
|
],
|
|
'@stylistic/arrow-parens': [
|
|
'warn',
|
|
'always',
|
|
],
|
|
'@stylistic/brace-style': [
|
|
'warn',
|
|
'stroustrup',
|
|
],
|
|
'@stylistic/comma-dangle': [
|
|
'warn',
|
|
'always-multiline',
|
|
],
|
|
'@stylistic/comma-spacing': [
|
|
'warn',
|
|
{
|
|
before: false,
|
|
after: true,
|
|
},
|
|
],
|
|
'@stylistic/comma-style': [
|
|
'error',
|
|
'last',
|
|
],
|
|
'@stylistic/dot-location': [
|
|
'error',
|
|
'property',
|
|
],
|
|
'@stylistic/function-call-argument-newline': [
|
|
'warn',
|
|
'consistent',
|
|
],
|
|
'@stylistic/function-paren-newline': [
|
|
'warn',
|
|
'consistent',
|
|
],
|
|
'@stylistic/indent': [
|
|
'warn',
|
|
4,
|
|
{
|
|
SwitchCase: 1,
|
|
ignoreComments: true,
|
|
ignoredNodes: ['TemplateLiteral > *'],
|
|
},
|
|
],
|
|
'@stylistic/key-spacing': [
|
|
'warn',
|
|
{
|
|
beforeColon: false,
|
|
afterColon: true,
|
|
},
|
|
],
|
|
'@stylistic/keyword-spacing': [
|
|
'warn',
|
|
{
|
|
before: true,
|
|
},
|
|
],
|
|
'@stylistic/linebreak-style': [
|
|
'error',
|
|
'unix',
|
|
],
|
|
'@stylistic/lines-between-class-members': [
|
|
'warn',
|
|
'always',
|
|
{
|
|
exceptAfterSingleLine: true,
|
|
},
|
|
],
|
|
'@stylistic/max-len': [
|
|
'warn',
|
|
{
|
|
code: 105,
|
|
ignoreComments: true,
|
|
ignoreTrailingComments: true,
|
|
ignoreUrls: true,
|
|
},
|
|
],
|
|
'@stylistic/multiline-ternary': [
|
|
'warn',
|
|
'always-multiline',
|
|
],
|
|
'@stylistic/new-parens': [
|
|
'error',
|
|
],
|
|
'@stylistic/no-mixed-operators': [
|
|
'warn',
|
|
],
|
|
'@stylistic/no-mixed-spaces-and-tabs': [
|
|
'error',
|
|
],
|
|
'@stylistic/no-multi-spaces': [
|
|
'error',
|
|
],
|
|
'@stylistic/no-tabs': [
|
|
'error',
|
|
],
|
|
'@stylistic/no-trailing-spaces': [
|
|
'error',
|
|
],
|
|
'@stylistic/no-whitespace-before-property': [
|
|
'warn',
|
|
],
|
|
'@stylistic/nonblock-statement-body-position': [
|
|
'error',
|
|
'below',
|
|
],
|
|
'@stylistic/object-curly-newline': [
|
|
'warn',
|
|
{
|
|
consistent: true,
|
|
},
|
|
],
|
|
'@stylistic/object-curly-spacing': [
|
|
'warn',
|
|
'always',
|
|
],
|
|
'@stylistic/operator-linebreak': [
|
|
'warn',
|
|
'after',
|
|
],
|
|
'@stylistic/padded-blocks': [
|
|
'error',
|
|
'never',
|
|
],
|
|
'@stylistic/padding-line-between-statements': [
|
|
'warn',
|
|
{
|
|
blankLine: 'always',
|
|
prev: '*',
|
|
next: 'return',
|
|
},
|
|
{
|
|
blankLine: 'always',
|
|
prev: [
|
|
'const',
|
|
'let',
|
|
'var',
|
|
],
|
|
next: '*',
|
|
},
|
|
{
|
|
blankLine: 'any',
|
|
prev: [
|
|
'const',
|
|
'let',
|
|
'var',
|
|
],
|
|
next: [
|
|
'const',
|
|
'let',
|
|
'var',
|
|
],
|
|
},
|
|
{
|
|
blankLine: 'always',
|
|
prev: [
|
|
'case',
|
|
'default',
|
|
],
|
|
next: '*',
|
|
},
|
|
],
|
|
'@stylistic/quote-props': [
|
|
'error',
|
|
'consistent-as-needed',
|
|
],
|
|
'@stylistic/quotes': [
|
|
'error',
|
|
'single',
|
|
{
|
|
avoidEscape: true,
|
|
},
|
|
],
|
|
'@stylistic/semi': [
|
|
'error',
|
|
'always',
|
|
],
|
|
'@stylistic/semi-spacing': [
|
|
'warn',
|
|
],
|
|
'@stylistic/space-before-blocks': [
|
|
'warn',
|
|
],
|
|
'@stylistic/space-before-function-paren': [
|
|
'warn',
|
|
'never',
|
|
],
|
|
'@stylistic/space-infix-ops': [
|
|
'warn',
|
|
],
|
|
'@stylistic/spaced-comment': [
|
|
'warn',
|
|
'always',
|
|
],
|
|
'@stylistic/switch-colon-spacing': [
|
|
'warn',
|
|
],
|
|
'@stylistic/wrap-regex': [
|
|
'warn',
|
|
],
|
|
},
|
|
},
|
|
);
|