Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chmouel/consult-vc-modified-files
List git modified files in a project with vc
https://github.com/chmouel/consult-vc-modified-files
emacs emacs-lisp emacs-mode
Last synced: about 1 month ago
JSON representation
List git modified files in a project with vc
- Host: GitHub
- URL: https://github.com/chmouel/consult-vc-modified-files
- Owner: chmouel
- License: gpl-3.0
- Created: 2023-10-19T05:06:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-10T19:35:11.000Z (2 months ago)
- Last Synced: 2024-12-10T19:44:30.345Z (2 months ago)
- Topics: emacs, emacs-lisp, emacs-mode
- Language: Emacs Lisp
- Homepage:
- Size: 36.1 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://melpa.org/#/consult-vc-modified-files)
# consult-vc-modified-files
`consult-vc-modified-files` provides a easy way to list Git-tracked files that have been modified, newly added, or are part of the HEAD commit in a project.
It integrates with Emacs' built-in [vc](https://www.gnu.org/software/emacs/manual/html_node/emacs/Version-Control.html) and
[project](https://github.com/emacs-mirror/emacs/blob/master/lisp/progmodes/project.el) libraries,
as well as the [consult](https://github.com/minad/consult) package for navigation.
## Features
- View **locally modified** and **newly added** files in the current Git project.
- List files from the HEAD commit.
- Customize sources for specific use cases.
- Navigate the open files with `consult`.
## Screenshot
## Installation
### Using `use-package` and [MELPA](https://melpa.org/)
```elisp
(use-package consult-vc-modified-files
:bind
;; choose any other key binding you prefer
("C-x v /" . consult-vc-modified-files))
```
## Usage
Call the interactive function `consult-vc-modified-files`, or use a key binding
like `C-x v /` (if configured with the configuration above).
When invoked, the command show a prompt for selecting files based on customizable sources:
- **Modified locally**: Lists locally modified or untracked files.
- **Modified in HEAD**: Lists files modified in the HEAD commit.
You can customize the available sources using the
`consult-vc-modified-files-sources` variable.
## Customization
### Configure Sources
Customize `consult-vc-modified-files-sources` to control which file categories appear in the selection. For example:
```elisp
(setq consult-vc-modified-files-sources
'(consult-vc-modified-source-files
consult-vc-modified-source-head-files))
```
### Customize Faces
Adjust the appearance of listed files by customizing:
- `consult-vc-modified-files-face`: For locally modified files.
- `consult-vc-modified-head-files-face`: For files modified in HEAD.
## Authors
### Chmouel Boudjnah
- **Fediverse**: [@[email protected]](https://fosstodon.org/@chmouel)
- **Twitter**: [@chmouel](https://twitter.com/chmouel)
- **Blog**: [https://blog.chmouel.com](https://blog.chmouel.com)
## License
This project is licensed under the [GPL-3.0](./LICENSE).