UNPKG

2.33 kBJavaScriptView Raw
1/* eslint sort-keys: ["error", "asc"] */
2/* eslint-disable sort-keys */
3
4module.exports = {
5 plugins: ["jsdoc"],
6 overrides: [
7 {
8 files: "*.ts{,x}",
9 rules: {
10 "jsdoc/no-types": "warn", // JSDoc types are not necessary when using TypeScript
11 "jsdoc/require-param": "off",
12 "jsdoc/require-param-type": "off",
13 "jsdoc/require-returns": "off",
14 "jsdoc/require-returns-type": "off",
15 },
16 },
17 ],
18 rules: {
19 // https://github.com/gajus/eslint-plugin-jsdoc/blob/master/README.md
20 "jsdoc/check-access": "warn",
21 "jsdoc/check-alignment": "warn",
22 "jsdoc/check-examples": "warn",
23 "jsdoc/check-indentation": "warn",
24 "jsdoc/check-param-names": "warn",
25 "jsdoc/check-property-names": "warn",
26 "jsdoc/check-syntax": "off",
27 "jsdoc/check-tag-names": [
28 "warn",
29 {
30 definedTags: ["swagger"],
31 },
32 ],
33 "jsdoc/check-types": "warn",
34 "jsdoc/check-values": "off",
35 "jsdoc/empty-tags": "warn",
36 "jsdoc/implements-on-classes": "off",
37 "jsdoc/match-description": "off",
38 "jsdoc/newline-after-description": "warn",
39 "jsdoc/no-bad-blocks": "warn",
40 "jsdoc/no-defaults": "warn",
41 "jsdoc/no-types": "off",
42 "jsdoc/no-undefined-types": "warn",
43 "jsdoc/require-description": "off",
44 "jsdoc/require-description-complete-sentence": "off",
45 "jsdoc/require-example": "off",
46 "jsdoc/require-file-overview": "off",
47 "jsdoc/require-hyphen-before-param-description": "warn",
48 "jsdoc/require-jsdoc": "off",
49 "jsdoc/require-param": "warn",
50 "jsdoc/require-param-description": "off",
51 "jsdoc/require-param-name": "off",
52 "jsdoc/require-param-type": "warn",
53 "jsdoc/require-property": "off",
54 "jsdoc/require-property-description": "off",
55 "jsdoc/require-property-name": "warn",
56 "jsdoc/require-property-type": "warn",
57 "jsdoc/require-returns": "warn",
58 "jsdoc/require-returns-check": "warn",
59 "jsdoc/require-returns-description": "off",
60 "jsdoc/require-returns-type": "warn",
61 "jsdoc/valid-types": "warn",
62 },
63};