8000 Formatting: `black` -> `ruff format` by tony · Pull Request #506 · tmux-python/libtmux · GitHub
[go: up one dir, main page]
Skip to content

Formatting: black -> ruff format#506

Merged
tony merged 7 commits intomasterfrom
ruff-format
Nov 18, 2023
Merged

Formatting: black -> ruff format#506
tony merged 7 commits intomasterfrom
ruff-format

Conversation

@tony
Copy link
Member
@tony tony commented Nov 18, 2023 •
edited
Loading

Changes

Development

  • Convert from black to ruff format (https://docs.astral.sh/ruff/formatter/)

    This retains the formatting style of black while eliminating a dev dependency by using our existing rust-based ruff linter.

@codecov
Copy link
codecov bot commented Nov 18, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6509995) 88.84% compared to head (7bce50f) 88.84%.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master     #506   +/-   ##
=======================================
  Coverage   88.84%   88.84%           
=======================================
  Files          35       35           
  Lines        3514     3514           
  Branches      484      484           
=======================================
  Hits         3122     3122           
  Misses        284      284           
  Partials      108      108

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

@tony tony force-pushed the ruff-format branch 2 times, most recently from 1112002 to cbdb89f Compare November 18, 2023 10:26
@piotr-dobrogost
Copy link
piotr-dobrogost commented Nov 18, 2023

Any rationale for replacing black with ruff?

@tony
Copy link
Member Author
tony commented Nov 18, 2023

@piotr-dobrogost ruff format (via ruff) supports the formatting style of black (mostly). It's faster since it's in rust. It's still permissively licensed. We can eliminate a dev dependency.

While we're here: Anything against ruff or ruff format? (Any issues with ruff or ruff format I could be made aware of?)

@piotr-dobrogost
Copy link
piotr-dobrogost commented Nov 18, 2023

Thanks for the answer.
Can't say anything about ruff as I haven't used it. I was asking just out of curiosity. I suggest trying to give short rationale for changes like this so that they don't appear "out of the blue".

@tony
Copy link
Member Author
tony commented Nov 18, 2023

@piotr-dobrogost Good idea. I will note the reasoning in the changelog (updated the PR as well)

@tony tony force-pushed the ruff-format branch 2 times, most recently from 6d1e0a0 to 15efb6a Compare November 18, 2023 11:10
@tony tony merged commit a94cee8 into master Nov 18, 2023
@tony tony deleted the ruff-format branch November 18, 2023 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tony @piotr-dobrogost
0