この記事を受けて、eslint-plugin-jsdocを導入した。
その同時期にstileをgoogle
からJavaScript Standard Style
へ変えてみた。
(参考: JavaScriptの有名なコーディングスタンダードまとめ | hifive開発者ブログ)
jsdocコメントのlintが出ない
google style
ではjsdocコメントは必須だが、JavaScript Standard Style
では必須ではない。
それらを加味してeslint-plugin-jsdocを入れてみた。設定は以下の通り。
@description
タグは使いたくない、日本語だと警告がでる、その部分だけオフにしている。
eslintrc.json
{
"extends": "Standard",
"plugins": ["jest", "node", "promise", "jsdoc"],
"env": {
"es6": true,
"node": true,
"jest/globals": true
},
"rules": {
~~中略~~
"jsdoc/check-param-names": 1,
"jsdoc/check-tag-names": 0,
"jsdoc/check-types": 1,
"jsdoc/newline-after-description": 1,
"jsdoc/no-undefined-types": 1,
"jsdoc/require-description": 0,
"jsdoc/require-description-complete-sentence": 0,
"jsdoc/require-example": 1,
"jsdoc/require-hyphen-before-param-description": 1,
"jsdoc/require-param": 1,
"jsdoc/require-param-description": 1,
"jsdoc/require-param-name": 1,
"jsdoc/require-param-type": 1,
"jsdoc/require-returns-description": 1,
"jsdoc/require-returns-type": 1,
"jsdoc/valid-types": 1
}
}
で、ふと気付いた。jsdocコメントを書いていないのに警告が出ない。
適当なコメントを書いたらMissing JSDoc @example declaration
とか言ってくれるのに。
どうやら全く書いていなければ警告は出ない。
書いているjsdocコメントについて「アレが足りないココがおかしい」とは言ってくれるが「コメント書かなきゃ!」とは言ってくれない。
修正方法
rulesに以下を追加します。これでjsdocコメントを書いていないことへの警告をしてくれます。プラグインの機能ではなく公式の機能です。
eslintrc.json
"require-jsdoc": 2,
公式では「JSDoc サポートが終了します」とのことですが、require-jsdoc
は残してくれるんでしょうか。