跳到主要內容

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 對映語法配置 Linter 規則,請在 linter > rules 下新增 package_prefixed_library_names: true

analysis_options.yaml
yaml
linter:
  rules:
    package_prefixed_library_names: true