@fluentui/eslint-plugin/src/configs/react-northstar.js

ESLint configuration and custom rules for Fluent UI

module.exports = {
  extends: [
    'airbnb',
    // Extended configs are applied in order, so these configs that turn other rules off should come last
    'prettier',
    'plugin:@typescript-eslint/eslint-recommended', // disable some rules not needed for TS
  ],
  parser: '@typescript-eslint/parser',
  plugins: ['@typescript-eslint', 'jest', 'import', 'react-hooks', '@fluentui'],
  env: {
    browser: true,
    'jest/globals': true,
  },
  // matched relative to cwd
  ignorePatterns: ['coverage', 'dist', 'etc', 'lib', 'lib-commonjs', 'node_modules', 'temp'],
  rules: {
    '@fluentui/no-global-react': 'error',
    '@fluentui/no-tslint-comments': 'error',

    'react-hooks/exhaustive-deps': 'error',
    'react-hooks/rules-of-hooks': 'error',

    'import/no-default-export': 'error',
    'import/no-extraneous-dependencies': [
      'error',
      { devDependencies: ['**/*-test.ts*', '**/*.test.ts*', '*.config.js', 'gulpfile.ts', 'just.config.ts'] },
    ],

    // False positive on arg types:
    // https://github.com/typescript-eslint/typescript-eslint/issues/46
    '@typescript-eslint/no-unused-vars': ['error', { args: 'none', ignoreRestSiblings: true }],

    'react/jsx-filename-extension': ['error', { extensions: ['.js', '.tsx'] }],

    'import/no-unresolved': 'off',
    'no-shadow': 'off', // https://github.com/microsoft/fluent-ui-react/pull/1261#pullrequestreview-231005092
    'no-unused-vars': 'off', // we use @typescript-eslint/no-unused-vars instead
    // TODO: investigate and re-enable where appropriate
    'import/extensions': 'off',

    // Temporary disabled rules
    'jsx-a11y/alt-text': 'off',
    'jsx-a11y/anchor-is-valid': 'off',
    'jsx-a11y/click-events-have-key-events': 'off',
    'jsx-a11y/control-has-associated-label': 'off',
    'jsx-a11y/label-has-associated-control': 'off',
    'jsx-a11y/label-has-for': 'off',
    'jsx-a11y/no-noninteractive-tabindex': 'off',
    'jsx-a11y/no-static-element-interactions': 'off',
    'import/export': 'off',
    'import/first': 'off',
    'import/no-dynamic-require': 'off',
    'import/no-named-default': 'off',
    'import/no-useless-path-segments': 'off',
    'import/order': 'off',
    'import/prefer-default-export': 'off',
    'react/button-has-type': 'off',
    'react/default-props-match-prop-types': 'off',
    'react/destructuring-assignment': 'off',
    'react/forbid-foreign-prop-types': 'off',
    'react/forbid-prop-types': 'off',
    'react/jsx-boolean-value': 'off',
    'react/jsx-curly-brace-presence': 'off',
    'react/jsx-no-bind': 'off',
    'react/jsx-props-no-spreading': 'off',
    'react/jsx-no-target-blank': 'off',
    'react/jsx-pascal-case': 'off',
    'react/no-access-state-in-setstate': 'off',
    'react/no-array-index-key': 'off',
    'react/no-children-prop': 'off',
    'react/no-find-dom-node': 'off',
    'react/no-multi-comp': 'off',
    'react/no-render-return-value': 'off',
    'react/no-string-refs': 'off',
    'react/no-unescaped-entities': 'off',
    'react/no-unused-prop-types': 'off',
    'react/no-unused-state': 'off',
    'react/prefer-stateless-function': 'off',
    'react/prop-types': 'off',
    'react/require-default-props': 'off',
    'react/sort-comp': 'off',
    'react/state-in-constructor': 'off',
    'react/static-property-placement': 'off',
    'arrow-body-style': 'off',
    camelcase: 'off',
    'class-methods-use-this': 'off',
    'consistent-return': 'off',
    'default-case': 'off',
    'dot-notation': 'off',
    'global-require': 'off',
    'guard-for-in': 'off',
    'lines-between-class-members': 'off',
    'max-classes-per-file': 'off',
    'no-await-in-loop': 'off',
    'no-bitwise': 'off',
    'no-case-declarations': 'off',
    'no-continue': 'off',
    'no-empty-function': 'off',
    'no-empty': 'off',
    'no-extra-boolean-cast': 'off',
    'no-fallthrough': 'off',
    'no-nested-ternary': 'off',
    'no-param-reassign': 'off',
    'no-plusplus': 'off',
    'no-prototype-builtins': 'off',
    'no-restricted-globals': 'off',
    'no-restricted-properties': ['off', { object: 'Math', property: 'pow' }],
    'no-restricted-syntax': 'off',
    'no-return-assign': 'off',
    'no-return-await': 'off',
    'no-sparse-arrays': 'off',
    'no-throw-literal': 'off',
    'no-undef-init': 'off',
    'no-undef': 'off',
    'no-underscore-dangle': 'off',
    'no-unused-expressions': 'off',
    'no-use-before-define': 'off',
    'no-useless-constructor': 'off',
    'no-useless-escape': 'off',
    'no-useless-return': 'off',
    'operator-assignment': 'off',
    'prefer-destructuring': 'off',
  },
  overrides: [
    {
      files: '**/jest.config.js',
      rules: {
        'global-require': 'off',
      },
    },
    {
      files: '**/test/**/*.{ts,tsx}',
      rules: {
        'import/no-extraneous-dependencies': 'off',
      },
    },
    {
      files: '**/examples/**/*.{ts,tsx}',
      rules: {
        'import/no-default-export': 'off',
      },
    },
    {
      files: '**/*.tsx',
      rules: {
        '@fluentui/no-visibility-modifiers': 'error',
      },
    },
    {
      files: '**/*.{ts,tsx}',
      rules: {
        'no-dupe-class-members': 'off',
      },
    },
  ],
  settings: {
    'import/resolver': {
      node: {
        extensions: ['.js', '.jsx', '.ts', '.tsx'],
      },
    },
  },
};