Skip to content

LEARN.md

Latest commit

 

History

History
99 lines (64 loc) · 3.13 KB

LEARN.md

File metadata and controls

99 lines (64 loc) · 3.13 KB
Raw

LEARN: Vector OS Team Hub — Developer & Publishing Guide

This document explains the extension architecture, common developer workflows, and step-by-step publishing instructions.

Architecture Overview

  • src/extension.ts — registers commands, sets up activation events, and wires the extension lifecycle.
  • src/models.ts — TypeScript interfaces and data shapes for Team, Member, and Task.
  • src/store.ts — persistence layer (local file or Memento-backed storage used by the extension).
  • src/webview.ts / webview.js — front-end code for the dashboard webview. Uses message passing between the extension host and webview.
  • out/ — compiled output generated by tsc; this is what gets packaged.

Local Development

  1. Install dependencies:
npm install
  1. Build TypeScript:
npm run compile
  1. Run the extension:
  • Open the workspace in VS Code and press F5 to launch the Extension Development Host.
  • Use the Vector Team Hub commands from the Command Palette to test flows.
  1. Debugging webview content:
  • In the Extension Development Host window, open Help → Toggle Developer Tools to view console logs from the webview.

Packaging & Release

  1. Bump the version in package.json (semantic versioning):
npm version patch    # or minor/major as appropriate

This command updates package.json and creates a git tag.

  1. Ensure the extension compiles:
npm run compile
  1. Create a .vsix package:
npx @vscode/vsce package
  • If the tool warns LICENSE is missing, add a LICENSE file (recommended).
  1. Publish to the Visual Studio Marketplace:
  • Create a Personal Access Token (PAT) for the Visual Studio Marketplace under your publisher account.
  • Export the token into the environment and publish:
$env:VSCE_PAT = 'YOUR_PERSONAL_ACCESS_TOKEN'
npx @vscode/vsce publish
  • Or publish a specific packaged file:
npx @vscode/vsce publish --packagePath .\vector-os-team-hub-0.0.2.vsix --pat 'YOUR_PERSONAL_ACCESS_TOKEN'

Security note: never commit personal tokens to source control.

Release Notes & Marketplace Listing

  • Update the extension README.md and package.json description field with any important changes.
  • Use the Visual Studio Marketplace publisher portal to add screenshots, tags, and release notes.

Common Issues

  • "Missing main or activation errors": ensure out/extension.js exists after compilation and main in package.json points to it.
  • "Webview not loading": check webview console, verify asset paths, and ensure CSP headers are set as expected.
  • "Publish fails": confirm publisher in package.json matches the publisher name in the Marketplace and that the PAT has the correct scopes.

Next Steps & Recommendations

  • Add a LICENSE file (MIT or Apache-2.0 are common) to silence packing warnings.
  • Add automated CI to run npm run lint and npm run compile on PRs.
  • Maintain CHANGELOG.md for readable release notes.

If you want, I can:

  • run the publish step (you supply the PAT in the terminal), or
  • add a LICENSE file now (ask which license to use).