@decaf-ts/utils 0.1.6

package/dist/types/cli/commands/update-scripts.d.ts

@@ -0,0 +1,211 @@
+import { Command } from "../command";
+import { CommandOptions } from "../types";
+import { LoggingConfig } from "../../output";
+import { DefaultCommandValues } from "../index";
+declare const options: {
+    templates: string[];
+    workflows: string[];
+    ide: string[];
+    docs: string[];
+    styles: string[];
+    scripts: string[];
+    tests: string[];
+    typescript: string[];
+    docker: string[];
+    automation: string[];
+};
+declare const argzz: {
+    boot: {
+        type: string;
+    };
+    org: {
+        type: string;
+        short: string;
+    };
+    name: {
+        type: string;
+        short: string;
+        default: undefined;
+    };
+    author: {
+        type: string;
+        short: string;
+        default: undefined;
+    };
+    all: {
+        type: string;
+    };
+    license: {
+        type: string;
+        message: string;
+    };
+    scripts: {
+        type: string;
+    };
+    styles: {
+        type: string;
+    };
+    docs: {
+        type: string;
+    };
+    ide: {
+        type: string;
+    };
+    workflows: {
+        type: string;
+    };
+    templates: {
+        type: string;
+    };
+    typescript: {
+        type: string;
+    };
+    docker: {
+        type: string;
+    };
+    pkg: {
+        type: string;
+    };
+    dependencies: {
+        type: string;
+    };
+    tests: {
+        type: string;
+    };
+    automation: {
+        type: string;
+    };
+};
+/**
+ * @class TemplateSync
+ * @extends {Command}
+ * @category scripts
+ * @description A command-line tool for synchronizing project templates and configurations.
+ * @summary This class provides functionality to download and update various project files and configurations from a remote repository.
+ * It supports updating licenses, IDE configurations, scripts, styles, documentation, workflows, and templates.
+ *
+ * @param {CommandOptions} args - The command options for TemplateSync
+ */
+export declare class TemplateSync extends Command<CommandOptions<typeof argzz>, void> {
+    private replacements;
+    constructor();
+    private loadValuesFromPackage;
+    /**
+     * @description Downloads files for a specific option category.
+     * @summary This method downloads all files associated with a given option key from the remote repository.
+     * @param {string} key - The key representing the option category to download
+     * @returns {Promise<void>}
+     * @throws {Error} If the specified option key is not found
+     */
+    downloadOption(key: keyof typeof options): Promise<void>;
+    /**
+     * @description Downloads and sets up the specified license.
+     * @summary This method downloads the chosen license file, saves it to the project, and updates the package.json license field.
+     * @param {"MIT" | "GPL" | "Apache" | "LGPL" | "AGPL"} license - The license to download and set up
+     * @returns {Promise<void>}
+     */
+    getLicense(license: "MIT" | "GPL" | "Apache" | "LGPL" | "AGPL"): Promise<void>;
+    /**
+     * @description Downloads IDE configuration files.
+     * @returns {Promise<void>}
+     */
+    getIde(): Promise<void>;
+    /**
+     * @description Update npm scripts
+     * @returns {Promise<void>}
+     */
+    getScripts(): Promise<void>;
+    /**
+     * @description Downloads style configuration files.
+     * @returns {Promise<void>}
+     */
+    getStyles: () => Promise<void>;
+    /**
+     * @description Downloads template files.
+     * @returns {Promise<void>}
+     */
+    getTemplates: () => Promise<void>;
+    /**
+     * @description Downloads workflow configuration files.
+     * @returns {Promise<void>}
+     */
+    getWorkflows: () => Promise<void>;
+    /**
+     * @description Downloads documentation files.
+     * @returns {Promise<void>}
+     */
+    getDocs: () => Promise<void>;
+    /**
+     * @description Downloads typescript config files.
+     * @returns {Promise<void>}
+     */
+    getTypescript: () => Promise<void>;
+    /**
+     * @description Downloads automation documentation files.
+     * @returns {Promise<void>}
+     */
+    getAutomation: () => Promise<void>;
+    /**
+     * @description Downloads automation documentation files.
+     * @returns {Promise<void>}
+     */
+    getTests: () => Promise<void>;
+    /**
+     * @description Downloads docker image files.
+     * @returns {Promise<void>}
+     */
+    getDocker: () => Promise<void>;
+    initPackage(pkgName: string, author: string, license: string): Promise<void>;
+    updatePackageScrips(): Promise<void>;
+    createTokenFiles(): Promise<void>;
+    getOrg(): Promise<string>;
+    auditFix(): Promise<string>;
+    patchFiles(): void;
+    updateDependencies(): Promise<void>;
+    /**
+     * @description Runs the template synchronization process.
+     * @summary This method orchestrates the downloading of various project components based on the provided arguments.
+     * @param {ParseArgsResult} args - The parsed command-line arguments
+     * @returns {Promise<void>}
+     *
+     * @mermaid
+     * sequenceDiagram
+     *   participant T as TemplateSync
+     *   participant L as getLicense
+     *   participant I as getIde
+     *   participant S as getScripts
+     *   participant St as getStyles
+     *   participant D as getDocs
+     *   participant W as getWorkflows
+     *   participant Te as getTemplates
+     *   T->>T: Parse arguments
+     *   alt all flag is true
+     *     T->>T: Set all component flags to true
+     *   end
+     *   alt license is specified
+     *     T->>L: getLicense(license)
+     *   end
+     *   alt ide flag is true
+     *     T->>I: getIde()
+     *   end
+     *   alt scripts flag is true
+     *     T->>S: getScripts()
+     *   end
+     *   alt styles flag is true
+     *     T->>St: getStyles()
+     *   end
+     *   alt docs flag is true
+     *     T->>D: getDocs()
+     *   end
+     *   alt workflows flag is true
+     *     T->>W: getWorkflows()
+     *   end
+     *   alt templates flag is true
+     *     T->>Te: getTemplates()
+     *   end
+     */
+    run(args: LoggingConfig & typeof DefaultCommandValues & {
+        [k in keyof typeof argzz]: unknown;
+    }): Promise<void>;
+}
+export {};

