Documentation
    Preparing search index...

    Interface AutoMetadataOptions

    interface AutoMetadataOptions {
        fallbackEntries?: Record<string, string>;
        keysFromWorkspace?: string[];
        logger?: Logger<unknown>;
        mandatoryKeys?: string[];
        overrideEntries?: Record<string, string>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    fallbackEntries? keysFromWorkspace? logger? mandatoryKeys? overrideEntries?

    Properties

    fallbackEntries?: Record<string, string>

    A set of key value pairs that will only be used as packageJson values when not found in the workspace packageJson

    {}
    keysFromWorkspace?: string[]

    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

    DEFAULT_AUTO_METADATA_KEYS_FROM_WORKSPACE - ["license", "author", "homepage", "bugs", "keywords", "config", "engines"]
    logger?: Logger<unknown>

    An optional Logger target.

    undefined
    mandatoryKeys?: string[]

    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!

    DEFAULT_AUTO_METADATA_MANDATORY_KEYS - ["name", "description", "version"]
    overrideEntries?: Record<string, string>

    A set of key value pairs that will always be used and overwrite everything else

    {}

    Settings

    Member Visibility

    On This Page

    Properties