Skip to content
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

Rename ruff_cli crate to ruff #9557

Merged
merged 1 commit into from
Jan 16, 2024
Merged

Rename ruff_cli crate to ruff #9557

merged 1 commit into from
Jan 16, 2024

Conversation

charliermarsh
Copy link
Member

Summary

Long ago, we had a single ruff crate. We started to break that up, and at some point, we wanted to separate the CLI from the core library. So we created ruff_cli, which created a ruff binary. Later, the ruff crate was renamed to ruff_linter and further broken up into additional crates.

(This is all from memory -- I didn't bother to look through the history to ensure that this is 100% correct :))

Now that ruff no longer exists, this PR renames ruff_cli to ruff. The primary benefit is that the binary target and the crate name are now the same, which helps with downstream tooling like cargo-dist, and also removes some complexity from the crate and Cargo.toml itself.

Test Plan

  • Ran rm -rf target/release.
  • Ran cargo build --release.
  • Verified that ./target/release/ruff was created.

@charliermarsh charliermarsh added the internal An internal refactor or improvement label Jan 16, 2024
@charliermarsh charliermarsh requested a review from zanieb January 16, 2024 20:53
@MichaReiser
Copy link
Member

This will mess with my brain mussels...

Copy link
Member

@MichaReiser MichaReiser left a comment

Choose a reason for hiding this comment

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

Is there anything that needs changing in the release workflow?

Copy link
Contributor

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

Formatter (stable)

✅ ecosystem check detected no format changes.

Formatter (preview)

✅ ecosystem check detected no format changes.

@charliermarsh
Copy link
Member Author

@MichaReiser - I don't believe so because we build the binaries with Maturin (which works with the changes to pyproject.toml), and the binaries generated still have the same name.

@charliermarsh charliermarsh merged commit 8118d29 into main Jan 16, 2024
40 checks passed
@charliermarsh charliermarsh deleted the charlie/ruff branch January 16, 2024 22:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal An internal refactor or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants