跳到主要內容

library_private_types_in_public_api

穩定
推薦

避免在公共 API 中使用庫私有型別。

詳細資訊

#

避免在公共 API 中使用庫私有型別。

就此 lint 而言,公共 API 被認為是任何頂層或成員宣告,除非該宣告是庫私有的或包含在庫私有的宣告中。檢查以下型別的使用情況:

  • 函式或方法的返回型別,
  • 函式或方法的任何引數型別,
  • 函式、方法、類、mixin、擴充套件的擴充套件型別或類型別名的任何型別引數的邊界,
  • 任何頂層變數或欄位的型別,
  • 類型別名宣告中使用的任何型別(例如 typedef F = _Private Function();),或
  • 擴充套件或 mixin 的 on 子句中使用的任何型別

BAD(錯誤示例)

dart
f(_Private p) { ... }
class _Private {}

GOOD(正確示例)

dart
f(String s) { ... }

啟用

#

要啟用 library_private_types_in_public_api 規則,請在您的 analysis_options.yaml 檔案的 linter > rules 下新增 library_private_types_in_public_api

analysis_options.yaml
yaml
linter:
  rules:
    - library_private_types_in_public_api

如果您改用 YAML map 語法來配置 linter 規則,請在 linter > rules 下新增 library_private_types_in_public_api: true

analysis_options.yaml
yaml
linter:
  rules:
    library_private_types_in_public_api: true