vitepress-jsdoc/dist/esm/index.js

A bridge between Vitepress and JSDoc-style commented codebases for hassle-free documentation.

/*
 * @vitepress
 * ---
 * headline: Main Index
 * ---
 */
import { printStats } from './utilities/output.js';
import { ArgumentParser, DocsFolderManager, DirectoryManager, FileProcessor, ReadmeManager, WatcherManager, } from './classes/index.js';
/**
 * ## Generate Markdown Files
 * Orchestrates the process of reading, filtering, and writing files.
 *
 * - **options**: The plugin options of type `PluginOptions`.
 *
 * @example
 * ```typescript
 * generate(myCliArgs);
 * ```
 */
export const generate = async (options) => {
    const argParser = new ArgumentParser();
    const parsedArgs = argParser.parse(options);
    const startTime = Date.now();
    const docsManager = new DocsFolderManager();
    const deletedPaths = await docsManager.delete(parsedArgs.docsFolder, parsedArgs.rmPattern);
    const dirManager = new DirectoryManager({
        srcPath: parsedArgs.srcFolder,
        include: parsedArgs.include,
        exclude: parsedArgs.exclude,
    });
    const lsFolder = await dirManager.build();
    docsManager.create(parsedArgs.docsFolder);
    const fileProc = new FileProcessor();
    const filteredResult = await fileProc.processFiles(lsFolder, options);
    printStats(lsFolder, filteredResult);
    const readme = new ReadmeManager();
    await readme.create(options, deletedPaths);
    const resultTime = (Math.abs(startTime - Date.now()) / 1000).toFixed(2);
    console.log(`\n⏰ Time: ${resultTime}s`);
    const watcher = new WatcherManager(options);
    watcher.watch();
};
/**
 * Vitepress JSDoc Plugin.
 *
 * @function
 * @param {PluginOptions} options - The options for the plugin.
 * @returns {Plugin} Returns a Vite plugin object.
 *
 * @example
 * ```typescript
 * // Example Vitepress Configuration
 * import { defineConfig } from "vitepress";
 * import VitpressJsdocPlugin from "vitepress-jsdoc";
 *
 * export default defineConfig({
 *   vite: {
 *     plugins: [
 *       VitpressJsdocPlugin({
 *         folder: "code",
 *         source: "./dist/mjs/",
 *         dist: "./docs",
 *         title: "API",
 *         partials: ["./dist/mjs/partials/*.hbs"],
 *         helpers: ["./dist/mjs/helpers/*.js"],
 *         readme: "./README.md",
 *         exclude: "**\/*.json,**\/*.hbs,**\/*.d.js,**\/*.map,**\/interfaces.*",
 *       }),
 *     ],
 *   },
 * });
 * ```
 */
const plugin = (options) => {
    return {
        name: 'vitepress-jsdoc-plugin',
        // Hook for 'serve'
        configureServer(server) {
            // Call your watch function here
            options.watch = true;
            const watcher = new WatcherManager(options);
            watcher.watch();
        },
        // Hook for 'build'
        // async buildStart() {
        //   await generate(options);
        // },
    };
};
export default plugin;
//# sourceMappingURL=index.js.map