Validated, autocompleting sphinx-needs
need references in VS Code.
TheoWorks reads your project's resolved needs.json (and, optionally, a
theoworks-schema.json resolved-metamodel dump) and turns that into
in-editor help while you write .rst:
Completion for need-reference roles/fields as you type.
Hover showing a need's title, type, status, and fields.
Diagnostics flagging references to needs that don't resolve.
A status bar item showing how many needs are loaded and where they
came from.
This is an early release focused on the foundation: activation, the status
bar, configuration and onboarding, and completion, hover, and diagnostics
wired to a needs.json source. Some enhancements such as server integration
are planned in the future releases.
Configuration
Setting
Purpose
theoworks.needsSource.needsJsonPath
Workspace-relative path to a needs.json build artifact. Leave unset to try the conventional locations.
theoworks.needsSource.schemaJsonPath
Workspace-relative path to a theoworks-schema.json dump, for directive-name completion. Leave unset to look beside the resolved needs.json.
Run TheoWorks: Configure Needs Source (Command Palette) to set these
interactively, or TheoWorks: Refresh Project Graph to re-read the
current source after your build regenerates needs.json.
Workspace trust / virtual workspaces
Untrusted workspaces: supported. The extension only reads
needs.json/theoworks-schema.json and probes a loopback server; it
never executes workspace-provided code or tasks.
Virtual workspaces: not supported. The source ladder reads through a
real local filesystem path, so a needs.json that exists only in a
virtual (non-disk) filesystem cannot currently be resolved.
