jsdoc-builder 0.0.1 → 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 dori
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.MD

@@ -61,7 +61,7 @@ jsdoc-builder example.ts
 
 ```typescript
 /**
- * @description Function add
+ * @description Press Your { Function add } Description
  * @param {number} a
  * @param {number} b
  * @returns {void}
@@ -71,7 +71,7 @@ function add(a: number, b: number) {
 }
 
 /**
- * @description Function multiply
+ * @description Press Your { Function multiply } Description
  * @param {number} a
  * @param {number} b
  * @returns {number}

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateJSDoc = void 0;
+exports.generateJSDoc = generateJSDoc;
 const ts = require("typescript");
 const fs = require("fs");
 /**
@@ -11,7 +11,8 @@ function generateJSDoc(filePath) {
     const sourceCode = fs.readFileSync(filePath, "utf-8");
     const sourceFile = ts.createSourceFile(filePath, sourceCode, ts.ScriptTarget.Latest, true);
     const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
-    function visit(node) {
+    // Visit function that processes each node
+    function visit(node, context) {
         if (ts.isFunctionDeclaration(node) && node.name) {
             const jsDoc = createJSDoc(node.name.text, node.parameters, node.type);
             ts.addSyntheticLeadingComment(node, ts.SyntaxKind.MultiLineCommentTrivia, jsDoc.comment, true);
@@ -30,35 +31,20 @@ function generateJSDoc(filePath) {
             }
             return node;
         }
-        return ts.visitEachChild(node, visit, context);
+        return ts.visitEachChild(node, (child) => visit(child, context), context); // Pass context to visit
     }
-    // Create a transformation context
-    const context = {
-        factory: ts.factory,
-        startLexicalEnvironment: () => { },
-        endLexicalEnvironment: () => [],
-        suspendLexicalEnvironment: () => { },
-        resumeLexicalEnvironment: () => { },
-        requestEmitHelper: () => { },
-        readEmitHelpers: () => undefined,
-        enableSubstitution: () => { },
-        isSubstitutionEnabled: () => false,
-        onSubstituteNode: (hint, node) => node,
-        enableEmitNotification: () => { },
-        isEmitNotificationEnabled: () => false,
-        onEmitNode: (hint, node, emitCallback) => emitCallback(hint, node),
-        getCompilerOptions: () => ({}),
-        hoistFunctionDeclaration: () => { },
-        hoistVariableDeclaration: () => { },
+    // Create the transformer
+    const transformer = (context) => {
+        return (sourceFile) => {
+            return ts.visitNode(sourceFile, (node) => visit(node, context)); // Pass context to visit
+        };
     };
-    const result = ts.transform(sourceFile, [
-        (context) => (rootNode) => ts.visitNode(rootNode, visit),
-    ]);
+    // Apply the transformer
+    const result = ts.transform(sourceFile, [transformer]);
     const transformedSourceFile = result.transformed[0];
     const updatedCode = printer.printFile(transformedSourceFile);
     fs.writeFileSync(filePath, updatedCode, "utf-8");
 }
-exports.generateJSDoc = generateJSDoc;
 /**
  * Creates a JSDoc comment.
  * @param functionName - The name of the function.

package/example/example.js

@@ -0,0 +1,18 @@
+/**
+ * @description Press Your { Function add } Description
+ * @param {any} a
+ * @param {any} b
+ * @returns {void}
+ */
+function add(a, b) {
+  return a + b;
+}
+/**
+ * @description Press Your { Function multiply } Description
+ * @param {any} a
+ * @param {any} b
+ * @returns {void}
+ */
+const multiply = (a, b) => {
+  return a * b;
+};

package/example/example.ts

@@ -0,0 +1,18 @@
+/**
+ * @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;
+};

package/package.json

@@ -1,23 +1,36 @@
 {
   "name": "jsdoc-builder",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "author": "dori",
   "description": "Generate JSDoc comments for JavaScript and TypeScript files.",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/klmhyeonwoo/jsdoc-builder"
+  },
+  "homepage": "https://github.com/klmhyeonwoo/jsdoc-builder#readme",
+  "bugs": {
+    "url": "https://github.com/klmhyeonwoo/jsdoc-builder/issues"
+  },
   "bin": {
     "jsdoc-builder": "./dist/cli.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "example"
   ],
   "license": "MIT",
   "keywords": [
     "jsdoc-generator",
-    "jsdoc",
-    "typescript",
-    "javascript",
-    "documentation",
-    "cli",
-    "auto-jsdoc"
+    "documentation-generator",
+    "auto-jsdoc",
+    "typescript-docs",
+    "typescript-jsdoc",
+    "javascript-documentation",
+    "cli-tool",
+    "developer-tools"
   ],
   "scripts": {
     "build": "tsc",

package/dist/example/example.js

@@ -1,2 +0,0 @@
-"use strict";
-const multiply = ({ x, y }) => x * y;

package/dist/generate.js

@@ -1,37 +0,0 @@
-import ts from "typescript";
-import fs from "fs";
-export function generateJSDoc(filePath) {
-    const fileContent = fs.readFileSync(filePath, "utf-8");
-    const sourceFile = ts.createSourceFile(filePath, fileContent, ts.ScriptTarget.Latest);
-    const functions = [];
-    function visit(node) {
-        if (ts.isFunctionDeclaration(node) ||
-            ts.isFunctionExpression(node) ||
-            ts.isArrowFunction(node)) {
-            const functionName = node.name?.text || "Anonymous";
-            const params = node.parameters
-                .map((param) => {
-                const paramName = param.name?.getText(sourceFile) || "unknown";
-                const paramType = param.type ? param.type.getText(sourceFile) : "any";
-                return `@param {${paramType}} ${paramName}`;
-            })
-                .join("\n");
-            const returnType = node.type
-                ? `@returns {${node.type.getText(sourceFile)}}`
-                : "@returns {any}";
-            const jsDoc = `
-/**
- * @function ${functionName}
- * ${params}
- * ${returnType}
- */
-      `;
-            functions.push(jsDoc);
-        }
-        ts.forEachChild(node, visit);
-    }
-    visit(sourceFile);
-    // JSDoc을 원본 파일 상단에 삽입
-    const updatedContent = functions.join("\n") + "\n\n" + fileContent;
-    fs.writeFileSync(filePath, updatedContent, "utf-8");
-}

package/dist/parse.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateJSDoc = void 0;
-const fs = require("fs");
-const ts = require("typescript");
-function generateJSDoc(filePath) {
-    const fileContent = fs.readFileSync(filePath, "utf-8");
-    const sourceFile = ts.createSourceFile(filePath, fileContent, ts.ScriptTarget.Latest, true);
-    // Example: Traverse the AST and insert JSDoc
-    ts.forEachChild(sourceFile, (node) => {
-        if (ts.isFunctionDeclaration(node) && node.name) {
-            const functionName = node.name.text;
-            console.log(`Found function: ${functionName}`);
-            // Add logic to generate JSDoc comments
-        }
-    });
-    // Save the updated file (placeholder)
-    console.log(`Generated JSDoc for: ${filePath}`);
-}
-exports.generateJSDoc = generateJSDoc;

package/dist/parser.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseFile = void 0;
-const ts = require("typescript");
-/**
- * Parse a TypeScript or JavaScript file to extract functions
- * @param content File content
- * @returns Array of FunctionInfo
- */
-function parseFile(content) {
-    const sourceFile = ts.createSourceFile("temp.ts", content, ts.ScriptTarget.ESNext, true);
-    const functions = [];
-    function visit(node) {
-        if (ts.isFunctionDeclaration(node) || ts.isFunctionExpression(node)) {
-            const name = node.name ? node.name.text : "anonymous";
-            const params = node.parameters.map((param) => ({
-                name: param.name.getText(),
-                type: param.type ? param.type.getText() : "any",
-                description: "",
-            }));
-            const returns = {
-                type: node.type ? node.type.getText() : "void",
-                description: "",
-            };
-            functions.push({
-                name,
-                description: `Function ${name}`,
-                params,
-                returns,
-                start: node.pos,
-            });
-        }
-        ts.forEachChild(node, visit);
-    }
-    visit(sourceFile);
-    return functions;
-}
-exports.parseFile = parseFile;

package/dist/src/cli.js

@@ -1,12 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const index_1 = require("./index");
-commander_1.program
-    .command("generate <file>")
-    .description("Generate JSDoc comments for the given TypeScript or JavaScript file")
-    .action((file) => {
-    (0, index_1.generateJSDoc)(file);
-});
-commander_1.program.parse(process.argv);

package/dist/src/index.js

@@ -1,56 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateJSDoc = void 0;
-const fs = __importStar(require("fs"));
-const parser_1 = require("./parser");
-const utils_1 = require("./utils");
-const utils_2 = require("./utils");
-/**
- * Main function to generate JSDoc for a file
- * @param filePath Path to the file
- */
-function generateJSDoc(filePath) {
-    if (!(0, utils_1.fileExists)(filePath)) {
-        console.error(`File not found: ${filePath}`);
-        return;
-    }
-    const content = fs.readFileSync(filePath, "utf-8");
-    const functions = (0, parser_1.parseFile)(content);
-    let updatedContent = content;
-    functions.forEach((func) => {
-        const jsdoc = (0, utils_2.formatJSDoc)(func.description, func.params, func.returns);
-        // 삽입할 위치 찾기
-        const insertPosition = func.start;
-        updatedContent =
-            updatedContent.slice(0, insertPosition) +
-                jsdoc +
-                "\n" +
-                updatedContent.slice(insertPosition);
-    });
-    (0, utils_1.writeFile)(filePath, updatedContent);
-    console.log(`JSDoc comments added to ${filePath}`);
-}
-exports.generateJSDoc = generateJSDoc;

package/dist/src/parser.js

@@ -1,61 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseFile = void 0;
-const ts = __importStar(require("typescript"));
-/**
- * Parse a TypeScript or JavaScript file to extract functions
- * @param content File content
- * @returns Array of FunctionInfo
- */
-function parseFile(content) {
-    const sourceFile = ts.createSourceFile("temp.ts", content, ts.ScriptTarget.ESNext, true);
-    const functions = [];
-    function visit(node) {
-        if (ts.isFunctionDeclaration(node) || ts.isFunctionExpression(node)) {
-            const name = node.name ? node.name.text : "anonymous";
-            const params = node.parameters.map((param) => ({
-                name: param.name.getText(),
-                type: param.type ? param.type.getText() : "any",
-                description: "",
-            }));
-            const returns = {
-                type: node.type ? node.type.getText() : "void",
-                description: "",
-            };
-            functions.push({
-                name,
-                description: `Function ${name}`,
-                params,
-                returns,
-                start: node.pos,
-            });
-        }
-        ts.forEachChild(node, visit);
-    }
-    visit(sourceFile);
-    return functions;
-}
-exports.parseFile = parseFile;

package/dist/src/utils.js

@@ -1,64 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatJSDoc = exports.writeFile = exports.fileExists = void 0;
-const fs = __importStar(require("fs"));
-/**
- * Check if the file exists
- * @param filePath Path to the file
- * @returns True if the file exists
- */
-function fileExists(filePath) {
-    return fs.existsSync(filePath);
-}
-exports.fileExists = fileExists;
-/**
- * Write content to a file
- * @param filePath Path to the file
- * @param content Content to write
- */
-function writeFile(filePath, content) {
-    fs.writeFileSync(filePath, content, "utf-8");
-}
-exports.writeFile = writeFile;
-/**
- * Format a JSDoc comment
- * @param description Description of the function
- * @param params Parameters of the function
- * @param returns Return type of the function
- * @returns Formatted JSDoc string
- */
-function formatJSDoc(description, params, returns) {
-    const paramDocs = params
-        .map((param) => ` * @param {${param.type}} ${param.name} - ${param.description}`)
-        .join("\n");
-    const returnDoc = ` * @returns {${returns.type}} - ${returns.description}`;
-    return `/**
- * ${description}
-${paramDocs}
-${returnDoc}
- */`;
-}
-exports.formatJSDoc = formatJSDoc;

package/dist/utils.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatJSDoc = exports.writeFile = exports.fileExists = void 0;
-const fs = require("fs");
-/**
- * Check if the file exists
- * @param filePath Path to the file
- * @returns True if the file exists
- */
-function fileExists(filePath) {
-    return fs.existsSync(filePath);
-}
-exports.fileExists = fileExists;
-/**
- * Write content to a file
- * @param filePath Path to the file
- * @param content Content to write
- */
-function writeFile(filePath, content) {
-    fs.writeFileSync(filePath, content, "utf-8");
-}
-exports.writeFile = writeFile;
-/**
- * Format a JSDoc comment
- * @param description Description of the function
- * @param params Parameters of the function
- * @param returns Return type of the function
- * @returns Formatted JSDoc string
- */
-function formatJSDoc(description, params, returns) {
-    const paramDocs = params
-        .map((param) => ` * @param {${param.type}} ${param.name} - ${param.description}`)
-        .join("\n");
-    const returnDoc = ` * @returns {${returns.type}} - ${returns.description}`;
-    return `/**
- * "vv"${description}
-${paramDocs}
-${returnDoc}
- */`;
-}
-exports.formatJSDoc = formatJSDoc;