@pakk/core/plugins/metadata/auto-metadata.class.options.d.ts

The core library of pakk, that can manage your package.json for library development.

import { LoggerOption } from '@alexaegis/logging';
export interface AutoMetadataOptions extends LoggerOption {
    /**
     * ### AutoMetadata
     *
     * A list of packageJson keys from the workspace root package.json to
     * autofill in built artifacts
     *
     * Keys already present in the package's packageJson file will take
     * precendence if they are objects or arrays, otherwise overwritten
     *
     * @defaultValue DEFAULT_AUTO_METADATA_KEYS_FROM_WORKSPACE - ["license", "author", "homepage", "bugs", "keywords", "config", "engines"]
     */
    keysFromWorkspace?: string[];
    /**
     * ### AutoMetadata
     *
     * Keys that you must define yourself. This plugin can't figure them out
     * for you, but it can add their keys as empty values into the source
     * packageJson. When one is missing or empty, the build is aborted!
     *
     * @defaultValue DEFAULT_AUTO_METADATA_MANDATORY_KEYS - ["name", "description", "version"]
     */
    mandatoryKeys?: string[];
    /**
     * ### AutoMetadata
     *
     * A set of key value pairs that will only be used as packageJson values
     * when not found in the workspace packageJson
     *
     * @defaultValue {}
     */
    fallbackEntries?: Record<string, string>;
    /**
     * ### AutoMetadata
     *
     * A set of key value pairs that will always be used and overwrite
     * everything else
     *
     * @defaultValue {}
     */
    overrideEntries?: Record<string, string>;
}
export declare const DEFAULT_AUTO_METADATA_KEYS_FROM_WORKSPACE: string[];
export declare const DEFAULT_AUTO_METADATA_MANDATORY_KEYS: string[];
export type NormalizedAutoMetadataOptions = Required<AutoMetadataOptions>;
export declare const normalizeAutoMetadataOptions: (options?: AutoMetadataOptions) => NormalizedAutoMetadataOptions;
//# sourceMappingURL=auto-metadata.class.options.d.ts.map