Skip to content

Commit

Permalink
chore: add telescope docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kid-icarus committed May 26, 2024
1 parent 9701968 commit f15ef7e
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ jobs:
neovim-nightly
dependencies: |
plenary.nvim
telescope.nvim
env:
LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}
7 changes: 3 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/luarocks
/lua_modules
/.luarocks
/lua
luarocks
lua_modules
.luarocks
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ use {
'kid-icarus/jira.nvim',
requires = {
'nvim-lua/plenary.nvim',
'nvim-telescope/telescope.nvim',
}
config = function ()
require'jira'.setup() -- see configuration section
Expand All @@ -45,6 +46,7 @@ Using [lazygit.nvim](https://github.com/folke/lazy.nvim)
'kid-icarus/jira.nvim',
dependencies = {
'nvim-lua/plenary.nvim',
'nvim-telescope/telescope.nvim',
},
opts = {}, -- see configuration section
}
Expand Down Expand Up @@ -81,3 +83,16 @@ There is only an Jira <object> <action> [arguments] command.
| issue | view [issue_id] | View the given issue, if none provided it will attempt to extract one out of the current git branch (disabled via `use_git_branch_issue_id`), else falls back to a prompt |
| | transition [issue_id] [transition_name] | Transition the ticket to a given status. Will attempt to extract issue ID from git branch, and will prompt if no options given

Additionally, the transition command has a Telescope picker.

`:Telescope jira transitions`

## Mappings

There are no default mappings, but you can create your own. Here's an example:

```lua
local t = require 'telescope'
vim.keymap.set('n', '<leader>jt', '<cmd>Jira issue view<cr>', {})
vim.keymap.set('n', '<leader>jv', t.extensions.jira.transitions, {})
```
1 change: 1 addition & 0 deletions jira.nvim-scm-1.rockspec
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ description = {
dependencies = {
'lua >= 5.1, < 5.4',
'plenary.nvim',
'telescope.nvim',
}

source = {
Expand Down

0 comments on commit f15ef7e

Please sign in to comment.