內容

package_prefixed_library_names

使用套件名稱和以點分隔的路徑作為函式庫名稱的前綴。

此規則自 Dart 2.0 起可用。

詳細資訊

#

請務必使用套件名稱和以點分隔的路徑作為函式庫名稱的前綴。

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

  • 所有函式庫名稱都加上套件名稱的前綴。
  • 使進入點函式庫的名稱與套件相同。
  • 對於套件中的所有其他函式庫,在套件名稱後,加上函式庫 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