Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

ts-context-commentstring

URL: https://github.com/joosepalviste/nvim-ts-context-commentstring/


Treesitter plugin for setting the commentstring based on the cursor location in a file.

plugins.ts-context-commentstring.enable

Whether to enable ts-context-commentstring.

Type: boolean

Default: false

Example: true

Declared by:

plugins.ts-context-commentstring.package

The ts-context-commentstring package to use.

Type: package

Default: pkgs.vimPlugins.nvim-ts-context-commentstring

Declared by:

plugins.ts-context-commentstring.autoLoad

Whether to automatically load ts-context-commentstring when neovim starts.

Type: boolean

Default: false when lazy-loading is enabled.

Example: false

Declared by:

plugins.ts-context-commentstring.disableAutoInitialization

Whether to disable auto-initialization.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.ts-context-commentstring.settings

Options provided to the require('ts_context_commentstring').setup function.

Type: open submodule of attribute set of anything

Default: { }

Example:

{
  enable_autocmd = false;
  languages = {
    haskell = "-- %s";
    nix = {
      __default = "# %s";
      __multiline = "/* %s */";
    };
  };
}

Declared by:

plugins.ts-context-commentstring.skipTsContextCommentStringModule

Whether to skip backwards compatibility routines and speed up loading.

Type: boolean

Default: true

Example: false

Declared by: