plugins.cmp-ai.settings

Options provided to the require('cmp_ai.config'):setup function.

Type: attribute set of anything

Default: { }

Example:

{
  ignored_file_types = {
    lua = true;
  };
  max_lines = 1000;
  notify = true;
  notify_callback = ''
    function(msg)
      vim.notify(msg)
    end
  '';
  provider = "HF";
  run_on_every_keystroke = true;
}

Declared by:

plugins.cmp-ai.settings.ignored_file_types

Which filetypes to ignore.

Type: null or (attribute set of (boolean or raw lua code))

Default: null

Plugin default: { }

Example:

{
  html = true;
  lua = true;
}

Declared by:

plugins.cmp-ai.settings.max_lines

How many lines of buffer context to use.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 50

Declared by:

plugins.cmp-ai.settings.notify

As some completion sources can be quit slow, setting this to true will trigger a notification when a completion starts and ends using vim.notify.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.cmp-ai.settings.notify_callback

The default notify function uses vim.notify, but an override can be configured.

Type: null or lua function string

Default: null

Plugin default:

''
  function(msg)
    vim.notify(msg)
  end
''

Example:

''
  function(msg)
    require('notify').notify(msg, vim.log.levels.INFO, {
      title = 'OpenAI',
      render = 'compact',
    })
  end
''

Declared by:

plugins.cmp-ai.settings.provider

Which AI provider to use.

Check the README to learn about available options.

Type: null or string or raw lua code

Default: null

Plugin default: "HF"

Declared by:

plugins.cmp-ai.settings.provider_options

Options to forward to the provider.

Type: null or (attribute set of (anything or raw lua code))

Default: null

Plugin default: { }

Declared by:

plugins.cmp-ai.settings.run_on_every_keystroke

Generate new completion items on every keystroke.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: