aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid Czihak <git@dcz.at>2026-05-10 19:21:33 +0200
committerDavid Czihak <git@dcz.at>2026-05-10 19:21:33 +0200
commitb80b9c1f82585677a7c042557576c41b1670d259 (patch)
tree9a741dfd7725205dba35b42bc6d5a6a7e084ced0 /README.md
parent33ea57ddd69f35f3f2db64a1a2d31b410ed7afb2 (diff)
Chore: Move extension bundle into Zig.novaextension/ subdirectory
Separates Nova extension resources from development-only items. Development items (ISSUES.md, vendor/, examples/) remain at the repo root. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md118
1 files changed, 0 insertions, 118 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 3741954..0000000
--- a/README.md
+++ /dev/null
@@ -1,118 +0,0 @@
-# Zig for Nova
-
-Zig language support – ZLS, LLDB, Tree-Sitter grammar
-
-## Requirements
-
-- [Zig](https://ziglang.org/download/) installed and on `PATH` (or configured in extension preferences)
-- [ZLS](https://github.com/zigtools/zls)\* for language intelligence
-- [LLDB DAP](https://lldb.llvm.org/use/lldbdap.html)\* for debugging (discovered automatically via `xcrun` or `PATH`; install the Xcode Command Line Tools if absent: `xcode-select --install`)
-
-\* optional but recommended for full experience
-
-## Why
-
-A personal project to learn Zig without leaving Nova and without giving up the comfort of language server and debugging features.
-
-This extension is not endorsed by, affiliated with, or associated with the [Zig Software Foundation](https://ziglang.org/zsf/) or the Zig core team in any way. It is maintained by an independent person, for fun.
-
-## Features
-
-### Editing
-
-- Syntax highlighting for `.zig` and `.zon`
-- Code folding for blocks, declarations, and control-flow expressions
-- Document symbols (outline, breadcrumbs, Go to Symbol)
-- Diagnostics, completion, hover, go to definition, find references, select all references, code actions, formatting (all via ZLS)
-- Inline compiler errors from `zig build`
-
-### Tasks
-
-Four templates expose the `zig build` surface — pick one in **Project Settings > Tasks > New Task**:
-
-- **Zig Package**: build and run a Zig package. Configurable optimize mode, target triple, custom `-D` user options, run step, build/program arguments, and console (Internal Console or External Terminal).
-- **Zig Debug**: build and launch under lldb-dap. Same flag surface as Zig Package, plus program path (auto-detected from `build.zig.zon` when blank), console, and stop-on-entry.
-- **Zig Test**: run `zig build test` with optional `--test-filter`, `--summary`, plus optimize/target/user-options.
-- **Zig Watch**: run `zig build --watch` with configurable step, debounce, and incremental flag.
-
-Every runnable template also exposes a clean action that removes `.zig-cache`, `zig-cache`, and `zig-out`. Clean refuses to run when the working directory resolves to `/`, `$HOME`, or anywhere outside the workspace; when the project's `build.zig` exposes an `uninstall` step, it runs first.
-
-Two ad-hoc tasks appear automatically:
-
-- **Current Zig File**: run via `zig run <file>` and clean the nearest `build.zig` ancestor.
-- **Zig Build: \<step\>**: one task per step discovered from `zig build --list-steps`. The list is cached and refreshed when `build.zig` or `build.zig.zon` changes.
-
-The legacy **Zig Package (macOS Terminal)** template is preserved for backward compatibility. New configurations should use **Zig Package** with Console set to External Terminal.
-
-#### Watch-mode caveat
-
-Nova issue matchers fire only on the first build cycle of a long-running task. With `zig build --watch`, errors from later cycles will not appear inline — re-run the task to refresh the issue overlay.
-
-### Debugging
-
-- Breakpoint support in Zig source files
-- LLDB-based debug adapter, auto-discovered via `xcrun` or `PATH`
-
-## Configuration
-
-Global settings live under **Nova Preferences > Extensions > Zig**.
-Per-workspace overrides live under **Project Settings > Zig** and take precedence.
-
-### Tooling
-
-Paths to the `zig`, `zls`, and `lldb-dap` executables. Leave any blank to discover from `PATH`.
-
-### Language Server
-
-- Enable or disable ZLS
-- Allow ZLS to run its build/check on save
-- Log ZLS traffic to the Extension Console (for troubleshooting)
-
-## Known Issues
-
-### Auto-discovered tasks cannot open the report automatically
-
-The **Current Zig File** and **zig build \<step\>** tasks are provided programmatically by the extension. Nova’s extension API does not expose the report-opening setting for tasks created this way. Open the report manually or use a task template (**Project Settings > Tasks > New Task**) if automatic report opening matters.
-
-### A large part of the file turns red after one error
-
-The parser may report a broad recovery range when it hits an incomplete expression, and Nova highlights that entire range. Fix the first syntax error shown and the overlay should narrow to the real error locations.
-
-## Development
-
-The Tree-sitter parser is built from the vendored grammar snapshot under `vendor/tree-sitter-zig`. The pinned upstream commit is recorded in `vendor/tree-sitter-zig/VENDORING.md`.
-
-Rebuild the parser dylib:
-
-```sh
-./Scripts/build-parser.sh
-```
-
-Bump the vendored snapshot (and rebuild):
-
-```sh
-./Scripts/update-parser.sh # upstream HEAD
-./Scripts/update-parser.sh <ref> # specific tag, branch, or SHA
-```
-
-Validate the extension bundle:
-
-```sh
-/Applications/Nova.app/Contents/SharedSupport/nova extension validate .
-```
-
-## License
-
-The extension's source code is licensed under the BSD 2-Clause License
-(see [`LICENSE`](LICENSE)). Bundled assets and vendored third-party
-code carry their own licenses, documented in
-[`NOTICES.md`](NOTICES.md):
-
-- The Zig logo and the icon/image assets derived from it
- (`extension.png`, `extension@2x.png`, `Images/zig-debug/*.png`,
- `Resources/Zig@32px.af`) are the work of the
- [Zig Software Foundation](https://ziglang.org) and remain licensed
- under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
-- The Tree-sitter grammar for Zig is sourced from
- [github.com/tree-sitter-grammars/tree-sitter-zig](https://github.com/tree-sitter-grammars/tree-sitter-zig)
- and is distributed under the MIT License.