package/dist/types/cli/constants.d.ts

@@ -0,0 +1,73 @@
+/**
+ * @description Default command options for CLI commands.
+ * @summary Defines the structure and default values for common command-line options used across various CLI commands.
+ * @const DefaultCommandOptions
+ * @typedef {Object} DefaultCommandOptions
+ * @property {Object} verbose - Verbosity level option.
+ * @property {string} verbose.type - The type of the verbose option (number).
+ * @property {string} verbose.short - The short flag for the verbose option (V).
+ * @property {number} verbose.default - The default value for verbosity (0).
+ * @property {Object} version - Version display option.
+ * @property {string} version.type - The type of the version option (boolean).
+ * @property {string} version.short - The short flag for the version option (v).
+ * @property {undefined} version.default - The default value for version display (undefined).
+ * @property {Object} help - Help display option.
+ * @property {string} help.type - The type of the help option (boolean).
+ * @property {string} help.short - The short flag for the help option (h).
+ * @property {boolean} help.default - The default value for help display (false).
+ * @property {Object} logLevel - Log level option.
+ * @property {string} logLevel.type - The type of the logLevel option (string).
+ * @property {string} logLevel.default - The default value for log level ("info").
+ * @property {Object} logStyle - Log styling option.
+ * @property {string} logStyle.type - The type of the logStyle option (boolean).
+ * @property {boolean} logStyle.default - The default value for log styling (true).
+ * @property {Object} timestamp - Timestamp display option.
+ * @property {string} timestamp.type - The type of the timestamp option (boolean).
+ * @property {boolean} timestamp.default - The default value for timestamp display (true).
+ * @property {Object} banner - Banner display option.
+ * @property {string} banner.type - The type of the banner option (boolean).
+ * @property {boolean} banner.default - The default value for banner display (false).
+ */
+export declare const DefaultCommandOptions: {
+    verbose: {
+        type: string;
+        short: string;
+        default: undefined;
+    };
+    version: {
+        type: string;
+        short: string;
+        default: undefined;
+    };
+    help: {
+        type: string;
+        short: string;
+        default: boolean;
+    };
+    logLevel: {
+        type: string;
+        default: string;
+    };
+    logStyle: {
+        type: string;
+        default: boolean;
+    };
+    timestamp: {
+        type: string;
+        default: boolean;
+    };
+    banner: {
+        type: string;
+        default: boolean;
+    };
+};
+/**
+ * @description Default command values derived from DefaultCommandOptions.
+ * @summary Creates an object with the default values of all options defined in DefaultCommandOptions.
+ * @const DefaultCommandValues
+ * @typedef {Object} DefaultCommandValues
+ * @property {unknown} [key: string] - The default value for each option in DefaultCommandOptions.
+ */
+export declare const DefaultCommandValues: {
+    [k in keyof typeof DefaultCommandOptions]: unknown;
+};

