vitepress-jsdoc

Version:

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

27 lines • 1.15 kB

JavaScript

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ReadmeManager = void 0;
const create_readme_js_1 = require("../utilities/create-readme.js");
/**
 * The `ReadmeManager` class provides functionalities to manage the README file
 * of the project. It offers methods to create or update the README based on
 * the provided arguments and configurations.
 */
class ReadmeManager {
    /**
     * Creates or updates the README file based on the provided arguments.
     *
     * @param {PluginOptions} options - Plugin options to guide the creation of the README.
     * @param {string[]} deletedPaths - An array of paths that were deleted, to be documented in the README.
     * @returns {Promise<void>} A promise that resolves once the README is created or updated.
     *
     * @example
     * const readmeManager = new ReadmeManager();
     * await readmeManager.create(cliArgs, deletedPathsArray);
     */
    async create(options, deletedPaths) {
        await (0, create_readme_js_1.createReadmeFile)(options, deletedPaths);
    }
}
exports.ReadmeManager = ReadmeManager;
//# sourceMappingURL=readme-manager.js.map