Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyoh86/telescope-gogh.nvim
https://github.com/kyoh86/telescope-gogh.nvim
neovim neovim-plugin nvim nvim-plugin
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/kyoh86/telescope-gogh.nvim
- Owner: kyoh86
- License: mit
- Created: 2021-02-02T22:47:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-14T00:59:51.000Z (over 1 year ago)
- Last Synced: 2024-08-07T18:36:15.942Z (3 months ago)
- Topics: neovim, neovim-plugin, nvim, nvim-plugin
- Language: Lua
- Size: 38.1 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# telescope-gogh.nvim
NOTE: I'm no longer using telescope. So active development has decelerated on the repository.
`telescope-gogh` is an extension for [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) that provides its users with operating [kyoh86/gogh](https://github.com/kyoh86/gogh).
## Installation
```lua
use{
'nvim-telescope/telescope-gogh.nvim',
requires = {
'nvim-telescope/telescope.nvim',
'nvim-lua/plenary.nvim',
'tyru/open-browser.vim',
},
config = function()
require'telescope'.load_extension'gogh'
end,
}
```
## Configuration
This extension can be configured using extensions field inside Telescope setup function.
```lua
require('telescope').setup {
extensions = {
gogh = {
bin = 'gogh',
tail_path = false,
shorten_path = true,
keys = {
list = {
open = 'default', -- as , open selected project in git-files
cd = '',
lcd = '',
tcd = '',
browse = '',
},
repos = {
browse = 'default',
get = '',
},
}
}
},
}
```
### `bin`
Filepath for the binary `gogh`. The path can be expanded.
### `tail_path`
Show only basename of the path.
Default value: `false`
### `shorten_path`
Call `pathshorten()` for each path.
Default value: `true`
### `keys`
It can change behaviors in telescope-prompt.
Place ` = { = }` in their.
## Usage
### list
`:Telescope gogh list`
Running `gogh list` and list repositories' paths.
In default, it does actions below when you input keys.
| key | action |
|----------|--------------------------|
| `` | `builtin.git_files` |
| `` | `:chdir` to the dir |
| `` | `:lchdir` to the dir |
| `` | `:tchdir` to the dir |
| `` | Browse target repositroy |
We can change the behavior in config.keys. See [#Configurations](#Configurations)
### repos
`:Telescope gogh repos`
Running `gogh repos` and list repositories' URLs.
In default, it does actions below when you input keys.
| key | action |
|----------|--------------------------|
| `` | Browse target repositroy |
| `` | Exec `gogh get` |
We can change the behavior in config.keys. See [#Configurations](#Configurations)
### options
#### Override configurations
You can override configurations with options like below:
- `bin`
- `tail_path`
- `shorten_path`
```vim
:Telescope gogh list bin=~/gogh tail_path=false
```
#### `cwd`
Transform the result paths into relative ones with this value as the base dir.
Default value: `vim.fn.getcwd()`
# LICENSE
[](http://www.opensource.org/licenses/MIT)
This is distributed under the [MIT License](http://www.opensource.org/licenses/MIT).