End-of-Life for Built-in JSDoc Support in ESLint – ESLint – Pluggable JavaScript linter
ESLintはJavaScriptの詳細で厳密なチェックをし、簡単なものによっては修正も行ってくれる検証ツールです。JSDocは次の様なJavaScript中のコメントのテンプレートです。
/** * 現在のソートの状態からアイコンを表示するべきかを判断する * @param {String} column カラム名 * @param {String} ascOrDesc 昇順か降順か * @return {Boolean} アイコンを表示するべきならtrue */ shouldDisplayIcon: function(column, ascOrDesc) {
JSDocは読みやすいことの他にもIDE等ソースコードを対象としたアプリ―ケーションで利用でき便利です。ESLintもJSDocを素でサポートしていたのですが、ESLintとJSDocの発展とメンテナ(スタッフみたいなもの)の規模の関係からJSDocのサポートが打ち切られました。これに従って、既存のJSDoc用ルールが非推奨ルールになりました。ESLintが勧めるJSDoc関連ルールを設定できる移行先プラグインがeslint-plugin-jsdocです。
eslint-plugin-jsdoc – npm
eslint-plugin-jsdocはESLint本体よりもJSDocに詳細なルールが用意されており、より厳密なルールによってJSDocを検証できます。readmeに載っていませんがrecommendedによるルールのプリセットも用意されています。次の様に.eslintrc.jsonに記述してサクッと使えます。
"plugins": [ "jsdoc" ], "extends": [ "plugin:jsdoc/recommended", ],