-
Notifications
You must be signed in to change notification settings - Fork 0
/
tslint.json
262 lines (255 loc) · 12.2 KB
/
tslint.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
{
"extends": "tslint:all",
"rulesDirectory": [
"node_modules/tslint-microsoft-contrib"
],
"rules": {
/**
* Security Rules. The following rules should be turned on because they find security issues
* or are recommended in the Microsoft Secure Development Lifecycle (SDL)
*/
"insecure-random": true,
"no-banned-terms": true,
"no-cookies": true,
"no-delete-expression": true,
"no-disable-auto-sanitization": true,
"no-document-domain": true,
"no-document-write": true,
"no-eval": true,
"no-exec-script": true,
"no-function-constructor-with-string-args": true,
"no-http-string": [false],
"no-inner-html": true,
"no-octal-literal": true,
"no-reserved-keywords": false,
"no-string-based-set-immediate": true,
"no-string-based-set-interval": true,
"no-string-based-set-timeout": true,
"non-literal-require": true,
"possible-timing-attack": true,
"react-anchor-blank-noopener": true,
"react-iframe-missing-sandbox": true,
"react-no-dangerous-html": true,
/**
* Common Bugs and Correctness. The following rules should be turned on because they find
* common bug patterns in the code or enforce type safety.
*/
"await-promise": true,
"forin": false,
"jquery-deferred-must-complete": true,
"label-position": true,
"match-default-export-name": true,
"mocha-avoid-only": true,
"mocha-no-side-effect-code": false,
"no-any": false,
"no-arg": true,
"no-backbone-get-set-outside-model": true,
"no-bitwise": false,
"no-conditional-assignment": true,
"no-console": [true, "debug", "info", "log", "time", "timeEnd", "trace"],
"no-constant-condition": true,
"no-control-regex": true,
"no-debugger": true,
"no-duplicate-switch-case": true,
"no-duplicate-super": true,
"no-duplicate-variable": true,
"no-empty": false,
"no-floating-promises": true,
"no-for-in-array": true,
"no-import-side-effect": true,
"no-increment-decrement": false,
"increment-decrement": false,
"no-invalid-regexp": true,
"no-invalid-template-strings": true,
"no-invalid-this": true,
"no-jquery-raw-elements": true,
"no-misused-new": true,
"no-non-null-assertion": true,
"no-reference-import": true,
"no-regex-spaces": true,
"no-sparse-arrays": true,
"no-stateless-class": false,
"no-string-literal": true,
"no-string-throw": true,
"no-unnecessary-bind": true,
"no-unnecessary-callback-wrapper": true,
"no-unnecessary-initializer": true,
"no-unnecessary-override": true,
"no-unsafe-any": false,
"no-unsafe-finally": true,
"no-unused-expression": true,
"no-use-before-declare": true,
"no-with-statement": true,
"promise-function-async": true,
"promise-must-complete": true,
"radix": true,
"react-this-binding-issue": true,
"react-unused-props-and-state": true,
"restrict-plus-operands": true, // the plus operand should really only be used for strings and numbers
"strict-boolean-expressions": false,
"switch-default": false,
"triple-equals": [true, "allow-null-check"],
"use-isnan": true,
"use-named-parameter": true,
"valid-typeof": false,
/**
* Code Clarity. The following rules should be turned on because they make the code
* generally more clear to the reader.
*/
"adjacent-overload-signatures": true,
"array-type": [true, "array"],
"arrow-parens": false, // for simple functions the parens on arrow functions are not needed
"callable-types": true,
"chai-prefer-contains-to-index-of": true,
"chai-vague-errors": false,
"class-name": true,
"comment-format": [true],
"completed-docs": [false, "classes"],
"export-name": false,
"function-name": [ true, {
"method-regex": "^[a-z][\\w\\d]+$",
"private-method-regex": "^[a-z][\\w\\d]+$",
"protected-method-regex": "^[a-z][\\w\\d]+$",
"static-method-regex": "^[a-z][\\w\\d]+$",
"function-regex": "^[a-z][\\w\\d]+$"
}],
"import-name": true,
"interface-name": [true],
"jsdoc-format": true,
"max-classes-per-file": [true, 3], // we generally recommend making one public class per file
"max-file-line-count": [true],
"max-func-body-length": [false],
"max-line-length": [true, 200],
"member-access": true,
"member-ordering": [true, { "order": "fields-first" }],
"mocha-unneeded-done": true,
"new-parens": true,
"no-construct": true,
"no-default-export": true,
"no-empty-interface": true,
"no-for-in": false,
"no-function-expression": true,
"no-inferrable-types": false, // turn no-inferrable-types off in order to make the code consistent in its use of type decorations
"no-multiline-string": true, // multiline-strings often introduce unnecessary whitespace into the string literals
"no-null-keyword": false, // turn no-null-keyword off and use undefined to mean not initialized and null to mean without a value
"no-parameter-properties": true,
"no-relative-imports": false,
"no-require-imports": true,
"no-shadowed-variable": true,
"no-suspicious-comment": true,
"no-typeof-undefined": true,
"no-unnecessary-field-initialization": true,
"no-unnecessary-local-variable": true,
"no-unnecessary-qualifier": true,
"no-unsupported-browser-code": true,
"no-useless-files": true,
"no-var-keyword": true,
"no-var-requires": true,
"no-this-assignment": true,
"no-void-expression": false,
"object-literal-sort-keys": false, // turn object-literal-sort-keys off and sort keys in a meaningful manner
"one-variable-per-declaration": [true],
"only-arrow-functions": [false], // there are many valid reasons to declare a function
"ordered-imports": [true],
"prefer-array-literal": true,
"prefer-const": true,
"prefer-for-of": false,
"prefer-method-signature": true,
"prefer-template": true,
"return-undefined": false, // this actually affect the readability of the code
"typedef": [true, "call-signature", "parameter", "property-declaration", "member-variable-declaration"],
"underscore-consistent-invocation": true,
"unified-signatures": true,
"variable-name": [true, "allow-leading-underscore"],
/**
* Accessibility. The following rules should be turned on to guarantee the best user
* experience for keyboard and screen reader users.
*/
"react-a11y-anchors": true,
"react-a11y-aria-unsupported-elements": true,
"react-a11y-event-has-role": true,
"react-a11y-image-button-has-alt": true,
"react-a11y-img-has-alt": true,
"react-a11y-lang": true,
"react-a11y-meta": true,
"react-a11y-props": true,
"react-a11y-proptypes": true,
"react-a11y-role": true,
"react-a11y-role-has-required-aria-props": true,
"react-a11y-role-supports-aria-props": true,
"react-a11y-tabindex-no-positive": true,
"react-a11y-titles": true,
/**
* Whitespace related rules. The only recommended whitespace strategy is to pick a single format and
* be consistent.
*/
"align": [true, "parameters", "arguments", "statements"],
"curly": true,
"eofline": true,
"import-spacing": true,
"indent": [true, "spaces"],
"linebreak-style": [true],
"newline-before-return": false,
"no-consecutive-blank-lines": true,
"no-empty-line-after-opening-brace": false,
"no-single-line-block-comment": true,
"no-trailing-whitespace": true,
"no-unnecessary-semicolons": true,
"object-literal-key-quotes": [true, "as-needed"],
"one-line": [true, "check-open-brace", "check-catch", "check-else", "check-whitespace"],
"quotemark": [true, "double"],
"react-tsx-curly-spacing": true,
"semicolon": [true, "always"],
"trailing-comma": [true, {"singleline": "never", "multiline": "never"}], // forcing trailing commas for multi-line
// lists results in lists that are easier to reorder and version control diffs that are more clear.
// Many teams like to have multiline be 'always'. There is no clear consensus on this rule but the
// internal MS JavaScript coding standard does discourage it.
"typedef-whitespace": [false],
"whitespace": [true, "check-branch", "check-decl", "check-operator", "check-separator", "check-type"],
/**
* Controversial/Configurable rules.
*/
"ban": false, // only enable this if you have some code pattern that you want to ban
"ban-types": true,
"cyclomatic-complexity": [false],
"file-header": [false], // enable this rule only if you are legally required to add a file header
"import-blacklist": false, // enable and configure this as you desire
"interface-over-type-literal": false, // there are plenty of reasons to prefer interfaces
"no-angle-bracket-type-assertion": false, // pick either type-cast format and use it consistently
"no-inferred-empty-object-type": false, // if the compiler is satisfied then this is probably not an issue
"no-internal-module": false, // only enable this if you are not using internal modules
"no-magic-numbers": false, // by default it will find too many false positives
"no-mergeable-namespace": false, // your project may require mergeable namespaces
"no-namespace": false, // only enable this if you are not using modules/namespaces
"no-reference": true, // in general you should use a module system and not /// reference imports
"no-unexternalized-strings": false, // the VS Code team has a specific localization process that this rule enforces
"object-literal-shorthand": false, // object-literal-shorthand offers an abbreviation not an abstraction
"prefer-type-cast": true, // pick either type-cast format and use it consistently
"space-before-function-paren": false, // turn this on if this is really your coding standard
"prefer-switch": false,
"prefer-function-over-method": false,
"prefer-conditional-expression": false,
"strict-type-predicates": false,
"no-submodule-imports": false,
"no-object-literal-type-assertion": false,
"no-unbound-method": false,
"no-unnecessary-class": false,
"no-implicit-dependencies": false,
"no-dynamic-delete": false,
"newline-per-chained-call": false,
/**
* Deprecated rules. The following rules are deprecated for various reasons.
*/
"missing-optional-annotation": false, // now supported by TypeScript compiler
"no-duplicate-parameter-names": false, // now supported by TypeScript compiler
"no-empty-interfaces": false, // use tslint no-empty-interface rule instead
"no-missing-visibility-modifiers": false, // use tslint member-access rule instead
"no-multiple-var-decl": false, // use tslint one-variable-per-declaration rule instead
"no-switch-case-fall-through": false, // now supported by TypeScript compiler
"typeof-compare": false, // the valid-typeof rule is currently superior to this version
"file-name-casing": false,
"no-unused-variable": false,
"ban-ts-ignore": false,
"unnecessary-else": false
}
}