plugins.auto-session.settings

Options provided to the require('auto-session').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

plugins.auto-session.settings.enabled

Enables/disables auto creating, saving and restoring.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.auto-session.settings.allowed_dirs

Allow session create/restore if in one of the list of dirs.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default: null

Declared by:

plugins.auto-session.settings.auto_create

Whether to enable auto creating new sessions

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.auto-session.settings.auto_restore

Whether to enable auto restoring session.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.auto-session.settings.auto_restore_last_session

On startup, loads the last saved session if session for cwd does not exist.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.auto-session.settings.auto_save

Whether to enable auto saving session.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.auto-session.settings.bypass_save_filetypes

List of file types to bypass auto save when the only buffer open is one of the file types listed.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default: null

Declared by:

plugins.auto-session.settings.cwd_change_handling

Follow cwd changes, saving a session before change and restoring after.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.auto-session.settings.log_level

Sets the log level of the plugin.

Type: null or one of “debug”, “info”, “warn”, “error” or raw lua code

Default: null

Plugin default: "error"

Declared by:

plugins.auto-session.settings.root_dir

Root directory for session files. Can be either a string or lua code (using {__raw = 'foo';}).

Type: null or string or raw lua code

Default: null

Plugin default:

{
  __raw = "vim.fn.stdpath 'data' .. '/sessions/'";
}

Declared by:

plugins.auto-session.settings.suppressed_dirs

Suppress session create/restore if in one of the list of dirs.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default: null

Declared by:

plugins.auto-session.settings.use_git_branch

Include git branch name in session name to differentiate between sessions for different git branches.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by: