eslint.config.js

// eslint-disable-next-line @eslint-community/eslint-comments/disable-enable-pair
/* eslint-disable @cspell/spellchecker, @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access */
import eslintCspell from '@cspell/eslint-plugin/recommended';
import eslint from '@eslint/js';
import eslintPluginEslintComments from '@eslint-community/eslint-plugin-eslint-comments/configs';
import eslintConfigLove from 'eslint-config-love';
import eslintPluginJsdoc from 'eslint-plugin-jsdoc';
import eslintPluginNoSecrets from 'eslint-plugin-no-secrets';
import eslintPluginNoUnsanitized from 'eslint-plugin-no-unsanitized';
import * as eslintPluginRegexp from 'eslint-plugin-regexp';
import eslintPluginSecurity from 'eslint-plugin-security';
import eslintPluginSonarJs from 'eslint-plugin-sonarjs';
import eslintPluginUnicorn from 'eslint-plugin-unicorn';
// import * as eslintPluginWoke from 'eslint-plugin-woke'
import * as eslintPluginWriteGoodComments from 'eslint-plugin-write-good-comments';
import tseslint from 'typescript-eslint';
import cspellFlagWords from './lists/cspell.flagWords.js';
import cspellWords from './lists/cspell.words.js';
import noMagicNumbers, { httpErrors } from './lists/noMagicNumbers.ignore.js';
import writeGoodCommentsWhitelist from './lists/writeGoodComments.whitelist.js';
export const config = tseslint.config(eslint.configs.recommended, ...tseslint.configs.recommendedTypeChecked, ...tseslint.configs.stylisticTypeChecked, eslintCspell, eslintPluginEslintComments.recommended, eslintPluginJsdoc.configs['flat/recommended-typescript'], eslintPluginRegexp.configs['flat/recommended'], eslintPluginSecurity.configs.recommended, eslintPluginSonarJs.configs.recommended, eslintPluginUnicorn.configs['flat/recommended'], eslintConfigLove, {
    files: ['**/*.ts', '**/*.js'],
    ignores: ['**/*.d.ts'],
    languageOptions: {
        parserOptions: {
            ecmaFeatures: { modules: true },
            ecmaVersion: 2022,
            project: true,
            sourceType: 'module'
        }
    },
    plugins: {
        'no-secrets': eslintPluginNoSecrets,
        // woke: eslintPluginWoke,
        'write-good-comments': eslintPluginWriteGoodComments
    },
    rules: {
        '@cspell/spellchecker': [
            'warn',
            {
                cspell: {
                    language: 'en-CA,en-US,en-GB',
                    flagWords: cspellFlagWords,
                    words: cspellWords
                }
            }
        ],
        '@typescript-eslint/init-declarations': 'warn',
        '@typescript-eslint/no-non-null-assertion': 'warn',
        '@typescript-eslint/no-magic-numbers': [
            'warn',
            {
                ignore: noMagicNumbers
            }
        ],
        '@typescript-eslint/no-misused-promises': 'warn',
        '@typescript-eslint/no-unnecessary-type-assertion': 'off',
        '@typescript-eslint/no-unsafe-assignment': 'warn',
        '@typescript-eslint/no-unsafe-argument': 'warn',
        '@typescript-eslint/no-unsafe-call': 'warn',
        '@typescript-eslint/no-unsafe-member-access': 'warn',
        '@typescript-eslint/no-unsafe-type-assertion': 'warn',
        '@typescript-eslint/non-nullable-type-assertion-style': 'off',
        '@typescript-eslint/prefer-destructuring': 'off',
        '@typescript-eslint/restrict-plus-operands': 'warn',
        '@typescript-eslint/space-before-function-paren': 'off',
        '@typescript-eslint/strict-boolean-expressions': 'warn',
        complexity: [
            'warn',
            {
                max: 20
            }
        ],
        'eslint-comments/require-description': 'off',
        'import/order': [
            'error',
            {
                'newlines-between': 'always',
                alphabetize: {
                    order: 'asc',
                    orderImportKind: 'asc'
                }
            }
        ],
        'jsdoc/require-jsdoc': ['warn', { publicOnly: true }],
        'n/no-missing-import': 'off',
        'no-extra-semi': 'off',
        'no-secrets/no-secrets': 'error',
        // checked by "complexity"
        'sonarjs/cognitive-complexity': 'off',
        'sonarjs/no-duplicate-string': 'warn',
        // checked by "@typescript-eslint/no-redundant-type-constituents"
        'sonarjs/no-redundant-type-constituents': 'off',
        // checked by "no-useless-escape"
        'regexp/no-useless-escape': 'off',
        'sonarjs/unnecessary-character-escapes': 'off',
        // checked by "regexp/no-dupe-characters-character-class"
        'sonarjs/duplicates-in-character-class': 'off',
        // checked by "@typescript-eslint/no-misused-promises"
        'sonarjs/no-misused-promises': 'off',
        'sort-imports': [
            'error',
            {
                ignoreDeclarationSort: true
            }
        ],
        'unicorn/consistent-function-scoping': 'warn',
        'unicorn/empty-brace-spaces': 'off',
        'unicorn/filename-case': [
            'error',
            {
                case: 'camelCase',
                ignore: ['DB', 'URL']
            }
        ],
        'unicorn/prevent-abbreviations': [
            'error',
            {
                replacements: {
                    def: {
                        definition: true
                    },
                    ele: {
                        element: true
                    },
                    eles: {
                        elements: true
                    },
                    fns: {
                        functions: true
                    },
                    res: {
                        result: false
                    },
                    temp: {
                        temporary: false
                    }
                }
            }
        ],
        // 'woke/all': 'error',
        'write-good-comments/write-good-comments': [
            'warn',
            {
                passive: false,
                whitelist: writeGoodCommentsWhitelist
            }
        ]
    }
});
export const configWebApp = tseslint.config(...config, {
    files: ['**/*.ts', '**/*.js'],
    ignores: ['**/*.d.ts'],
    plugins: {
        'no-unsanitized': eslintPluginNoUnsanitized
    },
    rules: {
        '@typescript-eslint/no-magic-numbers': [
            'warn',
            {
                ignore: [...noMagicNumbers, ...httpErrors]
            }
        ],
        'jsdoc/require-jsdoc': 'off',
        'no-unsanitized/method': [
            'error',
            {
                escape: {
                    methods: ['cityssm.escapeHTML']
                }
            }
        ],
        'no-unsanitized/property': [
            'error',
            {
                escape: {
                    methods: ['cityssm.escapeHTML']
                }
            }
        ]
    }
});
export { default as tseslint } from 'typescript-eslint';
export { default as cspellFlagWords } from './lists/cspell.flagWords.js';
export { default as cspellWords } from './lists/cspell.words.js';
export { default as writeGoodCommentsWhitelist } from './lists/writeGoodComments.whitelist.js';
export { default as noMagicNumbersIgnore, httpErrors as noMagicNumbersHttpErrors } from './lists/noMagicNumbers.ignore.js';
export default config;