GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Simplify getting dirty files in repository by clyvari · Pull Request #2004 · libgit2/libgit2sharp

Conversation

@clyvari

@clyvari clyvari commented Jan 7, 2023

Copy link
Copy Markdown

A simple PR to help getting the dirty files in the repository.

Background: When getting a RepositoryStatus, we can use the IsDirty property to tell if the repository is dirty.
However, we don't have the same convenience to get the list of those dirty files.

Indeed, getting the actual list of dirty files would imply some duplicated logic in the client code, the same code that is present in the RepositoryStatus ctor to initialize the IsDirty prop.

What I propose is two parts (and 2 independent commits):

  1. Most importantly, we move the IsDirty detection inside a StatusEntry, by adding a property of the same name. Before, the detection was done inside the RepositoryStatus ctor, analyzing each StatusEntry FileStatus. Now each StatusEntry has the responsibility of telling whether it is dirty.

  2. Least importantly, but I think it's nice, we add a Dirty collection inside RepositoryStatus, that is initialized with all the IsDirty StatusEntries

Before thos changes, a client code working with dirty files could look like this:

if(repositoryStatus.IsDirty)
{
    var dirtyFiles = repositoryStatus
                         .Where(file => file.State != FileStatus.Ignored
                                     && file.State != FileStatus.Unaltered) // Duplicated Logic
}

With those two modifications, the client code would look like this:

if(repositoryStatus.IsDirty)
{
    var dirtyFiles = repositoryStatus.Dirty;
}

I appreciate any feedback, let me know if anything need to be changed.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
clyvari added 2 commits January 7, 2023 16:30
@clyvari
Add IsDirty property to StatusEntry, Change RepositoryStatus.IsDirty …
62b3e0d
…logic to use StatusEntry.IsDirty
@clyvari
Add Dirty collection to RepositoryStatus
916be53
Add Unit Tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

1 participant

@clyvari
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.