Package Exports
- codecommentor
- codecommentor/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (codecommentor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
codecommentor
🚀 Auto-generate clean function comments for your TypeScript/JavaScript files.
codecommentor is a lightweight CLI tool that analyzes your .ts / .js files and inserts structured /** */ comments above functions using static code parsing — no AI, no dependencies, no fluff.
📦 Installation
npm install -g codecommentor# Basic usage in current directory
codecommentor
# Or specify a custom path
codecommentor --path my-folder.commentignore
Like .gitignore — skip files or folders from being commented:
bash # Ignore these files src/temp.ts src/legacy/*
Features
🧠 Static analysis — no runtime needed
⚡ Blazing fast and works offline
💾 Edits functions in place
🎯 Supports arrow + named functions
Example
Before:
function add(a: number, b: number): number {
return a + b;
}After:
/**
* Calculates the function "add".
* @param a - parameter
* @param b - parameter
* @returns number
*/
function add(a: number, b: number): number {
return a + b;
}📄 License
MIT © Divyansh Kumar