DocuMate
April 11, 2026 · View on GitHub
Internal documentation for DocuMate, a VS Code–compatible extension (runs in VS Code and Cursor) that inserts PHPDoc and JSDoc blocks for PHP and JavaScript (classes, methods, properties), file-level headers, and @version updates. Snippet content follows documate.* configuration.
For installation and daily usage, see the repository README.
Official VS Code extension authoring reference: Extension API · Publishing extensions.
Documentation map
| Document | Audience | Description |
|---|---|---|
| development.md | Contributors | Prerequisites, run/debug, lint, tests |
| architecture.md | Contributors | Modules, command flow, diagrams |
| reference.md | Contributors / advanced users | Command IDs, settings keys |
| contributing.md | Contributors | Issues, PRs, code expectations |
| publishing.md | Maintainers | Marketplace, Open VSX, release script |
| security.md | Everyone | Threat model, secrets, reporting |
Release history lives in the root CHANGELOG.md.
Source layout
extension.js # Activation, command registration, dispatch
language/
abstract.js # Aggregates config + extension classes
config.js # workspace.getConfiguration('documate')
CoreExtension.js # File header, @version update, default snippet
PhpExtension.js # PHP snippets
JsExtension.js # JavaScript snippets