← Back to rules

jsdoc/check-property-names 正しさ

An auto-fix is available for this rule.

何を実行するか

JSDoc 内のプロパティ名が同じブロック内で重複していないこと、およびネストされたプロパティに定義されたルートがあることを確認します。

なぜ悪いのか

同じ名前の @property タグは混乱を引き起こす可能性があり、誤りの兆候である場合があります。

例

このルールに対して 誤った 例：

/**
 * @typedef {object} state
 * @property {number} foo
 * @property {string} foo
 */

/**
 * @typedef {object} state
 * @property {number} foo.bar
 */

このルールに対して 正しい 例：

/**
 * @typedef {object} state
 * @property {number} foo
 */

/**
 * @typedef {object} state
 * @property {object} foo
 * @property {number} foo.bar
 */

使用方法

設定ファイルまたは CLI でこのルールを 有効化 するには、次のように使用できます：

設定 (.oxlintrc.json)

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/check-property-names": "error"
  }
}

CLI

oxlint --deny jsdoc/check-property-names --jsdoc-plugin

参照

• ルールのソース