apiDoc (Tyba) for VS Code

Completion, highlighting and snippets for @tyba-co/apidoc comments.

Completion inside doc comments: type @ for every tag; after @api { the HTTP methods; after @apiParam { (and the other field tags) the types; after @apiSuccess ( / @apiError ( the status groups; after @apiUse / @apiPermission the @apiDefine names of your workspace; after @apiGroup / @apiVersion the values already in use. Accepting a tag replaces what you typed, so there is no double @.
Highlighting of @api... tags, (group) and {type} inside comments.
Snippets: one per tag (with Optional and status-group variants), and apidoc / apidocdefine blocks for C-style languages.
apidoc.json: validation and completion of keys, template options and forceLanguage values.

Install

Search for apiDoc (Tyba) in the Extensions view, or run code --install-extension tyba-co.apidoc-vscode.

To build it from a clone of the repository and install the file:

cd vscode
npm run package
code --install-extension apidoc-vscode-0.2.1.vsix

npm run package needs network access the first time (it runs @vscode/vsce through npx).

If nothing shows up

The provider triggers on @, {, ( and the space after a tag. If the list does not appear, press Ctrl+Space.

Tests

npm test in the repository root: unit tests of the completion logic, and every registered tag must have a snippet the parser accepts.
npm install && npm run test:host here: loads the extension in a real VS Code and asks it for completions. It downloads a VS Code build, or set VSCODE_EXECUTABLE_PATH to an installed one. From VS Code's integrated terminal, unset ELECTRON_RUN_AS_NODE first. CI runs it under xvfb-run (.github/workflows/vscode-extension.yml).

Publishing

The manifest is ready for the Visual Studio Marketplace (publisher: tyba-co, icon.png is the Tyba app icon at 256x256). .github/workflows/vscode-extension.yml publishes it: bump version in package.json, add the entry to CHANGELOG.md, merge to master, then push a tag with the same version:

git tag vscode-v0.2.3 && git push origin vscode-v0.2.3

The workflow checks that the tag matches package.json, runs the host tests and publishes the .vsix. Do not create a GitHub release for these tags: releases trigger the npm publish.

Visual Studio Marketplace: no token. The job signs in to Microsoft Entra ID through OIDC as the app in the repository variables AZURE_CLIENT_ID and AZURE_TENANT_ID (federated credential for the vscode-marketplace environment), and runs vsce publish --azure-credential. That app is a Contributor member of the tyba-co publisher; to find its member ID, run the workflow by hand with marketplace-identity checked. Global personal access tokens stop working on December 1, 2026.
Open VSX (Cursor, Windsurf, VSCodium): the same .vsix with the secret OVSX_PAT; the step is skipped when it is unset.

To publish by hand, upload the .vsix from npm run package at https://marketplace.visualstudio.com/manage/publishers/tyba-co.

Adding a tag

When a parser is added to lib/core/index.js, add its snippet to snippets/tags.json; the tag completion uses the same snippets. npm test fails until every registered tag has one.

Not included

Hover text, live diagnostics and go-to-definition from @apiUse to @apiDefine.
Comments that follow code on the same line, and Ruby =begin blocks.
Schema for apidoc.config.js and for the apidoc key of package.json.