Git integration

[hpwxf]

Add git integration following a behaviour very close to what exa do.

It adds a --git option and a block git which is only display when --long option is enable.

git is called only once for the current tree (if the current directory is a subdirectory of git, the status is displayed but if you use a deeper display, e.g. using --tree, the git status of repositories in subdirectories is not done).

---

• Use cargo fmt
• Add necessary tests
• Add changelog entry
• Update default config/theme in README (if applicable)
• Update man page at lsd/doc/lsd.md (if applicable)

[hpwxf]

this PR follows a discussion in #7 (comment)

[hpwxf]

git is enabled by default (when available). The feature no-git may be used to force disable it.

The only unsupported target is i686-pc-windows-gnu (compilation failure during the link; ex: https://github.com/hpwxf/lsd/actions/runs/4271505990/jobs/7436019267)

[hpwxf]

Updated with master

[zwpaper]

I have done some of the reviews, and allow me to leave the rest to a next time.

I have checked the simple part, it only has some nit requests to change, and I am trying to walk through the complicated parts, trying my best to get this merged

[hpwxf]

Thx @zwpaper for the review. I'm sorry for the format issues; my conclusion: don't blindly trust code formatting

[hpwxf]

@zwpaper is everything ok for you?

[zwpaper]

hi @hpwxf, sorry again for the late reply, I was swamped recently, I had added more comments and it would be ok to go after we resolve them.

thanks so much for the PR, it looks great and we only have some nit to discuss.

let's make the magic happen!

[zwpaper]

hi @hpwxf, do you have some cycle for this PR, we are planning for 1.0 release, we can try to make it ship with the 1.0

[hpwxf]

hi @hpwxf, do you have some cycle for this PR, we are planning for 1.0 release, we can try to make it ship with the 1.0

Sorry for my discontinued availability. I will do the requested changes today or tomorrow.

[hpwxf]

Thx for the review. Everything solved (see comments for details)

[zwpaper]

hi @hpwxf, thanks for the great work again, I have only two more nit questions

1. the style is different in unicode and default
   
2. the space may cause confusion when most of the files are unchanged, but actually I like the clean spaces personally 🤣
   

Maybe a more consistent choice for the default would be better.

how about a dash - for default, and dot . for unmodified?

[hpwxf]

@zwpaper Thank you for your feedback.
Do you prefer ASCII chars in any mode?
Without the space separator, the symbols are sometimes too close:

A workaround could be to use simple ASCII chars:

[zwpaper]

hi @hpwxf, I would prefer icons, or Unicode, actually, but as you said that it may be too close in some cases, that would be a problem, and it would be too far away if a space added🤣

how about we use ASCII in this first version, and try to figure out a theme that fits all cases?

and we can also let users create a theme file to custom it themselves later.

[hpwxf]

Hi @zwpaper ;
An idea seems to be:

• default symbols using ASCII chars
• custom symbols using a theme (the user will be able to add a space for large symbol)

I will work on that. (I will first update to only use ASCII chars and then about the theme; if you prefer the git theme can be done in a next PR).

[hpwxf]

Git theme done:

In config file, you can define:

# == Git ==
git:
  # Whether to display git status
  # Possible values: false, true
  enabled: true
  # How to display git status
  # When "classic" is set, this is set to "default".
  # Possible values: default, <theme-file-name>
  # when specifying <theme-file-name>, lsd will look up theme file
  # XDG Base Directory if relative, e.g. ~/.config/lsd/themes/<theme-file-name>.yaml,
  # The file path if absolute
  theme: git

and ~/.config/lsd/themes/git.yaml can be:

default: "-"
unmodified: "."
new-in-index: 
new-in-workdir: "?"
deleted: D
modified: ✍
renamed: R
ignored: I
typechange: T
conflicted: C

I still have a small bug that always enable git when --config-file is used (even if enabled: false)

[zwpaper]

Hi, @hpwxf thanks so much for implementing the theme in this short time!

But I prefer a separate PR for the theme features.

One reason is that we would have more discussions about it like, we were planning to use a fixed theme file name, theme should be optional so that user doesn't have to offer all items, eg., keeping it simple would let us release the 1.0 in a shorter time.
Another one is that I am planning to squash the PR as this is one feature and tens of commits may be a nightmare for others to rebase onto.

[zwpaper]

Ps it would also be great if we make the git theme (in a separate PR) in time to release with the 1.0

[hpwxf]

Hi @zwpaper ; all done.

• First I finalized a functional code about a theme for git (only symbols; it could also include colors)
• Then I did a commit to remove the git theme and I saved the previous work in another branch for a next PR (in https://github.com/hpwxf/lsd/tree/git-theme)
• I squashed all the commits before your latest review (the latest commits are not yet squashed, but once reviewed it could be a good thing for sure)

[codecov-commenter]

Codecov Report

Merging #822 (9c7476d) into master (6840c01) will decrease coverage by 0.60%.
The diff coverage is 74.30%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##           master     #822      +/-   ##
==========================================
- Coverage   87.08%   86.48%   -0.60%     
==========================================
  Files          45       49       +4     
  Lines        4258     4602     +344     
==========================================
+ Hits         3708     3980     +272     
- Misses        550      622      +72     

Impacted Files	Coverage Δ
src/config_file.rs	64.93% <ø> (ø)
src/core.rs	0.00% <0.00%> (ø)
src/flags.rs	96.77% <ø> (ø)
src/main.rs	29.41% <ø> (ø)
src/sort.rs	98.00% <0.00%> (-1.49%)	⬇️
src/theme.rs	78.26% <ø> (ø)
src/app.rs	33.33% <9.09%> (-5.96%)	⬇️
src/meta/git_file_status.rs	11.76% <11.76%> (ø)
src/git_theme.rs	13.33% <13.33%> (ø)
src/color.rs	49.44% <50.00%> (+<0.01%)	⬆️
... and 9 more

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[tummetott]

@hpwxf any news when the git-theme branch will be merged? Is there an issue which tracks the announced discussion around the git-theme?

Or is it already possible defining custom icons for the git-status column?