igemnace / vim-makery Goto Github PK

See the following discussions for background:

https://www.reddit.com/r/vim/comments/7112pw/makeryvim_a_plugin_to_manage_your_makeprgs/dn7fj3k/

• https://www.reddit.com/r/vim/comments/7112pw/makeryvim_a_plugin_to_manage_your_makeprgs/dn7fu7z/

Right now, the plugin depends on the current working directory being set properly as Vim starts (or as the plugin is sourced, e.g. via :packadd).

This has a few drawbacks:

• Doesn't work with multiple projects with different root directories in a single Vim instance
• Doesn't work well after a :cd if the relevant makeprg is required to run from project root
• Doesn't allow for easy dynamic sourcing of config (e.g. re-source with some :MakeryReload command)

Ideas moving forward:

• Care about the current file, not the current working directory (set buffer variables? check out lh-vim-lib's project variables?)
• Save project root to a variable, to work properly even after a :cd

#3 has been resolved by having makery#Setup run in a buffer-local manner, then running config detection with an autocommand on BufRead,BufNewFile.

While this works in the simple cases I've tested, it doesn't seem as robust as it can be. For comparison, Projectionist runs config detection on a long list of autocommand events.

While duplicating Projectionist's effort would be a waste (better to just do #5), some of those might be required to catch edge cases. Catching buftype in commit 1ac07e8 was already a concession here, for example, since without it, opening the quickfix kept bringing up Makery warnings.

See the following discussion on how this could go wrong: https://www.reddit.com/r/vim/comments/7112pw/makeryvim_a_plugin_to_manage_your_makeprgs/dn7hyvy/

Solutions moving forward:

• DONE Warn the user if an existing command would have been overwritten
• DONE Forgo creating the command, so it doesn't cause any problems
• DONE Expose a :Makery command that takes subcommands as its first argument, e.g. :Makery lint and :Makery build

See this Reddit discussion for details.

Possible issue with doing this (as pointed out in the discussion) is pulling out the errorformat from under a running async :Make, which might result in garbled quickfix output.

Better test with some popular async options before pushing this out. Off the top of my head, test with:

• Dispatch.vim
• DONE Asyncrun.vim
• build-tools-wrapper

If Vim is opened from a project subdir, it reads .makery.json from project root properly, since it recurses up directories to search for it.

However, project root is sometimes needed for the makeprg to work (e.g. having Mtags run ctags -R src will certainly need to run in project root, for it to find src). Saving project root to a variable could certainly prove convenient.

Ideas for detecting project root:

• For .makery.json: use the directory in which .makery.json is found.
• For g:makery_config: without globbing, use the exact path as it appears in the config. With globbing, use the current path (parent directory of the current buffer)?
• For Projectionist support: use the most precisely targeted root from projectionist#query() or projectionist#path()?

After a discussion on #vim, the idea of having Makery config for filetypes, potentially across multiple projects, was brought up by m_ben and vxid. Use cases in mind were C++ and Python, for which multiple linters exist. The current Makery system works well for juggling the linters, although the project-specific nature of configuration will mean lots of duplicate .makery.json files.

No solid action plan for now, much less an implementation route. I'm leaving this space open for when I get a better idea of how to tackle this.

After changing makery.json, I need to save the current vim session, exit vim, and load the session again. I would rather have a command that rereads makery.json so changes take effect without restarting vim. Would that be something easy to add?

Alternatively use :echo instead of :echom as with current setup it sometimes requires user to <CR> through messages. It could be hidden behind some kind of g:makery_debug flag.

I want to run a linter for the current file based on something like the following:

{
  "lint": {"makeprg": "clang-tidy %"}
}

Currently, the percent sign is not recognized correctly. Is there something like that implemented? Thanks.

I think it would be good idea to provide support for vim-projectionist.