目次

library_private_types_in_public_api

公開APIでプライベート型を使用しないでください。

このルールは、Dart 2.14から利用可能です。

ルールセット:推奨Flutter

詳細

#

避けるべき:公開APIでライブラリプライベート型を使用すること。

このlintにおいて、公開APIとは、宣言がライブラリプライベートでない限り、またはライブラリプライベートな宣言に含まれていない限り、トップレベルまたはメンバー宣言を指します。以下の型の使用がチェックされます。

  • 関数の戻り値の型、
  • 関数のパラメータの型、
  • 関数、メソッド、クラス、ミックスイン、拡張の拡張型、または型エイリアスの型パラメータのバインド、
  • トップレベル変数またはフィールドの型、
  • 型エイリアスの宣言で使用される型(例:`typedef F = _Private Function();`)、または
  • 拡張またはミックスインの`on`句で使用される型

悪い例

dart
f(_Private p) { ... }
class _Private {}

良い例

dart
f(String s) { ... }

使用方法

#

`library_private_types_in_public_api`ルールを有効にするには、`analysis_options.yaml`ファイルのlinter > rulesセクションに`library_private_types_in_public_api`を追加します。

analysis_options.yaml
YAML
linter:
  rules:
    - library_private_types_in_public_api