← Back to rules

jsdoc/require-property 正しさ

An auto-fix is available for this rule.

機能

@typedef および @namespace タグが、型が単純な object、Object、または PlainObject である場合に、@property タグを含むことを要求します。

注: このルールは jsdoc 設定 オプションを使用してカスタマイズ可能です。

なぜ問題なのか？

オブジェクト型にはプロパティが定義されているべきです。

例

このルールに違反する 誤った コードの例:

/**
 * @typedef {Object} SomeTypedef
 */

/**
 * @namespace {Object} SomeNamesoace
 */

このルールに準拠する 正しい コードの例:

/**
 * @typedef {Object} SomeTypedef
 * @property {SomeType} propName プロパティの説明
 */

/**
 * @typedef {object} Foo
 * @property someProp
 */

使用方法

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

設定 (.oxlintrc.json)

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

CLI

oxlint --deny jsdoc/require-property --jsdoc-plugin

参考資料

• ルールのソース