jellyfin-vue/frontend/.eslintrc.js

// eslint-disable-next-line @typescript-eslint/no-var-requires -- The ESLint config expects Node modules
var restrictedGlobals = require('confusing-browser-globals');

module.exports = {
  root: false,
  env: {
    node: false,
    browser: true
  },
  parser: 'vue-eslint-parser',
  parserOptions: {
    parser: '@typescript-eslint/parser',
    sourceType: 'module'
  },
  globals: {
    __COMMIT_HASH__: 'readonly'
  },
  ignorePatterns: [
    '.eslintrc.js',
    '*.config.js',
    'types/global/routes.d.ts',
    'types/global/components.d.ts'
  ],
  extends: [
    'eslint:recommended',
    'plugin:jsonc/recommended-with-json',
    'plugin:jsonc/prettier',
    'plugin:no-unsanitized/DOM',
    'plugin:optimize-regex/recommended',
    'plugin:no-use-extend-native/recommended',
    'plugin:@typescript-eslint/recommended',
    'plugin:promise/recommended',
    'plugin:import/recommended',
    'plugin:import/typescript',
    'plugin:vue/vue3-recommended',
    'plugin:sonarjs/recommended',
    'plugin:eslint-comments/recommended',
    'plugin:css/recommended',
    'plugin:unicorn/recommended',
    'plugin:you-dont-need-lodash-underscore/compatible',
    'plugin:prettier/recommended'
  ],
  plugins: [
    'jsdoc',
    'jsonc',
    'no-unsanitized',
    'optimize-regex',
    'no-secrets',
    'no-use-extend-native',
    '@typescript-eslint',
    'promise',
    'import',
    'vue',
    'prettier',
    'sonarjs',
    'eslint-comments',
    'css',
    'unicorn',
    'you-dont-need-lodash-underscore',
    'file-progress'
  ],
  rules: {
    'file-progress/activate': 1,
    'no-restricted-globals': ['error'].concat(restrictedGlobals),
    'no-empty': ['error', { allowEmptyCatch: true }],
    'no-secrets/no-secrets': 'error',
    'import/newline-after-import': 'error',
    'import/order': 'error',
    'import/no-unresolved': ['error', { ignore: ['virtual:*'] }],
    'import/no-extraneous-dependencies': [
      'error',
      {
        devDependencies: ['vite.config.ts'],
        optionalDependencies: false,
        peerDependencies: false,
        bundledDependencies: false
      }
    ],
    'import/no-nodejs-modules': 'error',
    'no-restricted-imports': [
      'error',
      {
        patterns: [
          {
            group: ['*/plugins*'],
            message:
              'Do not use Vue plugins directly. Use composables (from @/composables) instead.'
          },
          {
            group: ['*/main*'],
            message:
              'Do not use the Vue instance directly. Use composables (from @/composables) instead.'
          }
        ]
      }
    ],
    'jsdoc/require-hyphen-before-param-description': 'error',
    'jsdoc/require-description': 'error',
    'jsdoc/no-types': 'error',
    'jsdoc/require-jsdoc': 'error',
    'promise/no-nesting': 'error',
    'promise/no-return-in-finally': 'error',
    'promise/prefer-await-to-callbacks': 'error',
    'promise/prefer-await-to-then': 'error',
    '@typescript-eslint/ban-ts-comment': [
      'error',
      {
        'ts-expect-error': true,
        'ts-ignore': true,
        'ts-nocheck': true,
        'ts-check': true
      }
    ],
    '@typescript-eslint/explicit-function-return-type': 'error',
    '@typescript-eslint/prefer-ts-expect-error': 'error',
    '@typescript-eslint/explicit-member-accessibility': 'error',
    'prefer-arrow-callback': 'error',
    'padding-line-between-statements': [
      'error',
      // Always require blank lines after directives (like 'use-strict'), except between directives
      { blankLine: 'always', prev: 'directive', next: '*' },
      { blankLine: 'any', prev: 'directive', next: 'directive' },
      // Always require blank lines after import, except between imports
      { blankLine: 'always', prev: 'import', next: '*' },
      { blankLine: 'any', prev: 'import', next: 'import' },
      // Always require blank lines before and after every sequence of variable declarations and export
      {
        blankLine: 'always',
        prev: '*',
        next: ['const', 'let', 'var', 'export']
      },
      {
        blankLine: 'always',
        prev: ['const', 'let', 'var', 'export'],
        next: '*'
      },
      {
        blankLine: 'any',
        prev: ['const', 'let', 'var', 'export'],
        next: ['const', 'let', 'var', 'export']
      },
      // Always require blank lines before and after class declaration, if, do/while, switch, try
      {
        blankLine: 'always',
        prev: '*',
        next: ['if', 'class', 'for', 'do', 'while', 'switch', 'try']
      },
      {
        blankLine: 'always',
        prev: ['if', 'class', 'for', 'do', 'while', 'switch', 'try'],
        next: '*'
      },
      // Always require blank lines before return statements
      { blankLine: 'always', prev: '*', next: 'return' }
    ],
    'you-dont-need-lodash-underscore/is-nil': 'off',
    // Force some component order stuff, formatting and such, for consistency
    curly: ['error', 'all'],
    'vue/component-name-in-template-casing': [
      'error',
      'kebab-case',
      {
        ignores: []
      }
    ],
    'vue/no-unused-refs': 'error',
    'vue/html-self-closing': [
      'error',
      {
        html: {
          void: 'always'
        }
      }
    ],
    'vue/html-closing-bracket-newline': ['error', { multiline: 'never' }],
    'vue/multiline-html-element-content-newline': 'error',
    'vue/multi-word-component-names': 'off',
    'vue/return-in-computed-property': 'off',
    'unicorn/filename-case': 'off',
    'unicorn/consistent-function-scoping': 'off',
    'unicorn/prevent-abbreviations': 'off',
    'unicorn/no-await-expression-member': 'off',
    'eslint-comments/no-unused-disable': 'error',
    'no-multiple-empty-lines': 'error'
  },
  settings: {
    'import/resolver': {
      typescript: true,
      node: true
    },
    settings: {
      progress: {
        hide: false,
        successMessage: 'Linting done!'
      }
    }
  }
};