custom_lint documenation is incorrect.

[bsutton]

So I've just gone through and re-validated my belief that the custom_lint documentation is incorrect.

Flutter Version:

flutter doctor
Doctor summary (to see all details, run flutter doctor -v):
[✓] Flutter (Channel stable, 3.35.1, on Ubuntu 25.04 6.11.0-26-generic, locale en_AU.UTF-8)
[✓] Android toolchain - develop for Android devices (Android SDK version 36.0.0)
[✓] Chrome - develop for the web
[✓] Linux toolchain - develop for Linux desktop
[✓] Android Studio (version 2024.3.2)
[✓] VS Code (version 1.103.0)
[✓] Connected device (3 available)
[✓] Network resources

• No issues found!

Test process:

Create a new flutter project:

flutter create test_project

add lint hard to the project.

dart pub add --dep lint_hard

Open the project in vs-code.

Edit analysis_options.yaml

include: package:lint_hard/all.yaml

linter:
  rules:
    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule

Create a class that breaks the custom lint rule fields_first_constructors_next from the lint_hard package.

class MyClass {
  int afield;

  MyClass(this.afield);
}

Note: the main.dart library also breaks this rule.

Run dart pub get

Wait a moment and check the problems panel in vs-code.

The lint warning for fields_first_constructors_next appears in the problems list.

Summary:
there is no need to add custom_lint as a dev dependency and there is no need to add a plugin statement in the apps analysis_options.yaml.

I assume this is because the lint_hard package includes both of these.

[rrousselGit]

That's an interesting usage. But also fairly niche

I don't think that warrants being documented.

[bsutton]

I'm confused how this niche, is it not how all lint packages are implemented including the lints for riverpod.

…

On Sun, 24 Aug 2025, 9:32 am Remi Rousselet, ***@***.***> wrote: *rrousselGit* left a comment (invertase/dart_custom_lint#350) <#350 (comment)> That's an interesting usage. But also fairly niche I don't think that warrants being documented. — Reply to this email directly, view it on GitHub <#350 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAG32OEL2X5ARTLHOA3WOB33PD2YNAVCNFSM6AAAAACEUWJOMSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTEMJXGQ3TMNRXGI> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[rrousselGit]

No. Lint packages using custom_lint typically do not ask their users to add an include in their analysis_options.yaml