WKT Viewer
Visualize and navigate files containing WKT (Well Known Text) geometries in Visual Studio Code.
Features
- Instantly visualizes WKT geometries in the current text editor.
- Highlights the current geometry as you navigate through text.
- Selects the corresponding text when you click a geometry in the viewer.
Quick Start
- Install WKT Viewer from the VS Code Marketplace.
- Open a file containing WKT geometries.
- Run
Start WKT Viewer from the command palette.
Extension Settings
wktViewer.maxGeometries: Maximum number of WKT geometries to parse and show from the active document. Defaults to 500.
Development
Requirements: Node.js 20 and npm.
npm ci
npm run build
npm test
Running the Extension
- F5: Launch the extension in an Extension Development Host.
- Ctrl+Shift+B -> Start Dev Env: Start TypeScript watch mode and the Vite dev server.
Debugging
- Extension backend: set breakpoints and press F5.
- Webview frontend: run
Developer: Open Webview Developer Tools from the command palette.
Contributing
We use Release Please, so commit messages should follow Conventional Commits. Release Please reads commits on main, so squash commit titles must follow this format too.
Use these types:
feat: user-visible features. Shown in the changelog and bumps the minor version.fix: user-visible bug fixes. Shown in the changelog and bumps the patch version.deps: dependency updates worth mentioning. Shown in the changelog.docs:, test:, refactor:, build:, chore: internal changes. Hidden from the changelog.
Use build: for build, CI, packaging, and workflow changes. Do not use ci: in this repository.
For breaking changes, use ! after the type or scope, or add a BREAKING CHANGE: footer.
Before publishing, verify a VSIX:
npm run package
Release and Publishing
Squash merge the PR generated by release-please. It updates CHANGELOG.md, updates package.json, and creates a GitHub release.
Publishing to the VS Code Marketplace is automated from .github/workflows/release-please.yml. When release-please creates a release, it calls .github/workflows/publish-marketplace.yml.
Required repository secret:
VSCE_PAT: Personal Access Token for the halls-byra publisher in the VS Code Marketplace.
Release flow:
- Merge the release-please PR.
- release-please creates a GitHub release.
Publish Marketplace checks out the release tag, runs build, tests, and package, then publishes the generated VSIX with VSCE_PAT.
To retry a failed publish, run Publish Marketplace manually from GitHub Actions and enter the release tag as ref.
