@rzl-zone/build-tools 0.0.5

package/dist/index-CzxZta4Z.d.ts

@@ -0,0 +1,356 @@
+/*!
+* ========================================================================
+*  @rzl-zone/build-tools
+* ------------------------------------------------------------------------
+*  Version: `0.0.5`
+*  Author: `Rizalvin Dwiky <rizalvindwiky1998@gmail.com>`
+*  Repository: `https://github.com/rzl-zone/rzl-zone/tree/main/packages/build-tools`
+* ========================================================================
+*/
+
+/** ----------------------------------------------------------------
+* * ***Options for generating a utility command title.***
+* ----------------------------------------------------------------
+*
+* Used by `CommandIdentity.utility()`.
+*/
+type CommandUtilityTitleOptions = {
+  /** ----------------------------------------------------------------
+  * * ***Command name displayed in the title.***
+  * ----------------------------------------------------------------
+  *
+  * Overrides the default command name provided in the constructor.
+  *
+  * @example
+  * ```ts
+  * { commandName: "fix-dts-react-import" }
+  * ```
+  */
+  commandName?: string;
+  /** ----------------------------------------------------------------
+  * * ***Optional arrow icon override.***
+  * ----------------------------------------------------------------
+  *
+  * If provided, this icon replaces the generator's
+  * `defaultIconArrow` for this call only.
+  *
+  * @example
+  * ```ts
+  * { iconArrow: "⇒" }
+  * ```
+  */
+  iconArrow?: string;
+  /** ----------------------------------------------------------------
+  * * ***Package name prefix.***
+  * ----------------------------------------------------------------
+  *
+  * Displayed at the beginning of every generated title.
+  *
+  * @default "@rzl-zone/build-tools"
+  */
+  packageName?: string;
+};
+/** ----------------------------------------------------------------
+* * ***Options for generating a CLI command title.***
+* ----------------------------------------------------------------
+*
+* Used by `CommandIdentity.cli()`
+*/
+type CommandCliTitleOptions = Omit<CommandUtilityTitleOptions, "packageName"> & {
+  /** ----------------------------------------------------------------
+  * * ***Package name prefix.***
+  * ----------------------------------------------------------------
+  *
+  * Overrides the resolved CLI package name for this call only.
+  *
+  * @default "@rzl-zone/build-tools-cli"
+  */
+  packageName?: string;
+};
+/** ----------------------------------------------------------------
+* * ***Global configuration for command identity formatting.***
+* ----------------------------------------------------------------
+*
+* Defines the default identity behavior applied to
+* all generated CLI and utility titles.
+*/
+type CommandIdentityOptions = {
+  /** ----------------------------------------------------------------
+  * * ***Default command name.***
+  * ----------------------------------------------------------------
+  *
+  * Used when a command name is not provided in the respective in method `CommandIdentity.cli()` and `CommandIdentity.utility()` options.
+  *
+  * @example
+  * ```ts
+  * defaultCommandName: "fix-dts-react-import"
+  * ```
+  */
+  defaultCommandName: string;
+  /** ----------------------------------------------------------------
+  * * ***Package name prefix.***
+  * ----------------------------------------------------------------
+  *
+  * Optional base package name used for title generation.
+  *
+  * If not provided, an internal default will be resolved
+  * depending on the title type (`CLI` or `utility`).
+  */
+  packageName?: string;
+  /** ----------------------------------------------------------------
+  * * ***Package version.***
+  * ----------------------------------------------------------------
+  *
+  * Optional version displayed alongside the package name
+  * in generated titles.
+  *
+  * If not provided, a default version will be resolved internally.
+  *
+  * @example
+  * ```ts
+  * version: "1.2.0"
+  * ```
+  */
+  version?: string;
+  /** ----------------------------------------------------------------
+  * * ***Label for CLI commands.***
+  * ----------------------------------------------------------------
+  *
+  * Optional label displayed between
+  * the package name and arrow icon for CLI titles.
+  */
+  cliLabel?: string;
+  /** ----------------------------------------------------------------
+  * * ***Label for utility commands.***
+  * ----------------------------------------------------------------
+  *
+  * Optional label displayed between
+  * the package name and arrow icon for utility titles.
+  */
+  utilityLabel?: string;
+  /** ----------------------------------------------------------------
+  * * ***Default arrow icon.***
+  * ----------------------------------------------------------------
+  *
+  * Icon displayed between the label and command name.
+  *
+  * @default
+  * "▶️"
+  * // or
+  * "▶"
+  */
+  defaultIconArrow?: string;
+};
+/** ----------------------------------------------------------------
+* * ***Command identity formatter with consistent CLI styling.***
+* ----------------------------------------------------------------
+*
+* Responsible for generating formatted and colorized
+* command titles for CLI and utility commands.
+*
+* - ***Each generated title may include:***
+*      - Package name.
+*      - Optional label (CLI / utility).
+*      - Arrow icon.
+*      - Command name.
+*      - Package version.
+*
+* ---
+*
+* @example
+* ```ts
+* const identity = new CommandIdentity({
+*   defaultCommandName: "fix-dts-react-import"
+* });
+*
+* identity.cli();
+* // => "@rzl-zone/build-tools-cli@<version> ➔ fix-dts-react-import"
+*
+* identity.utility({ commandName: "clean-dist" });
+* // => "@rzl-zone/build-tools@<version> ➔ clean-dist"
+* ```
+*
+* @example
+* ```ts
+* const identity = new CommandIdentity({
+*   defaultCommandName: "build",
+*   version: "2.1.0"
+* });
+*
+* identity.cli();
+* // => "@rzl-zone/build-tools-cli@2.1.0 ➔ build"
+*
+* identity.utility({ commandName: "clean-dist" });
+* // => "@rzl-zone/build-tools@2.1.0 ➔ clean-dist"
+* ```
+*/
+declare class CommandIdentity {
+  /** ----------------------------------------------------------------
+  * * ***Create a new command identity instance.***
+  * ----------------------------------------------------------------
+  *
+  * Initializes global identity configuration
+  * used by `CommandIdentity.cli()` and `CommandIdentity.utility()`.
+  *
+  * ---
+  *
+  * @param {CommandIdentityOptions} options - Global identity configuration.
+  * @throws {Error} If `options.defaultCommandName` is missing or empty.
+  *
+  * ---
+  *
+  * @example
+  * ```ts
+  * const identity = new CommandIdentity({
+  *   defaultCommandName: "fix-dts-react-import"
+  * });
+  *
+  * identity.cli();
+  * // => "@rzl-zone/build-tools-cli@<version> ➔ fix-dts-react-import"
+  *
+  * identity.utility({ commandName: "clean-dist" });
+  * // => "@rzl-zone/build-tools@<version> ➔ clean-dist"
+  * ```
+  *
+  * @example
+  * ```ts
+  * const identity = new CommandIdentity({
+  *   defaultCommandName: "build",
+  *   version: "2.1.0"
+  * });
+  *
+  * identity.cli();
+  * // => "@rzl-zone/build-tools-cli@2.1.0 ➔ build"
+  *
+  * identity.utility({ commandName: "clean-dist" });
+  * // => "@rzl-zone/build-tools@2.1.0 ➔ clean-dist"
+  * ```
+  */
+  constructor(options: CommandIdentityOptions);
+  /** ----------------------------------------------------------------
+  * * ***Generate a CLI command title.***
+  * ----------------------------------------------------------------
+  *
+  * Uses the CLI default package (unless overridden)
+  * and applies CLI-specific labeling.
+  *
+  * @param {CommandCliTitleOptions} options - CLI title configuration.
+  *
+  * @example
+  * ```ts
+  * identity.cli();
+  * identity.cli({ commandName: "build" });
+  * ```
+  */
+  cli(options?: CommandCliTitleOptions): string;
+  /** ----------------------------------------------------------------
+  * * ***Generate a utility command title.***
+  * ----------------------------------------------------------------
+  *
+  * Uses the utility default package (unless overridden)
+  * and applies utility-specific labeling.
+  *
+  * @param {CommandUtilityTitleOptions} options - Utility title configuration.
+  *
+  * @example
+  * ```ts
+  * identity.utility();
+  * identity.utility({ commandName: "clean-dist", iconArrow: "⇒" });
+  * ```
+  */
+  utility(options?: CommandUtilityTitleOptions): string;
+  /** ----------------------------------------------------------------
+  * * ***Package name.***
+  * ----------------------------------------------------------------
+  *
+  * Returns the effective package name used for title generation.
+  *
+  * If a custom package name has been provided via the constructor
+  * or `CommandIdentity.setPackageName()`, that value will be returned.
+  * Otherwise, an internal default package name (as utility) is used.
+  *
+  * @readonly
+  */
+  get packageName(): string;
+  /** ----------------------------------------------------------------
+  * * ***Set package name.***
+  * ----------------------------------------------------------------
+  *
+  * Assigns a custom package name to be used for title generation.
+  *
+  * - *This value overrides:*
+  *     - Any package name provided in the constructor.
+  *     - The internal default package name.
+  *
+  * Once set, this value will be returned by the `CommandIdentity.packageName`
+  * getter and used by `CommandIdentity.cli()` and
+  * `CommandIdentity.utility()` unless explicitly
+  * overridden per method call.
+  *
+  * @param value - The new package name to assign.
+  * @returns The current instance for fluent chaining.
+  */
+  setPackageName(value: string): this;
+  /** ----------------------------------------------------------------
+  * * ***Command name.***
+  * ----------------------------------------------------------------
+  *
+  * Returns the current command name used for title generation.
+  *
+  * This value is initialized via the constructor and may be
+  * updated later using
+  * `CommandIdentity.setCommandName()`.
+  *
+  * @readonly
+  */
+  get commandName(): string;
+  /** ----------------------------------------------------------------
+  * * ***Set command name.***
+  * ----------------------------------------------------------------
+  *
+  * Updates the command name used for title generation.
+  *
+  * This overrides the command name provided in the constructor
+  * and affects subsequent calls to
+  * `CommandIdentity.cli()`
+  * and `CommandIdentity.utility()`,
+  * unless a command name is explicitly provided per method call.
+  *
+  * @param value - The new command name to assign.
+  * @returns The current instance for fluent chaining.
+  */
+  setCommandName(value: string): this;
+  /** ----------------------------------------------------------------
+  * * ***Package version.***
+  * ----------------------------------------------------------------
+  *
+  * Returns the effective version used for title generation.
+  *
+  * - *Resolution order:*
+  *    1. If a custom version has been provided via the constructor
+  *       or `CommandIdentity.setVersion()`,
+  *       that value will be returned.
+  *    2. Otherwise, the version falls back to the internally
+  *       resolved default package version.
+  *
+  * A version value is always guaranteed to be present.
+  *
+  * @readonly
+  */
+  get version(): string;
+  /** ----------------------------------------------------------------
+  * * ***Set package version.***
+  * ----------------------------------------------------------------
+  *
+  * Overrides the version used for title generation.
+  *
+  * If an empty or invalid value is provided,
+  * the version will remain unchanged.
+  *
+  * @param value - The new version to assign.
+  * @returns The current instance for fluent chaining.
+  */
+  setVersion(value: string): this;
+}
+export { CommandIdentity as t };
+//# sourceMappingURL=index-CzxZta4Z.d.ts.map

