@gmb/bitmark-parser - v7.21.2
    Preparing search index...

    Interface TemplateOptions

    Options for template (PLAN-225): an empty, config-filtered skeleton of a bit — the tags an author usually writes (with their chains), the body and the card structure.

    interface TemplateOptions {
        all?: boolean;
        bit?: string;
        format?: TemplateFormat;
        full?: boolean;
        includeDeprecated?: boolean;
        indent?: number;
        pretty?: boolean;
    }
    Index
    all?: boolean

    Every authorable bit, both modes, every rendering, as one JSON object keyed by bit name ({ [bit]: { normal, full } }) — JSON whatever format says, except "snippet", which throws.

    bit?: string

    Bit name — required unless all is set.

    Output rendering (default "text"): plain bitmark with every value at its default, an LSP snippet (insertTextFormat: 2, ${n:default} placeholders, a choice for enums and booleans, $0 last), or the JSON slot model carrying both renderings.

    full?: boolean

    Every tag in the bit's set plus every attachable resource chain — the diagnostic dump, which validates with warnings. Default false: the normal template (required tags and tags flagged template in config).

    includeDeprecated?: boolean

    Keep deprecated tags (and, with all, deprecated bits). Default false.

    indent?: number

    Indent size for pretty-printing (default: 2).

    pretty?: boolean

    Whether to pretty-print JSON output (default: false).