メインコンテンツにスキップ

package_prefixed_library_names

安定版

パッケージ名とドット区切りのパスでライブラリ名を修飾してください。

詳細

#

DO パッケージ名とドット区切りのパスでライブラリ名を修飾してください。

このガイドラインは、2つのライブラリが同じ名前を持つ場合に表示される警告を回避するのに役立ちます。推奨されるルールは次のとおりです。

  • すべてのライブラリ名にパッケージ名を付けます。
  • エントリーライブラリには、パッケージと同じ名前を付けます。
  • パッケージ内の他のすべてのライブラリでは、パッケージ名の後にライブラリの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 > rules の下に package_prefixed_library_names: true を追加します。

analysis_options.yaml
yaml
linter:
  rules:
    package_prefixed_library_names: true