package/dist/index-Idak1iwg.d.cts

@@ -0,0 +1,356 @@
+/*!
+* ========================================================================
+*  @rzl-zone/build-tools
+* ------------------------------------------------------------------------
+*  Version: `0.0.5`
+*  Author: `Rizalvin Dwiky <rizalvindwiky1998@gmail.com>`
+*  Repository: `https://github.com/rzl-zone/rzl-zone/tree/main/packages/build-tools`
+* ========================================================================
+*/
+
+/** ----------------------------------------------------------------
+* * ***Options for generating a utility command title.***
+* ----------------------------------------------------------------
+*
+* Used by `CommandIdentity.utility()`.
+*/
+type CommandUtilityTitleOptions = {
+  /** ----------------------------------------------------------------
+  * * ***Command name displayed in the title.***
+  * ----------------------------------------------------------------
+  *
+  * Overrides the default command name provided in the constructor.
+  *
+  * @example
+  * ```ts
+  * { commandName: "fix-dts-react-import" }
+  * ```
+  */
+  commandName?: string;
+  /** ----------------------------------------------------------------
+  * * ***Optional arrow icon override.***
+  * ----------------------------------------------------------------
+  *
+  * If provided, this icon replaces the generator's
+  * `defaultIconArrow` for this call only.
+  *
+  * @example
+  * ```ts
+  * { iconArrow: "⇒" }
+  * ```
+  */
+  iconArrow?: string;
+  /** ----------------------------------------------------------------
+  * * ***Package name prefix.***
+  * ----------------------------------------------------------------
+  *
+  * Displayed at the beginning of every generated title.
+  *
+  * @default "@rzl-zone/build-tools"
+  */
+  packageName?: string;
+};
+/** ----------------------------------------------------------------
+* * ***Options for generating a CLI command title.***
+* ----------------------------------------------------------------
+*
+* Used by `CommandIdentity.cli()`
+*/
+type CommandCliTitleOptions = Omit<CommandUtilityTitleOptions, "packageName"> & {
+  /** ----------------------------------------------------------------
+  * * ***Package name prefix.***
+  * ----------------------------------------------------------------
+  *
+  * Overrides the resolved CLI package name for this call only.
+  *
+  * @default "@rzl-zone/build-tools-cli"
+  */
+  packageName?: string;
+};
+/** ----------------------------------------------------------------
+* * ***Global configuration for command identity formatting.***
+* ----------------------------------------------------------------
+*
+* Defines the default identity behavior applied to
+* all generated CLI and utility titles.
+*/
+type CommandIdentityOptions = {
+  /** ----------------------------------------------------------------
+  * * ***Default command name.***
+  * ----------------------------------------------------------------
+  *
+  * Used when a command name is not provided in the respective in method `CommandIdentity.cli()` and `CommandIdentity.utility()` options.
+  *
+  * @example
+  * ```ts
+  * defaultCommandName: "fix-dts-react-import"
+  * ```
+  */
+  defaultCommandName: string;
+  /** ----------------------------------------------------------------
+  * * ***Package name prefix.***
+  * ----------------------------------------------------------------
+  *
+  * Optional base package name used for title generation.
+  *
+  * If not provided, an internal default will be resolved
+  * depending on the title type (`CLI` or `utility`).
+  */
+  packageName?: string;
+  /** ----------------------------------------------------------------
+  * * ***Package version.***
+  * ----------------------------------------------------------------
+  *
+  * Optional version displayed alongside the package name
+  * in generated titles.
+  *
+  * If not provided, a default version will be resolved internally.
+  *
+  * @example
+  * ```ts
+  * version: "1.2.0"
+  * ```
+  */
+  version?: string;
+  /** ----------------------------------------------------------------
+  * * ***Label for CLI commands.***
+  * ----------------------------------------------------------------
+  *
+  * Optional label displayed between
+  * the package name and arrow icon for CLI titles.
+  */
+  cliLabel?: string;
+  /** ----------------------------------------------------------------
+  * * ***Label for utility commands.***
+  * ----------------------------------------------------------------
+  *
+  * Optional label displayed between
+  * the package name and arrow icon for utility titles.
+  */
+  utilityLabel?: string;
+  /** ----------------------------------------------------------------
+  * * ***Default arrow icon.***
+  * ----------------------------------------------------------------
+  *
+  * Icon displayed between the label and command name.
+  *
+  * @default
+  * "▶️"
+  * // or
+  * "▶"
+  */
+  defaultIconArrow?: string;
+};
+/** ----------------------------------------------------------------
+* * ***Command identity formatter with consistent CLI styling.***
+* ----------------------------------------------------------------
+*
+* Responsible for generating formatted and colorized
+* command titles for CLI and utility commands.
+*
+* - ***Each generated title may include:***
+*      - Package name.
+*      - Optional label (CLI / utility).
+*      - Arrow icon.
+*      - Command name.
+*      - Package version.
+*
+* ---
+*
+* @example
+* ```ts
+* const identity = new CommandIdentity({
+*   defaultCommandName: "fix-dts-react-import"
+* });
+*
+* identity.cli();
+* // => "@rzl-zone/build-tools-cli@<version> ➔ fix-dts-react-import"
+*
+* identity.utility({ commandName: "clean-dist" });
+* // => "@rzl-zone/build-tools@<version> ➔ clean-dist"
+* ```
+*
+* @example
+* ```ts
+* const identity = new CommandIdentity({
+*   defaultCommandName: "build",
+*   version: "2.1.0"
+* });
+*
+* identity.cli();
+* // => "@rzl-zone/build-tools-cli@2.1.0 ➔ build"
+*
+* identity.utility({ commandName: "clean-dist" });
+* // => "@rzl-zone/build-tools@2.1.0 ➔ clean-dist"
+* ```
+*/
+declare class CommandIdentity {
+  /** ----------------------------------------------------------------
+  * * ***Create a new command identity instance.***
+  * ----------------------------------------------------------------
+  *
+  * Initializes global identity configuration
+  * used by `CommandIdentity.cli()` and `CommandIdentity.utility()`.
+  *
+  * ---
+  *
+  * @param {CommandIdentityOptions} options - Global identity configuration.
+  * @throws {Error} If `options.defaultCommandName` is missing or empty.
+  *
+  * ---
+  *
+  * @example
+  * ```ts
+  * const identity = new CommandIdentity({
+  *   defaultCommandName: "fix-dts-react-import"
+  * });
+  *
+  * identity.cli();
+  * // => "@rzl-zone/build-tools-cli@<version> ➔ fix-dts-react-import"
+  *
+  * identity.utility({ commandName: "clean-dist" });
+  * // => "@rzl-zone/build-tools@<version> ➔ clean-dist"
+  * ```
+  *
+  * @example
+  * ```ts
+  * const identity = new CommandIdentity({
+  *   defaultCommandName: "build",
+  *   version: "2.1.0"
+  * });
+  *
+  * identity.cli();
+  * // => "@rzl-zone/build-tools-cli@2.1.0 ➔ build"
+  *
+  * identity.utility({ commandName: "clean-dist" });
+  * // => "@rzl-zone/build-tools@2.1.0 ➔ clean-dist"
+  * ```
+  */
+  constructor(options: CommandIdentityOptions);
+  /** ----------------------------------------------------------------
+  * * ***Generate a CLI command title.***
+  * ----------------------------------------------------------------
+  *
+  * Uses the CLI default package (unless overridden)
+  * and applies CLI-specific labeling.
+  *
+  * @param {CommandCliTitleOptions} options - CLI title configuration.
+  *
+  * @example
+  * ```ts
+  * identity.cli();
+  * identity.cli({ commandName: "build" });
+  * ```
+  */
+  cli(options?: CommandCliTitleOptions): string;
+  /** ----------------------------------------------------------------
+  * * ***Generate a utility command title.***
+  * ----------------------------------------------------------------
+  *
+  * Uses the utility default package (unless overridden)
+  * and applies utility-specific labeling.
+  *
+  * @param {CommandUtilityTitleOptions} options - Utility title configuration.
+  *
+  * @example
+  * ```ts
+  * identity.utility();
+  * identity.utility({ commandName: "clean-dist", iconArrow: "⇒" });
+  * ```
+  */
+  utility(options?: CommandUtilityTitleOptions): string;
+  /** ----------------------------------------------------------------
+  * * ***Package name.***
+  * ----------------------------------------------------------------
+  *
+  * Returns the effective package name used for title generation.
+  *
+  * If a custom package name has been provided via the constructor
+  * or `CommandIdentity.setPackageName()`, that value will be returned.
+  * Otherwise, an internal default package name (as utility) is used.
+  *
+  * @readonly
+  */
+  get packageName(): string;
+  /** ----------------------------------------------------------------
+  * * ***Set package name.***
+  * ----------------------------------------------------------------
+  *
+  * Assigns a custom package name to be used for title generation.
+  *
+  * - *This value overrides:*
+  *     - Any package name provided in the constructor.
+  *     - The internal default package name.
+  *
+  * Once set, this value will be returned by the `CommandIdentity.packageName`
+  * getter and used by `CommandIdentity.cli()` and
+  * `CommandIdentity.utility()` unless explicitly
+  * overridden per method call.
+  *
+  * @param value - The new package name to assign.
+  * @returns The current instance for fluent chaining.
+  */
+  setPackageName(value: string): this;
+  /** ----------------------------------------------------------------
+  * * ***Command name.***
+  * ----------------------------------------------------------------
+  *
+  * Returns the current command name used for title generation.
+  *
+  * This value is initialized via the constructor and may be
+  * updated later using
+  * `CommandIdentity.setCommandName()`.
+  *
+  * @readonly
+  */
+  get commandName(): string;
+  /** ----------------------------------------------------------------
+  * * ***Set command name.***
+  * ----------------------------------------------------------------
+  *
+  * Updates the command name used for title generation.
+  *
+  * This overrides the command name provided in the constructor
+  * and affects subsequent calls to
+  * `CommandIdentity.cli()`
+  * and `CommandIdentity.utility()`,
+  * unless a command name is explicitly provided per method call.
+  *
+  * @param value - The new command name to assign.
+  * @returns The current instance for fluent chaining.
+  */
+  setCommandName(value: string): this;
+  /** ----------------------------------------------------------------
+  * * ***Package version.***
+  * ----------------------------------------------------------------
+  *
+  * Returns the effective version used for title generation.
+  *
+  * - *Resolution order:*
+  *    1. If a custom version has been provided via the constructor
+  *       or `CommandIdentity.setVersion()`,
+  *       that value will be returned.
+  *    2. Otherwise, the version falls back to the internally
+  *       resolved default package version.
+  *
+  * A version value is always guaranteed to be present.
+  *
+  * @readonly
+  */
+  get version(): string;
+  /** ----------------------------------------------------------------
+  * * ***Set package version.***
+  * ----------------------------------------------------------------
+  *
+  * Overrides the version used for title generation.
+  *
+  * If an empty or invalid value is provided,
+  * the version will remain unchanged.
+  *
+  * @param value - The new version to assign.
+  * @returns The current instance for fluent chaining.
+  */
+  setVersion(value: string): this;
+}
+export { CommandIdentity as t };
+//# sourceMappingURL=index-Idak1iwg.d.cts.map