Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cenk1cenk2/youtrack.nvim
For the intersection set of handful of people that is using Youtrack and Neovim together. This plugin enables you to interact with Youtrack from Neovim.
https://github.com/cenk1cenk2/youtrack.nvim
neovim-plugin nvim-plugin
Last synced: about 4 hours ago
JSON representation
For the intersection set of handful of people that is using Youtrack and Neovim together. This plugin enables you to interact with Youtrack from Neovim.
- Host: GitHub
- URL: https://github.com/cenk1cenk2/youtrack.nvim
- Owner: cenk1cenk2
- Created: 2024-08-30T22:01:57.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-01T12:28:53.000Z (17 days ago)
- Last Synced: 2024-11-01T13:25:45.744Z (17 days ago)
- Topics: neovim-plugin, nvim-plugin
- Language: Rust
- Homepage:
- Size: 313 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# youtrack.nvim
For the intersection set of handful of people that is using Youtrack and Neovim together. This plugin enables you to interact with Youtrack from Neovim.
## Features
- Get issues from Youtrack, and list them and their details.
- Get your saved queries, and modify them realtime to list matching issues.  
- Get issue details, and modify them realtime. 
- View comment on the issue and add new comments. 
- Apply commands to the issue. 
- Open issue in the browser.
- Create new issues in Youtrack.
- Create a new issue in the project and fill the basic data.  
- Drop down to issue detail view to further fill the details. 
- Open and search agile boards. 
## Requirements
Even though this plugin could purely created with `lua`, I wanted to exercise with `rust` and `lua` bindings since I created this plugin for mostly myself and handful of people that is in the intersection set. You need to have `rust` installed in your system to build the plugin backend.
- `rust` has to be installed in your system to compile the backend.
- `make` has to be installed in your system to build the plugin.
## Installation
### `lazy.nvim`
```lua
{
"cenk1cenk2/youtrack.nvim",
build = { "make" },
dependencies = {
-- https://github.com/MunifTanjim/nui.nvim
"MunifTanjim/nui.nvim",
-- https://github.com/grapp-dev/nui-components.nvim
"grapp-dev/nui-components.nvim",
}
}
```
## Configuration
### Setup
Plugin requires `url` and `token` to be set in the configuration.
```lua
require("youtrack").setup({
url = vim.env["YOUTRACK_URL"],
token = vim.env["YOUTRACK_TOKEN"],
})
```
You can check the full configuration in [here](https://github.com/cenk1cenk2/youtrack.nvim/blob/main/lua/youtrack/config.lua).
### Adding Additional Queries
You can add additional queries to your saved ones directly in the `lua` configuration.
```lua
require("youtrack").setup({
-- rest of the configuration...
queries = { "for: me" }
})
```
### Limiting Fields
You can limit custom fields to the view, this will limit the cluter you will see in the given view.
```lua
require("youtrack").setup({
-- rest of the configuration...
-- to limit the fields in the get issues view
issues = {
fields = { "State" }
},
issue = {
-- to limit the fields in the get issue detail view
fields = { "State", "Subsystem", "Timer" }
}
})
```
### UI Configuration
UI parameters can be passed in to further customize the global keymaps and size per view.
```lua
require("youtrack").setup({
-- rest of the configuration...
-- global ui configuration
ui = {
border = "single",
width = 180,
keymap = {
close = "",
focus_next = "",
focus_prev = "",
focus_left = "",
focus_right = "",
focus_up = "",
focus_down = "",
},
},
-- sizing for specific views
issues = {
size = {
height = 24,
width = 180,
},
},
issue = {
size = {
height = 48,
width = 180,
},
},
})
```
## Usage
This plugin is designed to toggle different views directly.
So you can map the following calls into any keybind.
### Issues View
Lists the saved queries, and allow you to modify them to list the issues. You can open the issue details by pressing `Enter`.
```lua
require("youtrack").get_issues()
```
### Create Issue View
Create a new basic issue in the project then list the detail of it.
```lua
require("youtrack").create_issue()
```
### Boards View
List and open a board in the browser.
```lua
require("youtrack").get_agiles()
```
## References
The UI is only possible due to beautiful work done on [MunifTanjim/nui.nvim](https://github.com/MunifTanjim/nui.nvim) and [grapp-dev/nui-components.nvim](https://github.com/grapp-dev/nui-components.nvim).
Thanks to following plugins for inspiration:
- [Arekkusuva/jira-nvim](https://github.com/Arekkusuva/jira-nvim)