mirror of
https://github.com/actualbudget/actual.git
synced 2026-04-29 19:14:22 -05:00
497 lines
13 KiB
JavaScript
497 lines
13 KiB
JavaScript
import tsParser from '@typescript-eslint/parser';
|
|
import pluginJSXA11y from 'eslint-plugin-jsx-a11y';
|
|
import oxlint from 'eslint-plugin-oxlint';
|
|
import pluginPerfectionist from 'eslint-plugin-perfectionist';
|
|
import pluginTypescriptPaths from 'eslint-plugin-typescript-paths';
|
|
import { defineConfig } from 'eslint/config';
|
|
import globals from 'globals';
|
|
import pluginTypescript from 'typescript-eslint';
|
|
|
|
import pluginActual from './packages/eslint-plugin-actual/lib/index.js';
|
|
|
|
export default defineConfig(
|
|
{
|
|
ignores: [
|
|
'packages/api/app/bundle.api.js',
|
|
'packages/api/app/stats.json',
|
|
'packages/api/@types',
|
|
'packages/api/migrations',
|
|
'packages/component-library/src/icons/**/*',
|
|
'packages/desktop-client/bundle.browser.js',
|
|
'packages/desktop-client/dev-dist/',
|
|
'packages/desktop-client/service-worker/*',
|
|
'packages/desktop-client/build-electron/',
|
|
'packages/desktop-client/build-stats/',
|
|
'packages/desktop-client/public/kcab/',
|
|
'packages/desktop-client/public/data/',
|
|
'packages/desktop-client/test-results/',
|
|
'packages/desktop-client/playwright-report/',
|
|
'packages/desktop-electron/client-build/',
|
|
'packages/loot-core/**/lib-dist/*',
|
|
'packages/loot-core/**/proto/*',
|
|
'packages/sync-server/user-files/',
|
|
'packages/sync-server/server-files/',
|
|
'.yarn/*',
|
|
'.github/*',
|
|
'**/build/',
|
|
'**/dist/',
|
|
'**/node_modules/',
|
|
],
|
|
},
|
|
{
|
|
// Temporary until the sync-server is migrated to TypeScript
|
|
files: [
|
|
'packages/sync-server/**/*.spec.{js,jsx}',
|
|
'packages/sync-server/**/*.test.{js,jsx}',
|
|
],
|
|
languageOptions: {
|
|
globals: {
|
|
vi: true,
|
|
describe: true,
|
|
expect: true,
|
|
it: true,
|
|
beforeAll: true,
|
|
beforeEach: true,
|
|
afterAll: true,
|
|
afterEach: true,
|
|
test: true,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
linterOptions: {
|
|
reportUnusedDisableDirectives: true,
|
|
},
|
|
languageOptions: {
|
|
globals: {
|
|
...globals.browser,
|
|
...globals.commonjs,
|
|
...globals.node,
|
|
globalThis: false,
|
|
vi: true,
|
|
},
|
|
},
|
|
settings: {
|
|
react: {
|
|
version: 'detect',
|
|
},
|
|
|
|
'import/resolver': {
|
|
typescript: {
|
|
alwaysTryTypes: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
pluginTypescript.configs.recommended,
|
|
{
|
|
plugins: {
|
|
actual: pluginActual,
|
|
perfectionist: pluginPerfectionist,
|
|
},
|
|
rules: {
|
|
'actual/no-untranslated-strings': 'error',
|
|
'actual/prefer-trans-over-t': 'error',
|
|
},
|
|
},
|
|
{
|
|
files: ['**/*.{js,ts,jsx,tsx,mjs,mts}'],
|
|
plugins: {
|
|
'jsx-a11y': pluginJSXA11y,
|
|
},
|
|
rules: {
|
|
// http://eslint.org/docs/rules/
|
|
'array-callback-return': 'warn',
|
|
|
|
'default-case': [
|
|
'warn',
|
|
{
|
|
commentPattern: '^no default$',
|
|
},
|
|
],
|
|
|
|
curly: ['warn', 'multi-line', 'consistent'],
|
|
eqeqeq: ['warn', 'smart'],
|
|
'no-array-constructor': 'warn',
|
|
'no-caller': 'warn',
|
|
'no-cond-assign': ['warn', 'except-parens'],
|
|
'no-const-assign': 'warn',
|
|
'no-control-regex': 'warn',
|
|
'no-delete-var': 'warn',
|
|
'no-dupe-args': 'warn',
|
|
'no-dupe-class-members': 'warn',
|
|
'no-dupe-keys': 'warn',
|
|
'no-duplicate-case': 'warn',
|
|
'no-empty-character-class': 'warn',
|
|
'no-empty-pattern': 'warn',
|
|
'no-eval': 'warn',
|
|
'no-ex-assign': 'warn',
|
|
'no-extend-native': 'warn',
|
|
'no-extra-bind': 'warn',
|
|
'no-extra-label': 'warn',
|
|
'no-fallthrough': 'warn',
|
|
'no-func-assign': 'warn',
|
|
'no-implied-eval': 'warn',
|
|
'no-invalid-regexp': 'warn',
|
|
'no-iterator': 'warn',
|
|
'no-label-var': 'warn',
|
|
|
|
'no-labels': [
|
|
'warn',
|
|
{
|
|
allowLoop: true,
|
|
allowSwitch: false,
|
|
},
|
|
],
|
|
|
|
'no-lone-blocks': 'warn',
|
|
|
|
'no-multi-str': 'warn',
|
|
'no-global-assign': 'warn',
|
|
'no-unsafe-negation': 'warn',
|
|
'no-new-func': 'warn',
|
|
'no-new-object': 'warn',
|
|
'no-new-symbol': 'warn',
|
|
'no-new-wrappers': 'warn',
|
|
'no-obj-calls': 'warn',
|
|
'no-octal': 'warn',
|
|
'no-octal-escape': 'warn',
|
|
'no-script-url': 'warn',
|
|
'no-self-assign': 'warn',
|
|
'no-self-compare': 'warn',
|
|
'no-sequences': 'warn',
|
|
'no-shadow-restricted-names': 'warn',
|
|
'no-sparse-arrays': 'warn',
|
|
'no-template-curly-in-string': 'warn',
|
|
'no-this-before-super': 'warn',
|
|
'no-throw-literal': 'warn',
|
|
'no-undef': 'error',
|
|
'no-unreachable': 'warn',
|
|
|
|
'no-unused-expressions': [
|
|
'error',
|
|
{
|
|
allowShortCircuit: true,
|
|
allowTernary: true,
|
|
allowTaggedTemplates: true,
|
|
},
|
|
],
|
|
|
|
'no-unused-labels': 'warn',
|
|
|
|
'no-use-before-define': [
|
|
'warn',
|
|
{
|
|
functions: false,
|
|
classes: false,
|
|
variables: false,
|
|
},
|
|
],
|
|
|
|
'no-useless-computed-key': 'warn',
|
|
'no-useless-concat': 'warn',
|
|
'no-useless-constructor': 'warn',
|
|
'no-useless-escape': 'warn',
|
|
|
|
'no-useless-rename': [
|
|
'warn',
|
|
{
|
|
ignoreDestructuring: false,
|
|
ignoreImport: false,
|
|
ignoreExport: false,
|
|
},
|
|
],
|
|
|
|
'no-with': 'warn',
|
|
|
|
'require-yield': 'warn',
|
|
strict: ['warn', 'never'],
|
|
'unicode-bom': ['warn', 'never'],
|
|
'use-isnan': 'warn',
|
|
'valid-typeof': 'warn',
|
|
|
|
'no-restricted-properties': [
|
|
'error',
|
|
{
|
|
object: 'require',
|
|
property: 'ensure',
|
|
message:
|
|
'Please use import() instead. More info: https://facebook.github.io/create-react-app/docs/code-splitting',
|
|
},
|
|
{
|
|
object: 'System',
|
|
property: 'import',
|
|
message:
|
|
'Please use import() instead. More info: https://facebook.github.io/create-react-app/docs/code-splitting',
|
|
},
|
|
],
|
|
|
|
'getter-return': 'warn',
|
|
|
|
'perfectionist/sort-imports': [
|
|
'warn',
|
|
{
|
|
groups: [
|
|
'react',
|
|
'builtin',
|
|
'external',
|
|
'loot-core',
|
|
'parent',
|
|
'sibling',
|
|
'index',
|
|
'desktop-client',
|
|
],
|
|
customGroups: [
|
|
{
|
|
groupName: 'react',
|
|
elementNamePattern: '^react(-.*)?$',
|
|
},
|
|
{
|
|
groupName: 'loot-core',
|
|
elementNamePattern: '^loot-core',
|
|
},
|
|
{
|
|
groupName: 'desktop-client',
|
|
elementNamePattern: '^@desktop-client',
|
|
},
|
|
],
|
|
newlinesBetween: 'always',
|
|
},
|
|
],
|
|
|
|
// https://github.com/evcohen/eslint-plugin-jsx-a11y/tree/master/docs/rules
|
|
'jsx-a11y/alt-text': 'warn',
|
|
'jsx-a11y/anchor-has-content': 'warn',
|
|
'jsx-a11y/anchor-is-valid': [
|
|
'warn',
|
|
{
|
|
aspects: ['noHref', 'invalidHref'],
|
|
},
|
|
],
|
|
'jsx-a11y/aria-activedescendant-has-tabindex': 'warn',
|
|
'jsx-a11y/aria-props': 'warn',
|
|
'jsx-a11y/aria-proptypes': 'warn',
|
|
'jsx-a11y/aria-role': [
|
|
'warn',
|
|
{
|
|
ignoreNonDOM: true,
|
|
},
|
|
],
|
|
'jsx-a11y/aria-unsupported-elements': 'warn',
|
|
'jsx-a11y/heading-has-content': 'warn',
|
|
'jsx-a11y/iframe-has-title': 'warn',
|
|
'jsx-a11y/img-redundant-alt': 'warn',
|
|
'jsx-a11y/no-access-key': 'warn',
|
|
'jsx-a11y/no-distracting-elements': 'warn',
|
|
'jsx-a11y/no-redundant-roles': 'warn',
|
|
'jsx-a11y/role-has-required-aria-props': 'warn',
|
|
'jsx-a11y/role-supports-aria-props': 'warn',
|
|
'jsx-a11y/scope': 'warn',
|
|
|
|
'actual/typography': 'warn',
|
|
'actual/prefer-if-statement': 'warn',
|
|
'actual/prefer-logger-over-console': 'error',
|
|
|
|
// Note: base rule explicitly disabled in favor of the TS one
|
|
'no-unused-vars': 'off',
|
|
'@typescript-eslint/no-unused-vars': [
|
|
'warn',
|
|
{
|
|
varsIgnorePattern: '^(_|React)',
|
|
argsIgnorePattern: '^(_|React)',
|
|
ignoreRestSiblings: true,
|
|
caughtErrors: 'none',
|
|
},
|
|
],
|
|
|
|
// https://github.com/eslint/eslint/issues/16954
|
|
// https://github.com/eslint/eslint/issues/16953
|
|
'no-loop-func': 'off',
|
|
|
|
'object-shorthand': ['warn', 'properties'],
|
|
|
|
'no-restricted-syntax': [
|
|
'warn',
|
|
{
|
|
// forbid React.* as they are legacy https://twitter.com/dan_abramov/status/1308739731551858689
|
|
selector:
|
|
":matches(MemberExpression[object.name='React'], TSQualifiedName[left.name='React'])",
|
|
message:
|
|
'Using default React import is discouraged, please use named exports directly instead.',
|
|
},
|
|
{
|
|
// forbid <a> in favor of <Link>
|
|
selector: 'JSXOpeningElement[name.name="a"]',
|
|
message: 'Using <a> is discouraged, please use <Link> instead.',
|
|
},
|
|
],
|
|
|
|
'@typescript-eslint/ban-ts-comment': [
|
|
'error',
|
|
{
|
|
'ts-ignore': 'allow-with-description',
|
|
},
|
|
],
|
|
|
|
// Rules disabled during TS migration
|
|
'@typescript-eslint/no-var-requires': 'off',
|
|
'prefer-const': 'warn',
|
|
'prefer-spread': 'off',
|
|
'@typescript-eslint/no-empty-function': 'off',
|
|
'@typescript-eslint/no-require-imports': 'off',
|
|
},
|
|
},
|
|
{
|
|
files: ['**/*.{ts,tsx}'],
|
|
|
|
languageOptions: {
|
|
parser: tsParser,
|
|
ecmaVersion: 2018,
|
|
sourceType: 'module',
|
|
|
|
parserOptions: {
|
|
projectService: true,
|
|
ecmaFeatures: {
|
|
jsx: true,
|
|
},
|
|
|
|
// typescript-eslint specific options
|
|
warnOnUnsupportedTypeScriptVersion: true,
|
|
},
|
|
},
|
|
|
|
// If adding a typescript-eslint version of an existing ESLint rule,
|
|
// make sure to disable the ESLint rule here.
|
|
rules: {
|
|
// TypeScript's `noFallthroughCasesInSwitch` option is more robust (#6906)
|
|
'default-case': 'off',
|
|
// 'tsc' already handles this (https://github.com/typescript-eslint/typescript-eslint/issues/291)
|
|
'no-dupe-class-members': 'off',
|
|
// 'tsc' already handles this (https://github.com/typescript-eslint/typescript-eslint/issues/477)
|
|
'no-undef': 'off',
|
|
|
|
// Add TypeScript specific rules (and turn off ESLint equivalents)
|
|
'@typescript-eslint/consistent-type-assertions': 'warn',
|
|
'no-array-constructor': 'off',
|
|
'@typescript-eslint/no-array-constructor': 'warn',
|
|
'no-use-before-define': 'off',
|
|
|
|
'@typescript-eslint/no-use-before-define': [
|
|
'warn',
|
|
{
|
|
functions: false,
|
|
classes: false,
|
|
variables: false,
|
|
typedefs: false,
|
|
},
|
|
],
|
|
|
|
'no-unused-expressions': 'off',
|
|
|
|
'@typescript-eslint/no-unused-expressions': [
|
|
'error',
|
|
{
|
|
allowShortCircuit: true,
|
|
allowTernary: true,
|
|
allowTaggedTemplates: true,
|
|
},
|
|
],
|
|
|
|
'no-useless-constructor': 'off',
|
|
'@typescript-eslint/no-useless-constructor': 'warn',
|
|
},
|
|
},
|
|
{
|
|
files: ['packages/desktop-client/**/*.{js,ts,jsx,tsx}'],
|
|
plugins: {
|
|
'typescript-paths': pluginTypescriptPaths,
|
|
},
|
|
rules: {
|
|
'typescript-paths/absolute-parent-import': [
|
|
'error',
|
|
{ preferPathOverBaseUrl: true },
|
|
],
|
|
'typescript-paths/absolute-import': ['error', { enableAlias: false }],
|
|
},
|
|
},
|
|
{
|
|
files: [
|
|
'packages/desktop-client/**/*.{ts,tsx}',
|
|
'packages/loot-core/src/client/**/*.{ts,tsx}',
|
|
],
|
|
rules: {
|
|
// enforce import type
|
|
'@typescript-eslint/consistent-type-imports': [
|
|
'warn',
|
|
{
|
|
prefer: 'type-imports',
|
|
fixStyle: 'inline-type-imports',
|
|
},
|
|
],
|
|
|
|
'@typescript-eslint/no-restricted-types': [
|
|
'warn',
|
|
{
|
|
types: {
|
|
// forbid FC as superfluous
|
|
FunctionComponent: {
|
|
message:
|
|
'Type the props argument and let TS infer or use ComponentType for a component prop',
|
|
},
|
|
|
|
FC: {
|
|
message:
|
|
'Type the props argument and let TS infer or use ComponentType for a component prop',
|
|
},
|
|
},
|
|
},
|
|
],
|
|
},
|
|
},
|
|
{
|
|
files: [
|
|
'eslint.config.mjs',
|
|
'**/*.test.js',
|
|
'**/*.test.ts',
|
|
'**/*.test.jsx',
|
|
'**/*.test.tsx',
|
|
'**/*.spec.js',
|
|
],
|
|
|
|
rules: {
|
|
'actual/typography': 'off',
|
|
'actual/no-untranslated-strings': 'off',
|
|
'actual/prefer-logger-over-console': 'off',
|
|
},
|
|
},
|
|
{
|
|
files: ['packages/docs/**/*'],
|
|
rules: {
|
|
'actual/typography': 'off',
|
|
'actual/no-untranslated-strings': 'off',
|
|
'no-restricted-syntax': 'off',
|
|
},
|
|
},
|
|
{
|
|
files: [
|
|
'packages/desktop-client/**/*.{ts,tsx}',
|
|
'packages/loot-core/src/client/**/*.{ts,tsx}',
|
|
],
|
|
ignores: ['**/**/globals.d.ts'],
|
|
rules: {
|
|
// enforce type over interface
|
|
'@typescript-eslint/consistent-type-definitions': ['warn', 'type'],
|
|
},
|
|
},
|
|
{
|
|
files: ['packages/sync-server/**/*'],
|
|
// TODO: fix the issues in these files
|
|
rules: {
|
|
'actual/typography': 'off',
|
|
},
|
|
},
|
|
// Disable ESLint rules that are already covered by oxlint
|
|
// This must be at the end to override previous rule configurations
|
|
...oxlint.configs['flat/recommended'],
|
|
);
|