Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Upgrade ruff and add RUF022 & RUF100 #1482

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 4 commits into from
Jun 8, 2025

Conversation

gbaian10
Copy link
Contributor

@gbaian10 gbaian10 commented May 31, 2025

Description

resolved #1474

In addition to upgrading the version, two new rules have been added:
One is RUF022, which is similar to isort. It checks for __all__ definitions that are not ordered according to an "isort-style" sort.

The other is RUFF100, which is similar to unused-ignore of mypy. It ensures that ineffective # noqa comments are removed.

Both of these can be automatically and safely fixed using ruff check --fix.

Checklist

Code Changes

  • Add test cases to all the changes you introduce
  • Run poetry all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages renders correctly
    • Check if there are any broken links in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:

INFO    -  Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

Expected Behavior

Steps to Test This Pull Request

Additional Context

Copy link

codecov bot commented May 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.82%. Comparing base (59fd3f5) to head (0b99d74).
Report is 6 commits behind head on refactors.

Additional details and impacted files
@@            Coverage Diff             @@
##           refactors    #1482   +/-   ##
==========================================
  Coverage      97.82%   97.82%           
==========================================
  Files             57       57           
  Lines           2619     2619           
==========================================
  Hits            2562     2562           
  Misses            57       57           
Flag Coverage Δ
unittests 97.82% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bearomorphism
Copy link
Contributor

+1

@bearomorphism
Copy link
Contributor

LGTM.

@Lee-W
Copy link
Member

Lee-W commented Jun 8, 2025

LGTM.

I think you can actually approve this PR haha.

@Lee-W Lee-W merged commit f60e9a2 into commitizen-tools:refactors Jun 8, 2025
18 checks passed
@gbaian10 gbaian10 deleted the upgrade-ruff branch June 8, 2025 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants