fomod/src/definitions/lib/FomodDocumentConfig.ts

A library for creating, parsing, editing, and validating XML-based Fomod installers, widely popularized in the Bethesda modding scene

export interface FomodDocumentConfig {
    /** [asElement] Whether or to include a third-party schema for Info.xml
     *
     * If a string is provided, we'll use that string as the schema location. Otherwise, we'll use the library's default.
     *
     * @default true
    */
    includeInfoSchema?: boolean|string;

    /** [asElement] Whether to move all conditional installs with only a dependency on a single option to the <files> tag of that option
     *
     * Note that this may cause slight performance issues with Vortex on slower machines.
     *
     * @default false
    */
    flattenConditionalInstalls?: boolean;

    /** [asElement] Whether to reorganize all conditional installs with no dependencies into the <requiredInstallFiles> tag
     *
     * @default false
    */
    flattenConditionalInstallsNoDependencies?: boolean;

    /** [asElement] Whether to remove conditional installs with no dependencies and no files (has no effect when `flattenConditionalInstallsNoDependencies` is `true`)
     *
     * @default true
    */
    removeEmptyConditionalInstalls?: boolean;

    /** [parse/asElement] String used for the flag value of option dependencies
     *
     * @default 'OPTION_SELECTED'
    */
    optionSelectedValue?: string;

    /** [parse] Whether to attempt to determine if a flag is an option flag to the best of our knowledge
     *
     * If `'loose'` is provided, we'll accept any flag name or value so long as it's only set by one option.
     *
     * @default true
    */
    parseOptionFlags?: boolean | 'loose';

    /**
     * [asElement] Whether to discard existing option flag names and generate new ones for all options
     *
     * @default false
     */
    generateNewOptionFlagNames?: boolean;
}

export const DefaultFomodDocumentConfig = {
    includeInfoSchema: true,
    flattenConditionalInstalls: false,
    flattenConditionalInstallsNoDependencies: false,
    removeEmptyConditionalInstalls: true,
    optionSelectedValue: 'OPTION_SELECTED',
    parseOptionFlags: true,
    generateNewOptionFlagNames: false,
} as const satisfies Required<FomodDocumentConfig>;