Avi Drissman | 2497659 | 2022-09-12 15:24:31 | [diff] [blame] | 1 | // Copyright 2017 The Chromium Authors |
dpapad | ff82d51 | 2017-05-25 18:40:15 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | module.exports = { |
| 6 | 'root': true, |
| 7 | 'env': { |
| 8 | 'browser': true, |
dpapad | a0617309 | 2020-10-17 03:06:16 | [diff] [blame] | 9 | 'es2020': true, |
Christopher Lam | a5f2ad0 | 2018-12-05 10:05:58 | [diff] [blame] | 10 | }, |
| 11 | 'parserOptions': { |
dpapad | a0617309 | 2020-10-17 03:06:16 | [diff] [blame] | 12 | 'ecmaVersion': 2020, |
dpapad | 12b3c47 | 2019-05-29 02:16:05 | [diff] [blame] | 13 | 'sourceType': 'module', |
dpapad | ff82d51 | 2017-05-25 18:40:15 | [diff] [blame] | 14 | }, |
| 15 | 'rules': { |
| 16 | // Enabled checks. |
Dan Beam | 1a0d9dcb | 2019-01-08 09:05:35 | [diff] [blame] | 17 | 'brace-style': ['error', '1tbs'], |
dpapad | f4d85572 | 2022-07-19 01:28:18 | [diff] [blame] | 18 | |
| 19 | // https://google.github.io/styleguide/jsguide.html#features-arrays-trailing-comma |
| 20 | // https://google.github.io/styleguide/jsguide.html#features-objects-use-trailing-comma |
| 21 | 'comma-dangle': ['error', 'always-multiline'], |
| 22 | |
Dan Beam | 1a0d9dcb | 2019-01-08 09:05:35 | [diff] [blame] | 23 | 'curly': ['error', 'multi-line', 'consistent'], |
dpapad | c21c6fb | 2022-04-01 07:12:13 | [diff] [blame] | 24 | 'new-parens': 'error', |
dpapad | b2b0d6c | 2022-06-27 19:45:11 | [diff] [blame] | 25 | 'no-array-constructor': 'error', |
dpapad | c7570be | 2022-03-28 08:28:23 | [diff] [blame] | 26 | 'no-console': ['error', {allow: ['info', 'warn', 'error', 'assert']}], |
Dan Beam | b153665 | 2019-02-26 07:36:25 | [diff] [blame] | 27 | 'no-extra-boolean-cast': 'error', |
dpapad | ff82d51 | 2017-05-25 18:40:15 | [diff] [blame] | 28 | 'no-extra-semi': 'error', |
dpapad | 728cff0 | 2017-06-01 01:06:42 | [diff] [blame] | 29 | 'no-new-wrappers': 'error', |
dpapad | d6fe5df | 2023-04-11 16:55:13 | [diff] [blame] | 30 | 'no-restricted-imports': ['error', { |
| 31 | 'paths': [{ |
| 32 | 'name': 'chrome://resources/polymer/v3_0/polymer/polymer_bundled.min.js', |
| 33 | 'importNames': ['Polymer'], |
| 34 | 'message': 'Use PolymerElement instead.', |
| 35 | }, |
| 36 | { |
| 37 | 'name': '//resources/polymer/v3_0/polymer/polymer_bundled.min.js', |
| 38 | 'importNames': ['Polymer'], |
| 39 | 'message': 'Use PolymerElement instead.', |
| 40 | }], |
| 41 | }], |
Christopher Lam | a5f2ad0 | 2018-12-05 10:05:58 | [diff] [blame] | 42 | 'no-restricted-properties': [ |
| 43 | 'error', |
| 44 | { |
dpapad | 7b493a4 | 2019-06-22 02:07:09 | [diff] [blame] | 45 | 'property': '__lookupGetter__', |
| 46 | 'message': 'Use Object.getOwnPropertyDescriptor', |
| 47 | }, |
| 48 | { |
| 49 | 'property': '__lookupSetter__', |
| 50 | 'message': 'Use Object.getOwnPropertyDescriptor', |
| 51 | }, |
| 52 | { |
| 53 | 'property': '__defineGetter__', |
| 54 | 'message': 'Use Object.defineProperty', |
| 55 | }, |
| 56 | { |
| 57 | 'property': '__defineSetter__', |
| 58 | 'message': 'Use Object.defineProperty', |
| 59 | }, |
Dan Beam | 1aa00a12 | 2020-01-16 00:40:41 | [diff] [blame] | 60 | { |
| 61 | 'object': 'cr', |
| 62 | 'property': 'exportPath', |
| 63 | 'message': 'Use ES modules or cr.define() instead', |
| 64 | }, |
dpapad | 2674f928 | 2017-05-31 19:40:39 | [diff] [blame] | 65 | ], |
dpapad | b9eb38f1 | 2023-11-06 21:42:06 | [diff] [blame] | 66 | 'no-restricted-syntax': ['error', { |
| 67 | 'selector': 'CallExpression[callee.object.name=JSON][callee.property.name=parse] > CallExpression[callee.object.name=JSON][callee.property.name=stringify]', |
| 68 | 'message': 'Don\'t use JSON.parse(JSON.stringify(...)) to clone objects. Use structuredClone() instead.', |
dpapad | e4b476d | 2024-01-25 21:56:21 | [diff] [blame] | 69 | }, |
| 70 | { |
| 71 | // https://google.github.io/styleguide/tsguide.html#return-type-only-generics |
| 72 | 'selector': 'TSAsExpression > CallExpression > MemberExpression[property.name=/^querySelector$/]', |
| 73 | 'message': 'Don\'t use \'querySelector(...) as Type\'. Use the type parameter, \'querySelector<Type>(...)\' instead', |
| 74 | }, |
| 75 | { |
| 76 | // https://google.github.io/styleguide/tsguide.html#return-type-only-generics |
| 77 | 'selector': 'TSAsExpression > CallExpression > MemberExpression[property.name=/^querySelectorAll$/]', |
| 78 | 'message': 'Don\'t use \'querySelectorAll(...) as Type\'. Use the type parameter, \'querySelectorAll<Type>(...)\' instead', |
dpapad | e5ef8675 | 2024-01-31 00:15:19 | [diff] [blame] | 79 | }, |
| 80 | { |
| 81 | // Prevent a common misuse of "!" operator. |
| 82 | "selector": "TSNonNullExpression > CallExpression > MemberExpression[property.name=/^querySelectorAll$/]", |
| 83 | "message": "Remove unnecessary \"!\" non-null operator after querySelectorAll(). It always returns a non-null result", |
dpapad | b9eb38f1 | 2023-11-06 21:42:06 | [diff] [blame] | 84 | }], |
dpapad | bea253c3 | 2022-04-01 08:52:57 | [diff] [blame] | 85 | 'no-throw-literal': 'error', |
dpapad | 2d023f9 | 2022-03-29 21:11:23 | [diff] [blame] | 86 | 'no-trailing-spaces': 'error', |
Demetrios Papadopoulos | cf870bde | 2019-11-26 19:14:34 | [diff] [blame] | 87 | 'no-var': 'error', |
| 88 | 'prefer-const': 'error', |
dpapad | ab65692 | 2022-04-01 00:01:11 | [diff] [blame] | 89 | 'quotes': ['error', 'single', {allowTemplateLiterals: true}], |
dpapad | 1e511b1 | 2017-05-31 03:31:26 | [diff] [blame] | 90 | 'semi': ['error', 'always'], |
dpapad | 2674f928 | 2017-05-31 19:40:39 | [diff] [blame] | 91 | |
dpapad | d631d17 | 2022-07-20 17:29:01 | [diff] [blame] | 92 | // https://google.github.io/styleguide/jsguide.html#features-one-variable-per-declaration |
| 93 | 'one-var': ['error', { |
| 94 | let: 'never', |
| 95 | const: 'never', |
| 96 | }], |
| 97 | |
dpapad | ff82d51 | 2017-05-25 18:40:15 | [diff] [blame] | 98 | // TODO(dpapad): Add more checks according to our styleguide. |
| 99 | }, |
dpapad | ac97d7b | 2021-06-14 07:20:26 | [diff] [blame] | 100 | |
| 101 | 'overrides': [{ |
| 102 | 'files': ['**/*.ts'], |
dpapad | 1c17e50 | 2023-10-04 20:31:12 | [diff] [blame] | 103 | 'parser': './third_party/node/node_modules/@typescript-eslint/parser/dist/index.js', |
dpapad | fa76653e | 2022-02-24 09:08:40 | [diff] [blame] | 104 | 'plugins': [ |
| 105 | '@typescript-eslint', |
| 106 | ], |
| 107 | 'rules': { |
| 108 | 'no-unused-vars': 'off', |
| 109 | '@typescript-eslint/no-unused-vars': [ |
| 110 | 'error', { |
| 111 | argsIgnorePattern: '^_', |
| 112 | varsIgnorePattern: '^_', |
| 113 | } |
dpapad | 5df2304 | 2022-03-21 19:22:37 | [diff] [blame] | 114 | ], |
| 115 | |
dpapad | 39be89f6 | 2023-10-10 20:35:05 | [diff] [blame] | 116 | // https://google.github.io/styleguide/tsguide.html#array-constructor |
| 117 | // Note: The rule below only partially enforces the styleguide, since it |
| 118 | // it does not flag invocations of the constructor with a single |
| 119 | // parameter. |
| 120 | 'no-array-constructor': 'off', |
| 121 | '@typescript-eslint/no-array-constructor': 'error', |
| 122 | |
| 123 | // https://google.github.io/styleguide/tsguide.html#automatic-semicolon-insertion |
dpapad | 5df2304 | 2022-03-21 19:22:37 | [diff] [blame] | 124 | 'semi': 'off', |
| 125 | '@typescript-eslint/semi': ['error'], |
dpapad | a2eca91 | 2022-03-28 09:36:44 | [diff] [blame] | 126 | |
dpapad | 0927916 | 2022-07-07 18:34:06 | [diff] [blame] | 127 | // https://google.github.io/styleguide/tsguide.html#arrayt-type |
| 128 | '@typescript-eslint/array-type': ['error', { |
| 129 | default: 'array-simple', |
| 130 | }], |
| 131 | |
dpapad | d533279 | 2022-07-11 21:15:14 | [diff] [blame] | 132 | // https://google.github.io/styleguide/tsguide.html#type-assertions-syntax |
| 133 | '@typescript-eslint/consistent-type-assertions': ['error', { |
| 134 | assertionStyle: 'as', |
| 135 | }], |
| 136 | |
dpapad | b1a935f | 2022-07-27 16:49:06 | [diff] [blame] | 137 | // https://google.github.io/styleguide/tsguide.html#interfaces-vs-type-aliases |
dpapad | dc88a09 | 2023-10-04 00:19:04 | [diff] [blame] | 138 | '@typescript-eslint/consistent-type-definitions': ['error', 'interface'], |
| 139 | |
rbpotter | 38a7f0c | 2024-02-12 19:01:40 | [diff] [blame] | 140 | // https://google.github.io/styleguide/tsguide.html#import-type |
| 141 | '@typescript-eslint/consistent-type-imports': 'error', |
| 142 | |
dpapad | dc88a09 | 2023-10-04 00:19:04 | [diff] [blame] | 143 | // https://google.github.io/styleguide/tsguide.html#visibility |
| 144 | '@typescript-eslint/explicit-member-accessibility': ['error', { |
| 145 | accessibility: 'no-public', |
| 146 | overrides: { |
| 147 | parameterProperties: 'off', |
| 148 | }, |
| 149 | }], |
dpapad | b1a935f | 2022-07-27 16:49:06 | [diff] [blame] | 150 | |
dpapad | 684f427b | 2022-05-10 05:47:02 | [diff] [blame] | 151 | // https://google.github.io/styleguide/jsguide.html#naming |
dpapad | 50adcde | 2022-05-07 00:05:52 | [diff] [blame] | 152 | '@typescript-eslint/naming-convention': [ |
| 153 | 'error', |
| 154 | { |
dpapad | 684f427b | 2022-05-10 05:47:02 | [diff] [blame] | 155 | selector: ['class', 'interface', 'typeAlias', 'enum', 'typeParameter'], |
dpapad | 978c1da | 2022-10-19 18:12:09 | [diff] [blame] | 156 | format: ['StrictPascalCase'], |
| 157 | filter: { |
| 158 | regex: '^(' + |
| 159 | // Exclude TypeScript defined interfaces HTMLElementTagNameMap |
| 160 | // and HTMLElementEventMap. |
| 161 | 'HTMLElementTagNameMap|HTMLElementEventMap|' + |
| 162 | // Exclude native DOM types which are always named like HTML<Foo>Element. |
| 163 | 'HTML[A-Za-z]{0,}Element|' + |
| 164 | // Exclude native DOM interfaces. |
| 165 | 'UIEvent|UIEventInit|DOMError|' + |
| 166 | // Exclude the deprecated WebUIListenerBehavior interface. |
| 167 | 'WebUIListenerBehavior)$', |
| 168 | match: false, |
| 169 | }, |
dpapad | 50adcde | 2022-05-07 00:05:52 | [diff] [blame] | 170 | }, |
| 171 | { |
dpapad | 50adcde | 2022-05-07 00:05:52 | [diff] [blame] | 172 | selector: 'enumMember', |
| 173 | format: ['UPPER_CASE'], |
| 174 | }, |
dpapad | 684f427b | 2022-05-10 05:47:02 | [diff] [blame] | 175 | { |
| 176 | selector: 'classMethod', |
dpapad | e9ae77d | 2022-12-12 17:02:00 | [diff] [blame] | 177 | format: ['strictCamelCase'], |
dpapad | b7286e8 | 2022-06-16 01:33:27 | [diff] [blame] | 178 | modifiers: ['public'], |
| 179 | }, |
| 180 | { |
| 181 | selector: 'classMethod', |
dpapad | e9ae77d | 2022-12-12 17:02:00 | [diff] [blame] | 182 | format: ['strictCamelCase'], |
dpapad | b7286e8 | 2022-06-16 01:33:27 | [diff] [blame] | 183 | modifiers: ['private'], |
dpapad | 684f427b | 2022-05-10 05:47:02 | [diff] [blame] | 184 | trailingUnderscore: 'allow', |
dpapad | d5da00a9 | 2023-05-26 17:58:23 | [diff] [blame] | 185 | |
| 186 | // Disallow the 'Tap_' suffix, in favor of 'Click_' in event handlers. |
| 187 | // Note: Unfortunately this ESLint rule does not provide a way to |
| 188 | // customize the error message to better inform developers. |
| 189 | custom: { |
| 190 | regex: '^on[a-zA-Z0-9]+Tap$', |
| 191 | match: false, |
| 192 | }, |
dpapad | 684f427b | 2022-05-10 05:47:02 | [diff] [blame] | 193 | }, |
| 194 | { |
dpapad | e9d1fa7 | 2022-06-09 17:42:50 | [diff] [blame] | 195 | selector: 'classProperty', |
| 196 | format: ['UPPER_CASE'], |
dpapad | 588bb91 | 2022-06-15 05:35:33 | [diff] [blame] | 197 | modifiers: ['private', 'static', 'readonly'], |
| 198 | }, |
| 199 | { |
| 200 | selector: 'classProperty', |
| 201 | format: ['UPPER_CASE'], |
| 202 | modifiers: ['public', 'static', 'readonly'], |
dpapad | e9d1fa7 | 2022-06-09 17:42:50 | [diff] [blame] | 203 | }, |
| 204 | { |
| 205 | selector: 'classProperty', |
| 206 | format: ['camelCase'], |
dpapad | 588bb91 | 2022-06-15 05:35:33 | [diff] [blame] | 207 | modifiers: ['public'], |
| 208 | }, |
| 209 | { |
| 210 | selector: 'classProperty', |
| 211 | format: ['camelCase'], |
| 212 | modifiers: ['private'], |
dpapad | e9d1fa7 | 2022-06-09 17:42:50 | [diff] [blame] | 213 | trailingUnderscore: 'allow', |
| 214 | }, |
| 215 | { |
dpapad | 684f427b | 2022-05-10 05:47:02 | [diff] [blame] | 216 | selector: 'parameter', |
| 217 | format: ['camelCase'], |
| 218 | leadingUnderscore: 'allow', |
| 219 | }, |
dpapad | b17f3beb | 2022-05-10 21:34:13 | [diff] [blame] | 220 | { |
| 221 | selector: 'function', |
| 222 | format: ['camelCase'], |
| 223 | }, |
dpapad | 50adcde | 2022-05-07 00:05:52 | [diff] [blame] | 224 | ], |
| 225 | |
dpapad | 39be89f6 | 2023-10-10 20:35:05 | [diff] [blame] | 226 | // https://google.github.io/styleguide/tsguide.html#member-property-declarations |
dpapad | a2eca91 | 2022-03-28 09:36:44 | [diff] [blame] | 227 | '@typescript-eslint/member-delimiter-style': ['error', { |
| 228 | multiline: { |
| 229 | delimiter: 'comma', |
| 230 | requireLast: true, |
| 231 | }, |
| 232 | singleline: { |
| 233 | delimiter: 'comma', |
| 234 | requireLast: false, |
| 235 | }, |
| 236 | overrides: { |
| 237 | interface: { |
| 238 | multiline: { |
| 239 | delimiter: 'semi', |
| 240 | requireLast: true, |
| 241 | }, |
| 242 | singleline: { |
| 243 | delimiter: 'semi', |
| 244 | requireLast: false, |
| 245 | }, |
| 246 | }, |
| 247 | }, |
dpapad | b5aaf1a | 2022-07-11 18:00:41 | [diff] [blame] | 248 | }], |
| 249 | |
| 250 | // https://google.github.io/styleguide/tsguide.html#wrapper-types |
| 251 | '@typescript-eslint/ban-types': ['error', { |
| 252 | extendDefaults: false, |
| 253 | types: { |
| 254 | String: { |
| 255 | message: 'Use string instead', |
| 256 | fixWith: 'string', |
| 257 | }, |
| 258 | Boolean: { |
| 259 | message: 'Use boolean instead', |
| 260 | fixWith: 'boolean', |
| 261 | }, |
| 262 | Number: { |
| 263 | message: 'Use number instead', |
| 264 | fixWith: 'number', |
| 265 | }, |
| 266 | Symbol: { |
| 267 | message: 'Use symbol instead', |
| 268 | fixWith: 'symbol', |
| 269 | }, |
| 270 | BigInt: { |
| 271 | message: 'Use bigint instead', |
| 272 | fixWith: 'bigint', |
| 273 | }, |
| 274 | } |
| 275 | }], |
dpapad | fa76653e | 2022-02-24 09:08:40 | [diff] [blame] | 276 | } |
dpapad | ac97d7b | 2021-06-14 07:20:26 | [diff] [blame] | 277 | }] |
dpapad | ff82d51 | 2017-05-25 18:40:15 | [diff] [blame] | 278 | }; |