Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/crossr/vim-fhicl

Helpers for FHICL Files in Vim + Neovim.
https://github.com/crossr/vim-fhicl

fermilab larsoft neovim vim

Last synced: 25 days ago
JSON representation

Helpers for FHICL Files in Vim + Neovim.

Awesome Lists containing this project

README 

        
# vim-fhicl



Helpers for [FHICL](https://cdcvs.fnal.gov/redmine/projects/fhicl/wiki) Files in Vim + Neovim.



The demo below shows the opening of various fhicl files over CVMFS, syntax highlights, and 

[FZF](https://github.com/junegunn/fzf.vim) powered search.



https://user-images.githubusercontent.com/10038688/135842553-3f030d64-31be-4964-b9da-7df5dffbda34.mov



### Features



 * Adds basic syntax highlighting to `.fcl` files.

    * Highlight keywords like `physics`, `analyzers` to flag up typos.

    * Properly colour `#include` statements, comments and numbers.

 * Helper functions, with the default keybind:

    * Follow `#include` statement to `fcl` file → `-ff`.

    * Find all files that include the current one  → `-fi`.

    * List all `fcl` files in `FHICL_FILE_PATH` → `-fa`.

    * Search contents of all `fcl` files → `-fs`.

      * Search and list function requires `fzf`, https://github.com/junegunn/fzf.vim

 * Update the `commentstring` variable for `.fcl` files, so commenting plugins work.

 * Sets the `JSON` indentation rules for the `.fcl` files, to give more intelligent auto indentation.

    * **TODO:** Check and update this logic to make sure it works nicely for all files, and all styles of line.



### Usage



Once installed, syntax highlighting should be applied automatically for all

`.fcl` files.



Pressing `-ff` on any `#include` statement (`leader`

defaults to `\`, such that `\` then `ff` calls the function) will search for and

then open the corresponding `fcl` file. If multiple results are found, the

Location List will be populated, which can be navigated like normal and a selected

file opened with `Enter`.



Once finished with a file, pressing `Backspace` will navigate back to the parent file.



Similarly, `-fi` will search for all files that `#include` the current `fcl` file.

The results will be populated into a Location List, or an FZF search if installed.



`-fa` will populate the location list (or FZF) with every `fcl` file that can be found.



`-fs` will populate FZF with the content of every `fcl` file, such that they can all

be searched through.



### Installation



Can be installed with `vim-plug` or any other similar package manager with:



```vim

Plug 'CrossR/vim-fhicl'

```



### Config Options



```vim

" Controls if the current directory should be searched.

" Defaults to 0, set to 1 to search it.

let g:vim_fhicl#search_current = 0



" Controls when the search stops.

" Defaults to 'all' which means get all results.

" If set to 'first', will break after finding one match.

let g:vim_fhicl#search_setting = "all"



" Controls if the first file should be opened.

" If multiple results are found, the results are

" sent to the location list. If this option is set,

" the first file will be opened as well.

" Defaults to 0, set to 1 to open it every time.

let g:vim_fhicl#always_open_first = 0



" Controls if the given file should be opened.

" If set to 1, when invoking the plugin on an include line,

" the results will always be sent to the location list, and

" never opened.

" Defaults to 0, set to 1 to never open a file and only populate

" the location list.

let g:vim_fhicl#dont_open_file = 0



" The command used to search for files that include the current one.

" If replaced, the command should be passed with any flags needed for

" recursive running, as well as only returning files.

" Defaults to using "grep -r".

" To use ripgrep, instead use "rg --type-add 'fcl:*.fcl' -tfcl".

let g:vim_fhicl#search_command = "grep -lr"



" The command used to find files.

" If replaced, the command should be passed with any flags needed for

" recursive running, as well as only returning files.

" Defaults to using "find", and due to the command setup, only find

" replacements will work easily. Code could be updated to instead take a full

" command, not just an executable.

let g:vim_fhicl#find_command = "find"

```



### Custom Binds



```vim

" Remap the follow function with the following.

" Replace -ff with the correct bind.

" ff -> Follow Fhicl

nmap -ff vim-fhiclFindFhiclFile



" Remap the swap back function with the following.

" Replace  with the correct bind.

nmap  vim-fhiclSwapToPrevious



" Remap the search include function with the following.

" Replace -fi with the correct bind.

" fi -> Fhicl Include / Find Include

nmap -fi vim-fhiclFindIncludes



" Remap the search through all file names with the following.

" Replace -fa with the correct bind.

" fa -> Find all / Fhicl All

nmap -fa vim-fhiclFindAll



" Remap the search through all files.

" Replace -fs with the correct bind.

" fs -> Fhicl Search

nmap -fs vim-fhiclSearchAll

```