|
| 1 | +/** |
| 2 | + * @license |
| 3 | + * Copyright 2023 Google LLC |
| 4 | + * |
| 5 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | + * you may not use this file except in compliance with the License. |
| 7 | + * You may obtain a copy of the License at |
| 8 | + * |
| 9 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + * |
| 11 | + * Unless required by applicable law or agreed to in writing, software |
| 12 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | + |
| 18 | +const path = require("path"); |
| 19 | + |
| 20 | +module.exports = { |
| 21 | + env: { |
| 22 | + browser: true, |
| 23 | + es6: true, |
| 24 | + node: true, |
| 25 | + }, |
| 26 | + parser: "@typescript-eslint/parser", |
| 27 | + plugins: [ |
| 28 | + "@typescript-eslint", |
| 29 | + "@typescript-eslint/tslint", |
| 30 | + "import", |
| 31 | + "unused-imports", |
| 32 | + ], |
| 33 | + parserOptions: { |
| 34 | + ecmaVersion: 2015, |
| 35 | + sourceType: "module", |
| 36 | + }, |
| 37 | + overrides: [ |
| 38 | + { |
| 39 | + files: ["**/*.test.ts", "**/{test,testing}/**/*.ts"], |
| 40 | + rules: { |
| 41 | + // TODO: Use https://www.npmjs.com/package/eslint-plugin-chai-friendly instead |
| 42 | + "no-unused-expressions": "off", |
| 43 | + "@typescript-eslint/no-explicit-any": "off", |
| 44 | + }, |
| 45 | + }, |
| 46 | + ], |
| 47 | + ignorePatterns: ["dist/", ".eslintrc.js"], |
| 48 | + rules: { |
| 49 | + curly: ["error", "all"], |
| 50 | + "guard-for-in": "error", |
| 51 | + "no-extra-label": "error", |
| 52 | + "no-unused-labels": "error", |
| 53 | + "new-parens": "error", |
| 54 | + "no-new-wrappers": "error", |
| 55 | + "no-debugger": "error", |
| 56 | + "no-duplicate-case": "error", |
| 57 | + "no-throw-literal": "error", |
| 58 | + "no-return-await": "error", |
| 59 | + "no-unsafe-finally": "error", |
| 60 | + "no-unused-expressions": [ |
| 61 | + "error", |
| 62 | + { |
| 63 | + allowShortCircuit: true, |
| 64 | + }, |
| 65 | + ], |
| 66 | + "no-var": "error", |
| 67 | + "object-shorthand": "error", |
| 68 | + "prefer-arrow-callback": [ |
| 69 | + "error", |
| 70 | + { |
| 71 | + allowNamedFunctions: true, |
| 72 | + }, |
| 73 | + ], |
| 74 | + "prefer-const": [ |
| 75 | + "error", |
| 76 | + { |
| 77 | + destructuring: "all", |
| 78 | + }, |
| 79 | + ], |
| 80 | + radix: "error", |
| 81 | + "unused-imports/no-unused-imports-ts": "error", |
| 82 | + "default-case": "error", |
| 83 | + eqeqeq: [ |
| 84 | + "error", |
| 85 | + "always", |
| 86 | + { |
| 87 | + null: "ignore", |
| 88 | + }, |
| 89 | + ], |
| 90 | + "no-caller": "error", |
| 91 | + "no-cond-assign": ["error", "always"], |
| 92 | + "use-isnan": "error", |
| 93 | + "constructor-super": "error", |
| 94 | + "no-restricted-properties": [ |
| 95 | + "error", |
| 96 | + { |
| 97 | + object: "it", |
| 98 | + property: "skip", |
| 99 | + }, |
| 100 | + { |
| 101 | + object: "it", |
| 102 | + property: "only", |
| 103 | + }, |
| 104 | + { |
| 105 | + object: "describe", |
| 106 | + property: "skip", |
| 107 | + }, |
| 108 | + { |
| 109 | + object: "describe", |
| 110 | + property: "only", |
| 111 | + }, |
| 112 | + { |
| 113 | + object: "xit", |
| 114 | + }, |
| 115 | + ], |
| 116 | + "no-restricted-globals": [ |
| 117 | + "error", |
| 118 | + { name: "xit" }, |
| 119 | + { name: "xdescribe" }, |
| 120 | + { name: "parseInt", message: "tsstyle#type-coercion" }, |
| 121 | + { name: "parseFloat", message: "tsstyle#type-coercion" }, |
| 122 | + ], |
| 123 | + "no-array-constructor": "error", |
| 124 | + "sort-imports": [ |
| 125 | + "error", |
| 126 | + { |
| 127 | + ignoreCase: false, |
| 128 | + ignoreDeclarationSort: true, // don"t want to sort import lines, use eslint-plugin-import instead |
| 129 | + ignoreMemberSort: false, |
| 130 | + memberSyntaxSortOrder: ["none", "all", "multiple", "single"], |
| 131 | + allowSeparatedGroups: true, |
| 132 | + }, |
| 133 | + ], |
| 134 | + "import/no-default-export": "error", |
| 135 | + "import/no-duplicates": "error", |
| 136 | + "import/no-extraneous-dependencies": [ |
| 137 | + "error", |
| 138 | + { |
| 139 | + // Check dependencies from both local package.json |
| 140 | + // and from root package.json. |
| 141 | + packageDir: [path.join(__dirname, "../"), "./"], |
| 142 | + devDependencies: [ |
| 143 | + "**/*.test.ts", |
| 144 | + "**/test/**/*.ts", |
| 145 | + "**/testing/**/*.ts", |
| 146 | + "*.config.*", |
| 147 | + ], |
| 148 | + peerDependencies: true, |
| 149 | + }, |
| 150 | + ], |
| 151 | + "@typescript-eslint/array-type": [ |
| 152 | + "error", |
| 153 | + { |
| 154 | + default: "array-simple", |
| 155 | + }, |
| 156 | + ], |
| 157 | + "@typescript-eslint/ban-types": [ |
| 158 | + "error", |
| 159 | + { |
| 160 | + types: { |
| 161 | + Object: "Use {} or 'object' instead.", |
| 162 | + String: "Use 'string' instead.", |
| 163 | + Number: "Use 'number' instead.", |
| 164 | + Boolean: "Use 'boolean' instead.", |
| 165 | + Function: `Avoid the Function type, as it provides little safety for the following reasons: |
| 166 | + It provides no type safety when calling the value, which means it's easy to provide the wrong arguments. |
| 167 | + It accepts class declarations, which will fail when called, as they are called without the new keyword.`, |
| 168 | + }, |
| 169 | + extendDefaults: false, |
| 170 | + }, |
| 171 | + ], |
| 172 | + "@typescript-eslint/naming-convention": [ |
| 173 | + "error", |
| 174 | + { |
| 175 | + selector: "class", |
| 176 | + format: ["PascalCase"], |
| 177 | + }, |
| 178 | + { |
| 179 | + selector: "interface", |
| 180 | + format: ["PascalCase"], |
| 181 | + custom: { |
| 182 | + regex: "^I[A-Z]", |
| 183 | + match: false, |
| 184 | + }, |
| 185 | + }, |
| 186 | + ], |
| 187 | + "@typescript-eslint/consistent-type-definitions": ["error", "interface"], |
| 188 | + "@typescript-eslint/explicit-member-accessibility": [ |
| 189 | + "error", |
| 190 | + { |
| 191 | + accessibility: "no-public", |
| 192 | + overrides: { |
| 193 | + parameterProperties: "off", |
| 194 | + }, |
| 195 | + }, |
| 196 | + ], |
| 197 | + "@typescript-eslint/consistent-type-assertions": [ |
| 198 | + "error", |
| 199 | + { |
| 200 | + assertionStyle: "as", |
| 201 | + }, |
| 202 | + ], |
| 203 | + "@typescript-eslint/no-explicit-any": ["error", { ignoreRestArgs: true }], |
| 204 | + "@typescript-eslint/no-namespace": [ |
| 205 | + "error", |
| 206 | + { |
| 207 | + allowDeclarations: true, |
| 208 | + }, |
| 209 | + ], |
| 210 | + "@typescript-eslint/triple-slash-reference": [ |
| 211 | + "error", |
| 212 | + { |
| 213 | + path: "never", |
| 214 | + types: "never", |
| 215 | + lib: "never", |
| 216 | + }, |
| 217 | + ], |
| 218 | + "@typescript-eslint/no-require-imports": "error", |
| 219 | + "@typescript-eslint/no-useless-constructor": "error", |
| 220 | + "@typescript-eslint/semi": "error", |
| 221 | + "@typescript-eslint/explicit-function-return-type": [ |
| 222 | + "error", |
| 223 | + { |
| 224 | + allowExpressions: true, |
| 225 | + allowTypedFunctionExpressions: true, |
| 226 | + allowHigherOrderFunctions: true, |
| 227 | + }, |
| 228 | + ], |
| 229 | + "@typescript-eslint/no-unused-vars": [ |
| 230 | + "error", |
| 231 | + { |
| 232 | + varsIgnorePattern: "^_", |
| 233 | + argsIgnorePattern: "^_", |
| 234 | + }, |
| 235 | + ], |
| 236 | + "@typescript-eslint/no-floating-promises": "error", |
| 237 | + "@typescript-eslint/tslint/config": [ |
| 238 | + "error", |
| 239 | + { |
| 240 | + rules: { |
| 241 | + "jsdoc-format": true, |
| 242 | + "arrow-return-shorthand": true, |
| 243 | + }, |
| 244 | + }, |
| 245 | + ], |
| 246 | + }, |
| 247 | +}; |
0 commit comments