seniority/explain

import { explain, explanation, renderExplanation } from 'seniority/explain';

function explain(name: string, resolution: Resolution): string;

function explanation(key: string, resolution: ExplainedResolution): Explanation;

function renderExplanation(e: Explanation): string;

interface Explanation {
    /** The option asked about. */
    key: string;
    /** False when the command declares no such option — different from "declared and unset". */
    declared: boolean;
    /** The resolved value, or `undefined` when no source set one. */
    value: unknown;
    /** The candidate that won, or `undefined` when none did. */
    winner?: ExplainedCandidate;
    /** Every candidate, in `ORDER`. The truth table for this one option. */
    candidates: ExplainedCandidate[];
    /** Candidates that set a value and were outranked. */
    lost: ExplainedCandidate[];
    /**
     * Candidates that were consulted and had nothing. Kept apart from `lost` because
     * "the config file says `lib` and the flag beat it" and "there is no config file" are
     * different answers, and `--explain` exists to tell them apart.
     */
    unset: ExplainedCandidate[];
}