#ModuleConfig

Core configuration interface for the module system.

#Interface Definition

interface ModuleConfig {
    lib?: boolean;
    links?: Record<string, string>;
    imports?: ModuleConfigImportMapping;
    scopes?: Record<string, ModuleConfigImportMapping>;
    exports?: ModuleConfigExportExports;
}

#lib

• Type: boolean
• Description: Specifies whether the current module is in pure library mode. When set to true, the module will not automatically create default entry file exports (such as src/entry.client and src/entry.server).

Default Value: false

#links

• Type: Record<string, string>
• Description: Module linking configuration, where the key is the remote module name and the value is the module build artifact directory path.

#imports

• Type: ModuleConfigImportMapping
• Description: Module import mapping configuration, where the key is the local module identifier and the value is the remote module path. Supports environment-specific configuration.

#scopes

• Type: Record<string, ModuleConfigImportMapping>
• Description: Module scope mapping configuration, where the key is the directory path prefix and the value is the import mapping configuration within that scope.

#exports

• Type: ModuleConfigExportExports
• Description: Module export configuration. Supports multiple configuration formats.

#Type Definitions

#ModuleConfigImportMapping

type ModuleConfigImportMapping = Record<
    string,
    string | Record<BuildEnvironment, string>
>;

Import mapping configuration type, supporting string and environment-specific configurations.

#ModuleConfigExportExports

type ModuleConfigExportExports = ModuleConfigExportExport[];

Export configuration array type, supporting mixed arrays of strings and export objects.

#ModuleConfigExportExport

type ModuleConfigExportExport = string | ModuleConfigExportObject;

Export configuration item type, supporting both string and export object formats.

#ModuleConfigExportObject

type ModuleConfigExportObject = Record<
    string,
    ModuleConfigExportObjectValue
>;

Export object configuration type, where the key is the export name and the value is the export configuration value.

#ModuleConfigExportObjectValue

type ModuleConfigExportObjectValue =
    | string
    | Record<BuildEnvironment, string | boolean>;

Export configuration value type, supporting string and environment-specific configurations.

#BuildEnvironment

type BuildEnvironment = 'client' | 'server';

Build target environment type.

#Parsed Interfaces

#ParsedModuleConfig

interface ParsedModuleConfig {
    name: string;
    root: string;
    lib: boolean;
    links: Record<string, ParsedModuleConfigLink>;
    environments: {
        client: ParsedModuleConfigEnvironment;
        server: ParsedModuleConfigEnvironment;
    };
}

#lib

• Type: boolean
• Description: Whether the current module is in pure library mode.

#ParsedModuleConfigEnvironment

interface ParsedModuleConfigEnvironment {
    imports: Record<string, string>;
    exports: ParsedModuleConfigExports;
    scopes: Record<string, Record<string, string>>;
}

#ParsedModuleConfigLink

interface ParsedModuleConfigLink {
    name: string;
    root: string;
    client: string;
    clientManifestJson: string;
    server: string;
    serverManifestJson: string;
}

#ParsedModuleConfigExports

type ParsedModuleConfigExports = Record<
    string,
    ParsedModuleConfigExport
>;

Parsed export configuration record type, where the key is the export name and the value is the export configuration object.

#ParsedModuleConfigExport

interface ParsedModuleConfigExport {
    name: string;
    file: string;
    pkg: boolean;
}