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