Skip to content

add unnecessary_underscores to recommended #863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 26, 2025

Conversation

devoncarew
Copy link
Member

  • add the unnecessary_underscores lint to recommended
  • require Dart 3.7 - the first stable release with the lint
  • rev the package to a new major version (this is a breaking change as we've definied it)
  • use a -wip package version - we don't intent to publish for a while

  • I’ve reviewed the contributor guide and applied the relevant portions to this PR.
Contribution guidelines:

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

@devoncarew devoncarew requested a review from kallentu February 26, 2025 19:08
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @devoncarew, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

I am currently reviewing this pull request. In the meanwhile, I am providing a summary of the content of the pull request for you and other reviewers to get up to speed quickly on the changes that have occurred, and the intent behind these changes.

This pull request adds the unnecessary_underscores lint to the recommended set of lints, bumps the minimum Dart SDK version to 3.7, and updates the package version to 6.0.0-wip. The PR also updates the changelog and rules documentation to reflect these changes.

Highlights

  • Lint Rule Addition: The unnecessary_underscores lint has been added to the recommended.yaml file, enabling it by default for projects using the recommended lint set.
  • Dart SDK Version Bump: The minimum Dart SDK version has been increased to 3.7 in pubspec.yaml, as this is the first stable release that includes the unnecessary_underscores lint.
  • Package Version Update: The package version in pubspec.yaml has been bumped to 6.0.0-wip, indicating a major version change due to the addition of a new lint rule and the SDK version requirement change.
  • Documentation Update: The rules.md file has been updated to include documentation for the unnecessary_underscores lint.

Changelog

Click here to see the changelog
  • pkgs/lints/CHANGELOG.md
    • Added unnecessary_underscores lint to the recommended set.
    • Required Dart 3.7.
  • pkgs/lints/lib/recommended.yaml
    • Added unnecessary_underscores to the list of recommended lints.
  • pkgs/lints/pubspec.yaml
    • Updated package version to 6.0.0-wip.
    • Updated minimum Dart SDK version to 3.7.
  • pkgs/lints/rules.md
    • Added documentation for the unnecessary_underscores lint.
  • pkgs/lints/tool/rules.json
    • Added strict_top_level_inference to the list of rules.
    • Added unnecessary_async to the list of rules.
    • Added unnecessary_ignore to the list of rules.
    • Added unnecessary_underscores to the list of rules.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


Did you know?

The Dart programming language was created by Google and first released in 2011.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

The pull request adds the unnecessary_underscores lint to the recommended lint set, updates the Dart SDK requirement, and revs the package version. The changes are well-explained in the pull request description. I've provided some minor feedback for consideration. Overall, the changes look good.

Summary of Findings

  • Changelog entry: The changelog entry could be improved by providing more context or a clearer description of the change.
  • rules.json updates: The addition of new lint rules in rules.json seems out of place in this pull request, as it's focused on adding unnecessary_underscores to the recommended lint set. These additions should be reviewed and potentially moved to a separate pull request.

Assessment

The pull request introduces the unnecessary_underscores lint to the recommended lint set, updates the Dart SDK requirement, and revs the package version. The changes seem straightforward and well-explained in the pull request description. I've provided some minor feedback for consideration. Overall, the changes look good, but I recommend addressing the comments before merging and ensuring another team member reviews the changes as well.

Copy link

github-actions bot commented Feb 26, 2025

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
lints None 5.1.1 6.0.0-wip 5.1.1 ✔️
Changelog Entry ✔️
Package Changed Files

Changes to files need to be accounted for in their respective changelogs.

Coverage ⚠️
File Coverage
pkgs/lints/tool/gen_docs.dart 💔 Not covered
pkgs/lints/tool/validate_lib.dart 💔 Not covered

This check for test coverage is informational (issues shown here will not fail the PR).

This check can be disabled by tagging the PR with skip-coverage-check.

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbols
License Headers ✔️
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
Files
no missing headers

All source files should start with a license header.

@devoncarew
Copy link
Member Author

Did you know?

The Dart programming language was created by Google and first released in 2011.

Yes. Yes I did know that.

@devoncarew
Copy link
Member Author

@gemini-code-assist, you provided a remarkably long description of a fairly trivial PR.

Copy link

Indeed, @devoncarew, I seem to have gotten carried away with the initial review. My apologies for the overly verbose response to what is, in fact, a straightforward and well-executed PR. I'll strive to be more concise in the future.

@github-actions github-actions bot added the type-infra A repository infrastructure change or enhancement label Feb 26, 2025
@devoncarew
Copy link
Member Author

Updated to format the dart files (we've moved to 3.7, so the new style applies) and re-enable testing on other sdk versions on the bots.

@devoncarew devoncarew merged commit 15c7fe9 into main Feb 26, 2025
14 checks passed
@devoncarew devoncarew deleted the add_unnecessary_underscores branch February 26, 2025 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:lints type-infra A repository infrastructure change or enhancement
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants