nilts

Description:

nilts

nilts #
nilts is lint rules, quick fixes and assists for Dart and Flutter projects that helps you enforce best practices, and avoid errors.





Contents #

Usage
Configuration

Disabling strategy
Enabling strategy


Lint rules and quick fixes

Overview
Details


Assists
Known issues
Feature requests
Bug reports
Contributing

Usage #
nilts depends on custom_lint.
You should add nilts and custom_lint to your dev_dependencies in pubspec.yaml file.
dev_dependencies:
custom_lint: <version>
nilts: <version>
copied to clipboard
And also, add custom_lint to your analysis_options.yaml file.
analyzer:
plugins:
- custom_lint
copied to clipboard
Configuration #
You can configure all lint rules provided by nilts in analysis_options.yaml file.
Choice one of the following configuration strategies.
Disabling strategy #
All of nilts rules are enabled by default.
Add lint rule name and set false to disable it.
custom_lint:
rules:
# Disable particular lint rules if you want ignore them whole package.
- unnecessary_rebuilds_from_media_query: false
copied to clipboard
Enabling strategy #
You can disable all lint rules depends on custom_lint by setting enable_all_lint_rules to false.
Add lint rule name and set true to enable it.
custom_lint:
# Disable all lint rules depends on custom_lint.
enable_all_lint_rules: false
rules:
- unnecessary_rebuilds_from_media_query: true
copied to clipboard
NOTE: If you enable_all_lint_rules set to false, all of lint rules (not only all of nilts's lint rules) depends on custom_lint will be disabled by default.
Lint rules and quick fixes #
Read below to learn about each lint rules intend to.
Some of lint rules support quick fixes on IDE.

Overview #



Rule name
Overview
Target SDK
Rule type
Maturity level
Quick fix




defined_async_callback_type
Checks Future<void> Function() definitions.
Any versions nilts supports
Practice
Experimental
✅️


defined_async_value_getter_type
Checks Future<T> Function() definitions.
Any versions nilts supports
Practice
Experimental
✅️


defined_async_value_setter_type
Checks Future<void> Function(T value) definitions.
Any versions nilts supports
Practice
Experimental
✅️


defined_value_changed_type
Checks void Function(T value) definitions.
Any versions nilts supports
Practice
Experimental
✅️


defined_value_getter_type
Checks T Function() definitions.
Any versions nilts supports
Practice
Experimental
✅️


defined_value_setter_type
Checks void Function(T value) definitions.
Any versions nilts supports
Practice
Experimental
✅️


defined_void_callback_type
Checks void Function() definitions.
Any versions nilts supports
Practice
Experimental
✅️


fixed_text_scale_rich_text
Checks usage of textScaler or textScaleFactor in RichText constructor.
Any versions nilts supports
Practice
Experimental
✅️


flaky_tests_with_set_up_all
Checks setUpAll usages.
Any versions nilts supports
Practice
Experimental
✅️


no_support_multi_text_direction
Checks if supports TextDirection changes.
Any versions nilts supports
Practice
Experimental
✅️


no_support_web_platform_check
Checks if Platform.isXxx usages.
Any versions nilts supports
Practice
Experimental
✅️


shrink_wrapped_scroll_view
Checks the content of the scroll view is shrink wrapped.
Any versions nilts supports
Practice
Experimental
✅️


unnecessary_rebuilds_from_media_query
Checks MediaQuery.xxxOf(context) or MediaQuery.maybeXxxOf(context) usages.
>= Flutter 3.10.0 (Dart 3.0.0)
Practice
Experimental
✅️



Details #
defined_async_callback_type


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Consider replace Future<void> Function() with AsyncCallback which is defined in Flutter SDK.
BAD:
final Future<void> Function() callback;
copied to clipboard
GOOD:
final AsyncCallback callback;
copied to clipboard
See also:

AsyncCallback typedef - foundation library - Dart API


defined_async_value_getter_type


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Consider replace Future<T> Function() with AsyncValueGetter which is defined in Flutter SDK.
BAD:
final Future<int> Function() callback;
copied to clipboard
GOOD:
final AsyncValueGetter<int> callback;
copied to clipboard
See also:

AsyncValueGetter typedef - foundation library - Dart API


defined_async_value_setter_type


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Consider replace Future<void> Function(T value) with AsyncValueSetter which is defined in Flutter SDK.
BAD:
final Future<void> Function(int value) callback;
copied to clipboard
GOOD:
final AsyncValueSetter<int> callback;
copied to clipboard
See also:

AsyncValueSetter typedef - foundation library - Dart API


defined_value_changed_type


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Consider replace void Function(T value) with ValueChanged which is defined in Flutter SDK.
If the value has been set, use ValueSetter instead.
BAD:
final void Function(int value) callback;
copied to clipboard
GOOD:
final ValueChanged<int> callback;
copied to clipboard
See also:

ValueChanged typedef - foundation library - Dart API
ValueSetter typedef - foundation library - Dart API


defined_value_getter_type


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Consider replace T Function() with ValueGetter which is defined in Flutter SDK.
BAD:
final int Function() callback;
copied to clipboard
GOOD:
final ValueGetter<int> callback;
copied to clipboard
See also:

ValueGetter typedef - foundation library - Dart API


defined_value_setter_type


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Consider replace void Function(T value) with ValueSetter which is defined in Flutter SDK.
If the value has changed, use ValueChanged instead.
BAD:
final void Function(int value) callback;
copied to clipboard
GOOD:
final ValueSetter<int> callback;
copied to clipboard
See also:

ValueSetter typedef - foundation library - Dart API
ValueChanged typedef - foundation library - Dart API


defined_void_callback_type


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Consider replace void Function() with VoidCallback which is defined in Flutter SDK.
BAD:
final void Function() callback;
copied to clipboard
GOOD:
final VoidCallback callback;
copied to clipboard
See also:

VoidCallback typedef - dart:ui library - Dart API


fixed_text_scale_rich_text


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Consider using Text.rich or adding textScaler or textScaleFactor (deprecated on Flutter 3.16.0 and above) argument to RichText constructor to make the text size responsive for user setting.
BAD:
RichText(
text: TextSpan(
text: 'Hello, world!',
),
)
copied to clipboard
GOOD:
Text.rich(
TextSpan(
text: 'Hello, world!',
),
)
copied to clipboard
GOOD:
RichText(
text: TextSpan(
text: 'Hello, world!',
),
textScaler: MediaQuery.textScalerOf(context),
)
copied to clipboard
GOOD (deprecated on Flutter 3.16.0 and above):
RichText(
text: TextSpan(
text: 'Hello, world!',
),
textScaleFactor: MediaQuery.textScaleFactorOf(context),
)
copied to clipboard
See also:

Text.rich constructor - Text - widgets library - Dart API
RichText class - widgets library - Dart API


flaky_tests_with_set_up_all


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Consider using setUp function or initialization on top level or body of test group.
setUpAll may cause flaky tests with concurrency executions.
BAD:
setUpAll(() {
// ...
});
copied to clipboard
GOOD:
setUp(() {
// ...
});
copied to clipboard
void main() {
// do initialization on top level
// ...

group('...', () {
// or do initialization on body of test group
// ...
});
}
copied to clipboard
See also:

setUpAll function - flutter_test library - Dart API
setUp function - flutter_test library - Dart API


no_support_multi_text_direction


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Consider using TextDirection aware configurations if your application supports different TextDirection languages.
BAD:
Align(
alignment: Alignment.bottomLeft,
)
copied to clipboard
BAD:
Padding(
padding: EdgeInsets.only(left: 16, right: 4),
)
copied to clipboard
BAD:
Positioned(left: 12, child: SizedBox())
copied to clipboard
GOOD:
Align(
alignment: AlignmentDirectional.bottomStart,
)
copied to clipboard
GOOD:
Padding(
padding: EdgeInsetsDirectional.only(start: 16, end: 4),
)
copied to clipboard
GOOD:
Positioned.directional(
start: 12,
textDirection: TextDirection.ltr,
child: SizedBox(),
)

PositionedDirectional(
start: 12,
child: SizedBox(),
)
copied to clipboard
See also:

TextDirection enum - dart:ui library - Dart API
AlignmentDirectional class - painting library - Dart API
EdgeInsetsDirectional class - painting library - Dart API
PositionedDirectional class - widgets library - Dart API


no_support_web_platform_check


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Prefer using defaultTargetPlatform instead of Platform API if you want to know which platform your application is running on.
This is because

Platform API throws a runtime exception on web application.
By combining kIsWeb and defaultTargetPlatform, you can accurately determine which platform your web application is running on.

BAD:
bool get isIOS => !kIsWeb && Platform.isIOS;
copied to clipboard
GOOD:
bool get isIOS => !kIsWeb && defaultTargetPlatform == TargetPlatform.iOS;
copied to clipboard
See also:

defaultTargetPlatform property - foundation library - Dart API


shrink_wrapped_scroll_view


Target SDK : Any versions nilts supports
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Consider removing shrinkWrap argument and update the Widget not to shrink wrap.
Shrink wrapping the content of the scroll view is significantly more expensive than expanding to the maximum allowed size because the content can expand and contract during scrolling, which means the size of the scroll view needs to be recomputed whenever the scroll position changes.
You can avoid shrink wrap with 3 steps below in case of your scroll view is nested.

Replace the parent scroll view with CustomScrollView.
Replace the child scroll view with SliverListView or SliverGridView.
Set SliverChildBuilderDelegate to delegate argument of the SliverListView or SliverGridView.

BAD:
ListView(shrinkWrap: true)
copied to clipboard
GOOD:
ListView(shrinkWrap: false)
copied to clipboard
See also:

shrinkWrap property - ScrollView class - widgets library - Dart API
ShrinkWrap vs Slivers | Decoding Flutter - YouTube


unnecessary_rebuilds_from_media_query


Target SDK : >= Flutter 3.10.0 (Dart 3.0.0)
Rule type : Practice
Maturity level : Experimental
Quick fix : ✅

Prefer using MediaQuery.xxxOf or MediaQuery.maybeXxxOf instead of MediaQuery.of or MediaQuery.maybeOf to avoid unnecessary rebuilds.
BAD:
final size = MediaQuery.of(context).size;
copied to clipboard
GOOD:
final size = MediaQuery.sizeOf(context);
copied to clipboard
Note that using MediaQuery.of or MediaQuery.maybeOf makes sense following cases:

wrap Widget with MediaQuery overridden MediaQueryData
observe all changes of MediaQueryData

See also:

MediaQuery as InheritedModel by moffatman · Pull Request #114459 · flutter/flutter
MediaQuery class - widgets library - Dart API


Assists #
Upcoming... 🚀
Known issues #
Quick fix priorities #
The priorities assigned to quick fixes are not currently visible in IntelliJ IDEA and Android Studio due to the lack of support for PrioritizedSourceChange in these environments.
In contrast, VS Code does support this feature, allowing quick fixes to be listed along with their respective priorities.



VS Code
IntelliJ IDEA / Android Studio









See also:

IDEA-336551 Support PrioritizedSourceChange on quick fix.

fix-all assist #
The fix-all assist feature has been introduced in custom_lint_builder 0.6.0.
However, this feature is not yet supported in IntelliJ IDEA and Android Studio, owing to their current lack of support for PrioritizedSourceChange.



VS Code
IntelliJ IDEA / Android Studio









Feature requests #
If you have any feature requests, please create an issue from this template.
Bug reports #
If you find any bugs, please create an issue from this template.
Contributing #
Welcome your contributions!!
Please read CONTRIBUTING docs before submitting your PR.