plugins.neogen.enable
Whether to enable neogen.
Type: boolean
Default:
false
Example:
true
Declared by:
plugins.neogen.enablePlaceholders
If true, enables placeholders when inserting annotation
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by:
plugins.neogen.package
The neogen package to use.
Type: package
Default:
pkgs.vimPlugins.neogen
Declared by:
plugins.neogen.extraOptions
These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.
Type: attribute set of anything
Default:
{ }
Declared by:
plugins.neogen.inputAfterComment
If true, go to annotation after insertion, and change to insert mode
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by:
plugins.neogen.keymapsSilent
Whether Neogen keymaps should be silent
Type: boolean
Default:
false
Declared by:
plugins.neogen.languages
Configuration for languages.
template.annotation_convention
(default: check the language default configurations):
Change the annotation convention to use with the language.
template.use_default_comment
(default: true):
Prepend any template line with the default comment for the filetype
template.position
(fun(node: userdata, type: string):(number,number)?):
Provide an absolute position for the annotation.
If return values are nil, use default position
template.append
:
If you want to customize the position of the annotation.
template.append.child_name
:
What child node to use for appending the annotation.
template.append.position
(before/after):
Relative positioning with child_name
.
template.<convention_name>
(replace <convention_name> with an annotation convention):
Template for an annotation convention.
To know more about how to create your own template, go here:
https://github.com/danymat/neogen/blob/main/docs/adding-languages.md#default-generator
Type: null or (attribute set of (anything or raw lua code))
Default:
null
Example:
{
csharp = {
template = {
annotation_convention = "...";
};
};
}
Declared by:
plugins.neogen.placeholderHighlight
Placeholders highlights to use. If you don’t want custom highlight, pass “None”
Type: null or string or raw lua code
Default:
null
Plugin default: "DiagnosticHint"
Declared by:
plugins.neogen.snippetEngine
Use a snippet engine to generate annotations. Some snippet engines come out of the box bundled with neogen:
"luasnip"
(https://github.com/L3MON4D3/LuaSnip)"snippy"
(https://github.com/dcampos/nvim-snippy)"vsnip"
(https://github.com/hrsh7th/vim-vsnip)
Type: null or string
Default:
null
Declared by: