jsdoc-builder 0.0.6 → 0.0.7

package/dist/vite.d.ts

@@ -0,0 +1,20 @@
+import { GenerateJSDocOptions } from "./index";
+type FilterPattern = string | RegExp;
+export interface ViteLikeTransformResult {
+    code: string;
+    map: null;
+}
+export interface ViteLikePlugin {
+    name: string;
+    enforce?: "pre" | "post";
+    apply?: "serve" | "build";
+    transform?: (code: string, id: string) => Promise<ViteLikeTransformResult | null> | ViteLikeTransformResult | null;
+}
+export interface JSDocBuilderVitePluginOptions extends GenerateJSDocOptions {
+    include?: FilterPattern[];
+    exclude?: FilterPattern[];
+    extensions?: string[];
+    apply?: "serve" | "build" | "both";
+}
+export declare function jsdocBuilderVitePlugin(options?: JSDocBuilderVitePluginOptions): ViteLikePlugin;
+export {};

package/dist/vite.js

@@ -0,0 +1,111 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsdocBuilderVitePlugin = jsdocBuilderVitePlugin;
+const path = __importStar(require("path"));
+const index_1 = require("./index");
+const DEFAULT_EXTENSIONS = [".js", ".jsx", ".ts", ".tsx", ".vue"];
+function jsdocBuilderVitePlugin(options = {}) {
+    const { include = [], exclude = [/node_modules/], extensions = DEFAULT_EXTENSIONS, apply = "both" } = options, generateOptions = __rest(options, ["include", "exclude", "extensions", "apply"]);
+    return {
+        name: "jsdoc-builder",
+        enforce: "pre",
+        apply: apply === "both" ? undefined : apply,
+        transform(code, id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const targetId = stripQuery(id);
+                if (!shouldProcessFile(targetId, include, exclude, extensions)) {
+                    return null;
+                }
+                const nextCode = yield (0, index_1.generateJSDocFromCode)(targetId, code, generateOptions);
+                if (nextCode === code) {
+                    return null;
+                }
+                return {
+                    code: nextCode,
+                    map: null,
+                };
+            });
+        },
+    };
+}
+function shouldProcessFile(id, include, exclude, extensions) {
+    if (!id || id.startsWith("\0")) {
+        return false;
+    }
+    const normalizedId = id.replace(/\\/g, "/");
+    const fileExt = path.extname(normalizedId).toLowerCase();
+    const normalizedExtensions = new Set(extensions.map((ext) => ext.toLowerCase()));
+    if (!normalizedExtensions.has(fileExt)) {
+        return false;
+    }
+    if (exclude.some((pattern) => matchesPattern(normalizedId, pattern))) {
+        return false;
+    }
+    if (include.length === 0) {
+        return true;
+    }
+    return include.some((pattern) => matchesPattern(normalizedId, pattern));
+}
+function matchesPattern(id, pattern) {
+    if (typeof pattern === "string") {
+        return id.includes(pattern);
+    }
+    return pattern.test(id);
+}
+function stripQuery(id) {
+    const queryIndex = id.indexOf("?");
+    return queryIndex >= 0 ? id.slice(0, queryIndex) : id;
+}

package/example/example.jsx

@@ -0,0 +1,17 @@
+/**
+* @description Press Your { Function Component } Description
+* @param {any} props
+* @returns {void}
+*/
+function Component(props) {
+    return <div>{props.title}</div>;
+}
+/**
+* @description Press Your { Function ArrowComponent } Description
+* @param {any} props
+* @returns {void}
+*/
+const ArrowComponent = (props) => {
+    return <div>{props.content}</div>;
+};
+export default Component;

package/example/example.tsx

@@ -0,0 +1,21 @@
+interface Props {
+    title: string;
+    count?: number;
+}
+/**
+* @description Press Your { Function Component } Description
+* @param {Props} props
+* @returns {void}
+*/
+function Component(props: Props) {
+    return <div>{props.title}</div>;
+}
+/**
+* @description Press Your { Function ArrowComponent } Description
+* @param {Props} props
+* @returns {JSX.Element}
+*/
+const ArrowComponent = (props: Props): JSX.Element => {
+    return <div>{props.title}</div>;
+};
+export default Component;

package/example/example.vue

@@ -0,0 +1,36 @@
+<template>
+  <div>{{ message }}</div>
+</template>
+
+<script>/**
+* @description Press Your { Function greet } Description
+* @param {any} name
+* @returns {void}
+*/
+function greet(name) {
+    return `Hello, ${name}`;
+}
+/**
+* @description Press Your { Function farewell } Description
+* @param {any} name
+* @returns {void}
+*/
+const farewell = (name) => {
+    return `Goodbye, ${name}`;
+};
+export default {
+    name: 'ExampleComponent',
+    setup() {
+        return {
+            greet,
+            farewell
+        };
+    }
+};
+</script>
+
+<style scoped>
+div {
+  color: blue;
+}
+</style>

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "jsdoc-builder",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "author": "dori",
-  "description": "Generate JSDoc comments for JavaScript and TypeScript files.",
+  "description": "Generate JSDoc comments for JavaScript, TypeScript, JSX, TSX, and Vue files.",
   "publishConfig": {
     "access": "public"
   },
@@ -14,6 +14,18 @@
   "bugs": {
     "url": "https://github.com/klmhyeonwoo/jsdoc-builder/issues"
   },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./vite": {
+      "types": "./dist/vite.d.ts",
+      "default": "./dist/vite.js"
+    }
+  },
   "bin": {
     "jsdoc-builder": "./dist/cli.js"
   },
@@ -29,6 +41,11 @@
     "typescript-docs",
     "typescript-jsdoc",
     "javascript-documentation",
+    "jsx-documentation",
+    "tsx-documentation",
+    "vue-documentation",
+    "react-jsdoc",
+    "vue-jsdoc",
     "cli-tool",
     "developer-tools"
   ],
@@ -42,7 +59,7 @@
     "typescript": "^5.0.0"
   },
   "devDependencies": {
-    "@types/node": "^20.0.0",
+    "@types/node": "^20.19.34",
     "ts-node": "^10.0.0"
   }
 }