plugins.projections.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  patterns = [
    ".git"
    ".svn"
    ".hg"
  ];
  sessions_directory = "path/to/dir";
  workspaces = [
    [
      "~/Documents/dev"
      [
        ".git"
      ]
    ]
    [
      "~/repos"
      [ ]
    ]
    "~/dev"
  ];
  workspaces_file = "path/to/file";
}

Declared by:

plugins.projections.settings.patterns

Default patterns to use if none were specified. These are NOT regexps.

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

Default: null

Plugin default:

[
  ".git"
  ".svn"
  ".hg"
]

Declared by:

plugins.projections.settings.restore_hooks

Pre and post hooks for restore_session.

Type: null or (submodule) or raw lua code

Default: null

Plugin default:

{
  post = null;
  pre = null;
}

Declared by:

plugins.projections.settings.sessions_directory

Directory where sessions are stored.

Type: null or string or raw lua code

Default: null

Plugin default: lib.nixvim.mkRaw "vim.fn.stdpath('cache') .. 'projections_sessions'"

Example: "path/to/dir"

Declared by:

plugins.projections.settings.store_hooks

Pre and post hooks for store_session.

Type: null or (submodule) or raw lua code

Default: null

Plugin default:

{
  post = null;
  pre = null;
}

Example:

{
  pre = {
    __raw = ''
      function()
        -- nvim-tree
        local nvim_tree_present, api = pcall(require, "nvim-tree.api")
        if nvim_tree_present then api.tree.close() end
          -- neo-tree
        if pcall(require, "neo-tree") then vim.cmd [[Neotree action=close]] end
      end
    '';
  };
}

Declared by:

plugins.projections.settings.workspaces

Default workspaces to search for.

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

Default: null

Plugin default: [ ]

Example:

[
  [
    "~/Documents/dev"
    [
      ".git"
    ]
  ]
  [
    "~/repos"
    [ ]
  ]
  "~/dev"
]

Declared by:

plugins.projections.settings.workspaces_file

Path to workspaces json file.

Type: null or string or raw lua code

Default: null

Plugin default: lib.nixvim.mkRaw "vim.fn.stdpath('data') .. 'projections_workspaces.json'"

Example: "path/to/file"

Declared by: