⚠️ BETA VERSION — Under active development. Bugs are expected. Use at your own risk. Currently supports TypeScript and JavaScript only. PHP, C#, and Python support coming in future versions.

Albertool DocGen

Automatically generates complete documentation for your backend project with a single command.

Scans src/, reads package.json, analyzes routes, environment variables, security, commits and more — everything becomes organized markdown files inside a docs/ folder.

What is generated

How to use

1. Open your project in VSCode
2. Ctrl+Shift+P → DocGen: Generate All Documentation
3. The docs/ folder is created at the root with all files

Output example

CONTROLLERS.md

## 🎯 UserController

| Method     | Parameters                        | Return              |
|------------|-----------------------------------|---------------------|
| `getAll`   | `req: Request, res: Response`     | `Promise<Response>` |
| `register` | `req: Request, res: Response`     | `Promise<Response>` |

ENV.md

| Variable    | Description                          | Required |
|-------------|--------------------------------------|----------|
| `DB_HOST`   | Database host                        | ✅       |
| `JWT_SECRET`| Secret key for token generation      | ✅       |

LIBS.md

| Lib         | Version   | Description                      |
|-------------|-----------|----------------------------------|
| `express`   | `^4.18.2` | HTTP framework for Node.js       |
| `typeorm`   | `^0.3.20` | ORM for TypeScript and JavaScript|
| `zod`       | `^3.22.4` | Schema validation                |

Automatic detection

Technologies — detects from package.json and documents in README and SECURITY what is being used: JWT, bcrypt, Helmet, CORS, rate limiting, 2FA, Zod, cookies and more.

Environment variables — reads .env, .env.example and scans process.env.X across all files. Normalizes everything to uppercase automatically.

Routes — captures Express pattern (router.get, app.post) and TypeScript decorators (@Get, @Post). Groups by HTTP method with handler and source file.

Commits — reads git log and adds semantic emojis automatically:

Expected project structure

The extension works best with projects following the MVC pattern:

src/
├── controllers/
├── services/
├── models/
├── repositories/
├── middlewares/
├── schemas/
├── routes/
├── config/
└── errors/

Files outside these folders are automatically documented in MISC.md.

⚠️ Known limitations (Beta)

• TypeScript and JavaScript only — PHP, C# and Python are not supported yet
• Projects with non-standard folder structures may generate incomplete docs
• Zod schemas must follow the z.object({}) pattern to be detected
• Git changelog requires an initialized repository with at least one commit

Part of the Albertool ecosystem

• Albertool Constructor — constructor, getters, setters and interface generator

Philosophy

Built by devs, for devs. You write the code, the extension documents it.

License

MIT