view_model_lint 1.3.1

Analyzer plugin for safe ViewModel ownership, specs, and dependency composition.

view_model_lint

Recommended native analyzer checks for applications and business packages using view_model. Requires Dart 3.10 / Flutter 3.38 or newer. The plugin runs in the analysis process and adds no runtime dependency or runtime SDK requirement.

Enable the plugin

Add this to the consuming package's root analysis_options.yaml, preserving its existing includes and rules:

plugins:
  view_model_lint:
    version: ^1.3.1

For local plugin development, replace version with path: /absolute/path/to/flutter_view_model/packages/view_model_lint. The repository examples use path: ../../packages/view_model_lint. No analyzer or custom_lint dependency is needed in the consuming package's pubspec.yaml. Restart the IDE's Dart Analysis Server, then run from the consuming package root:

dart analyze --fatal-infos --fatal-warnings

Use this command in CI as well. With this workstation's aliases, run zsh -ic 'fd analyze --fatal-infos --fatal-warnings'. Avoid targeting only lib or test: on the verified Dart 3.11 toolchain that invocation can skip loading the package-root plugin. All four diagnostics are enabled as warnings.

Rules

Diagnostic	Meaning and recommended fix
view_model_dependency_cycle	A statically visible parent-to-child type cycle. Break the cycle or review whether keys/bindings identify distinct instances.
view_model_cached_instance	A resolved read/watch VM is stored in a field, top-level variable, or field assignment. Use a getter that resolves on every access.
view_model_alive_forever_key	Literal aliveForever: true, including a simple callback, has no non-null key. Supply an explicit key.
view_model_unmanaged_construction	A VM is constructed outside a spec builder, ViewModelFactory.build, or an annotated @GenSpec factory named spec. Resolve a stable spec through a binding.

Parameterized specs may omit key without a diagnostic. Use an argument-derived key when separate instances are intended. The aliveForever key requirement still applies to both ordinary and parameterized specs.

Disable individual rules through the plugin's diagnostics map, for example view_model_cached_instance: false. For a narrowly scoped exception, use // ignore: view_model_lint/view_model_cached_instance with a reason. Remove old view_model_parameterized_spec_key settings and suppressions when upgrading; that diagnostic is no longer registered.

Analysis boundaries

Rules identify resolved framework types and methods, including inherited VMs and prefixed imports. Unrelated same-named classes and methods are not framework APIs. Managed builders, local temporaries, getters, callbacks, and transformed plain values are not treated as stored VM instances.

Cycle detection follows the VM's own viewModelBinding.read/watch calls. Within the current library, including its parts, it checks statically visible calls. Across libraries it follows VM getters/fields that directly return a resolution. Dynamic calls, indirect helper-function dependencies, key/tag identity, and runtime overrides are outside this proof. Type cycles are advisory and cannot replace runtime instance-cycle validation. Unknown key/aliveForever expressions are not guessed to be null/true.

Development

dart pub get
dart analyze --fatal-infos --fatal-warnings lib test
dart test --concurrency=1

Tests cover positive cases, false-positive boundaries, cross-file cycles, configuration, and plugin loading by a real dart analyze process. This package shares its release version with view_model, view_model_annotation, and view_model_generator. See the repository publishing skill for the coordinated release procedure.

Integration follows the Dart analyzer plugin documentation.