Tim van der Lippe | d6c33c4 | 2020-03-10 16:57:22 | [diff] [blame] | 1 | const path = require('path'); |
| 2 | const rulesDirPlugin = require('eslint-plugin-rulesdir') |
| 3 | rulesDirPlugin.RULES_DIR = path.join(__dirname, 'scripts', 'eslint_rules', 'lib'); |
| 4 | |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 5 | module.exports = { |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 6 | 'root': true, |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 7 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 8 | 'env': {'browser': true, 'es6': true}, |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 9 | |
Tim van der Lippe | 399a956 | 2020-01-16 10:53:28 | [diff] [blame] | 10 | 'parser': '@typescript-eslint/parser', |
| 11 | |
| 12 | 'plugins': [ |
| 13 | '@typescript-eslint', |
Jack Franklin | 8b9aa2f | 2020-02-12 16:35:15 | [diff] [blame] | 14 | 'mocha', |
Tim van der Lippe | d6c33c4 | 2020-03-10 16:57:22 | [diff] [blame] | 15 | 'rulesdir', |
Tim van der Lippe | 298b8cc | 2020-04-03 11:55:10 | [diff] [blame] | 16 | 'import', |
Tim van der Lippe | 399a956 | 2020-01-16 10:53:28 | [diff] [blame] | 17 | ], |
| 18 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 19 | 'parserOptions': {'ecmaVersion': 9, 'sourceType': 'module'}, |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 20 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 21 | /** |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 22 | * ESLint rules |
| 23 | * |
| 24 | * All available rules: http://eslint.org/docs/rules/ |
| 25 | * |
| 26 | * Rules take the following form: |
| 27 | * "rule-name", [severity, { opts }] |
| 28 | * Severity: 2 == error, 1 == warning, 0 == off. |
| 29 | */ |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 30 | 'rules': { |
| 31 | /** |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 32 | * Enforced rules |
| 33 | */ |
| 34 | |
| 35 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 36 | // syntax preferences |
Mathias Bynens | 23ee1aa | 2020-03-02 12:06:38 | [diff] [blame] | 37 | 'quotes': [2, 'single', {'avoidEscape': true, 'allowTemplateLiterals': false}], |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 38 | 'semi': 2, |
| 39 | 'no-extra-semi': 2, |
| 40 | 'comma-style': [2, 'last'], |
| 41 | 'wrap-iife': [2, 'inside'], |
| 42 | 'spaced-comment': [2, 'always', {'markers': ['*']}], |
| 43 | 'eqeqeq': [2], |
| 44 | 'accessor-pairs': [2, {'getWithoutSet': false, 'setWithoutGet': false}], |
| 45 | 'curly': 2, |
| 46 | 'new-parens': 2, |
| 47 | 'func-call-spacing': 2, |
| 48 | 'arrow-parens': [2, 'as-needed'], |
Tim van der Lippe | 20b29c2 | 2019-11-04 14:36:15 | [diff] [blame] | 49 | 'eol-last': 2, |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 50 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 51 | // anti-patterns |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 52 | 'no-caller': 2, |
Mathias Bynens | 88e8f15 | 2020-03-25 14:33:12 | [diff] [blame] | 53 | 'no-case-declarations': 2, |
Mathias Bynens | f06e8c0 | 2020-02-28 13:58:28 | [diff] [blame] | 54 | 'no-cond-assign': 2, |
| 55 | 'no-console': [2, {'allow': ['assert', 'context', 'error', 'timeStamp', 'time', 'timeEnd', 'warn']}], |
| 56 | 'no-debugger': 2, |
| 57 | 'no-dupe-keys': 2, |
| 58 | 'no-duplicate-case': 2, |
| 59 | 'no-else-return': [2, {'allowElseIf': false}], |
| 60 | 'no-empty-character-class': 2, |
Mathias Bynens | 15213d0 | 2020-05-14 11:55:11 | [diff] [blame] | 61 | 'no-global-assign': 2, |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 62 | 'no-implied-eval': 2, |
| 63 | 'no-labels': 2, |
Mathias Bynens | f06e8c0 | 2020-02-28 13:58:28 | [diff] [blame] | 64 | 'no-multi-str': 2, |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 65 | 'no-new-object': 2, |
| 66 | 'no-octal-escape': 2, |
| 67 | 'no-self-compare': 2, |
| 68 | 'no-shadow-restricted-names': 2, |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 69 | 'no-unreachable': 2, |
| 70 | 'no-unsafe-negation': 2, |
Mathias Bynens | f06e8c0 | 2020-02-28 13:58:28 | [diff] [blame] | 71 | 'no-unused-vars': [2, {'args': 'none', 'vars': 'local'}], |
| 72 | 'no-var': 2, |
| 73 | 'no-with': 2, |
| 74 | 'prefer-const': 2, |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 75 | 'radix': 2, |
| 76 | 'valid-typeof': 2, |
Patrick Brosset | e65aaac | 2020-06-22 08:04:40 | [diff] [blame] | 77 | 'no-return-assign': [2, 'always'], |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 78 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 79 | // es2015 features |
| 80 | 'require-yield': 2, |
| 81 | 'template-curly-spacing': [2, 'never'], |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 82 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 83 | // spacing details |
| 84 | 'space-infix-ops': 2, |
| 85 | 'space-in-parens': [2, 'never'], |
| 86 | 'space-before-function-paren': [2, {'anonymous': 'never', 'named': 'never', 'asyncArrow': 'always'}], |
| 87 | 'no-whitespace-before-property': 2, |
| 88 | 'keyword-spacing': [ |
| 89 | 2, { |
| 90 | 'overrides': { |
| 91 | 'if': {'after': true}, |
| 92 | 'else': {'after': true}, |
| 93 | 'for': {'after': true}, |
| 94 | 'while': {'after': true}, |
| 95 | 'do': {'after': true}, |
| 96 | 'switch': {'after': true}, |
| 97 | 'return': {'after': true} |
| 98 | } |
| 99 | } |
| 100 | ], |
| 101 | 'arrow-spacing': [2, {'after': true, 'before': true}], |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 102 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 103 | // file whitespace |
| 104 | 'no-multiple-empty-lines': [2, {'max': 2}], |
| 105 | 'no-mixed-spaces-and-tabs': 2, |
| 106 | 'no-trailing-spaces': 2, |
| 107 | 'linebreak-style': [2, 'unix'], |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 108 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 109 | /** |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 110 | * Disabled, aspirational rules |
| 111 | */ |
| 112 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 113 | 'indent': [0, 2, {'SwitchCase': 1, 'CallExpression': {'arguments': 2}, 'MemberExpression': 2}], |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 114 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 115 | // brace-style is disabled, as eslint cannot enforce 1tbs as default, but allman for functions |
| 116 | 'brace-style': [0, 'allman', {'allowSingleLine': true}], |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 117 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 118 | // key-spacing is disabled, as some objects use value-aligned spacing, some not. |
| 119 | 'key-spacing': [0, {'beforeColon': false, 'afterColon': true, 'align': 'value'}], |
| 120 | // quote-props is diabled, as property quoting styles are too varied to enforce. |
| 121 | 'quote-props': [0, 'as-needed'], |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 122 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame] | 123 | // no-implicit-globals will prevent accidental globals |
Tim van der Lippe | 399a956 | 2020-01-16 10:53:28 | [diff] [blame] | 124 | 'no-implicit-globals': [0], |
| 125 | |
Jack Franklin | 264237a | 2020-07-15 09:02:26 | [diff] [blame] | 126 | // forbids interfaces starting with an I prefix. |
Paul Lewis | 839037f | 2020-07-21 12:25:19 | [diff] [blame] | 127 | '@typescript-eslint/naming-convention': |
| 128 | [2, {'selector': 'interface', 'format': ['PascalCase'], 'custom': {'regex': '^I[A-Z]', 'match': false}}], |
Tim van der Lippe | 399a956 | 2020-01-16 10:53:28 | [diff] [blame] | 129 | '@typescript-eslint/explicit-member-accessibility': [0], |
Paul Lewis | 839037f | 2020-07-21 12:25:19 | [diff] [blame] | 130 | '@typescript-eslint/no-explicit-any': 2, |
Jack Franklin | 8b9aa2f | 2020-02-12 16:35:15 | [diff] [blame] | 131 | |
| 132 | // errors on it('test') with no body |
| 133 | 'mocha/no-pending-tests': 2, |
| 134 | // errors on {describe, it}.only |
| 135 | 'mocha/no-exclusive-tests': 2, |
Tim van der Lippe | d6c33c4 | 2020-03-10 16:57:22 | [diff] [blame] | 136 | |
Tim van der Lippe | 298b8cc | 2020-04-03 11:55:10 | [diff] [blame] | 137 | // Closure does not properly typecheck default exports |
| 138 | 'import/no-default-export': 2, |
| 139 | |
Tim van der Lippe | d6c33c4 | 2020-03-10 16:57:22 | [diff] [blame] | 140 | // DevTools specific rules |
| 141 | 'rulesdir/es_modules_import': 2, |
Tim van der Lippe | 4a8441c | 2020-03-12 15:45:18 | [diff] [blame] | 142 | 'rulesdir/check_license_header': 2, |
Tim van der Lippe | 80c1028 | 2020-04-22 12:03:04 | [diff] [blame] | 143 | 'rulesdir/check_test_definitions': 2, |
Jack Franklin | 28447fd | 2020-04-23 12:09:35 | [diff] [blame] | 144 | 'rulesdir/avoid_assert_equal': 2, |
Tim van der Lippe | 399a956 | 2020-01-16 10:53:28 | [diff] [blame] | 145 | }, |
| 146 | 'overrides': [{ |
| 147 | 'files': ['*.ts'], |
| 148 | 'rules': { |
Jack Franklin | 173a1ae | 2020-06-12 13:45:40 | [diff] [blame] | 149 | '@typescript-eslint/explicit-member-accessibility': [2, {'accessibility': 'no-public'}], |
Tim van der Lippe | 399a956 | 2020-01-16 10:53:28 | [diff] [blame] | 150 | 'comma-dangle': [2, 'always-multiline'], |
Jack Franklin | 9531032 | 2020-03-20 14:34:04 | [diff] [blame] | 151 | // run just the TypeScript unused-vars rule, else we get duplicate errors |
| 152 | 'no-unused-vars': 0, |
Tim van der Lippe | 399a956 | 2020-01-16 10:53:28 | [diff] [blame] | 153 | '@typescript-eslint/no-unused-vars': [2], |
| 154 | } |
| 155 | }] |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 | [diff] [blame] | 156 | }; |