microsoft / microsoft/markitdown
Migrate from Black to Ruff
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 186k
- Forks
- 13.7k
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 49
Description
Reason
- Hatch build-in
-
Static analysis performed by the fmt command is (by default) backed entirely by Ruff.
-
- Import sorting
- Black does not support import sorting, requiring an additional tool (isort).
- Ruff includes import sorting functionality, simplifying the workflow
- Simpler workflow:
- Instead use
pre-commit run --all-files(need pre-commit), can usehatch fmt
- Instead use
If this proposal is approved, I will make a PR to implement these changes.
Reference
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the repository's Hatch formatting configuration and pre-commit setup, then check how Black and import sorting are currently invoked. The migration is complete when Ruff handles formatting and import sorting through Hatch's fmt command without the existing Black/isort workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, tooling
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100