Noora Alerts

Use this skill when a Swift CLI needs concise, styled status messaging that should stand apart from raw print output.

Alert Shapes

Use these APIs:

let noora = Noora()

noora.warning(
    .alert(
        "Your token is about to expire",
        takeaway: "Generate a new token with \(.command("mycli auth refresh"))"
    )
)

noora.success(
    .alert(
        "Project initialized",
        takeaways: [
            "Run \(.command("swift build")) to verify the package.",
            "Open \(.command("Package.swift")) to review dependencies.",
        ]
    )
)

noora.error(
    .alert(
        "Deployment failed",
        takeaways: [
            "Verify the token passed to \(.command("deploy --token ...")).",
            "Check that the target environment is reachable.",
        ]
    )
)

noora.info(
    .alert(
        "The current version is up to date",
        takeaways: ["Consider enabling automatic updates."]
    )
)

Choosing the Right Alert

• warning: non-fatal issue or caution. Supports one takeaway per warning item.
• success: positive completion plus optional takeaways.
• error: failed action plus concrete next steps.
• info: neutral state or context worth surfacing.

Writing Good Alert Copy

• Keep the top-level message to one sentence.
• Put next steps in takeaways, not in the headline.
• Prefer 1 to 3 takeaways.
• Use TerminalText interpolation for commands and links.

Avoid

• Using alerts for every line of normal command output.
• Hiding actionable remediation inside a long paragraph.
• Using warning for a hard failure that should be error.