package/dist/types/cli/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./commands";
+export * from "./command";
+export * from "./constants";
+export * from "./types";

package/dist/types/cli/types.d.ts

@@ -0,0 +1,28 @@
+import { LoggingConfig } from "../output/types";
+import { ParseArgsOptionConfig } from "../input/types";
+/**
+ * @description Interface for input options.
+ * @summary Defines the structure of input options for CLI commands.
+ * @interface InputOptions
+ * @property {number} [verbose] - The verbosity level.
+ * @property {boolean} [version] - Flag to show version information.
+ * @property {boolean} [banner] - Flag to show banner.
+ * @property {boolean} [help] - Flag to show help information.
+ */
+export type InputOptions = {
+    verbose?: number;
+    version?: boolean;
+    banner?: boolean;
+    help?: boolean;
+};
+/**
+ * @description Type definition for command options.
+ * @summary Combines input options, input option configurations, and logging configurations into a single type.
+ * @template I - The type of additional input options specific to the command.
+ * @typedef {Object} CommandOptions
+ */
+export type CommandOptions<I> = I & Partial<{
+    [k in keyof InputOptions]: ParseArgsOptionConfig;
+}> & Partial<{
+    [k in keyof LoggingConfig]: ParseArgsOptionConfig;
+}>;

package/dist/types/index.d.ts

@@ -0,0 +1,39 @@
+export * from "./cli";
+export * from "./input";
+export * from "./output";
+export * from "./utils";
+export * from "./writers";
+/**
+ * @module @decaf-ts/utils
+ * @description
+ * This module serves a light version of Decaf CLI tool, providing a comprehensive set of utilities
+ * and functionalities for command-line interface operations. It encompasses several key components:
+ *
+ * 1. Input Handling: Manages user input and command-line arguments processing.
+ * 2. Utility Functions: Offers a collection of helper functions and constants for various operations.
+ * 3. Type Definitions: Defines custom types and interfaces used throughout the module.
+ * 4. Output Management: Provides different output writing strategies for flexible console output handling.
+ *
+ * The module is designed to facilitate the creation of robust CLI applications by offering:
+ * - Standardized input parsing and validation
+ * - Consistent output formatting and handling
+ * - Reusable utility functions for common CLI tasks
+ * - Extensible architecture for adding new commands and features
+ *
+ * It supports various output modes, including standard console output and regular expression-based output,
+ * allowing for versatile data presentation and processing. The modular structure enables easy maintenance
+ * and extension of the CLI functionality.
+ *
+ * This module is particularly useful for developers building complex command-line tools that require
+ * structured input handling, flexible output formatting, and a rich set of utility functions.
+ */
+/**
+ * @description Represents the current version of the module.
+ * @summary This constant stores the version number of the @asdasdasd/utils module.
+ * The actual version number is replaced during the build process,
+ * with the placeholder "0.1.6" being substituted with the current version.
+ *
+ * @const VERSION
+ * @memberOf module:@decaf-ts/utils
+ */
+export declare const VERSION = "0.1.6";

package/dist/types/input/index.d.ts

@@ -0,0 +1,2 @@
+export * from './input';
+export * from './types';