Cell API
    Preparing search index...

    Interface ProjectInfo

    The result of cell info (docs/design/architecture.md §8): what the next cell build with the same flags would use.

    interface ProjectInfo {
        backend?: TargetSummary;
        build: {
            compile: false | CompileTarget;
            external: string[];
            format: "esm" | "cjs";
            outDir: string;
            single: boolean;
            sourcemap: boolean;
        };
        cellVersion: string;
        components: ComponentSummary[];
        configFile?: string;
        frontend?: TargetSummary;
        hooks: Record<string, string>;
        mode: string[];
        moduleOptions: string[];
        modules: ModuleSpec[];
        name: string;
        output: OutputSummary;
        preset: {
            available: string[];
            deployer?: string;
            description?: string;
            entry?: string;
            format?: "esm" | "cjs";
            name: string;
            runtime?: any;
            source: ValueSource;
        };
        root: string;
        targets: Target[];
        targetSources: Partial<Record<TestApp, string[]>>;
        toolchainModules: ModuleRegistrations[];
        version: string;
    }
    Index
    backend? build cellVersion components configFile? frontend? hooks mode moduleOptions modules name output preset root targets targetSources toolchainModules version
    backend?: TargetSummary
    build: {
        compile: false | CompileTarget;
        external: string[];
        format: "esm" | "cjs";
        outDir: string;
        single: boolean;
        sourcemap: boolean;
    }
    cellVersion: string
    components: ComponentSummary[]
    configFile?: string

    cell.config file, relative to the root.

    frontend?: TargetSummary
    hooks: Record<string, string>

    Project hooks by event. cell info lists them and never runs them.

    mode: string[]
    moduleOptions: string[]

    Keys of toolchain module options in cell.config.ts.

    modules: ModuleSpec[]

    The modules entries of cell.config.ts.

    name: string
    output: OutputSummary
    preset: {
        available: string[];
        deployer?: string;
        description?: string;
        entry?: string;
        format?: "esm" | "cjs";
        name: string;
        runtime?: any;
        source: ValueSource;
    }

    Type Declaration

    • available: string[]
    • Optionaldeployer?: string

      Deployer of cell deploy; none means the output is run by hand.

    • Optionaldescription?: string
    • Optionalentry?: string
    • Optionalformat?: "esm" | "cjs"
    • name: string
    • Optionalruntime?: any
    • source: ValueSource
    root: string
    targets: Target[]
    targetSources: Partial<Record<TestApp, string[]>>

    Why each target is built: cell.config.ts, default (the backend) or the components that declare it.

    toolchainModules: ModuleRegistrations[]

    Toolchain modules in load order and what each registered (docs/design/modules.md §3.5); file is relative to the root.

    version: string

    Settings
    Member Visibility

    On This Page
    Properties