Editor IntelliSense

JSON Schemas ship in the nux repository for both config types:

schemas/global.schema.json - global config.yaml
schemas/project.schema.json - per-project YAML under projects/

Point your YAML language server at these schemas to get completion, validation, and hover docs in your editor.

The schemas include:

Required panes — windows without at least one pane are flagged inline.
Layout validation — named layouts (tiled, main-vertical, etc.) get autocomplete, and custom tmux layout strings are also accepted.
String-or-object shorthands — panes: [nvim] is recognized as valid.

nux config and nux new automatically include the appropriate schema modeline in generated files. For existing configs or manual setup, use one of the methods below.

1. Inline modeline#

Add a modeline at the top of any config file:

# yaml-language-server: $schema=https://raw.githubusercontent.com/Drew-Daniels/nux/main/schemas/project.schema.json

Use project.schema.json for files in projects/ and global.schema.json for config.yaml.

2. VS Code#

In .vscode/settings.json, map schema URLs to file patterns:

{
  "yaml.schemas": {
    "https://raw.githubusercontent.com/Drew-Daniels/nux/main/schemas/global.schema.json": [
      ".config/nux/config.yaml",
      "**/nux/config.yaml"
    ],
    "https://raw.githubusercontent.com/Drew-Daniels/nux/main/schemas/project.schema.json": [
      ".config/nux/projects/*.yaml"
    ]
  }
}

Adjust paths to match where you keep configs.

3. Neovim (yamlls)#

If you use nvim-lspconfig, add schema mappings to your yamlls setup:

require("lspconfig").yamlls.setup({
  settings = {
    yaml = {
      schemas = {
        ["https://raw.githubusercontent.com/Drew-Daniels/nux/main/schemas/global.schema.json"] = {
          ".config/nux/config.yaml",
          "**/nux/config.yaml",
        },
        ["https://raw.githubusercontent.com/Drew-Daniels/nux/main/schemas/project.schema.json"] = {
          ".config/nux/projects/*.yaml",
        },
      },
    },
  },
})