Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joechrisellis/vim-git-arglist

Vim commands for manipulating the arglist based on the current Git repository
https://github.com/joechrisellis/vim-git-arglist

arglist git integration plugin vim

Last synced: 2 months ago
JSON representation

Vim commands for manipulating the arglist based on the current Git repository

Host: GitHub
URL: https://github.com/joechrisellis/vim-git-arglist
Owner: joechrisellis
Created: 2021-05-12T10:31:09.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2021-08-11T17:50:23.000Z (over 3 years ago)
Last Synced: 2023-09-01T20:35:38.510Z (over 1 year ago)
Topics: arglist, git, integration, plugin, vim
Language: Vim script
Homepage:
Size: 31.3 KB
Stars: 17
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# vim-git-arglist

A plugin which adds helper commands for manipulating the arglist based on the
current Git repository.

Vi/Vim's arglist is useful for grouping together a collection of files for easy
navigation. This plugin adds helper commands that interface with Git for
manipulating the arglist based on the repository you're working with.

As a quick example, you can add all of the files modified/added by a particular
commit to the arglist with `:ArgsTreeish `. Or, you can add all of
the files modified/created in your working tree to the arglist using
`:ArgsDiffed`. For more, check out `:h git-arglist-example-workflow`, which
explains one of my personal workflows with this plugin.

You can also use `:h git-arglist` for help.

# Installation

The plugin is plain Vimscript, so the installation doesn't require anything
special. You can install the plugin using whichever plugin manager you normally
use. For example, if you use vim-plug, add:

```
Plug 'joechrisellis/vim-git-arglist'
```

to your vimrc.

# Examples

You can take full advantage of Git pathspecs with vim-git-arglist:

- `:ArgsDiffed HEAD :/'**'.{cpp,h}` -- open all C++ source/header files that
have changed in the working tree. Strictly, this means "set the arglist to
all files modified in the working tree with extension `.cpp` and `.h`".
- `:ArgsTreeish ':**/test/**'` -- open all tests touched by
``. Strictly, this means "set the arglist to all files in the
repository touched by `` that are beneath a `test` subdirectory".
- `:ArgsTreeish ':!/**/docs/**'` -- open everything touched by
`` except for documentation changes. Strictly, this means "set the
arglist to all files in the repository touched by `` that are not
beneath a `docs` subdirectory".

You can also take advantage of Git revision specifiers:

- `:ArgsDiffed @{u}` -- open all of the files that have been modified on the
current branch since the last push to upstream. If you want to exclude
uncommitted changes in your working directory, you can use
`:ArgsDiffed @{u}..`.

# License