rome/tools

馃搸 New `--changed` argument

Open

#4,453 opened on May 9, 2023

View on GitHub
聽(2 comments)聽(2 reactions)聽(0 assignees)Rust聽(23,438 stars)聽(647 forks)batch import
A-CLIA-ProjectHelp wantedI-Normal

Description

Description

Rome now has support for VCS, which means that we can unlock new features that make the life of developers easier!

One of these features is the addition of a new argument called --changed to the CLI. When we pass this argument, Rome will execute check/format/etc. only to those files that were changed.

Technical details

I am still determining the implementation of this argument. There are two alternatives:

  1. execute the command via Command, we pass the proper arguments to the git program, and we read the output that was generated. Although I don't know yet what's the correct command/arguments to get an accurate output
  2. Use the crate git2. While this crate is phenomenal, its size is not small (207kb)

What do you guys think?

Contributor guide

Tech stack
rust
Domain
clideveloper experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Rust programmingRome codebase understandingKnowledge of Git VCS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The issue is in early discussion, with two proposed approaches for implementing the ` changed` argument: using `std::process::Command` to call git or the `git2` crate. The decision is not yet made, and the exact command to list changed files is undetermined. Further discussion with maintainers is needed to finalize the implementation path.