Reference

April 11, 2026 · View on GitHub

Contribution points defined in package.json. Command IDs are what you pass to vscode.commands.executeCommand(...) and what appears in keybindings.json.

Commands

Command IDTitle (UI)When shown (context)
extension.insertClassDocPhpClass DocumenteditorLangId == php
extension.insertClassDocJSClass DocumenteditorLangId == javascript
extension.insertMethodDocPhpMethod DocumenteditorLangId == php
extension.insertMethodDocJSMethod DocumenteditorLangId == javascript
extension.insertPropertyDocPhpProperty DocumenteditorLangId == php
extension.insertPropertyDocJSProperty DocumenteditorLangId == javascript
extension.updateVersionTagUpdate @versionPHP or JavaScript editor
extension.updateFileInfoUpdate File InformationPHP or JavaScript editor

For the last two rows, package.json uses when: editorLangId == php || editorLangId == javascript.

Commands are grouped under the submenu documate.context (“DocuMate: Code Documentation”) on editor/context.

Configuration reference

All keys are under the documate section (e.g. documate.author in Settings JSON).

KeyTypeScopePurpose
documate.enableAuthorbooleandefaultToggle @author in generated blocks
documate.authorstringresourceAuthor name
documate.enableVersionbooleandefaultToggle @version
documate.versionstringresourceVersion string for snippets / update command
documate.enableEmailbooleandefaultToggle email next to author
documate.emailstringresourceEmail for snippets
documate.enableSincebooleandefaultToggle @since (calendar year)
documate.enableCopyrightbooleandefaultToggle @copyright

Resource-scoped settings can be overridden per workspace in .vscode/settings.json.

Extension entry

FieldValue
main./extension.js

There is no explicit activationEvents block: the host activates the extension when the user runs a contributed command (see Activation events).

Extension identity (package.json)

FieldValue
namedocumate
displayNameDocuMate
publisheriNandi
descriptionCode Documentation
engines.vscode^1.75.0
repositoryhttps://github.com/inandi/documate.git