{"id":25425323,"url":"https://github.com/klmhyeonwoo/jsdoc-builder","last_synced_at":"2026-02-26T10:45:48.294Z","repository":{"id":273225959,"uuid":"919044699","full_name":"klmhyeonwoo/jsdoc-builder","owner":"klmhyeonwoo","description":"Generate JSDoc comments for JavaScript and TypeScript files.","archived":false,"fork":false,"pushed_at":"2026-02-26T05:03:39.000Z","size":64,"stargazers_count":6,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-26T08:49:25.187Z","etag":null,"topics":["auto-jsdoc","frontend-lib","jsdoc","jsdoc-generator","jsdoc-template","jsdocs","tsdoc","tsdocs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/jsdoc-builder","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/klmhyeonwoo.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-01-19T15:14:30.000Z","updated_at":"2026-02-26T04:47:46.000Z","dependencies_parsed_at":"2025-08-24T21:28:06.103Z","dependency_job_id":"42615132-c818-4f38-89da-6e4cbef52e6a","html_url":"https://github.com/klmhyeonwoo/jsdoc-builder","commit_stats":null,"previous_names":["klmhyeonwoo/jsdoc-generator"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/klmhyeonwoo/jsdoc-builder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klmhyeonwoo%2Fjsdoc-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klmhyeonwoo%2Fjsdoc-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klmhyeonwoo%2Fjsdoc-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klmhyeonwoo%2Fjsdoc-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klmhyeonwoo","download_url":"https://codeload.github.com/klmhyeonwoo/jsdoc-builder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klmhyeonwoo%2Fjsdoc-builder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29856746,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-26T08:51:08.701Z","status":"ssl_error","status_checked_at":"2026-02-26T08:50:19.607Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["auto-jsdoc","frontend-lib","jsdoc","jsdoc-generator","jsdoc-template","jsdocs","tsdoc","tsdocs"],"created_at":"2025-02-16T23:45:45.235Z","updated_at":"2026-02-26T10:45:48.277Z","avatar_url":"https://github.com/klmhyeonwoo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JSDoc Builder\n\n[English](./README.MD) | [한국어](./README.ko.md) | [简体中文](./README.zh-CN.md) | [日本語](./README.ja.md)\n\nJSDoc Builder is a CLI and library that adds JSDoc comments to JavaScript/TypeScript code automatically.\nIt supports JavaScript, TypeScript, JSX, TSX, and Vue SFC files.\n\n## Table of Contents\n\n- [Why JSDoc Builder](#why-jsdoc-builder)\n- [Features](#features)\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [CLI Usage](#cli-usage)\n- [Config File](#config-file)\n- [AI Providers (OpenAI and Gemini)](#ai-providers-openai-and-gemini)\n- [Language Support for Descriptions](#language-support-for-descriptions)\n- [Vite Plugin Usage](#vite-plugin-usage)\n- [Programmatic API](#programmatic-api)\n- [Behavior and Safety](#behavior-and-safety)\n- [Troubleshooting](#troubleshooting)\n- [License](#license)\n\n## Why JSDoc Builder\n\n- Reduces repetitive JSDoc writing.\n- Keeps function docs consistent across mixed JS/TS/Vue codebases.\n- Works as:\n  - CLI for one-off or script-based use\n  - Library API for custom tooling\n  - Vite plugin for on-the-fly transform during dev/build\n\n## Features\n\n- Generates JSDoc for:\n  - Function declarations\n  - Arrow functions assigned to variables\n  - Function expressions assigned to variables\n- Supported file types:\n  - `.js`, `.mjs`, `.cjs`\n  - `.ts`\n  - `.jsx`\n  - `.tsx`\n  - `.vue` (updates only `\u003cscript\u003e` content)\n- Skips nodes that already have JSDoc comments.\n- Tries to infer parameter and return types.\n- Supports custom JSDoc templates via config.\n- Supports AI-generated `@description` using OpenAI or Gemini.\n- Provides safe fallback when AI key/request is unavailable.\n\n## Installation\n\nInstall globally:\n\n```bash\nnpm install -g jsdoc-builder\n```\n\nOr install in a project:\n\n```bash\nnpm install --save-dev jsdoc-builder\n```\n\n## Quick Start\n\n1. Create a source file:\n\n```ts\nfunction add(a: number, b: number) {\n  return a + b;\n}\n```\n\n2. Run CLI:\n\n```bash\njsdoc-builder ./example.ts\n```\n\n3. Result:\n\n```ts\n/**\n * @description add function\n * @param {number} a\n * @param {number} b\n * @returns {number}\n */\nfunction add(a: number, b: number) {\n  return a + b;\n}\n```\n\n## CLI Usage\n\nBasic:\n\n```bash\njsdoc-builder \u003cfile-path\u003e\n```\n\nOptions:\n\n```bash\njsdoc-builder \u003cfile-path\u003e --config ./jsdoc-builder.config.json\njsdoc-builder \u003cfile-path\u003e --no-ai\n```\n\n- `-c, --config \u003cpath\u003e`: custom config file path.\n- `--no-ai`: force disable AI descriptions even if config enables AI.\n\n## Config File\n\nDefault config location is `./jsdoc-builder.config.json`.\n\nExample:\n\n```json\n{\n  \"template\": {\n    \"descriptionLine\": \"@description {{description}}\",\n    \"paramLine\": \"@param {${type}} ${name}\",\n    \"returnsLine\": \"@returns {${type}}\"\n  },\n  \"includeReturnsWhenVoid\": true,\n  \"ai\": {\n    \"enabled\": true,\n    \"provider\": \"openai\",\n    \"model\": \"gpt-4o-mini\",\n    \"apiKey\": \"YOUR_API_KEY\",\n    \"baseUrl\": \"https://api.openai.com/v1/chat/completions\",\n    \"timeoutMs\": 12000,\n    \"promptTemplate\": \"Write one concise sentence for '{{functionName}}'. Params: {{parameters}}. Return type: {{returnType}}. Source: {{sourceSnippet}}\"\n  }\n}\n```\n\n### Config Fields\n\n- `template.descriptionLine`: template for description line.\n- `template.paramLine`: template for each parameter line.\n- `template.returnsLine`: template for returns line.\n- `includeReturnsWhenVoid`: when `false`, omits `@returns` for `void` functions.\n- `ai.enabled`: enables or disables AI generation.\n- `ai.provider`: `\"openai\"` or `\"gemini\"`.\n- `ai.model`: model name for selected provider.\n- `ai.apiKey`: provider API key.\n- `ai.baseUrl`: provider base endpoint.\n- `ai.timeoutMs`: request timeout in milliseconds.\n- `ai.promptTemplate`: prompt template used for the AI request.\n\n### Template Placeholders\n\nSupported placeholders in templates:\n\n- `{{functionName}}` or `${functionName}`\n- `{{description}}` or `${description}`\n- `{{type}}` or `${type}`\n- `{{name}}` or `${name}`\n- `{{returnType}}` or `${returnType}`\n- `{{paramsCount}}` or `${paramsCount}`\n\n## AI Providers (OpenAI and Gemini)\n\n### OpenAI\n\n- `ai.provider`: `\"openai\"`\n- Default model: `gpt-4o-mini`\n- Default endpoint: `https://api.openai.com/v1/chat/completions`\n- Env fallback key: `OPENAI_API_KEY`\n\n### Gemini\n\n- `ai.provider`: `\"gemini\"`\n- Default model: `gemini-1.5-flash`\n- Default base URL: `https://generativelanguage.googleapis.com/v1beta`\n- Env fallback key: `GEMINI_API_KEY` or `GOOGLE_API_KEY`\n\nGemini config example:\n\n```json\n{\n  \"ai\": {\n    \"enabled\": true,\n    \"provider\": \"gemini\",\n    \"model\": \"gemini-1.5-flash\",\n    \"apiKey\": \"YOUR_GEMINI_API_KEY\"\n  }\n}\n```\n\n### Missing API Key Behavior\n\nIf `ai.apiKey` is missing:\n\n1. JSDoc Builder checks environment variables based on provider.\n2. If still missing, AI is disabled automatically.\n3. `@description` falls back to `\"\u003cfunctionName\u003e function\"`.\n\n## Language Support for Descriptions\n\nJSDoc Builder can generate description text in Korean, English, Chinese, or Japanese by changing `ai.promptTemplate`.\n\nKorean prompt example:\n\n```json\n{\n  \"ai\": {\n    \"enabled\": true,\n    \"provider\": \"openai\",\n    \"promptTemplate\": \"함수 '{{functionName}}'의 JSDoc 설명을 한국어 한 문장으로 작성해 주세요. 파라미터: {{parameters}}, 반환 타입: {{returnType}}\"\n  }\n}\n```\n\nChinese prompt example:\n\n```json\n{\n  \"ai\": {\n    \"enabled\": true,\n    \"provider\": \"gemini\",\n    \"promptTemplate\": \"请用中文一句话编写函数 '{{functionName}}' 的 JSDoc 描述。参数: {{parameters}}，返回类型: {{returnType}}\"\n  }\n}\n```\n\nJapanese prompt example:\n\n```json\n{\n  \"ai\": {\n    \"enabled\": true,\n    \"provider\": \"openai\",\n    \"promptTemplate\": \"関数 '{{functionName}}' の JSDoc 説明を日本語で1文で作成してください。引数: {{parameters}}、戻り値型: {{returnType}}\"\n  }\n}\n```\n\n## Vite Plugin Usage\n\n```ts\nimport { defineConfig } from \"vite\";\nimport { jsdocBuilderVitePlugin } from \"jsdoc-builder/vite\";\n\nexport default defineConfig({\n  plugins: [\n    jsdocBuilderVitePlugin({\n      apply: \"serve\",\n      configPath: \"./jsdoc-builder.config.json\",\n      include: [\"src/\"],\n      exclude: [/node_modules/, /dist/],\n      extensions: [\".js\", \".jsx\", \".ts\", \".tsx\", \".vue\"]\n    })\n  ]\n});\n```\n\nPlugin options:\n\n- `apply`: `\"serve\" | \"build\" | \"both\"` (default `\"both\"`)\n- `include`: only process matching files (string includes or RegExp)\n- `exclude`: skip matching files\n- `extensions`: file extensions to process\n- Also supports all `GenerateJSDocOptions` (`configPath`, `config`, `disableAI`)\n\n## Programmatic API\n\n```ts\nimport { generateJSDoc, generateJSDocFromCode } from \"jsdoc-builder\";\n\nawait generateJSDoc(\"./src/utils.ts\", {\n  configPath: \"./jsdoc-builder.config.json\"\n});\n\nconst output = await generateJSDocFromCode(\n  \"/virtual/example.ts\",\n  \"const sum = (a, b) =\u003e a + b;\",\n  {\n    config: {\n      ai: { enabled: false }\n    }\n  }\n);\n\nconsole.log(output);\n```\n\n### API Reference\n\n- `generateJSDoc(filePath, options?)`: reads a file, transforms it, writes result.\n- `generateJSDocFromCode(filePath, code, options?)`: returns transformed code string.\n\n## Behavior and Safety\n\n- Existing JSDoc is preserved.\n- If no transform target is found, content is unchanged.\n- Vue files keep template/style blocks untouched.\n- AI errors do not break processing; fallback description is used.\n\n## Troubleshooting\n\n- `Cannot find module ...` in TypeScript:\n  - Check `tsconfig.json` includes Node types.\n  - Use `module` and `moduleResolution` values compatible with your TS version.\n- AI descriptions are not generated:\n  - Confirm `ai.enabled: true`\n  - Confirm provider API key is set in config or env\n  - Confirm provider endpoint is reachable\n- Descriptions are in the wrong language:\n  - Update `ai.promptTemplate` with your target language instruction.\n\n## License\n\nMIT. See [LICENSE](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklmhyeonwoo%2Fjsdoc-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklmhyeonwoo%2Fjsdoc-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklmhyeonwoo%2Fjsdoc-builder/lists"}