Member Junction
    Preparing search index...
    interface AdoptOptions {
        AddNpmScript?: boolean;
        Ci?: "github" | "none";
        DeclareCompliant?: boolean;
        DryRun?: boolean;
        OnlyChecks?: string[];
        RepoRoot: string;
        Upgrade?: boolean;
        Version: string;
    }
    Index

    Properties

    AddNpmScript?: boolean

    Add an mj:standards npm script to package.json.

    Ci?: "github" | "none"

    Also write a CI workflow.

    DeclareCompliant?: boolean

    Declare mjUILayer on packages that already comply.

    Without this, a fresh adoption produces a config that enforces nothing — every package is undeclared, so every package is skipped, and the repo gets a green check that means nothing. Declaring the already-clean packages is what makes the first run honest.

    DryRun?: boolean

    Report what would happen, change nothing.

    OnlyChecks?: string[]

    Limit to these check ids. Empty means "every check at or below Version".

    RepoRoot: string
    Upgrade?: boolean

    Review and enable standards newer than the repo's recorded StandardsVersion, and bump it. Without this, adopt on a configured repo leaves the version line alone — which is what makes upgrading the package safe.

    Version: string

    The version being adopted against — normally the installed MJ/CLI version.