notebook-navigator/eslint.config.mjs at main · johansan/notebook-navigator · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
import js from '@eslint/js';
import tseslint from 'typescript-eslint';
import obsidianmd from 'eslint-plugin-obsidianmd';
import react from 'eslint-plugin-react';
import reactHooks from 'eslint-plugin-react-hooks';
import { fixupPluginRules } from '@eslint/compat';
import globals from 'globals';

export default tseslint.config(
    {
        ignores: ['node_modules/**', 'dist/**', 'build/**', 'main.js', '*.min.js', 'web/**', 'codemods/**', 'tests/api-test-suite.js'],
        linterOptions: {
            reportUnusedDisableDirectives: 'error'
        }
    },
    js.configs.recommended,
    ...tseslint.configs.recommended,
    ...obsidianmd.configs.recommended,
    {
        files: ['tests/**/*.{ts,tsx}'],
        languageOptions: {
            globals: {
                ...globals.node
            },
            parserOptions: {
                project: './tsconfig.json'
            }
        },
        rules: {
            // Tests may legitimately use Node built-ins (e.g. reading fixture files).
            // Keep this rule enabled for `src/**` to avoid shipping Node-only imports in the plugin runtime.
            'import/no-nodejs-modules': 'off',
            'no-restricted-properties': [
                'error',
                {
                    object: 'describe',
                    property: 'only',
                    message: 'Do not commit describe.only()'
                },
                {
                    object: 'it',
                    property: 'only',
                    message: 'Do not commit it.only()'
                },
                {
                    object: 'test',
                    property: 'only',
                    message: 'Do not commit test.only()'
                }
            ]
        }
    },
    {
        files: ['src/**/*.{ts,tsx}'],
        languageOptions: {
            ecmaVersion: 2020,
            sourceType: 'module',
            globals: {
                ...globals.browser,
                ...globals.node,
                React: 'readonly'
            },
            parserOptions: {
                ecmaFeatures: {
                    jsx: true
                },
                project: './tsconfig.json'
            }
        },
        plugins: {
            react: fixupPluginRules(react),
            'react-hooks': fixupPluginRules(reactHooks),
            obsidianmd: obsidianmd
        },
        settings: {
            react: {
                version: 'detect'
            }
        },
        rules: {
            '@typescript-eslint/no-explicit-any': 'error',
            '@typescript-eslint/no-unused-vars': 'error',
            '@typescript-eslint/explicit-module-boundary-types': 'off',
            '@typescript-eslint/no-non-null-assertion': 'warn',
            'react/react-in-jsx-scope': 'off',
            'react/prop-types': 'off',
            'react-hooks/rules-of-hooks': 'error',
            'react-hooks/exhaustive-deps': 'warn',
            'no-console': 'off',
            'no-debugger': 'error',
            'prefer-const': 'error',
            'no-var': 'error',
            'no-restricted-syntax': [
                'error',
                {
                    selector: "NewExpression[callee.name='Notice']",
                    message: 'Use showNotice(...) instead of new Notice(...).'
                }
            ],
            // Upgrade obsidianmd rules from warn to error
            'obsidianmd/prefer-file-manager-trash-file': 'error',

            // Type assertions
            '@typescript-eslint/no-unnecessary-type-assertion': 'warn',
            '@typescript-eslint/prefer-as-const': 'warn',

            // Code style
            eqeqeq: ['error', 'always'], // Require === and !== instead of == and !=
            'prefer-template': 'warn', // Use template literals instead of string concatenation
            '@typescript-eslint/array-type': ['warn', { default: 'array' }], // Prefer T[] over Array<T>
            'prefer-object-spread': 'warn', // Use {...obj} instead of Object.assign()
            curly: ['warn', 'multi-line'], // Require curly braces for multi-line blocks
            'no-else-return': 'warn', // Remove unnecessary else after return
            'obsidianmd/ui/sentence-case': [
                'warn',
                {
                    acronyms: ['RRGGBB', 'RRGGBBAA']
                }
            ]
        }
    },
    {
        files: ['src/utils/noticeUtils.ts'],
        rules: {
            'no-restricted-syntax': 'off'
        }
    }
);