Flutter Linting Comparison
(Published July 28, 2021, Updated September 10, 2021)
Dart and Flutter linting is important, if you have not used it before it is a good idea to start now. At the end of this article I also present a comparison of different popular lint packages and the Dart and Flutter lint rules they use.
What Is the Dart Linter?
The Dart linter is a static analyzer for identifying possible problems in your Dart source code. There are close to two hundred linter rules are available, checking anything from potential typing issues, coding style and formatting.
You can set up the Dart analyzer and linter to do your bidding the way you like it. Some rules are more important than others, and some are just style and personal preference related, the kind that developers like to debate forever. When it comes to them, there is no real right or wrong, do what you prefer if a certain style is not mandated in your project.
Enabling very strict linting rules on a code base that previously did not use it, can also be very time-consuming. For such cases, gradually introducing more stringent lint rules is a good idea. To do that, you may want to get to know the lint rules better and how to set them up yourself, without using a package.
To study and read more about each lint rule, you can head over to the Linter for Dart site.
How Do I Use the Dart Linter?
Personally I like to start by enabling all lint rules in one file, and then including it in
analysis_options.yaml file. I simply call this file
You can grab the latest official and always up-to-date version of all lint rules
here, grab its content
and put it in a file called
analysis_options.yaml and the
all_lint_rules.yaml can be placed in the root of your
Flutter project folder, same place where you have your
analysis_options.yaml I include the
I exclude commonly generated Dart files from being analyzed, and enable analyzer
strong-mode. In strong mode, I like to disable implicit type casts and implicit dynamic. I cannot
recommend doing so enough. It might feel a bit tedious, but it will save you from a bunch of
potential gotchas in Dart code.
I lift common mistakes that I think should be errors, to error level. Then the analyzer won’t even let me compile code with these mistakes. I like to flag missing return and missing required parameters as such errors, not as warnings or info. I keep parameter re-assignments as a warning though, there are occasions when it may be needed.
analysis_options.yaml file starts like this:
# RydMike LINTER Preferences v1.2.5 # Gist: https://gist.github.com/rydmike/fdb53ddd933c37d20e6f3188a936cd4c # Include and activate all lint rules, later below we disable the not used or desired ones. # For a comparison of all lint rules settings in rule style listed below, please see this # sheet: https://docs.google.com/spreadsheets/d/1Nc1gFjmCOMubWZD7f2E4fLhWN7LYaOE__tsA7bf2NjA include: all_lint_rules.yaml analyzer: exclude: - "**/*.g.dart" - "**/*.freezed.dart" - "test/.test_coverage.dart" - "bin/cache/**" - "lib/generated_plugin_registrant.dart" strong-mode: implicit-casts: false implicit-dynamic: false errors: # Without ignore here, we cause import of all_lint_rules to warn, because some rules conflict. # We explicitly enabled even conflicting rules and are fixing the conflicts in this file. included_file_warning: ignore # Treat missing required parameters as an error, not as a hint or a warning. missing_required_param: error # Treat missing returns as an error, not as a hint or a warning. missing_return: error # DON'T assign new values to parameters of methods or functions. # # https://dart-lang.github.io/linter/lints/parameter_assignments.html # # Treat assigning new values to a parameter as a warning. We would almost like to set this # to an error. However, this warning rule or even more so if set to an error, can sometimes # be a bit problematic you include other code directly that does it a lot. # It does however, make code safer when this cannot be done without involving # an extra local variable for clarity and safety. Enabling this error, even as just a warning, # does get in the way a bit if all you want to do is a null to default value release runtime # safety/fallback assignment. For that use case you have to add a local rule override. With # null-safety, the need for this kind of null check and re-assignment to default if null, # pretty much goes away. Considering the comment in: # https://dart-lang.github.io/linter/lints/parameter_assignments.html: # "Assigning new values to parameters is generally a bad practice unless an operator # such as ??= is used. Otherwise, arbitrarily reassigning parameters is usually a mistake." # One might even think the rule would allow using the ??= operator, but it does not. For now, # we keep this lint as warning and overriding locally with: # # ignore: parameter_assignments # # When we need it for the ??= operator, or some copy/paste in of some code that does things # that needs it too, and that we don't want to deal with fixing at the moment. parameter_assignments: warning # Allow having TODOs in the code. todo: ignore # LINTER Preferences # # Explicitly disable only the rules we do not want. linter: rules:
The rest of the settings is just turning OFF linting rules I do not want to use. Since all rules are now ON by default, it is a list of rules that should NOT be used. I try to keep it relatively short.
As for what actually gets turned OFF, first there are some linting rules that conflict with each other. When it comes to them, you can go two ways. If you don’t want to make a choice and want to be able to use both alternatives, then disable both rules. Alternatively choose one of them and disable the one you do not want to use. I prefer to make a choice, the conflicting rules are often highly opinionated, in certain scenarios, it might be more lenient to allow both options, but if it is a personal project, then go ahead and use what you prefer.
A typical example of a personal preference linting rule, is the
prefer_single_quotes choice. Even if a linting rule is highly opinionated, in
large project you may still want to make choice to enforce a consistent style.
Here is my choice and my rationale on the quote style:
# DO use double quotes where they wouldn't require additional escapes. # # https://dart-lang.github.io/linter/lints/prefer_double_quotes.html # # This rule is mostly about what style you want to use and enforce, if any. # It of course conflicts with rule: # `prefer_single_quotes` : "DO use single quotes where they wouldn't require additional escapes." # https://dart-lang.github.io/linter/lints/prefer_single_quotes.html # # For us single quotes are easier to type. On our ISO keyboards it is next to Enter key, and # we don't need the Shift plus the far to reach nr 2 key on R1 to type it. Also, we don't think # they compromise on readability. # Then again if you don't care and don't mind mixing and matching, then ALSO # turning OFF `prefer_single_quotes` works fine too, and then you can use both options. # # We thought it was cleaner to stick to one style. Single quotes are easier to type for us, # thus we turn OFF this `prefer_double_quotes` rule. There is another lint rules that recommends you # to use double quotes when you otherwise would need to escape the single quote char, it works # well when you use the prefer_single_quotes rule as well. # # Other known linters use: # # Core disabled : https://pub.dev/packages/lints # Recommended disabled : https://pub.dev/packages/lints # Flutter Lints disabled : https://pub.dev/packages/flutter_lints # Pedantic disabled : https://pub.dev/packages/pedantic # Effective Dart disabled : https://pub.dev/packages/effective_dart # Flutter repo disabled : https://github.com/flutter/flutter/blob/master/analysis_options.yaml # Lint disabled : https://pub.dev/packages/lint # VG Analysis disabled : https://pub.dev/packages/very_good_analysis # RydMike disabled : https://gist.github.com/rydmike/fdb53ddd933c37d20e6f3188a936cd4c prefer_double_quotes: false
In addition to things that conflict with their own counter-part, what else do I turn off? As little as possible, I prefer things pretty strict, but that is just my personal preference.
I documented the choices I made, and the reasoning behind the choices at the point in time when I made them. I vary it slightly depending on if I am using linting for a package or an app, keeping it even stricter for public packages. These options and selections are also documented.
Here is a Gist with the full
details of the settings I use in
analysis_options.yaml for my personal projects.
I might change a few settings as things evolve. One rule I found myself disliking recently and
disabling, is the
sort_constructors_first. Sounds like it is a fine rule, right?
For the default constructor I agree, I want it first too.
However, after that I want to see all the properties of the
default constructor, with their documentation comments. I find this useful for more complex
packages that may have constructors with a lot of named parameters.
sort_constructors_first rule is enabled, I am forced to use an order where I have to
scroll far down to find the properties much further below, after all the named constructors
and factories. I find this very inconvenient. This is another minor example of personal style
preference. There are many lint rules that are style and code consistency related.
Get to know them and find your own personal preferences.
When you disable a lint rule, try to write a short note to your future self why you disabled it.
This is what I wrote down concerning why I turned off the
The good thing is you can certainly change your mind about a rule’s usefulness or add more as you need, well at least in your personal projects.
# DO sort constructor declarations before other members. # # We do like this lint rule, but we want to have the default constructor first, followed # by its properties, after this other named constructors and factories. This rule gets # in the way of that and forces you to put (often final) constructor properties after all # the named constructors and factories, making them tedious to find and disconnected from # where we want to see, read and handily edit them. This is especially the case if there are # many constructors and factories, and they have a lot of parameters. For now, we disable # this rule and order things as described above, which apart from the default constructor # properties coming right after the constructor, is the only part where we in practice # deviate from this rule, so other yes, we do put constructors first as well anyway. # # Other known linters use: # # Core disabled : https://pub.dev/packages/lints # Recommended disabled : https://pub.dev/packages/lints # Flutter Lints disabled : https://pub.dev/packages/flutter_lints # Pedantic disabled : https://pub.dev/packages/pedantic # Effective Dart disabled : https://pub.dev/packages/effective_dart # Flutter repo enabled : https://github.com/flutter/flutter/blob/master/analysis_options.yaml # Lint disabled : https://pub.dev/packages/lint # Discussion https://github.com/passsy/dart-lint/issues/1 # VG Analysis enabled : https://pub.dev/packages/very_good_analysis # RydMike disabled : https://gist.github.com/rydmike/fdb53ddd933c37d20e6f3188a936cd4c sort_constructors_first: false
The above is also an example of the documentation style I use for all lint rules that I turned OFF. Yes it is verbose, but now I can find my past reasoning for the choice I made. I can also find references to what others have chosen as their lint preference for each rule that I do not use.
What About Using a Third Party Linting Package?
There are many 3rd party packages that define linting rules for you. Previously most notably Effective Dart, Pedantic and Lint as well as Very Good Analysis are popular packages that comes with their recommended rules.
There is nothing wrong with using any of these packages if they fit your needs. Using a ready-made linting package may very well be the right choice for you. If you are not interested in getting to know the rules yourself and follow-up on new rules that are added by the Dart team occasionally, then please do use a package. I have a personal recommendation regarding which one as well.
For my personal projects I just prefer the clarity of enabling all rules in one file, and then disabling the ones that do not fit my use case and preferences.
Earlier I started with one of the above packages too, but I noticed that when I needed or wanted to modify a few
rules. I then ended up with enabling or disabling rules in relation to used package settings. This got a bit messy
to keep track of. Eventually it felt cleaner to just turn everything ON, and then just have OFF definitions in my
analysis_options.yaml. Super simple, clear and easy to modify when needed, without messing things up.
Plus no need for a package for this relatively simple setup.
In a big project the lint rules have probably been agreed and defined already for you, then just stick to that. If you find that the lint rules have not been defined, nor documented why they are a certain way in the project, well then they really should be.
Which Lint Package Should I Use?
If I want to use a package, which lint package should I use? Answering this question recently got a lot easier. First, both the package Effective Dart and Pedantic have been deprecated. For a new project I do not recommend them anymore. Pedantic was from Google mostly for internal use. Despite its name, it was not very strict nor pedantic, more like a minimum set they could agree on internally for Dart projects.
Starting from Flutter 2.5.0 Dart and Flutter teams launched two new lint packages that are used as default when you make a new Flutter package. Let us take a look at them.
The first one is called Lints. It was launched as version 1.0.0 on May 12, 2021. This package contains the new official recommended selection of lint rules for Dart projects.
It comes in two flavors, the absolute minimum lints, called Core lints, and a broader set called Recommended lints. The recommended set also includes the core lints. In the Dart guide you can read more about it here.
The second package is called Flutter lints, It was also launched as version 1.0.0 on May 12, 2021. The Flutter lints package includes the recommended set from Dart lints, plus a few more rules that are important in Flutter projects. These Dart and Flutter lint rule sets are built as supersets, with increasing amount of rules enabled.
Starting from Flutter version 2.3.0-12.0.pre and thus now included in stable 2.5.0 and later versions, the package Flutter lints defines the latest set of officially recommended lints that encourage good coding practices for Flutter apps, packages, and plugins.
Projects created with flutter create using Flutter version 2.3.0-12.0.pre or newer, and thus now also in stable 2.5.0 and later, are automatically enabled to use the Flutter lints package.
You can find the instructions here.
Since this lint rule set is the new default lint package for new Flutter projects, there is no sense in recommending any other linter package than Flutter lints as a general good starting point.
Other Packaged Linters
All that being said, as long as Lint or Very Good Analysis have not been deprecated, and you are used to them, or already using them, or just prefer them, they are still perfectly good choices as well.
They both enable more and even stricter lint rules than the new default flutter_lints. Both lint and very_good_analysis use strong mode and disable implicits casts, and Very Good Analysis also wisely opts to disable implicit dynamic. From version 2.3.0 Very Good Analysis also started treating missing required parameters and missing return, as code errors. I consider this a wise and welcome addition.
The lint package includes excellent reasoning documentation for its lint rule choices in the source, allowing you to read and understand the author’s rationale for the used choices. It also comes with a variant for packages, adding a few useful rules for public packages.
Out of packaged linters very_good_analysis, starting from version 2.3.0 enables the most rules of the compared packaged linters. With 79.7% of available lint rules enabled, it is the most strict and “pedantic” of the compared packaged linters, at least if we exclude my own custom setup from the comparison. My personal choice for a packaged linter would be very_good_analysis, but that is because I like its very strict. The lint package is not far behind, with its recent 1.7.2 version it is at 72.9% of rules enabled. Close call, and the differences are not big. You can use my comparison table to compare them all and each rule setting.
If you want to stay on top of your linting rule setup yourself, then do as I do. Roll your own linting rule setup. Mostly I do this to use even stricter lint rules than current package linters offer, and to make the opinionated choices I prefer. Most lint packages on purpose avoid making any choice for you when it comes to highly opinionated personal preferences rules.
I also like the clean setup of enabling all rules in one file, that include all currently available rules and turning OFF the ones I don’t use. This keeps the setup easy to maintain. Feel free to do the same or take the easy route and start using Flutter lints now or walk the narrow and strict path with Very Good Analysis or Lint.
If you don’t care about linting and tuning it yourself, the really nice part is that a good linting setup is now part of Flutter. Starting from version 2.5.0 you will get an excellent rule set enabled by default for new projects. It is a really cool and a smart move by the Dart and Flutter teams to offer this. It means that eventually all Flutter developers will use more strict lint rules by default, rules that will help improve the quality of produced Flutter apps.
What Are the Rule Differences Between All These Packages?
What are the lint rule differences between all these packages? That is a very good question. I guess I saved the most interesting part for last. I was very curious about this as well, so I went through all the lint settings for the following lint packages and setups:
|Lint style||Used rules||%|
|Dart Core (v1.0.1)||26||13.5%|
|Dart Recommended (v1.0.1)||74||38.5%|
|Flutter lints (v1.0.4)||85||44.3%|
|Pedantic (v1.11.1) (Deprecated)||52||27.1%|
|Effective Dart (v1.3.2) (Deprecated)||57||29.7%|
|Flutter SDK repository (v2.5.0)||129||67.2%|
|Very Good Analysis (v2.3.0)||153||79.7%|
|RydMike - All ON, then turn a few OFF (v1.2.5)||171||89.1%|
|All LINT rules||192||100.0%|
Enough talk, here is the comparison in a Google Sheet, enjoy!
PS. I may have made some mistakes in the review of the settings, if you notice any, please let me know, and I will update it. You can find me on Twitter
(Page updated September 10, 2021)