目次

パッケージプレフィックス付きライブラリ名

ライブラリ名にパッケージ名とドット区切りのパスをプレフィックスとして追加します。

このルールは、Dart 2.0以降で利用可能です。

詳細

#

必ずライブラリ名にパッケージ名とドット区切りのパスをプレフィックスとして追加してください。

このガイドラインは、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ファイルのリンター > ルールの下にpackage_prefixed_library_namesを追加します。

analysis_options.yaml
YAML
linter:
  rules:
    - package_prefixed_library_names