path: root/extension.json

{
  "identifier": "at.dcz.nova-zig",
  "organization": "David Czihak",
  "name": "Zig",
  "version": "0.1.8",
  "license": "BSD-2-Clause",

  "description": "Zig language support – ZLS, LLDB, Tree-Sitter grammar",
  "categories": ["completions", "formatters", "issues", "languages", "tasks"],
  "keywords": ["zig", "zon", "zls"],

  "repository": "https://git.dcz.at/Zig.novaextension/",
  "bugs": { "email": "bugs@dcz.at" },

  "min_runtime": "10",

  "entitlements": {
    "process": true,
    "filesystem": "readwrite"
  },

  "main": "main.js",

  "activationEvents": [
    "onLanguage:zig",
    "onWorkspaceContains:*.zig",
    "onWorkspaceContains:build.zig",
    "onWorkspaceContains:build.zig.zon"
  ],

  "config": [
    {
      "type": "section",
      "title": "Tooling",
      "description": "Paths to the Zig toolchain and language server. Leave blank to discover them from PATH.",
      "children": [
        {
          "key": "at.dcz.nova-zig.toolchain.zig-path",
          "title": "Zig Executable",
          "type": "path",
          "placeholder": "zig",
          "description": "Absolute path to the Zig executable."
        },
        {
          "key": "at.dcz.nova-zig.toolchain.zls-path",
          "title": "ZLS Executable",
          "type": "path",
          "placeholder": "zls",
          "description": "Absolute path to the ZLS language server executable."
        },
        {
          "key": "at.dcz.nova-zig.toolchain.lldb-dap-path",
          "title": "LLDB DAP Executable",
          "type": "path",
          "placeholder": "lldb-dap",
          "description": "Absolute path to the lldb-dap executable. Leave blank to discover it via xcrun or PATH."
        }
      ]
    },
    {
      "type": "section",
      "title": "Language Server",
      "description": "Controls for the ZLS integration.",
      "children": [
        {
          "key": "at.dcz.nova-zig.zls.enabled",
          "title": "Enable ZLS",
          "type": "boolean",
          "default": true,
          "description": "Enable diagnostics, completion, navigation, and other language-server features."
        },
        {
          "key": "at.dcz.nova-zig.zls.build-on-save",
          "title": "Build On Save",
          "type": "boolean",
          "default": false,
          "description": "Allow ZLS to run its build/check runner on save when the workspace is a Zig project."
        },
        {
          "key": "at.dcz.nova-zig.zls.debug",
          "title": "Debug Server Messages",
          "type": "boolean",
          "default": false,
          "description": "Log ZLS traffic to the Extension Console while developing the extension."
        }
      ]
    },
    {
      "type": "section",
      "title": "Debug Adapter",
      "description": "Controls for the lldb-dap integration.",
      "children": [
        {
          "key": "at.dcz.nova-zig.debug-adapter.debug",
          "title": "Enable Proxy Log",
          "type": "boolean",
          "default": false,
          "description": "Write lldb-dap-proxy traffic to a log file in the extension's storage directory. For extension development only."
        }
      ]
    },
    {
      "type": "section",
      "title": "Tasks",
      "description": "Controls for the task system.",
      "children": [
        {
          "key": "at.dcz.nova-zig.tasks.discover-steps",
          "title": "Discover Build Steps",
          "type": "boolean",
          "default": true,
          "description": "Run `zig build --list-steps` and surface each step as a task in the task list. Disable for projects where running build.zig on activation is undesirable."
        }
      ]
    }
  ],

  "configWorkspace": [
    {
      "type": "section",
      "title": "Tooling",
      "description": "Workspace-specific overrides for Zig and ZLS executable paths.",
      "children": [
        {
          "key": "at.dcz.nova-zig.toolchain.zig-path",
          "title": "Zig Executable",
          "type": "path",
          "placeholder": "zig",
          "description": "Absolute path to the Zig executable."
        },
        {
          "key": "at.dcz.nova-zig.toolchain.zls-path",
          "title": "ZLS Executable",
          "type": "path",
          "placeholder": "zls",
          "description": "Absolute path to the ZLS language server executable."
        },
        {
          "key": "at.dcz.nova-zig.toolchain.lldb-dap-path",
          "title": "LLDB DAP Executable",
          "type": "path",
          "placeholder": "lldb-dap",
          "description": "Absolute path to the lldb-dap executable. Leave blank to discover it via xcrun or PATH."
        }
      ]
    },
    {
      "type": "section",
      "title": "Language Server",
      "description": "Workspace-specific language server settings.",
      "children": [
        {
          "key": "at.dcz.nova-zig.zls.enabled",
          "title": "Enable ZLS",
          "type": "boolean",
          "description": "Enable diagnostics, completion, navigation, and other language-server features."
        },
        {
          "key": "at.dcz.nova-zig.zls.build-on-save",
          "title": "Build On Save",
          "type": "boolean",
          "description": "Allow ZLS to run its build/check runner on save when the workspace is a Zig project."
        },
        {
          "key": "at.dcz.nova-zig.zls.debug",
          "title": "Debug Server Messages",
          "type": "boolean",
          "description": "Log ZLS traffic to the Extension Console while developing the extension."
        }
      ]
    },
    {
      "type": "section",
      "title": "Debug Adapter",
      "description": "Controls for the lldb-dap integration.",
      "children": [
        {
          "key": "at.dcz.nova-zig.debug-adapter.debug",
          "title": "Enable Proxy Log",
          "type": "boolean",
          "description": "Write lldb-dap-proxy traffic to a log file in the extension's storage directory. For extension development only."
        }
      ]
    },
    {
      "type": "section",
      "title": "Tasks",
      "description": "Workspace-specific task settings.",
      "children": [
        {
          "key": "at.dcz.nova-zig.tasks.discover-steps",
          "title": "Discover Build Steps",
          "type": "boolean",
          "description": "Run `zig build --list-steps` and surface each step as a task in the task list. Disable for projects where running build.zig on activation is undesirable."
        }
      ]
    }
  ],

  "breakpoints": [
    {
      "syntax": "zig"
    }
  ],

  "debugAdapters": {
    "zig-lldb-dap": {
      "name": "Zig (LLDB DAP)",
      "image": "zig-debug"
    }
  },

  "taskTemplates": {
    "zigBuildRun": {
      "name": "Zig Package",
      "description": "Build and run a Zig package from one Nova task configuration.",
      "tasks": {
        "build": {
          "resolve": "at.dcz.nova-zig.tasks",
          "data": {
            "type": "build"
          }
        },
        "run": {
          "resolve": "at.dcz.nova-zig.tasks",
          "data": {
            "type": "build-run"
          }
        },
        "clean": {
          "resolve": "at.dcz.nova-zig.tasks",
          "data": {
            "type": "clean"
          }
        }
      },
      "config": [
        {
          "key": "cwd",
          "title": "Working Directory",
          "type": "path",
          "allowFiles": false,
          "allowFolders": true,
          "relative": true,
          "placeholder": "Workspace Root"
        },
        {
          "key": "runStep",
          "title": "Run Step",
          "type": "string",
          "default": "",
          "placeholder": "install",
          "description": "The `zig build` step to execute for the Run action. Leave blank to run `zig build` with no step (Zig's default install step)."
        },
        {
          "key": "optimize",
          "title": "Optimize",
          "type": "enum",
          "default": "",
          "values": [
            ["", "Project Default"],
            ["Debug", "Debug"],
            ["ReleaseSafe", "ReleaseSafe"],
            ["ReleaseFast", "ReleaseFast"],
            ["ReleaseSmall", "ReleaseSmall"]
          ],
          "description": "Passed as `-Doptimize=<mode>`. Leave on Project Default to let `build.zig` decide."
        },
        {
          "key": "target",
          "title": "Target",
          "type": "string",
          "placeholder": "host",
          "description": "Cross-compile target triple, passed as `-Dtarget=`. Leave blank for the host."
        },
        {
          "key": "userOptions",
          "title": "User Options",
          "type": "stringArray",
          "description": "Custom `-D` flags. Each entry is `key` (boolean flag) or `key=value`."
        },
        {
          "key": "buildArgs",
          "title": "Build Arguments",
          "type": "stringArray",
          "description": "Additional arguments appended after `zig build` for both Build and Run."
        },
        {
          "key": "runArgs",
          "title": "Program Arguments",
          "type": "stringArray",
          "description": "Arguments passed after `--` to the built program."
        },
        {
          "key": "console",
          "title": "Console",
          "type": "enum",
          "default": "internalConsole",
          "values": [
            ["internalConsole", "Internal Console"],
            ["externalTerminal", "External Terminal"]
          ],
          "description": "Where to run the program. External Terminal launches the macOS Terminal app."
        }
      ]
    },

    "zigDebug": {
      "name": "Zig Debug",
      "description": "Build a Zig package in Debug mode and launch it under lldb-dap.",
      "tasks": {
        "build": {
          "resolve": "at.dcz.nova-zig.tasks",
          "data": {
            "type": "build-debug"
          }
        },
        "run": {
          "resolve": "at.dcz.nova-zig.tasks",
          "buildBeforeRunning": true,
          "data": {
            "type": "debug"
          }
        },
        "clean": {
          "resolve": "at.dcz.nova-zig.tasks",
          "data": {
            "type": "clean"
          }
        }
      },
      "config": [
        {
          "key": "cwd",
          "title": "Working Directory",
          "type": "path",
          "allowFiles": false,
          "allowFolders": true,
          "relative": true,
          "placeholder": "Workspace Root"
        },
        {
          "key": "programPath",
          "title": "Program",
          "type": "path",
          "allowFiles": true,
          "allowFolders": false,
          "relative": true,
          "placeholder": "zig-out/bin/app",
          "description": "Path to the executable to debug. Relative paths are resolved against the working directory. Leave blank to auto-detect from `build.zig.zon`."
        },
        {
          "key": "optimize",
          "title": "Optimize",
          "type": "enum",
          "default": "Debug",
          "values": [
            ["Debug", "Debug"],
            ["ReleaseSafe", "ReleaseSafe"],
            ["ReleaseFast", "ReleaseFast"],
            ["ReleaseSmall", "ReleaseSmall"]
          ],
          "description": "Passed as `-Doptimize=<mode>`. Debug is the recommended default for stepping through code."
        },
        {
          "key": "target",
          "title": "Target",
          "type": "string",
          "placeholder": "host",
          "description": "Cross-compile target triple, passed as `-Dtarget=`. Leave blank for the host."
        },
        {
          "key": "userOptions",
          "title": "User Options",
          "type": "stringArray",
          "description": "Custom `-D` flags. Each entry is `key` (boolean flag) or `key=value`."
        },
        {
          "key": "buildArgs",
          "title": "Build Arguments",
          "type": "stringArray",
          "description": "Additional arguments appended after `zig build`."
        },
        {
          "key": "runArgs",
          "title": "Program Arguments",
          "type": "stringArray",
          "description": "Arguments passed to the debugged program."
        },
        {
          "key": "console",
          "title": "Console",
          "type": "enum",
          "default": "internalConsole",
          "values": [
            ["internalConsole", "Internal Console"],
            ["integratedTerminal", "Integrated Terminal"],
            ["externalTerminal", "External Terminal"]
          ],
          "description": "Where the debugged program should run."
        },
        {
          "key": "stopOnEntry",
          "title": "Stop On Entry",
          "type": "boolean",
          "default": false,
          "description": "Pause immediately when the program starts."
        }
      ]
    },

    "zigTest": {
      "name": "Zig Test",
      "description": "Run `zig build test` with optional --test-filter and --summary controls.",
      "tasks": {
        "build": {
          "resolve": "at.dcz.nova-zig.tasks",
          "data": {
            "type": "test-build"
          }
        },
        "run": {
          "resolve": "at.dcz.nova-zig.tasks",
          "data": {
            "type": "test-run"
          }
        },
        "clean": {
          "resolve": "at.dcz.nova-zig.tasks",
          "data": {
            "type": "clean"
          }
        }
      },
      "config": [
        {
          "key": "cwd",
          "title": "Working Directory",
          "type": "path",
          "allowFiles": false,
          "allowFolders": true,
          "relative": true,
          "placeholder": "Workspace Root"
        },
        {
          "key": "testFilter",
          "title": "Test Filter",
          "type": "string",
          "placeholder": "substring of test name",
          "description": "Substring of the test name. Passed as `--test-filter`."
        },
        {
          "key": "summary",
          "title": "Summary",
          "type": "enum",
          "default": "",
          "values": [
            ["", "Default"],
            ["all", "All"],
            ["failures", "Failures only"],
            ["none", "None"]
          ],
          "description": "Controls `zig build`'s --summary verbosity."
        },
        {
          "key": "optimize",
          "title": "Optimize",
          "type": "enum",
          "default": "",
          "values": [
            ["", "Project Default"],
            ["Debug", "Debug"],
            ["ReleaseSafe", "ReleaseSafe"],
            ["ReleaseFast", "ReleaseFast"],
            ["ReleaseSmall", "ReleaseSmall"]
          ],
          "description": "Passed as `-Doptimize=<mode>`."
        },
        {
          "key": "target",
          "title": "Target",
          "type": "string",
          "placeholder": "host",
          "description": "Cross-compile target triple, passed as `-Dtarget=`. Leave blank for the host."
        },
        {
          "key": "userOptions",
          "title": "User Options",
          "type": "stringArray",
          "description": "Custom `-D` flags. Each entry is `key` (boolean flag) or `key=value`."
        },
        {
          "key": "buildArgs",
          "title": "Build Arguments",
          "type": "stringArray",
          "description": "Additional arguments appended after `zig build test`."
        },
        {
          "key": "runArgs",
          "title": "Program Arguments",
          "type": "stringArray",
          "description": "Arguments passed after `--` to the test runner."
        }
      ]
    },

    "zigWatch": {
      "name": "Zig Watch",
      "description": "Run `zig build --watch` and rebuild on file changes. Note: inline issues only update on the first build cycle — Nova's matchers do not re-arm for streaming output.",
      "tasks": {
        "build": {
          "resolve": "at.dcz.nova-zig.tasks",
          "data": {
            "type": "watch"
          }
        },
        "clean": {
          "resolve": "at.dcz.nova-zig.tasks",
          "data": {
            "type": "clean"
          }
        }
      },
      "config": [
        {
          "key": "cwd",
          "title": "Working Directory",
          "type": "path",
          "allowFiles": false,
          "allowFolders": true,
          "relative": true,
          "placeholder": "Workspace Root"
        },
        {
          "key": "step",
          "title": "Step",
          "type": "string",
          "default": "",
          "placeholder": "install",
          "description": "Build step to watch. Leave blank for `zig build`'s default install step."
        },
        {
          "key": "debounceMs",
          "title": "Debounce (ms)",
          "type": "number",
          "description": "Passed as `--debounce <N>`. Leave blank for Zig's default."
        },
        {
          "key": "incremental",
          "title": "Incremental",
          "type": "enum",
          "default": "",
          "values": [
            ["", "Default"],
            ["on", "On"],
            ["off", "Off"]
          ],
          "description": "Toggle `-fincremental` / `-fno-incremental`."
        },
        {
          "key": "optimize",
          "title": "Optimize",
          "type": "enum",
          "default": "",
          "values": [
            ["", "Project Default"],
            ["Debug", "Debug"],
            ["ReleaseSafe", "ReleaseSafe"],
            ["ReleaseFast", "ReleaseFast"],
            ["ReleaseSmall", "ReleaseSmall"]
          ],
          "description": "Passed as `-Doptimize=<mode>`."
        },
        {
          "key": "target",
          "title": "Target",
          "type": "string",
          "placeholder": "host",
          "description": "Cross-compile target triple, passed as `-Dtarget=`. Leave blank for the host."
        },
        {
          "key": "userOptions",
          "title": "User Options",
          "type": "stringArray",
          "description": "Custom `-D` flags. Each entry is `key` (boolean flag) or `key=value`."
        },
        {
          "key": "buildArgs",
          "title": "Build Arguments",
          "type": "stringArray",
          "description": "Additional arguments appended after `zig build`."
        }
      ]
    }
  },

  "issueMatchers": {
    "zig.compiler": {
      "pattern": [
        {
          "regexp": "^(.+?):(\\d+):(\\d+):\\s*(error|warning):\\s*(.+)$",
          "file": 1,
          "line": 2,
          "column": 3,
          "severity": 4,
          "message": 5
        }
      ]
    }
  }
}