Skip to content

VS Code Extension for Auto README Generator #36

@Franci-343

Description

@Franci-343

Summary

This issue proposes a VS Code extension that brings the Auto README Generator
pipeline (implemented in PR #35) directly into the editor. Instead of pasting
project information into the Oxtools web UI, developers would trigger README
generation from inside VS Code, with direct access to the workspace files.

The Oxtools web tool requires users to manually describe their project.
A VS Code extension can read the workspace directly — package.json, requirements.txt,
directory structure — and build a richer, more accurate metadata object automatically.

Motivation

  • Developers work inside VS Code. Having to open a browser, copy-paste project
    details, and come back to save the result is friction that reduces adoption.
  • VS Code extensions have direct file system access, enabling automatic detection
    of tech stack, entry points, and dependencies without user input.
  • The pipeline backend is already built and deployed. The extension is purely
    a new client layer consuming the same Oxlo API.

Extension Structure (proposed)

vscode-auto-readme-generator/
├── src/
│   ├── extension.ts          ← activation + command registration
│   ├── workspaceAnalyzer.ts  ← reads package.json, requirements.txt, etc.
│   ├── oxloClient.ts         ← calls Oxlo API with streaming support
│   └── outputPanel.ts        ← manages VS Code Output Channel + preview
├── package.json              ← extension manifest (contributes.commands)
├── tsconfig.json
└── README.md

Tech Stack

  • Language: TypeScript (standard for VS Code extensions)
  • HTTP client: node-fetch or built-in https module for Oxlo API calls
  • No additional bundler required beyond the VS Code extension scaffolding

Out of Scope (for this issue)

  • Chrome extension (separate issue if needed)
  • Publishing to the VS Code Marketplace (future milestone)

Related

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions