Automatically check for new Dart lints

[chykon]

Description & Motivation

Since the lints for Dart is updated quite often and no official package that provides a complete set of rules, the problem of automating tracking arises. This pull request contains changes to address this issue without using third-party dependencies.

It is proposed to add a step to check for new rules in CI and in the tool/run_checks.sh script.

ISSUES

After updating analysis_options.yaml, new rules-related issues have been identified:

• dangling_library_doc_comments
• unreachable_from_main
• use_string_in_part_of_directives

The first rule has been temporarily disabled due to file header peculiarities (#264). For the other two, changes will be provided in a separate PR.

Related Issue(s)

#264

Testing

See step Check Dart lints:

• SUCCESS
• FAILURE

Backwards-compatibility

Is this a breaking change that will not be backwards-compatible? If yes, how so?

Yes, because of the new rules, dart analyze throws an error.

Documentation

Does the change require any updates to documentation? If so, where? Are they included?

No.

[mkorbel1]

This is a cool tool, good idea!

What are your thoughts on when this check should be run? Suppose new rules show up and start blocking all open PRs on the same set of new lint issues even though no particular PR was the root-cause for the PR to fail. Worse, imagine that multiple people resolve the new lint issues in their PRs in slightly different ways, causing merge conflict headaches for everyone after the first PR to get merged.

I'd almost wish that some periodic automation would create a new independent PR to update lints any time it detects new lint rules created. Then it would be up to others to try to help fix the PR failures before it can get merged in. I know its possible to set up cron-triggered GitHub actions, but I'm not that familiar with automation to create pull requests. Maybe we'd need a separate lints branch of some sort in the main intel/rohd repo which others could open PRs against to fix lint issues? I don't know, open to ideas and thoughts.

[chykon]

Indeed, I did not think about possible conflicts in different PRs. It's good that you pointed this out.

I like your suggestion for a way to resolve conflicts and check for new rules.

Reminder: a local check (run_checks.sh) should also not encourage conflicting changes (make checking for new lints optional?).