https://github.com/klmhyeonwoo/jsdoc-builder
Generate JSDoc comments for JavaScript and TypeScript files.
https://github.com/klmhyeonwoo/jsdoc-builder
auto-jsdoc frontend-lib jsdoc jsdoc-generator jsdoc-template jsdocs tsdoc tsdocs
Last synced: 6 months ago
JSON representation
Generate JSDoc comments for JavaScript and TypeScript files.
- Host: GitHub
- URL: https://github.com/klmhyeonwoo/jsdoc-builder
- Owner: klmhyeonwoo
- License: mit
- Created: 2025-01-19T15:14:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-15T05:51:22.000Z (12 months ago)
- Last Synced: 2025-08-09T09:11:48.924Z (6 months ago)
- Topics: auto-jsdoc, frontend-lib, jsdoc, jsdoc-generator, jsdoc-template, jsdocs, tsdoc, tsdocs
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/jsdoc-builder
- Size: 21.5 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# JSDoc Builder
JSDoc Builder is a CLI tool for automatically generating JSDoc comments for JavaScript and TypeScript files. It parses functions and variables to infer parameter types, return types, and descriptions, and then inserts JSDoc comments directly into the source code.
## Features
- Automatically generates JSDoc comments for:
- Function declarations
- Arrow functions
- TypeScript types and interfaces
- Infers parameter and return types from TypeScript annotations.
- Outputs clean and structured JSDoc comments.
## Installation
Install the library globally or locally via npm:
```bash
npm install jsdoc-builder -g
```
or
```bash
npm install jsdoc-builder --save-dev
```
## Usage
### CLI Command
Run the following command to generate JSDoc comments for a file:
```bash
jsdoc-builder
```
Replace `` with the path to the JavaScript or TypeScript file you want to process.
### Example
#### Input File (`example.ts`):
```typescript
function add(a: number, b: number) {
return a + b;
}
const multiply = (a: number, b: number): number => {
return a * b;
};
```
#### Command:
```bash
jsdoc-builder example.ts
```
#### Output File (`example.ts`):
```typescript
/**
* @description Press Your { Function add } Description
* @param {number} a
* @param {number} b
* @returns {void}
*/
function add(a: number, b: number) {
return a + b;
}
/**
* @description Press Your { Function multiply } Description
* @param {number} a
* @param {number} b
* @returns {number}
*/
const multiply = (a: number, b: number): number => {
return a * b;
};
```
## API
### `generateJSDoc(filePath: string): void`
- **Description**: Processes the specified file to add JSDoc comments.
- **Parameters**:
- `filePath` (string): The path to the file to be processed.
- **Returns**: `void`
## Contributing
Contributions are welcome! Please follow these steps:
1. Fork the repository.
2. Create a new branch: `git checkout -b feature-name`.
3. Commit your changes: `git commit -m 'Add feature-name'`.
4. Push to the branch: `git push origin feature-name`.
5. Submit a pull request.
## License
This project is licensed under the MIT License. See the LICENSE file for details.