plugins.coverage.enable

Whether to enable nvim-coverage.

Type: boolean

Default: false

Example: true

Declared by:

plugins.coverage.package

Which package to use for the nvim-coverage plugin.

Type: package

Default: <derivation vimplugin-nvim-coverage-2024-03-24>

Declared by:

plugins.coverage.autoReload

If true, the coverage_file for a language will be watched for changes after executing :CoverageLoad or coverage.load(). The file watcher will be stopped after executing :CoverageClear or coverage.clear().

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.coverage.autoReloadTimeoutMs

The number of milliseconds to wait before auto-reloading coverage after detecting a change.

Plugin default: 500

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.coverage.commands

If true, create commands.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.coverage.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.coverage.keymapsSilent

Whether nvim-coverage keymaps should be silent

Type: boolean

Default: false

Declared by:

plugins.coverage.lang

Each key corresponds with the filetype of the language and maps to an attrs of configuration values that differ. See plugin documentation for language specific options.

Example:

  {
    python = {
      coverage_file = ".coverage";
      coverage_command = "coverage json --fail-under=0 -q -o -";
    };
    ruby = {
        coverage_file = "coverage/coverage.json";
    };
  }

Plugin default: see upstream documentation

Type: null or (attribute set)

Default: null

Declared by:

plugins.coverage.lcovFile

File that the plugin will try to read lcov coverage from.

Type: null or string

Default: null

Declared by:

plugins.coverage.loadCoverageCb

A lua function that will be called when a coverage file is loaded.

Example:

  function (ftype)
    vim.notify("Loaded " .. ftype .. " coverage")
  end

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.coverage.signGroup

Name of the sign group used when placing the signs. See :h sign-group.

Plugin default: "coverage"

Type: null or string or raw lua code

Default: null

Declared by: