react-zeroconfig/types.d.ts

# 🚀 Quick Start

import { PackageJson } from 'type-fest';
export declare const packageCommands: readonly ["build", "publish", "validate", "list", "sync"];
export declare const webappCommands: readonly ["build", "start", "server-watch", "server-start", "browser-start"];
export declare const desktopappCommands: readonly ["build", "start", "electron-watch", "electron-start"];
export declare const extensionCommands: readonly ["build", "watch"];
export declare const modes: readonly ["production", "development"];
export declare type PackageCommand = typeof packageCommands[number];
export declare type WebappCommand = typeof webappCommands[number];
export declare type DesktopappCommand = typeof desktopappCommands[number];
export declare type ExtensionCommand = typeof extensionCommands[number];
export declare type Mode = typeof modes[number];
export declare function isPackageCommand(command: string): command is PackageCommand;
export declare function isWebappCommand(command: string): command is WebappCommand;
export declare function isDesktopappCommand(command: string): command is DesktopappCommand;
export declare function isExtensionCommand(command: string): command is ExtensionCommand;
export declare function isMode(mode: string | undefined): mode is Mode;
export interface PackageArgv {
    command: PackageCommand;
    choice: boolean;
}
export interface PackageBuildOption {
    /** module name is package.json name */
    name: string;
    /** absolute index file location */
    file: string;
    /** build typescript declarations */
    buildTypescriptDeclaration: boolean;
    /** external libraries */
    externals: string[];
}
export interface PackagePublishOption {
    /** module name is package.json name */
    name: string;
    /** tag (eg. latest, alpha, beta) */
    tag: string;
    /** current package.json */
    currentPackageJson: PackageJson;
    /** remote package.json */
    remotePackageJson: PackageJson | undefined;
}
export interface WebappArgv {
    command: WebappCommand;
    app: string;
    sourceMap: boolean | undefined;
    staticFileDirectories: string | undefined;
    staticFilePackages: string | undefined;
    sizeReport: boolean;
    mode: Mode;
    output: string | undefined;
    appFileName: string;
    vendorFileName: string;
    styleFileName: string;
    chunkPath: string;
    publicPath: string;
    internalEslint: boolean;
    port: number;
    serverPort: number;
    https: boolean | {
        key: string;
        cert: string;
    };
}
export interface WebappConfig {
    command: WebappCommand;
    app: string;
    sourceMap: boolean | undefined;
    staticFileDirectories: string[];
    sizeReport: boolean;
    mode: Mode;
    output: string;
    appFileName: string;
    vendorFileName: string;
    styleFileName: string;
    chunkPath: string;
    publicPath: string;
    internalEslint: boolean;
    port: number;
    serverPort: number;
    https: boolean | {
        key: string;
        cert: string;
    };
    cwd: string;
    zeroconfigPath: string;
    extend: {
        serverSideRendering: boolean;
        templateFiles: string[];
    };
}
export interface DesktopappArgv {
    command: DesktopappCommand;
    app: string;
    mode: Mode;
    sourceMap: boolean | undefined;
    output: string | undefined;
    staticFileDirectories: string | undefined;
    staticFilePackages: string | undefined;
}
export interface DesktopappConfig {
    command: DesktopappCommand;
    app: string;
    sourceMap: boolean | undefined;
    staticFileDirectories: string[];
    mode: Mode;
    output: string;
    cwd: string;
    zeroconfigPath: string;
    extend: {
        templateFiles: string[];
    };
}
export interface ExtensionArgv {
    command: ExtensionCommand;
    app: string;
    output: string | undefined;
    vendorFileName: string;
    styleFileName: string;
    staticFileDirectories: string | undefined;
    staticFilePackages: string | undefined;
}
export interface ExtensionConfig {
    command: ExtensionCommand;
    app: string;
    output: string;
    vendorFileName: string;
    styleFileName: string;
    staticFileDirectories: string[];
    entryFiles: string[];
    cwd: string;
    zeroconfigPath: string;
    extend: {
        templateFiles: string[];
    };
}