tcmts.vscode.extension

Types

AppEntry type

An app of the codebase (tcm/apps), and what would stop it building.

AppNode type

AppsTree typeof AppsTree

The apps in the codebase, as a launcher: each app's status, and starting, stopping and opening it. What an app is made of is in the Codebase view (grouped by role) and the Data view; only problems that would stop it building are listed here.

CodebaseNode type

CodebaseTree typeof CodebaseTree

Sidebar items: namespaces, then the definitions directly in each (grouped by role in big namespaces).

DataTree typeof DataTree

The app data: every table, with its row count; a table opens in the table viewer.

DefinitionEntry type

A definition, as the language server lists it (tcm/tree).

FoundItem type

A result of tcm/find: a definition, or why the query didn't parse.

PackageNode type

PackageRange type

One compatible range of a package the codebase runs (tcm/packages).

PackagesTree typeof PackagesTree

The packages the codebase runs: each package, then (when it runs more than one) each compatible range, then the definitions that use it. A package or range opens its page (README, API, users).

RunningApp type

An app started from here.

TableEntry type

A table of app data (tcm/data).

Server

activate (context: ExtensionContext) => Promise<void>

tcmCommand () => string[]

`tcm.path` is the tcm executable, or a path to tcm's `bin/tcm.js` (run with Node), or a command line whose words are separated by spaces, with "quotes" around a word that contains spaces.

Shared

ROLE_ICONS Record<Role, string>

The Codebase view's icon for each role's group (the groups and their order are `tcmts.cli.pages.ROLES`).

deactivate () => Promise<void> | undefined

definitionItem (e: DefinitionEntry, label?: string) => TreeItem

An item for one definition (shared by both views).

quote (s: string) => string

running () => boolean

Whether the language server is up to answer requests.

session { client?: LanguageClient | undefined; }

The language client, while the extension is active.

short (s: string, n?: number) => string