feat: add support for configuration error severities in analysis_options.yaml

[Artur-Wisniewski]

Closes issue: ISSUE-323

Now it is possible to override error severities from analysis_options.yaml using the errors parameter inside custom_lint

You should be able to do this:

custom_lint:
  errors:
    some_lint_with_info_severity: error

All of the some_lint_with_info_severity lint's error messages will be shown as errors by the analyzer

[vercel]

@Artur-Wisniewski is attempting to deploy a commit to the Invertase Team on Vercel.

A member of the Team first needs to authorize it.

[docs-page]

To view this pull requests documentation preview, visit the following URL:

docs.page/invertase/dart_custom_lint~326

Documentation is deployed and generated using docs.page.

[rrousselGit]

Thanks for this!

Those tests are a bit too tied to the implementation details for my liking. Could you write e2e tests instead?

Like running dart run custom_lint and verify that the console flags a diagnostic as WARNING instead of INFO.

[Artur-Wisniewski]

Thanks for this!

Those tests are a bit too tied to the implementation details for my liking. Could you write e2e tests instead?

Like running dart run custom_lint and verify that the console flags a diagnostic as WARNING instead of INFO.

Hello @rrousselGit 👋🏻
I've managed to add some additional tests for this task. (packages/custom_lint/test/analysis_options_test.dart)
If I understand correctly, these should be counted as e2e tests.

Please don't hesitate to let me know if there is anything else you need here.

[rrousselGit]

Isn't this covered by the previous tests? I'd rather not have tests that are so tied to the implementation details.

[Artur-Wisniewski]

You're right. I will remove this test because it isn't needed here, and as you said, it is too much tied to the implementation details (now I see it).

[Artur-Wisniewski]

@rrousselGit Hello, I don't know if you've seen my recent changes. Could you please check this PR in your free time? I'm keen for this feature to help me implement better programming practices in my project.

[Artur-Wisniewski]

Hey @rrousselGit could you check this PR please?

[rrousselGit]

This feels like an odd place to have this logic.

But I can't immediately think of a better location due to AnalysisError being immutable.

[rrousselGit]

I'd rather not change this file, as it is forked from analyzer. I want to keep it close to the source, for easy upgrade.

Could we maybe add a separate util such that:

dart_custom_lint/packages/custom_lint_builder/lib/src/client.dart

Lines 994 to 995 in f44a7cb

	CustomAnalyzerConverter().convertAnalysisErrors(
	allAnalysisErrors,

Does something like:

...convertAnalysisError(...).map((error) => error.copyWith(error: <apply error config>))

Then the file stays untouched, and the location of the logic is in a more sensible place.

[rrousselGit]

Afaik analyzer uses ignore not none:

errors:
  unused_parameter: ignore

We should match

[rrousselGit]

Let's not rely on "displayName" .
There is no guarantee about its stability. This could indirectly break custom_lint

That has already happened to me before, so I won't fall for it twice :P

[rrousselGit]

Instead we can do a simple switch:

ErrorSeverity parseSeverity(String str) {
  return switch (str) {
    'error' => ErrorSeverity.error,
    'ignore' => ErrorSeverity.none,
     ...,
     _ => throw UnsupportedError('Unsupported severity $str'),
  };
}

[rrousselGit]

I don't think that is useful to have in the default example

[rrousselGit]

LGTM with some tiny changes :)