jsdoc-builder 0.0.1 → 0.0.2

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/package.json

@@ -1,8 +1,19 @@
 {
   "name": "jsdoc-builder",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "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"
   },
@@ -12,12 +23,13 @@
   "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",