mcpField
S
signals-lint

signals-lint

github.com/rodydavisTesting & quality82496 installsUpdated 12w ago
Repository

About signals-lint

A tooling reference for `signals_lint` in the `signals.dart` ecosystem, for developers maintaining Flutter applications. It documents static-analysis rules and IDE quick-fixes for common signal and widget patterns.

Key features

  1. 01Flags signal creation inside build methods
  2. 02Detects deprecated watch APIs and mixins
  3. 03Enforces named builder callbacks
  4. 04Recommends unified option classes
  5. 05IDE quick-fixes for widget conversion and migration

Use cases

  1. 01Finding signal state recreated during Flutter builds
  2. 02Migrating deprecated watch and mixin usage
  3. 03Applying consistent SignalBuilder conventions
  4. 04Refactoring widgets with IDE assists

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/rodydavis/signals.dart --skill signals-lint

After installing, type/signals-lintin Claude Code to confirm it loaded.

Bundled filesCONTEXT.md

Details

From the project README

signals_lint Tooling & Rules

This skill covers working with static code analysis, custom compiler warning diagnostics, and automated quick-fixes in the signals.dart ecosystem.

🚀 Activation & Setup

Ensure the plugin is active in your project to enable real-time IDE diagnostics and fixes:

# pubspec.yaml
dev_dependencies:
  custom_lint: ^0.8.1
  signals_lint: ^7.0.0

# analysis_options.yaml
analyzer:
  plugins:
    - custom_lint

🛡️ Lint Rules Reference

1. signals_avoid_create_in_build_method

Flags instances where a signal or computed variable is created inside a Flutter build method.

  • Problem: Creating state during build causes state to reset on every rebuild.
  • Solution: Move the creation to the class fields or initialize inside a state lifecycle hook.
2. signals_avoid_deprecated_watch_extension

Flags uses of deprecated BuildContext.watch() and BuildContext.unwatch() extensions.

  • Problem: Watch extensions can cause broad stateful widget lifecycle overhead.
  • Solution: Use localized SignalBuilder or inherit from SignalWidget/SignalStatefulWidget.
3. signals_avoid_deprecated_signals_mixin

Flags usage of deprecated with SignalsMixin mixins on StatefulWidget states.

  • Problem: Inherits stateful widget tracking hooks unnecessarily.
  • Solution: Inherit from SignalStatefulWidget instead.
4. signals_prefer_named_builder

Enforces named builder: callbacks in SignalBuilder and Watch elements instead of positional arguments.

  • Reason: Guarantees standard API parameters and readability.
5. signals_prefer_unified_options

Flags direct creator configuration arguments (e.g. autoDispose: true).

  • Solution: Bundle configuration properties under unified options classes (e.g., options: SignalOptions(autoDispose: true)).

💡 Automated IDE Code Assists (Quick-fixes)

Place your cursor on the relevant class name or widget instantiation inside your IDE to reveal these automatic assists via the quick-fix menu (Cmd+. or Alt+Enter):

  1. WrapWithSignalBuilder: Wraps any widget expression inside SignalBuilder(builder: (context) => ...).
  2. ConvertStatelessToSignalWidget: Refactors a standard StatelessWidget into a SignalWidget instantly.
  3. ConvertStatefulToSignalStatefulWidget: Refactors a standard StatefulWidget to a SignalStatefulWidget.
  4. MigrateSignalsMixinToSignalStatefulWidget: Strips the legacy SignalsMixin and converts the class structure to SignalStatefulWidget.
  5. MigrateWatchToSignalBuilder: Converts legacy Watch(...) instances into clean SignalBuilder widgets.

Comments

Markdown supported