版本

規則棄用

規則棄用元數據描述規則是否已棄用,以及在有替代方案時規則如何被取代。舊格式使用兩個頂層的 規則 meta 屬性 deprecated: truereplacedBy。在新格式中,deprecated 是一個 DeprecatedInfo 類型的物件,而 replacedBy 應定義在 deprecated 內部,而不是頂層。

◆ DeprecatedInfo 類型

此類型表示有關規則棄用的一般資訊。每個屬性都是可選的。

  • message (string)
    可呈現給使用者的一般訊息。可能包含此規則為何被棄用或如何取代規則。
  • url (string)
    包含有關此規則棄用更多資訊的 URL。
  • replacedBy (ReplacedByInfo[])
    有關規則可用替代方案的資訊。這可能是一個空陣列,以明確聲明沒有替代方案。
  • deprecatedSince (string)
    Semver 棄用規則的版本。
  • availableUntil (string | null)
    Semver 可能移除規則的版本,例如下一個主要版本。特殊值 null 表示規則將不再更改,但將保持可用。

◆ ReplacedByInfo 類型

此類型描述規則的單個可能替代方案。每個屬性都是可選的。

  • message (string)
    關於此規則替代方案的一般訊息,例如
  • url (string)
    包含有關此規則替代方案更多資訊的 URL。
  • plugin (ExternalSpecifier)
    指定哪個外掛程式具有替代規則。名稱應為套件名稱,如果替代方案是 ESLint 核心規則,則應為“eslint”。如果替代方案在同一個外掛程式中,則應省略此屬性。
  • rule (ExternalSpecifier)
    指定替代規則。如果外掛程式僅包含單個規則或具有與規則相同的名稱,則可以省略。

◆ ExternalSpecifier 類型

此類型表示外部資源。每個屬性都是可選的。

  • name (string)
    plugin 的套件名稱和 rule 的規則 ID。
  • url (string)
    指向外掛程式/規則文件的 URL…
變更語言