跳至主要內容

package_prefixed_library_names

穩定

在函式庫名稱前加上套件名稱和點分隔的路徑。

詳細資訊

#

務必在函式庫名稱前加上套件名稱和點分隔的路徑。

此指南有助於避免在兩個函式庫具有相同名稱時收到的警告。以下是我們建議的規則

  • 在所有函式庫名稱前加上套件名稱。
  • 使入口函式庫具有與套件相同的名稱。
  • 對於套件中的所有其他函式庫,在套件名稱後加上以點分隔的函式庫 Dart 檔案路徑。
  • 對於 lib 下的函式庫,省略最上層目錄名稱。

例如,假設套件名稱為 my_package。以下是套件中各種檔案的函式庫名稱

良好範例

dart
// In lib/my_package.dart
library my_package;

// In lib/other.dart
library my_package.other;

// In lib/foo/bar.dart
library my_package.foo.bar;

// In example/foo/bar.dart
library my_package.example.foo.bar;

// In lib/src/private.dart
library my_package.src.private;

啟用

#

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

analysis_options.yaml
yaml
linter:
  rules:
    - package_prefixed_library_names

如果您改為使用 YAML map 語法來設定 linter 規則,請在 linter > rules 下新增 package_prefixed_library_names: true

analysis_options.yaml
yaml
linter:
  rules:
    package_prefixed_library_names: true