Source code
Revision control
Copy as Markdown
Other Tools
/* 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
import jsdoc from "eslint-plugin-jsdoc";
export default {
name: "mozilla/require-jsdoc",
plugins: { jsdoc },
rules: {
"jsdoc/require-jsdoc": [
"error",
{
require: {
ClassDeclaration: true,
FunctionDeclaration: false,
},
},
],
"jsdoc/require-next-type": "error",
"jsdoc/require-param": "error",
"jsdoc/require-param-name": "error",
"jsdoc/require-param-type": "error",
"jsdoc/require-property": "error",
"jsdoc/require-property-description": "error",
"jsdoc/require-property-name": "error",
"jsdoc/require-property-type": "error",
"jsdoc/require-returns-check": "error",
// "jsdoc/require-throws-type": "error",
"jsdoc/require-yields": "error",
"jsdoc/require-yields-check": "error",
"jsdoc/require-yields-type": "error",
},
};