Sphinx Needs Preview - CSW Support

VS Code extension for browsing and previewing reStructuredText files that use Sphinx-needs directives.

Main Features

• Dedicated preview panel for .rst files
• Interactive model browser grouped by directive type
• Fast search by need ID, title, directive, and source file
• Detailed need view with options, body, and relations
• Interactive diagrams with:
  • zoom, pan, and drag-to-reposition
  • directive filters
  • Reset Layout button for default placement
  • fullscreen view
• Open Source navigation with in-editor highlight and fade effect
• Need ID rename command across workspace .rst files
• Auto refresh on file save

Commands

• Sphinx Needs: Open Preview
• Sphinx Needs: Rename Need ID

Quick Start

1. Open an .rst file containing Sphinx-needs directives.
2. Run Sphinx Needs: Open Preview from Command Palette.
3. Select a node or table row to inspect details.
4. Use Open Source to jump to the source line in the editor.

Development

npm install
npm run compile

Package VSIX

npm run package

Marketplace Release Preparation

Before publishing, verify these package.json fields:

1. publisher is your Azure DevOps Marketplace publisher ID (not "local")
2. version is incremented
3. description, categories, and keywords are accurate
4. README.md reflects current features

Then run:

npm run compile
npm run package

Optional publish commands:

npx @vscode/vsce login <publisher>
npx @vscode/vsce publish patch

Use minor or major instead of patch when needed.