fntlnz / atags.vim Goto Github PK

View Code? Open in Web Editor NEW

40.0 3.0 4.0 10 KB

:collision: A plugin that simplifies tags generation on neovim

License: MIT License

Vim Script 100.00%

neovim vim ctags

atags.vim's Introduction

atags.vim is a Neovim plugin that helps you creating and updating your tag files.

Installation

Using vim-plug

Plug 'fntlnz/atags.vim'

Customization

Customize the generation command

The generation command is a list of commands that will be executed to generate your tags.

This is the default generation command:

let g:atags_build_commands_list = [
    \"ctags -R -f tags.tmp",
    \"awk 'length($0) < 400' tags.tmp > tags",
    \"rm tags.tmp"
    \]

Use cases

Generate tags with `<Leader>t`

map <Leader>t :call atags#generate()<cr>

Generate tags everytime a file is being written.

autocmd BufWritePost * call atags#generate()

Generation examples

Generate tags using stags within a Docker container

let g:atags_build_commands_list = [
    \"docker run --rm -v $PWD:/project -w /project fntlnz/pfff:latest stags -lang php -o tags -vim ."
    \]
]

Generate tags only for files that are not in `.gitignore`

let g:atags_build_commands_list = [
    \ 'ag -g "" | ctags -L - --fields=+l -f tags.tmp',
    \ 'awk "length($0) < 400" tags.tmp > tags',
    \ 'rm tags.tmp'
    \ ]

Generate tags only for PHP files that are not in `.gitignore`

let g:atags_build_commands_list = [
    \ 'ag --php -g "" | ctags -L - --fields=+l -f tags.tmp',
    \ 'awk "length($0) < 400" tags.tmp > tags',
    \ 'rm tags.tmp'
    \ ]

Work in progress

~~Support for different tag generators. At the moment this supports only ctags.~~
Use tpope/vim-dispatch to be compatible with vim that doesn't have jobstart
Write the docs

atags.vim's People

Contributors

Stargazers

Watchers

Forkers

gcollura fourjay yannham jasonwzz

atags.vim's Issues

error opening neovim

Let me preface this with sorry, this is a horrible vague issue. I'm running a release neovim build, which doesn't produce logs.

I get a "Error detected while processing [...] #generate:" when I open neovim without args (nvim). More text flashes afterwards, but it's too quick to see. There might be the string "command_list" and "on_stdout" somewhere.

If I open a file directly, I do not get an error.

awk division by zero error

When I use any of the example atag build command lists, including the default, I get an awk: division by zero error. It also happens when I try to run the commands manually.

Versions

OS: OS X 10.10.5
Neovim: 0.1.4
Ctags: 5.8
Shell: Bash 4.3.46(1)-release (x86_64-apple-darwin14.5.0)
Awk: awk version 20070501

Thanks!

stdin isn't a terminal

I get that error when using the plugin in neovim.

Use value of `tags` to determine output path?

Would it make sense to use the value of set tags to determine the output path?

use job for ordinary vim if it exsits

Ordinary vim also supports job.

Here is a library that shows how to use it https://github.com/prabirshrestha/async.vim

!c An error occurred generating ctags: /bin/bash: ag: command not found

After I call atags#generate() this error occurred

Output of :call atags#generate() does strange visual things with neovim+tmux

Here's me calling atags#generate() in neovim inside a terminal:

The same, but inside tmux:

It seems to bump everything up a line in the window and skip a few letters on the word "generated." Neovim then doesn't know that things are messed up, so your cursor location is a line below where you think it is. If you do something like scroll down a bit:

things get very strange. This is fixable by changing the window size in tmux, forcing neovim to redraw itself, by doing something like making a new split and then closing it.

I'm not sure why this would be happening, or if you think this is better suited for tmux or neovim's issue trackers.

Limit to a single generate call per root directory

I have vim configured to run #generate on open and save. On big repositories, this takes a long time. There should be a mechanism to prevent multiple processes.

Either use tags.tmp as a touchfile/lock, or pgrep.

Thoughts?