@gobstones/gobstones-scripts/src/Tasks/typedoc.ts

Scripts to abstract away build configuration of Gobstones Project's libraries and modules.

/*
 * *****************************************************************************
 * Copyright (C) National University of Quilmes 2018-2024
 * Gobstones (TM) is a trademark of the National University of Quilmes.
 *
 * This program is free software distributed under the terms of the
 * GNU Affero General Public License version 3.
 * Additional terms added in compliance to section 7 of such license apply.
 *
 * You may read the full license at https://gobstones.github.io/gobstones-guidelines/LICENSE.
 * *****************************************************************************
 */

/**
 * ----------------------------------------------------
 * @module Tasks
 * @author Alan Rodas Bonjour <alanrodas@gmail.com>
 * ----------------------------------------------------
 */

import { runBin } from './runBin';

import { config } from '../Config';

/**
 * This type represents the options that you can pass to the typedoc task.
 */
export interface TaskTypedocOptions {
    /**
     * The files to watch for changes, if desired.
     */
    watch?: string;
}

/**
 * Returns the string for the bash command  to run
 * typedoc with the gobstones-script detected configuration.
 *
 * @param options - The options applied when running typedoc.
 *
 * @example typedoc()
 *
 * @returns The bash command string.
 */
export const typedoc = (options: TaskTypedocOptions = {}): string =>
    `${runBin('typedoc')} --options ${config.projectType.typedoc.toolingFile} ` +
    `--tsconfig ${config.projectType.tsConfigJSON.toolingFile}` +
    (options.watch ? ` --watch ${options.watch}` : '');