const { join } = require('node:path'); const createPattern = packageName => [ { group: ['**/dist', '**/dist/**'], message: 'Do not import from dist', allowTypeImports: false, }, { group: ['**/src', '**/src/**'], message: 'Do not import from src', allowTypeImports: false, }, { group: [`@affine/${packageName}`], message: 'Do not import package itself', allowTypeImports: false, }, { group: [`@toeverything/${packageName}`], message: 'Do not import package itself', allowTypeImports: false, }, { group: ['@blocksuite/store'], message: "Import from '@blocksuite/global/utils'", importNames: ['assertExists', 'assertEquals'], }, { group: ['react-router-dom'], message: 'Use `useNavigateHelper` instead', importNames: ['useNavigate'], }, { group: ['@affine/env/constant'], message: 'Do not import from @affine/env/constant. Use `environment.isDesktop` instead', importNames: ['isDesktop'], }, ]; const allPackages = [ 'packages/backend/server', 'packages/frontend/component', 'packages/frontend/core', 'packages/frontend/electron', 'packages/frontend/graphql', 'packages/frontend/i18n', 'packages/frontend/native', 'packages/frontend/templates', 'packages/common/debug', 'packages/common/env', 'packages/common/infra', 'packages/common/theme', 'packages/common/y-indexeddb', 'tools/cli', ]; /** * @type {import('eslint').Linter.Config} */ const config = { root: true, settings: { react: { version: 'detect', }, next: { rootDir: 'packages/frontend/core', }, }, extends: [ 'eslint:recommended', 'plugin:react-hooks/recommended', 'plugin:react/recommended', 'plugin:react/jsx-runtime', 'plugin:@typescript-eslint/recommended', 'prettier', ], parser: '@typescript-eslint/parser', parserOptions: { ecmaFeatures: { globalReturn: false, impliedStrict: true, jsx: true, }, ecmaVersion: 'latest', sourceType: 'module', project: join(__dirname, 'tsconfig.eslint.json'), }, plugins: [ 'react', '@typescript-eslint', 'simple-import-sort', 'sonarjs', 'import-x', 'unused-imports', 'unicorn', 'rxjs', ], rules: { 'array-callback-return': 'error', 'no-undef': 'off', 'no-empty': 'off', 'no-func-assign': 'off', 'no-cond-assign': 'off', 'no-constant-binary-expression': 'error', 'no-constructor-return': 'error', 'no-self-compare': 'error', eqeqeq: ['error', 'always', { null: 'ignore' }], 'react/prop-types': 'off', 'react/jsx-no-useless-fragment': 'error', '@typescript-eslint/consistent-type-imports': 'error', '@typescript-eslint/no-non-null-assertion': 'error', '@typescript-eslint/no-explicit-any': 'off', '@typescript-eslint/no-empty-function': 'off', '@typescript-eslint/await-thenable': 'error', '@typescript-eslint/require-array-sort-compare': 'error', '@typescript-eslint/unified-signatures': 'error', '@typescript-eslint/prefer-for-of': 'error', '@typescript-eslint/no-unused-vars': [ 'error', { varsIgnorePattern: '^_', argsIgnorePattern: '^_', caughtErrorsIgnorePattern: '^_', }, ], 'unused-imports/no-unused-imports': 'error', 'simple-import-sort/imports': 'error', 'simple-import-sort/exports': 'error', 'import-x/no-duplicates': 'error', '@typescript-eslint/ban-ts-comment': [ 'error', { 'ts-expect-error': 'allow-with-description', 'ts-ignore': true, 'ts-nocheck': true, 'ts-check': false, }, ], '@typescript-eslint/no-restricted-imports': [ 'error', { patterns: [ { group: ['**/dist'], message: "Don't import from dist", allowTypeImports: false, }, { group: ['**/src'], message: "Don't import from src", allowTypeImports: false, }, { group: ['@blocksuite/store'], message: "Import from '@blocksuite/global/utils'", importNames: ['assertExists', 'assertEquals'], }, { group: ['react-router-dom'], message: 'Use `useNavigateHelper` instead', importNames: ['useNavigate'], }, ], }, ], 'unicorn/filename-case': [ 'error', { case: 'kebabCase', ignore: ['^\\[[a-zA-Z0-9-_]+\\]\\.tsx$'], }, ], 'unicorn/no-unnecessary-await': 'error', 'unicorn/no-useless-fallback-in-spread': 'error', 'unicorn/prefer-dom-node-dataset': 'error', 'unicorn/prefer-dom-node-append': 'error', 'unicorn/prefer-dom-node-remove': 'error', 'unicorn/prefer-array-some': 'error', 'unicorn/prefer-date-now': 'error', 'unicorn/prefer-blob-reading-methods': 'error', 'unicorn/no-typeof-undefined': 'error', 'unicorn/no-useless-promise-resolve-reject': 'error', 'unicorn/no-new-array': 'error', 'unicorn/new-for-builtins': 'error', 'unicorn/prefer-node-protocol': 'error', 'sonarjs/no-all-duplicated-branches': 'error', 'sonarjs/no-element-overwrite': 'error', 'sonarjs/no-empty-collection': 'error', 'sonarjs/no-extra-arguments': 'error', 'sonarjs/no-identical-conditions': 'error', 'sonarjs/no-identical-expressions': 'error', 'sonarjs/no-ignored-return': 'error', 'sonarjs/no-one-iteration-loop': 'error', 'sonarjs/no-use-of-empty-return-value': 'error', 'sonarjs/non-existent-operator': 'error', 'sonarjs/no-collapsible-if': 'error', 'sonarjs/no-same-line-conditional': 'error', 'sonarjs/no-duplicated-branches': 'error', 'sonarjs/no-collection-size-mischeck': 'error', 'sonarjs/no-useless-catch': 'error', 'sonarjs/no-identical-functions': 'error', 'rxjs/finnish': [ 'error', { functions: false, methods: false, strict: true, types: { '^LiveData$': true, // some yjs classes are Observables, but they don't need to be in Finnish notation '^Doc$': false, // yjs Doc '^Awareness$': false, // yjs Awareness '^UndoManager$': false, // yjs UndoManager }, }, ], }, overrides: [ { files: 'packages/backend/server/**/*.ts', rules: { '@typescript-eslint/consistent-type-imports': 0, }, }, { files: '*.cjs', rules: { '@typescript-eslint/no-var-requires': 0, }, }, ...allPackages.map(pkg => ({ files: [`${pkg}/src/**/*.ts`, `${pkg}/src/**/*.tsx`, `${pkg}/**/*.mjs`], rules: { '@typescript-eslint/no-restricted-imports': [ 'error', { patterns: createPattern(pkg), }, ], '@typescript-eslint/no-floating-promises': [ 'error', { ignoreVoid: false, ignoreIIFE: false, }, ], '@typescript-eslint/no-misused-promises': ['error'], '@typescript-eslint/prefer-readonly': 'error', 'import-x/no-extraneous-dependencies': ['error'], 'react-hooks/exhaustive-deps': [ 'warn', { additionalHooks: 'useAsyncCallback', }, ], }, })), { files: [ '**/__tests__/**/*', '**/*.stories.tsx', '**/*.spec.ts', '**/tests/**/*', 'scripts/**/*', '**/benchmark/**/*', '**/__debug__/**/*', '**/e2e/**/*', ], rules: { '@typescript-eslint/no-non-null-assertion': 0, '@typescript-eslint/ban-ts-comment': [ 'error', { 'ts-expect-error': false, 'ts-ignore': true, 'ts-nocheck': true, 'ts-check': false, }, ], '@typescript-eslint/no-floating-promises': 0, '@typescript-eslint/no-misused-promises': 0, '@typescript-eslint/no-restricted-imports': 0, }, }, ], }; module.exports = config;