burgee/completions

Completions, generated statically from the manifest (D2): bash, zsh, fish and PowerShell scripts that never run Node on TAB (D3), plus a Fig spec from the same walk (D5). Every script is deterministic for a manifest, so a snapshot pins it and the shell itself exercises it in CI (D4).

import { completionTree, renderFigSpec, renderCompletion, … } from 'burgee/completions';

FunctionsCopy Anchor Link

completionTreeCopy Anchor Link

The tree the templates walk; the root's own name is the program name.

function completionTree(manifest: Manifest): {
    program: string;
    root: Node;
};

Returns { program: string; root: Node; }

renderCompletionCopy Anchor Link

function renderCompletion(manifest: Manifest, shell: Shell): string;

Returns string

renderFigSpecCopy Anchor Link

A Fig spec (Fig.Spec) from the same walk (D5): one entry per node, children attached by path.

function renderFigSpec(manifest: Manifest): FigSubcommand;

Returns FigSubcommand

ConstantsCopy Anchor Link

SHELLSCopy Anchor Link

const SHELLS: readonly Shell[];

TypesCopy Anchor Link

ShellCopy Anchor Link

type Shell = 'bash' | 'zsh' | 'fish' | 'pwsh';