Changelog¶

0.6.2¶

Released:: 04.02.2025

Fixes¶

🐛 ubCode Marketplace URLs

0.6.1¶

Released:: 04.02.2025

New and Improved¶

👌 Add quickstart command
👌 Add chain option to the scripts configuration
📚 Improve the documentation

0.6.0¶

Released:: 03.02.2025

New and Improved¶

👌 Add diagnostic for unknown need directive options.
👌 Add autocompletion of needextend directive options.
✨ Add need directive status auto-completions, with items from needs.statuses configuration, if set.
👌 Add config needs.external_needs.skip_in_ubcode, which will skip reading of the external source when indexing.
✨ goto definition / references for need directive links, when cursor is on the link value:
```
.. req::
  :link_name: value
              ^^^^^
```
✨ Add “select ubcode ID in view” command. Available in command palette or right-click menu.
✨ Add scripts configuration and use in VS Code, for defining/running commands in the terminal (see Configuring a project with ubproject.toml):
```
[scripts]
sphinx = "sphinx-build -b html . _build/html {{filepath}}"
sphinx = { cmd = "sphinx-build -b html . _build/html {{filepath}}", env.SPHINXOPTS = "-W", terminal = "name", jinja = true }
```
In VS Code they can be accessed via the command palette (Ctrl+Shift+P) by selecting “ubCode: Run Command in Terminal”.
👌 Add Project item to needs index view, with configuration, current file and indexing issues children.
👌 Add n.is_directive, l.type, o.id filter fields for needs index view.
👌 Persist needs index view filter query, when re-starting VS Code.
✨ Add context button to open external URLs in need index view, for needs originating from external sources. These are resolved from the base_url / target_url on the extend_needs configuration.
👌 Add restart server button to home view.

0.5.0¶

Released:: 29.01.2025

New and Improved¶

✨ Cache license checks for offline use. The remote license check is now cached for 3 days, allowing for offline use during this time.
✨ Add processing of needextend directives. These directives are now gathered and applied to the needs index. Needs with associated needextend can be filtered for in the index tree view, using the n.is_modified filter expression.

Note, currently only needextend with “single ID” filters are applied; expression filter processing is planned for a future release.
👌 Make external need reads more fault tolerant. External needs.json with invalid extra/link field value types will no longer error the entire read. Instead, the errors are stored (and reported in the tree view) and the fields are skipped.
✨ Add Linux ARM64 build target

0.4.0¶

Released:: 22.01.2025

New and Improved¶

✨ Add external and import needs parsing:
- Add needs.import_keys configuration
- Add project.srcdir configuration (to resolve needimport sources starting with /)
- Note, the filter option of needimport is not yet supported
VS Code index tree view:
- ⚡️ Improve performance of updates and item expansion
- ✨ Show need indexing issues
- 👌 Expand querying capabilities
- 👌 Add copy link ID to clipboard buttons for incoming/outgoing need links
👌 Improve rst-preview CSS: do not word-wrap directive option names
👌 Complete find references on directive id named_option

0.3.0¶

Released:: 12.12.2024

New and Improved¶

⚡️ Improve performance of diagnostics/needs index builds.

Including parallel file reads, better caching, and background (non-blocking) processing.
✨ Add initial filtering of needs in index tree-view.

Using a sub-set of the Cypher query syntax.

Note, currently it is constrained to n.id and n.type queries; this will be expanded in the future.
✨ Add find references for need directives.

Activated by placing the cursor on the directive name, and using the context menu or pressing SHIFT+F12.
✨ Add quick fix for inline.role_no_name diagnostic.
👌 Add index directive to built-ins.
✨ Add “Re-index project” to VS Code command palette.
✨ Add “Remove project cache” to VS Code command palette.
👌 Open license path from VS Code Home tree.

0.2.3¶

Released:: 03.12.2024

New and Improved¶

✨ Add : role and directive option auto-completions
✨ Allow for named_options to be specified on parse.extend_directives (see Configuring a project with ubproject.toml)

0.2.2¶

Released:: 24.11.2024

Improved¶

✨ Add extend configuration, for sharing configuration between multiple projects (see Configuring a project with ubproject.toml)
✨ Add auto-completion and hover information of directives in rST files
👌 Graph DB performance improvements

0.2.1¶

Released:: 21.11.2024

Fixes¶

🐛 Build manylinux2014 compatible wheels to support systems such as Ubuntu 20.04 LTS

0.2.0¶

Released:: 20.11.2024

Initial release of the new ubCode VS Code extension.

This is a complete rewrite of the existing ubCode extension (v0.1.2).

This version features a new language server that understands RST, generates HTML previews in real-time and provides diagnostics for RST problems.

The extension integrates with Sphinx-Needs via a new ubproject.toml file format. The new needs index can be used to navigate to needs without running a Sphinx build.