.eslintrc.js

/**
 * Copyright (c) 2015-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the license found in the LICENSE file in
 * the root directory of this source tree.
 *
 * @noflow
 */
'use strict';

/* eslint
  comma-dangle: [1, always-multiline],
  prefer-object-spread/prefer-object-spread: 0,
  rulesdir/no-commonjs: 0,
  */
/* eslint-disable max-len */

module.exports = {
  root: true,

  parser: 'babel-eslint',

  parserOptions: {
    ecmaVersion: 7,
    sourceType: 'module',
    ecmaFeatures: {
      globalReturn: true,
      jsx: true,
      experimentalObjectRestSpread: true,
    },
  },

  // https://github.com/sindresorhus/globals/blob/master/globals.json
  env: {
    atomtest: true,
    es6: true,
    jasmine: true,
    jest: true,
    node: true,
  },

  extends: ['plugin:jsx-a11y/recommended'],

  globals: {
    atom: false,
    document: false,
    window: false,
  },

  rules: {
    // Possible Errors (http://eslint.org/docs/rules/#possible-errors)
    'no-await-in-loop': 1,
    'no-cond-assign': 1,
    'no-console': 1,
    'no-constant-condition': [1, {checkLoops: false}],
    'no-control-regex': 1,
    'no-debugger': 1,
    'no-dupe-args': 1,
    'no-dupe-keys': 1,
    'no-duplicate-case': 1,
    'no-empty-character-class': 1,
    'no-empty': [1, {allowEmptyCatch: true}],
    'no-ex-assign': 1,
    'no-extra-boolean-cast': 0, // Flow actually requires us to cast to avoid sketchy null checks.
    'no-extra-parens': 0,
    'no-extra-semi': 1,
    'no-func-assign': 1,
    'no-inner-declarations': 1,
    'no-invalid-regexp': 1,
    'no-irregular-whitespace': 1,
    'no-obj-calls': 1,
    'no-prototype-builtins': 0,
    'no-regex-spaces': 1,
    'no-sparse-arrays': 1,
    'no-template-curly-in-string': 0,
    'no-unexpected-multiline': 1,
    'no-unreachable': 1,
    'no-unsafe-finally': 1,
    'no-unsafe-negation': 1,
    'use-isnan': 1,
    'valid-jsdoc': 0,
    'valid-typeof': 1,

    // Best Practices (http://eslint.org/docs/rules/#best-practices)
    'accessor-pairs': 1,
    'array-callback-return': 0,
    'block-scoped-var': 0,
    'class-methods-use-this': 0,
    complexity: 0,
    'consistent-return': 0,
    curly: 1,
    'default-case': 0,
    'dot-location': [1, 'property'],
    'dot-notation': 1,
    eqeqeq: [1, 'always', {null: 'never'}],
    'getter-return': 2,
    'guard-for-in': 0,
    'no-alert': 0,
    'no-caller': 1,
    'no-case-declarations': 0,
    'no-div-regex': 1,
    'no-else-return': 0,
    'no-empty-function': 0,
    'no-empty-pattern': 1,
    'no-eq-null': 0,
    'no-eval': 1,
    'no-extend-native': 1,
    'no-extra-bind': 1,
    'no-extra-label': 1,
    'no-fallthrough': 1,
    'no-floating-decimal': 1,
    'no-global-assign': 1,
    'no-implicit-coercion': 1,
    'no-implicit-globals': 0,
    'no-implied-eval': 1,
    'no-invalid-this': 0,
    'no-iterator': 1,
    'no-labels': 1,
    'no-lone-blocks': 1,
    'no-loop-func': 0,
    'no-magic-numbers': 0,
    'no-multi-spaces': 1,
    'no-multi-str': 0,
    'no-new-func': 1,
    'no-new-wrappers': 1,
    'no-new': 1,
    'no-octal-escape': 1,
    'no-octal': 1,
    'no-param-reassign': 1,
    'no-proto': 1,
    'no-redeclare': [1, {builtinGlobals: true}],
    'no-restricted-properties': 0,
    'no-return-assign': 1,
    'no-return-await': 1,
    'no-script-url': 1,
    'no-self-assign': 1,
    'no-self-compare': 1,
    'no-sequences': 1,
    'no-throw-literal': 1,
    'no-unmodified-loop-condition': 0,
    'no-unused-expressions': 0,
    'no-unused-labels': 1,
    'no-useless-call': 1,
    'no-useless-concat': 1,
    'no-useless-escape': 1,
    'no-useless-return': 0,
    'no-void': 1,
    'no-warning-comments': 0,
    'no-with': 1,
    'prefer-promise-reject-errors': 1,
    radix: 1,
    'require-await': 0,
    // 'require-await': 1,
    'vars-on-top': 0,
    'wrap-iife': [1, 'inside'],
    yoda: 1,

    // Strict Mode (http://eslint.org/docs/rules/#strict-mode)
    strict: 0,

    // Variables (http://eslint.org/docs/rules/#variables)
    'init-declarations': 0,
    'no-catch-shadow': 1,
    'no-delete-var': 1,
    'no-label-var': 1,
    'no-restricted-globals': 0,
    'no-shadow-restricted-names': 1,
    'no-shadow': 1,
    'no-undef-init': 0,
    'no-undef': 1,
    'no-undefined': 0,
    'no-unused-vars': [1, {args: 'none', ignoreRestSiblings: true}],
    'no-use-before-define': 0,

    // Node.js and CommonJS (http://eslint.org/docs/rules/#nodejs-and-commonjs)
    'callback-return': 0,
    'global-require': 0,
    'handle-callback-err': 1,
    'no-mixed-requires': 1,
    'no-new-require': 1,
    'no-path-concat': 1,
    'no-process-env': 0,
    'no-process-exit': 0,
    'no-restricted-modules': 0,
    'no-sync': 0,

    // Stylistic Issues (http://eslint.org/docs/rules/#stylistic-issues)
    'array-bracket-spacing': 1,
    'block-spacing': 1,
    'brace-style': [1, '1tbs', {allowSingleLine: true}],
    camelcase: 0,
    'capitalized-comments': 0,
    'comma-dangle': 0,
    'comma-spacing': 1,
    'comma-style': 1,
    'computed-property-spacing': 1,
    'consistent-this': 0,
    'eol-last': 1,
    'func-call-spacing': 1,
    'func-name-matching': 0,
    'func-names': 0,
    'func-style': 0,
    'id-blacklist': 0,
    'id-length': 0,
    'id-match': 0,
    // 'indent': [1, 2, {SwitchCase: 1}],
    'jsx-quotes': [1, 'prefer-double'],
    'key-spacing': [1, {beforeColon: false, afterColon: true}],
    'keyword-spacing': 1,
    'line-comment-position': 0,
    'linebreak-style': 1,
    'lines-between-class-members': [1, 'always', { exceptAfterSingleLine: true }],
    'lines-around-comment': 0,
    'lines-around-directive': 0,
    'max-depth': 0,
    // 'max-len': [1, 100, {tabWidth: 2, ignoreUrls: true}],
    'max-lines': 0,
    'max-nested-callbacks': 0,
    'max-params': 0,
    'max-statements-per-line': 0,
    'max-statements': 0,
    'multiline-ternary': 0,
    'new-cap': 0,
    'new-parens': 1,
    'newline-after-var': 0,
    'newline-before-return': 0,
    'newline-per-chained-call': 0,
    'no-array-constructor': 1,
    'no-bitwise': 1,
    'no-continue': 0,
    'no-inline-comments': 0,
    'no-lonely-if': 0,
    'no-mixed-operators': 0,
    'no-mixed-spaces-and-tabs': 1,
    'no-multi-assign': 0,
    'no-multiple-empty-lines': [1, {max: 2, maxBOF: 0, maxEOF: 1}],
    'no-negated-condition': 0,
    'no-nested-ternary': 0,
    'no-new-object': 1,
    'no-plusplus': 0,
    'no-restricted-syntax': 0,
    'no-tabs': 1,
    'no-ternary': 0,
    'no-trailing-spaces': 1,
    'no-underscore-dangle': 0,
    'no-unneeded-ternary': 0,
    'no-whitespace-before-property': 1,
    'object-curly-newline': 0,
    // 'object-curly-spacing': 1,
    'object-property-newline': 0,
    'one-var-declaration-per-line': 0,
    'one-var': [1, 'never'],
    'operator-assignment': 1,
    'operator-linebreak': 0,
    'padded-blocks': [
      1,
      {blocks: 'never', classes: 'never', switches: 'never'},
    ],
    // 'quote-props': [1, 'as-needed'],
    quotes: [1, 'single', 'avoid-escape'],
    'require-jsdoc': 0,
    // 'semi-spacing': 1,
    semi: 1,
    'sort-keys': 0,
    'sort-vars': 0,
    'space-before-blocks': 1,
    'space-before-function-paren': [
      1,
      {anonymous: 'never', named: 'never', asyncArrow: 'always'},
    ],
    'space-in-parens': [1, 'never'],
    'space-infix-ops': 1,
    'space-unary-ops': 1,
    'spaced-comment': [
      1,
      'always',
      {line: {exceptions: ['-']}, block: {balanced: true}},
    ],
    'template-tag-spacing': 1,
    'unicode-bom': [1, 'never'],
    'wrap-regex': 0,

    // ECMAScript 6 (http://eslint.org/docs/rules/#ecmascript-6)
    'arrow-body-style': 0,
    'arrow-parens': [1, 'as-needed'],
    'arrow-spacing': 1,
    'constructor-super': 1,
    // 'generator-star-spacing': 1,
    'no-class-assign': 1,
    'no-confusing-arrow': 0,
    'no-const-assign': 1,
    'no-dupe-class-members': 1,
    'no-duplicate-imports': 0,
    'no-new-symbol': 1,
    'no-restricted-imports': 0,
    'no-this-before-super': 1,
    'no-useless-computed-key': 1,
    'no-useless-constructor': 0,
    'no-useless-rename': 1,
    'no-var': 1,
    'object-shorthand': 1,
    'prefer-arrow-callback': [1, {allowNamedFunctions: true}],
    'prefer-const': 1,
    'prefer-destructuring': 0,
    'prefer-numeric-literals': 0,
    'prefer-rest-params': 0,
    'prefer-spread': 1,
    'prefer-template': 0,
    'require-yield': 0,
    'rest-spread-spacing': 1,
    'sort-imports': 0,
    'symbol-description': 1,
    'template-curly-spacing': 1,
    'yield-star-spacing': 1,

    // dependencies (https://github.com/zertosh/eslint-plugin-dependencies)
    'dependencies/case-sensitive': 1,
    'dependencies/no-cycles': [0, {skip: ['/spec/', '/sample-[^/]+/']}],
    'dependencies/no-unresolved': 0,
    'dependencies/require-json-ext': 1,

    // flowtype (https://github.com/gajus/eslint-plugin-flowtype)
    'flowtype/boolean-style': 1,
    'flowtype/define-flow-type': 1,
    'flowtype/delimiter-dangle': [1, 'always-multiline'],
    // 'flowtype/generic-spacing': 1,
    'flowtype/no-dupe-keys': 0,
    'flowtype/no-primitive-constructor-types': 1,
    'flowtype/no-weak-types': 0,
    'flowtype/object-type-delimiter': 0,
    'flowtype/require-parameter-type': 0,
    'flowtype/require-return-type': 0,
    'flowtype/require-valid-file-annotation': 0,
    'flowtype/require-variable-type': 0,
    'flowtype/semi': 1,
    'flowtype/sort-keys': 0,
    'flowtype/space-after-type-colon': [1, 'always', {allowLineBreak: true}],
    'flowtype/space-before-generic-bracket': 1,
    'flowtype/space-before-type-colon': 1,
    'flowtype/type-id-match': 0,
    'flowtype/union-intersection-spacing': 1,
    'flowtype/use-flow-type': 1,
    'flowtype/valid-syntax': 0,

    // Jasmine (https://github.com/tlvince/eslint-plugin-jasmine)
    'jasmine/missing-expect': 0,
    'jasmine/named-spy': 0,
    'jasmine/no-assign-spyon': 0,
    'jasmine/no-disabled-tests': 1,
    'jasmine/no-expect-in-setup-teardown': 0,
    'jasmine/no-focused-tests': 0,
    'jasmine/no-global-setup': 0,
    'jasmine/no-spec-dupes': [1, 'branch'],
    'jasmine/no-suite-callback-args': 0,
    'jasmine/no-suite-dupes': [1, 'branch'],
    'jasmine/no-unsafe-spy': 0,
    'jasmine/valid-expect': 0,

    // nuclide-internal (https://github.com/facebook/nuclide/tree/master/modules/eslint-plugin-nuclide-internal)
    'rulesdir/api-spelling': 1,
    'rulesdir/atom-apis': 1,
    'rulesdir/consistent-import-name': 1,
    'rulesdir/disallowed-modules': 1,
    'rulesdir/dom-apis': 1,
    'rulesdir/flow-fb-oss': 1,
    'rulesdir/import-type-style': 1,
    'rulesdir/jsx-simple-callback-refs': 1,
    'rulesdir/license-header': 1,
    'rulesdir/modules-dependencies': 1,
    'rulesdir/no-cross-atom-imports': [1, {whitelist: ['nuclide-ui']}],
    'rulesdir/no-unnecessary-disposable-wrapping': 1,
    'rulesdir/no-unresolved': 1,
    'rulesdir/prefer-nuclide-uri': 1,
    'rulesdir/react-virtualized-import': 1,
    'rulesdir/require-universal-disposable': 1,
    'rulesdir/use-nuclide-ui-components': 1,
    'rulesdir/no-commonjs': 1,

    // prefer-object-spread (https://github.com/bryanrsmith/eslint-plugin-prefer-object-spread)
    'prefer-object-spread/prefer-object-spread': 1,

    // prettier (https://github.com/prettier/eslint-plugin-prettier)
    'prettier/prettier': [1, 'fb', '@format'],

    // React (https://github.com/yannickcr/eslint-plugin-react)
    'react/display-name': 0,
    'react/forbid-component-props:': 0,
    'react/forbid-prop-types': 1,
    'react/no-array-index-key': 0,
    'react/no-children-prop': 0,
    'react/no-danger': 0,
    'react/no-danger-with-children': 0,
    'react/no-deprecated': 1,
    'react/no-did-mount-set-state': 0,
    'react/no-did-update-set-state': 0,
    'react/no-direct-mutation-state': 1,
    'react/no-find-dom-node': 0,
    'react/no-is-mounted': 0,
    'react/no-multi-comp': 0,
    'react/no-render-return-value': 0,
    'react/no-set-state': 0,

    // String refs don't work correctly if multiple versions of React are at play.
    'react/no-string-refs': 1,

    'react/no-unescaped-entities': 0,
    'react/no-unknown-property': 1,
    'react/no-unused-prop-types': 1,
    'react/no-unused-state': 1,
    'react/prefer-es6-class': 0,
    'react/prefer-stateless-function': 0,
    // 'react/prefer-stateless-function': 1,
    // 'react/prop-types': 1,
    'react/react-in-jsx-scope': 1,
    'react/require-default-props': 0,
    'react/require-optimization': 0,
    'react/require-render-return': 0,
    'react/self-closing-comp': 1,
    'react/sort-comp': 0,
    'react/sort-prop-types': 0,
    'react/style-prop-object': 0,
    'react/jsx-boolean-value': 0,
    'react/jsx-closing-bracket-location': [
      1,
      {selfClosing: 'tag-aligned', nonEmpty: 'after-props'},
    ],
    // 'react/jsx-curly-spacing': [1, 'never'],
    'react/jsx-equals-spacing': 0,
    'react/jsx-filename-extension': 0,
    'react/jsx-first-prop-new-line': 0,
    'react/jsx-handler-names': 0,
    'react/jsx-indent': 0,
    'react/jsx-indent-props': 0,
    'react/jsx-key': 1,
    'react/jsx-max-props-per-line': 0,
    'react/jsx-no-bind': 0,
    // 'react/jsx-no-bind': 1,
    'react/jsx-no-comment-textnodes': 1,
    'react/jsx-no-duplicate-props': 1,
    'react/jsx-no-literals': 0,
    'react/jsx-no-target-blank': 0,
    'react/jsx-no-undef': 1,
    'react/jsx-pascal-case': 0,
    'react/jsx-sort-props': 0,
    'react/jsx-tag-spacing': 1,
    'react/jsx-uses-react': 1,
    'react/jsx-uses-vars': 1,
    'react/jxs-wrap-multilines': 0,

    // JSX Accessibility checks
    // some currently disabled to adopt incrementally, annotated 'incremental'
    'jsx-a11y/accessible-emoji': 0,
    'jsx-a11y/alt-text': 0, // incremental: error
    'jsx-a11y/anchor-has-content': 0,
    'jsx-a11y/anchor-is-valid': 0, // incremental: error
    'jsx-a11y/aria-activedescendant-has-tabindex': 0,
    'jsx-a11y/aria-props': 1,
    'jsx-a11y/aria-proptypes': 0,
    'jsx-a11y/aria-role': 0,
    'jsx-a11y/aria-unsupported-elements': 0,
    'jsx-a11y/click-events-have-key-events': 0,
    'jsx-a11y/heading-has-content': 0,
    'jsx-a11y/href-no-hash': 0,
    'jsx-a11y/html-has-lang': 0,
    'jsx-a11y/iframe-has-title': 0,
    'jsx-a11y/img-has-alt': 0,
    'jsx-a11y/img-redundant-alt': 0,
    'jsx-a11y/interactive-supports-focus': [
      1,
      {
        tabbable: [
          'button',
          'checkbox',
          'link',
          'searchbox',
          'spinbutton',
          'switch',
          'textbox',
        ],
      },
    ],
    'jsx-a11y/label-has-for': 0,
    'jsx-a11y/lang': 0,
    'jsx-a11y/mouse-events-have-key-events': 0,
    'jsx-a11y/no-access-key': 0,
    'jsx-a11y/no-autofocus': 0,
    'jsx-a11y/no-distracting-elements': 0,
    'jsx-a11y/no-interactive-element-to-noninteractive-role': [
      1,
      {
        tr: ['none', 'presentation'],
      },
    ],
    'jsx-a11y/no-noninteractive-element-interactions': [
      0, // incremental: warning
      {
        handlers: ['onClick'],
      },
    ],
    'jsx-a11y/no-noninteractive-element-to-interactive-role': [
      1,
      {
        ul: [
          'listbox',
          'menu',
          'menubar',
          'radiogroup',
          'tablist',
          'tree',
          'treegrid',
        ],
        ol: [
          'listbox',
          'menu',
          'menubar',
          'radiogroup',
          'tablist',
          'tree',
          'treegrid',
        ],
        li: ['menuitem', 'option', 'row', 'tab', 'treeitem'],
        table: ['grid'],
        td: ['gridcell'],
      },
    ],
    'jsx-a11y/no-noninteractive-tabindex': 0, // incremental: error
    'jsx-a11y/no-onchange': 0,
    'jsx-a11y/no-redundant-roles': 0,
    'jsx-a11y/no-static-element-interactions': [
      0, // incremental: warning
      {
        handlers: ['onClick'],
      },
    ],
    'jsx-a11y/role-has-required-aria-props': 0,
    'jsx-a11y/role-supports-aria-props': 0,
    'jsx-a11y/scope': 0,
    'jsx-a11y/tabindex-no-positive': 0,
  },

  plugins: [
    'dependencies',
    'flowtype',
    'jasmine',
    'jsx-a11y',
    'prefer-object-spread',
    'prettier',
    'react',
    'rulesdir',
  ],
};

// TODO(#21523621): Remove rulesdir when Yarn workspaces is enforced.
const rulesDirPlugin = require('eslint-plugin-rulesdir');
rulesDirPlugin.RULES_DIR = 'modules/eslint-plugin-nuclide-internal';