leancode_lint 15.1.0 
leancode_lint: ^15.1.0 copied to clipboard
leancode.coRobust, high-quality lint rules used at LeanCode.
leancode_lint #
An opinionated set of high-quality, robust, and up-to-date lint rules used at LeanCode.
Installation #
-
Add
leancode_lintandcustom_lintas a dev dependency in your project'spubspec.yaml.dart pub add leancode_lint custom_lint --devcopied to clipboard -
In your
analysis_options.yamladdinclude: package:leancode_lint/analysis_options.yaml. You might want to exclude some files (e.g generated json serializable) from analysis. -
Enable the
custom_lintanalyzer plugin inanalysis_options.yaml. You can customize lint rules by adding acustom_lintconfig with arulessection. -
Run
flutter pub getin your project main directory and restart your IDE. You're ready to go!
Example analysis_options.yaml:
include: package:leancode_lint/analysis_options.yaml
# Optional lint rules configuration
custom_lint:
rules:
- use_design_system_item:
AppText:
- instead_of: Text
from_package: flutter
- instead_of: RichText
from_package: flutter
AppScaffold:
- instead_of: Scaffold
from_package: flutter
analyzer:
plugins:
# Required for our custom lints support
- custom_lint
exclude:
- '**/*.g.dart'
Usage in libraries #
If your package is a library rather than a binary application, you will expose some public API for users of your library. Therefore, you should use lint rules optimized for this case by just changing your include entry in analysis_options.yaml:
include: package:leancode_lint/analysis_options_package.yaml
Custom lint rules #
To disable a particular custom lint rule, set the rule to false in analysis_options.yaml. For example, to disable prefix_widgets_returning_slivers:
custom_lint:
rules:
- prefix_widgets_returning_slivers: false
add_cubit_suffix_for_your_cubits #
DO add a 'Cubit' suffix to your cubit names.
BAD:
class MyClass extends Cubit<int> {}
GOOD:
class MyClassCubit extends Cubit<int> {}
Configuration
None.
avoid_conditional_hooks #
AVOID using hooks conditionally
BAD:
Widget build(BuildContext context) {
if (condition) {
useEffect(() {
// ...
}, []);
}
}
BAD:
Widget build(BuildContext context) {
final controller = this.controller ?? useTextEditingController();
}
BAD:
Widget build(BuildContext context) {
if (condition) {
return Text('Early return');
}
final state = useState(0);
}
GOOD:
Widget build(BuildContext context) {
useEffect(() {
if (condition) {
// ...
}
}, []);
}
GOOD:
Widget build(BuildContext context) {
final backingController = useTextEditingController();
final controller = this.controller ?? backingController;
}
GOOD:
Widget build(BuildContext context) {
final state = useState(0);
if (condition) {
return Text('Early return');
}
}
Configuration
None.
catch_parameter_names #
DO name catch clause parameters consistently
- if it's a catch-all, the exception should be named
errand the stacktracest - if it's a typed catch, the stacktrace has to be named
st
BAD:
try {} catch (e, s) {}
try {} on SocketException catch (e, s) {}
GOOD:
try {} catch (err, st) {}
try {} on SocketException catch (e, st) {}
Configuration
None.
hook_widget_does_not_use_hooks #
AVOID extending HookWidget if no hooks are used.
BAD:
class MyWidget extends HookWidget {
@override
Widget build(BuildContext context) {
return Placeholder();
}
}
BAD:
HookBuilder(
builder: (context) {
return Placeholder();
},
);
GOOD:
class MyWidget extends StatelessWidget {
@override
Widget build(BuildContext context) {
return Placeholder();
}
}
GOOD:
Builder(
builder: (context) {
return Placeholder();
},
);
Configuration
None.
prefix_widgets_returning_slivers #
DO prefix widget names with 'Sliver' if the widget returns slivers.
BAD:
class MyWidget extends StatelessWidget {
@override
Widget build(BuildContext context) {
return SliverToBoxAdapter();
}
}
GOOD:
class SliverMyWidget extends StatelessWidget {
@override
Widget build(BuildContext context) {
return SliverToBoxAdapter();
}
}
Configuration
application_prefix: A string. Specifies the application prefix to accept sliver prefixes. For example if set to "Lncd" then "LncdSliverMyWidget" is a valid sliver name.
custom_lint:
rules:
- prefix_widgets_returning_slivers:
application_prefix: Lncd
start_comments_with_space #
DO start comments/docs with an empty space.
BAD:
//some comment
///some doc
GOOD:
// some comment
/// some doc
Configuration
None.
use_design_system_item #
AVOID using items disallowed by the design system.
This rule has to be configured to do anything. The rule will highlight forbidden usages and suggest alternatives preferred by the design system.
Configuration
<preferredItem>: The item to be preferred. A list of objects:instead_of: A required string. Name of the item that is forbidden.from_package: A required string. Name of the package from which that forbidden item is from.
custom_lint:
rules:
- use_design_system_item:
LncdText:
- instead_of: Text
from_package: flutter
- instead_of: RichText
from_package: flutter
LncdScaffold:
- instead_of: Scaffold
from_package: flutter
avoid_single_child_in_multi_child_widgets #
AVOID using Column, Row, Flex, Wrap, SliverList, MultiSliver, SliverChildListDelegate, SliverMainAxisGroup, and SliverCrossAxisGroup with a single child.
BAD:
Column(
children: [
Container(),
]
)
GOOD:
Container(),
Configuration
None.
Assists #
Assists are IDE refactorings not related to a particular issue. They can be triggered by placing your cursor over a relevant piece of code and opening the code actions dialog. For instance, in VSCode this is done with ctrl+. or ⌘+..
See linked source code containing explanation in dart doc.
Metadata
Publisher
Weekly Downloads
Metadata
Robust, high-quality lint rules used at LeanCode.
Topics
Documentation
License
Apache-2.0 (license)
Dependencies
analyzer, analyzer_plugin, custom_lint_builder
