Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonastoth/gitforge.nvim
nvim Plugin to provide access to your favorite Git Forge - GitHub, GitLab (and more to come)
https://github.com/jonastoth/gitforge.nvim
git gitforge github gitlab issues nvim
Last synced: about 18 hours ago
JSON representation
nvim Plugin to provide access to your favorite Git Forge - GitHub, GitLab (and more to come)
- Host: GitHub
- URL: https://github.com/jonastoth/gitforge.nvim
- Owner: JonasToth
- License: apache-2.0
- Created: 2024-08-18T12:36:15.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-25T19:52:09.000Z (1 day ago)
- Last Synced: 2025-01-25T20:25:48.906Z (1 day ago)
- Topics: git, gitforge, github, gitlab, issues, nvim
- Language: Lua
- Homepage:
- Size: 107 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gitforge.nvim - Issues, PRs, CI/CD
- list, comment and change issues on GitLab and Github
- pin relevant issues for you and have them available without searching for them
> [!WARNING]
> This plugin is in an early development state. Things may not work, they are clumsy and may break
> randomly after an update.
> Please keep this in mind.
This plugin aims to provide integrated access to various Git Forges for your daily development
tasks - working with issues, working with PRs and checking CI/CD pipelines.
Its goal is being a workhorse plugin that is reliable and stable.
You can read more about the goals and development milestones under [development resources](development_resources/README.md).
## Installation
**[lazy.nvim](https://github.com/folke/lazy.nvim)**
```lua
local ia = "gitforge.issue_actions"
return {
"JonasToth/gitforge.nvim",
version = "*",
dependencies = {
{ "nvim-telescope/telescope.nvim" },
{ "pysan3/pathlib.nvim" },
},
cmd = { "GForgeViewIssue", "GForgeListIssues", "GForgeOpenedIssues", "GForgePinnedIssues", "GForgeCreateIssue" },
keys = {
{ "gv", "GForgeViewIssue", desc = "View an issue" },
{ "gn", "GForgeCreateIssue", desc = "Create a new issue" },
{ "ggo", "GForgeOpenedIssues", desc = "List opened issue" },
{ "ggp", "GForgePinnedIssues", desc = "List pinned issues" },
{
"gio", function() require(ia).list_issues({ state = "open", limit = 100, }) end,
desc = "List All Open Issues"
},
{
"giB", function() require(ia).list_issues({ state = "open", labels = "bug", limit = 100, }) end,
desc = "List All Open Bugs"
},
{
"gim", function() require(ia).list_issues({ state = "open", assignee = "@me", }) end,
desc = "List My Issues"
},
{
"gib", function() require(ia).list_issues({ state = "open", assignee = "@me", labels = "bug", }) end,
desc = "List My Bugs"
},
},
opts = {},
}
```
Please call any of the following commands to see if any issues are detected by the plugin:
- `:checkhealth gitforge` to check the overall plugin health
- `:checkhealth gitforge.gh` to check the Github provier
- `:checkhealth gitforge.glab` to check the GitLab provier
## Usage
> [!NOTE]
> The commands of this plugin execute a CLI tool in the background. Its behavior depends on the working
> directory of `nvim`.
> ```bash
> $ cd $MY_GIT_REPOSITORY
> $ nvim
> > # Usage here will perform commands as if calling e.g. 'gh issue list' directly
> ```
> You can change your working directory in `nvim` with the `:cd path/to/new/directory` command.
Interacting with an issue buffer is done through key binding using the `` key.
Closing an issue is done with `q`. The key bindings are configurable as [documented here](/docs/configuration.md#issue-settings).
| Single Issue | Default Binding | Github | Gitlab |
| -----------------------: | :---------------------: | :----: | :----: |
| View an Issue | `:GForgeViewIssue` | ✓ | ✓ |
| Create New Issue | `:GForgeCreateIssue` | ✓ | ✓ |
| List All Issues | `:GForgeListIssues` | ✓ | ✓ |
| List Locally Open Issues | `:GForgeOpenedIssues` | ✓ | ✓ |
| List Pinned Issues | `:GForgePinnedIssues` | ✓ | ✓ |
| Issue-Buffer Actions | Default Binding | Github | Gitlab |
| -----------------------: | :---------------------: | :----: | :----: |
| Hide Issue | `q` | ✓ | ✓ |
| Refresh Content | `u` | ✓ | ✓ |
| Edit Title | `t` | ✓ | ✓ |
| Edit Labels | `l` | ✓ | ✓ |
| Edit Assignees | `a` | ✓ | ✓ |
| Edit Description | `d` | ✓ | ✓ |
| Open/Close Issue | `s` | ✓ | ✓ |
| Add comment | `c` | ✓ | ✓ |
| Pin Issue | `p` | ✓ | ✓ |
| Open in Browser | `w` | ✓ | ✓ |
### Configuration
This plugin probably requires a bit of configuration to select the elements issues that are of your interest.
Smaller projects are probably fine without the more complicated key bindings. Large projects certainly aren't.
To view only issues with specific labels, e.g. for a subproject is possible, but requires calling the matching
`lua` functions with proper arguments.
See [docs/configuration.md](docs/configuration.md) for more information on how to configure the plugin.
## Plugins that will improve the user experience
- [markview.nvim](https://github.com/OXY2DEV/markview.nvim) or [render-markdown.nvim](https://github.com/MeanderingProgrammer/render-markdown.nvim) for markdown visualization
- [neogit](https://github.com/NeogitOrg/neogit) for direct `git` interaction
- for better `vim.ui.input` and notifications, there are multiple options
- [snacks.nvim](https://github.com/folke/snacks.nvim)
- [dressing.nvim](https://github.com/stevearc/dressing.nvim)
- [nvim-notify](https://github.com/rcarriga/nvim-notify)
- [toggleterm.nvim](https://github.com/akinsho/toggleterm.nvim) to quickly execute commands directly
## Plugins you might want to use instead
- [jirac.nvim](https://github.com/janBorowy/jirac.nvim)
- [gitlab.nvim](https://github.com/harrisoncramer/gitlab.nvim)
## Status
### General Capabilities
- [x] Project Specific configuration to use different backends for different repositories
- [x] Proper Commands for more efficient lazy loading
### Issues
The issue interactions are ready to be tried out. Please create issues if you experience problems.
Right now, only single-issue interactions are available. Switch to the Web-View directly from
`nvim` if necessary.
### Pull Requests
No work has been done.
### CI/Commands
No work has been done.