https://github.com/Arekkusuva/jira-nvim

Control Jira from Neovim
https://github.com/Arekkusuva/jira-nvim

jira jira-client jira-rest-api neovim neovim-plugin

Last synced: about 10 hours ago
JSON representation

Control Jira from Neovim

• Host: GitHub
• URL: https://github.com/Arekkusuva/jira-nvim
• Owner: Arekkusuva
• Created: 2022-04-03T12:24:59.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-31T12:00:39.000Z (over 1 year ago)
• Last Synced: 2024-08-02T13:29:00.325Z (3 months ago)
• Topics: jira, jira-client, jira-rest-api, neovim, neovim-plugin
• Language: Rust
• Homepage:
• Size: 36.1 KB
• Stars: 20
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Jira.nvim

Jira client as an extension for [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)

| ⚠️ | Work in progress |

| ----------- | ----------- |

* 🌠 [Features](#-features)

* ✔️ [Requirements](#-requirements)

* 📦 [Installation](#-installation)

* 🤖 [Commands](#-commands)

* 🚀 [Actions](#-actions)

* 📃 [Configuration sample](#-configuration-sample)

* 📋 [To-dos](#-to-dos)

## 🌠 Features

* Search issues using JQL

* Transition issues from one status to another

## ✔️ Requirements

* [neovim](https://neovim.io), tested for version >= 0.7.0

* [Rust](https://www.rust-lang.org/tools/install) to build dynamic lib

* [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) to show issues

## 📦 Installation

Using [packer.nvim](https://github.com/wbthomason/packer.nvim)

```lua

use {

  "Arekkusuva/jira-nvim",

  requires = {

    "nvim-telescope/telescope.nvim",

  },

  run = "make build",

  config = function ()

    require("jira-nvim").setup({

      host = "https://your-domain.atlassian.com",

      token_path = "~/.config/jira-nvim/token.txt",

    })

  end

}

```

## 🤖 Commands

There is only one command available `JiraQuery `, which executes query and shows found issues using telescope.

## 🚀 Actions

### Transition from one status to another

1. Select the issue to move and press ``

2. Select the desired status and press ``

### Copy issue URL

1. Select the issue and press ``

### Open issue in browser

1. Select the issue and press ``

## 📃 Configuration sample

With [which-key.nvim](https://github.com/folke/which-key.nvim)

```lua

require("which-key").register({

  j = {

    name = "Jira",

    t = { "JiraQuery project =  and status = 'To Do'", "To Do" },

    p = { "JiraQuery project =  and status = 'In Progress'", "In Progress" },

    d = { "JiraQuery project =  and status = 'Done'", "Done" },

  },

}, { prefix = "" })

```

## 📋 To-dos

- [x] Use specific version of Jira API

- [x] Fix error model in jira client

- [ ] Add issue detailed view with description and comments

- [ ] Ability to edit issue description

- [ ] Ability to add and edit comments