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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
module.exports = {
plugins: ["jsdoc"],
rules: {
"jsdoc/require-jsdoc": [
"error",
{
require: {
ClassDeclaration: true,
FunctionDeclaration: false,
},
},
],
"jsdoc/require-param": "error",
"jsdoc/require-param-description": "error",
"jsdoc/require-param-name": "error",
"jsdoc/require-property": "error",
"jsdoc/require-property-description": "error",
"jsdoc/require-property-name": "error",
"jsdoc/require-property-type": "error",
"jsdoc/require-returns": "error",
"jsdoc/require-returns-check": "error",
"jsdoc/require-yields": "error",
"jsdoc/require-yields-check": "error",
},
settings: {
jsdoc: {
// This changes what's allowed in JSDocs, enabling more type-inference
// friendly types. This is the default in eslint-plugin-jsdoc versions
// since May 2023, but we're still on 39.9 and need opt-in for now.
// https://github.com/gajus/eslint-plugin-jsdoc/issues/834
mode: "typescript",
},
},
};
|
