PitcherPro
Automatic README management for VS Code projects.
PitcherPro helps developers create and maintain project documentation directly from VS Code.
It analyzes the project workspace and generates structured documentation containing useful project information such as project structure, technology stack, statistics, previews, and badges.
Features
- Automatic README generation
- Automatic documentation synchronization
- Project structure documentation
- Technology stack detection
- Programming language detection
- Project statistics
- Lines of Code (LOC) information
- File and folder information
- Empty folder detection
- Project preview generation
- Preview image detection
- Numeric preview ordering
- README badges
- Documentation updates as projects change
Getting Started
1. Install PitcherPro
Open VS Code and open the Extensions panel.
Ctrl + Shift + X
Search for:
PitcherPro
Select PitcherPro and click Install.
2. Open Your Project
Open the project you want PitcherPro to document.
File → Open Folder
Select the project folder.
PitcherPro works with the project currently available in your VS Code workspace.
3. Let PitcherPro Generate Your Documentation
After PitcherPro is installed and your project is open, it can analyze the workspace and generate project documentation.
The generated README can contain information such as:
- Project overview
- Technology stack
- Programming languages
- Project statistics
- Lines of Code
- Folder structure
- Preview images
- Project badges
The generated information is based on the project being analyzed.
What PitcherPro Generates
Project Overview
PitcherPro can generate a structured overview of your project based on the information available in the workspace.
This provides a quick way to understand the project without manually writing every basic detail.
Technology Stack
PitcherPro can detect supported technologies and frameworks used by the project.
Depending on the project, detected technologies may include:
JavaScript
TypeScript
React
Next.js
Node.js
Express
Firebase
MongoDB
Tailwind CSS
The detected technology information depends on the project being analyzed.
Programming Languages
PitcherPro can identify programming languages represented in the project.
For example:
JavaScript
TypeScript
HTML
CSS
Python
The actual languages shown depend on the files present in the project.
Project Statistics
PitcherPro can provide useful project statistics.
Example:
Files 42
Folders 8
Lines of Code 3,240
The values are generated from the project being analyzed.
PitcherPro can document information about the files and folders within the project.
This makes the generated README more representative of the actual project rather than relying on manually written documentation.
Empty Folder Detection
Empty folders can be identified as part of the project structure.
For example:
my-project/
├── src/
├── assets/
├── docs/
└── empty-folder/
An empty folder can be represented separately from folders containing files, helping the generated project structure remain more accurate.
Project Structure
PitcherPro can represent your project structure in an easy-to-read format.
Example:
my-project/
├── src/
│ ├── components/
│ ├── utils/
│ └── App.js
├── public/
├── assets/
├── package.json
└── README.md
This is only an example.
The actual structure is generated from the project being analyzed.
Project Preview
PitcherPro can include visual project previews in the generated README.
This is particularly useful for:
- Web applications
- Websites
- UI projects
- VS Code extensions
- Design-focused projects
- Developer tools
- Projects where screenshots help explain the product
Instead of manually maintaining image references in the README, you can keep relevant preview images inside the project.
PitcherPro can detect supported preview images and organize them into the generated documentation.
Setting Up Project Previews
Create a supported image folder in your project.
For example:
my-project/
├── src/
├── assets/
│ ├── preview-1.png
│ ├── preview-2.png
│ └── preview-3.png
├── package.json
└── README.md
You can also organize images in supported locations such as:
assets/
screenshots/
previews/
Place the screenshots or preview images you want to showcase inside these locations.
PitcherPro can then detect the available images while generating or updating the documentation.
Preview Naming
For numbered previews, meaningful filenames are recommended.
Example:
preview-1.png
preview-2.png
preview-3.png
If a project contains:
preview-1.png
preview-2.png
preview-10.png
PitcherPro handles the numeric ordering as:
1 → 2 → 10
instead of:
1 → 10 → 2
This keeps screenshots in their intended sequence.
Multiple Preview Locations
Preview images can be organized across supported project folders.
Example:
my-project/
├── assets/
│ └── preview-1.png
│
├── screenshots/
│ └── preview-2.png
│
├── previews/
│ └── preview-3.png
│
└── README.md
PitcherPro can detect supported images from relevant preview locations and include them in the generated documentation.
Preview Image Recommendations
For the best results:
- Use clear screenshots.
- Use meaningful filenames.
- Keep screenshots at a reasonable resolution.
- Avoid unnecessary duplicate images.
- Use numbered filenames when order matters.
- Keep project screenshots inside the project rather than relying on temporary external links.
Recommended:
preview-1.png
preview-2.png
preview-3.png
Avoid unclear names such as:
image1.png
newfinal.png
final2latest.png
abc.png
No Preview Images
If no supported preview images are available, PitcherPro can handle the preview section without creating broken image references.
Where applicable, the generated documentation can provide an appropriate fallback instead of displaying invalid images.
Badges
PitcherPro can include badges in the generated README.
Badges provide quick visual information about a project and make important project information easier to identify.
Depending on the available project information, badges may represent information such as:
Version
License
Technology
Project status
The actual badges generated depend on the information available in the project.
Badge Example
A generated README may contain a badge section near the project introduction.
Example:
Generated badges should be reviewed before publishing the README, especially when the project contains information that changes frequently.
Documentation Synchronization
Projects are constantly changing.
Files are added.
Files are removed.
Folders change.
Technologies change.
Project statistics change.
Preview images may also change.
PitcherPro is designed to keep the generated documentation aligned with the current project state.
When the project changes, the documentation can be updated so that information such as:
- Project structure
- File information
- Statistics
- LOC
- Technologies
- Preview images
- Badges
can remain consistent with the project.
Example
Suppose your project initially contains:
my-project/
├── src/
│ ├── App.js
│ └── Header.js
├── assets/
│ └── preview-1.png
├── package.json
└── README.md
PitcherPro can generate documentation based on this structure.
Later, you add:
src/
└── Footer.js
and another preview:
assets/
└── preview-2.png
After the documentation is updated, the generated information can reflect:
my-project/
├── src/
│ ├── App.js
│ ├── Header.js
│ └── Footer.js
├── assets/
│ ├── preview-1.png
│ └── preview-2.png
├── package.json
└── README.md
This reduces the need to manually rewrite project documentation whenever the project structure changes.
Screenshots
The following section can be used to showcase PitcherPro and its generated documentation.
PitcherPro Overview
Recommended screenshot:
Show the main PitcherPro workflow or interface inside VS Code.
Project Analysis
Project Statistics
Recommended screenshot:
Show information such as:
Files
Folders
LOC
Languages
Technology
Project Preview
Recommended screenshot:
Show multiple project screenshots inside the generated README.
README Badges
Why PitcherPro?
Project documentation often becomes outdated as development continues.
New files are added.
Folders are moved.
Technologies change.
Statistics change.
Screenshots change.
Manually maintaining all of this information can become repetitive.
PitcherPro helps automate this documentation work by generating project information directly from the workspace and keeping the documentation aligned with the project.
Requirements
- Visual Studio Code
- A VS Code workspace/project
PitcherPro works with supported project structures and configuration information available in the workspace.
Privacy
PitcherPro works with the project opened in your VS Code workspace to generate documentation.
Always review generated documentation before publishing it publicly, especially if your project contains private or sensitive information.
Do not publish documentation containing:
- API keys
- Passwords
- Access tokens
- Private URLs
- Internal credentials
- Other confidential information
Tips
For the best results:
- Open the correct project folder in VS Code.
- Keep project configuration files available.
- Keep preview images organized in supported folders.
- Use meaningful preview filenames.
- Review generated project information.
- Review generated badges and preview images.
- Review the README before publishing it publicly.
- Keep project documentation synchronized with major project changes.
Support
If you encounter a problem or have a feature suggestion, use the project's official issue tracker.
When reporting an issue, provide:
- PitcherPro version
- VS Code version
- Operating system
- Description of the problem
- Steps to reproduce the issue
Do not include:
- Passwords
- API keys
- Access tokens
.env values- Private source code
- Other sensitive information
License
PitcherPro is released under the MIT License.
PitcherPro
Build your project. PitcherPro keeps your README organized.
If PitcherPro is useful to you, consider leaving a review on the VS Code Marketplace and sharing your feedback.
pitcher
Overview
pitcher is a VS Code Extension built using Node.js, JavaScript, VS Code Extension. The codebase comprises 55 source files totaling 9,117 lines of code.
Key Highlights:
- Backend API & server side processing core
Preview
Demo
Prerequisites
Ensure you have installed the following before developing or debugging this VS Code Extension:
- VS Code: Version
1.70.0 or higher
- Node.js:
>= 18.x recommended
- npm / pnpm / yarn: Package manager
Installation Guide
Follow these steps to set up the extension locally:
Clone the repository:
git clone <repository-url>
cd pitcher
Install Extension Dependencies:
npm install
Open in VS Code & Compile:
Press F5 inside VS Code to launch the Extension Development Host window for debugging.
How to Run
Execute the following command(s) in your terminal to start the application:
Start Application:
npm start
Technology Stack
- Node.js
- JavaScript
- VS Code Extension
Folder Structure
pitcher/
├── allVersions
│ ├── PitcherPro-1.0.0.vsix (501.8 KB)
│ ├── PitcherPro-1.4.0.vsix (501.8 KB)
│ ├── PitcherPro-2.0.1.vsix (515.8 KB)
│ ├── PitcherPro-2.0.2.vsix (197.9 KB)
│ ├── PitcherPro-2.0.3.vsix (201.8 KB)
│ └── PitcherPro-2.0.4.vsix (216.5 KB)
├── src
│ ├── bitmap
│ │ └── bitmap.js (8.9 KB)
│ ├── images
│ │ ├── badges.png (5.7 KB)
│ │ ├── demo.png (134.0 KB)
│ │ ├── overview.png (9.5 KB)
│ │ ├── pitcher-icon.png (9.6 KB)
│ │ └── statics.png (17.3 KB)
│ ├── readme
│ │ ├── formatters
│ │ │ ├── badgeFormatter.js (3.0 KB)
│ │ │ ├── dateFormatter.js (446 B)
│ │ │ ├── folderTreeFormatter.js (194 B)
│ │ │ ├── installationFormatter.js (6.7 KB)
│ │ │ ├── overviewFormatter.js (2.1 KB)
│ │ │ ├── prerequisitesFormatter.js (6.4 KB)
│ │ │ ├── previewFormatter.js (1.8 KB)
│ │ │ ├── statisticsFormatter.js (3.4 KB)
│ │ │ ├── techStackFormatter.js (236 B)
│ │ │ └── usageFormatter.js (6.5 KB)
│ │ ├── generator
│ │ │ └── generateReadme.js (2.1 KB)
│ │ ├── templates
│ │ │ └── defaultTemplate.js (906 B)
│ │ └── index.js (115 B)
│ ├── Scanner
│ │ ├── builders
│ │ │ └── treeBuilder.js (3.9 KB)
│ │ ├── detectors
│ │ │ ├── authorDetector
│ │ │ │ ├── authorValidator.js (714 B)
│ │ │ │ ├── commentAuthorDetector.js (1.2 KB)
│ │ │ │ ├── gitAuthorDetector.js (1.3 KB)
│ │ │ │ ├── index.js (1.1 KB)
│ │ │ │ ├── manifestAuthorDetector.js (2.2 KB)
│ │ │ │ └── osAuthorDetector.js (845 B)
│ │ │ ├── languageDetector.js (415 B)
│ │ │ ├── locCalculator.js (3.3 KB)
│ │ │ ├── packageDetector.js (1.6 KB)
│ │ │ ├── projectTypeDetector.js (16.5 KB)
│ │ │ └── techStackDetector.js (1.6 KB)
│ │ ├── scanners
│ │ │ ├── fileScanner.js (2.6 KB)
│ │ │ ├── folderScanner.js (1.5 KB)
│ │ │ ├── sizeCalculator.js (4.8 KB)
│ │ │ └── workSpaceScanner.js (244 B)
│ │ └── index.js (3.7 KB)
│ ├── utils
│ │ └── fileSystem.js (1.3 KB)
│ └── extension.js (2.1 KB)
├── .gitIgnore (161 B)
├── .vscode-test.mjs (113 B)
├── CHANGELOG.md (234 B)
├── eslint.config.mjs (548 B)
├── jsconfig.json (183 B)
├── LICENSE.txt (1.1 KB)
├── package-lock.json (101.3 KB)
├── package.json (1.0 KB)
├── README.md (18.1 KB)
├── test.md (953 B)
└── vsc-extension-quickstart.md (2.7 KB)
Project Statistics
- Total Files & Folders: 55 files in 15 folders
- Project Size: 2.5 MB
- Source Code (LOC): 9,117 lines
- Code Composition: 91.8% Code • 3.4% Comments • 4.8% Blanks
- File Extensions:
other (1) • .mjs (2) • .vsix (6) • .md (4) • .json (3) • .txt (1) • .js (33) • .png (5)
Key Files & Sizes
allVersions/PitcherPro-2.0.1.vsix — 515.8 KB (1735 lines)allVersions/PitcherPro-1.4.0.vsix — 501.8 KB (1684 lines)allVersions/PitcherPro-1.0.0.vsix — 501.8 KB (1688 lines)allVersions/PitcherPro-2.0.4.vsix — 216.5 KB (762 lines)allVersions/PitcherPro-2.0.3.vsix — 201.8 KB (721 lines)
Author
Author: Himanshu
Last Updated: 26 / 08 / 2026 at 05:29 PM
Documentation generated by PitcherPro
