Skip to content

project-memory.md

Latest commit

 

History

History
56 lines (42 loc) · 2.19 KB

project-memory.md

File metadata and controls

56 lines (42 loc) · 2.19 KB

Project Memory

Current Goal

  • Build a proposal-ready yet extensible VS Code extension POC for an AI desktop application workflow.
  • Keep the implementation runnable in standard VS Code while assuming API-level compatibility with a future VSCodium fork.

Confirmed Decisions

  • Repository shape uses a lightweight npm workspaces monorepo.
  • Primary demo scenario is a Markdown workbench rendered through CustomTextEditorProvider.
  • Demo balances visual presentation with implementation quality rather than being mock-only.
  • Data source combines Markdown frontmatter with a same-name sidecar YAML file.
  • No real LLM calls, Electron shell customization, or fork-specific patches are included in this POC.
  • Git commit messages should use Conventional Commits.

Implemented Structure

  • Root repo contains AGENTS.md, spec.md, README.md, package.json, tsconfig.base.json, and VS Code launch/tasks settings.
  • Extension package lives in extensions/markdown-workbench.
  • Demo content lives in demo-workspace.
  • Core extension pieces include:
    • typed constants and message contracts
    • Markdown frontmatter parser
    • sidecar YAML parser/loader
    • payload builder for webview rendering
    • command routing for mock actions
    • custom document surface provider
    • metadata side view provider

Demo Behavior

  • project-brief.md can be reopened with AI Desktop Surface.
  • The surface renders a hero block, tags, Markdown body, metadata cards, action buttons, and related document links.
  • Actions currently support copy-to-clipboard, mock notification, and open-related-document flows.
  • fallback-only.md demonstrates the no-sidecar fallback path.
  • Metadata side panel updates from the active document payload.

Verification Completed

  • npm install
  • npm run compile
  • npm run lint
  • npm run test
  • npm run package:vsix

Current Artifacts

  • VSIX output path: extensions/markdown-workbench/markdown-workbench-0.1.0.vsix
  • Git repository has been initialized locally.

Known Non-Blocking Gaps

  • Extension manifest does not yet define a real repository field.
  • No LICENSE file has been chosen yet.
  • No integration with other extensions or true YAML write-back has been implemented.