Skip to content

The design language that makes your AI harness better at design.

JavaScript
3.2 KB
Raw Blame
//! impeccable-detect: `impeccable detect` orchestration and the non-DOM
//! engines, ported from `cli/bin/cli.js`, `cli/engine/cli/main.mjs`,
//! `cli/engine/node/file-system.mjs`, `cli/lib/impeccable-config.mjs`,
//! `cli/engine/engines/regex/detect-text.mjs`, `cli/engine/design-system.mjs`,
//! `cli/engine/profile/profiler.mjs`, and `cli/bin/commands/ignores.mjs`.
//!
//! Engine seams: [`engines::HtmlEngine`] (static HTML, crates/html) and
//! [`engines::UrlEngine`] (browser, crates/browser). This crate never depends
//! on those crates; the `cli` binary wires them in through
//! [`engines::Engines`]. crates/html depends on this crate for the design
//! system types and helpers ([`design_system`]).

pub mod cdp_endpoint;
pub mod cli;
pub mod config;
pub mod design_system;
pub mod detect_text;
pub mod engines;
pub mod file_system;
pub mod github_annotations;
pub mod ignores;
pub mod jsp;
pub mod list_rules;
pub mod profiler;
pub mod project_tokens;
pub mod regex_matchers;
pub mod skills;
pub mod util;

use impeccable_common::Io;

pub use engines::{
    Engines, HtmlEngine, MissingHtmlEngine, MissingUrlEngine, ScanOptions, UrlEngine,
};

/// `impeccable detect [args]` (`detectCli`). Returns the exit code.
pub fn run_detect(args: &[String], io: &mut Io, engines: &Engines) -> i32 {
    cli::run_detect(args, io, engines)
}

/// `impeccable ignores [args]`.
pub fn run_ignores(args: &[String], io: &mut Io) -> i32 {
    ignores::run(args, io)
}

/// `impeccable skills [args]` and the top-level `help|install|link|update|check`.
pub fn run_skills(args: &[String], io: &mut Io) -> i32 {
    skills::run(args, io)
}

/// JS: cli.js#looksLikeDetectTarget
pub fn looks_like_detect_target(arg: &str, cwd: &str) -> bool {
    let is_flag = arg.starts_with('-');
    let is_url = {
        let lower = arg.to_ascii_lowercase();
        lower.starts_with("http://") || lower.starts_with("https://")
    };
    let is_path_shaped = arg.contains('/') || arg.contains('\\') || arg.contains('.');
    let is_existing = util::exists(&jsp::resolve(cwd, &[arg]));
    is_flag || is_url || is_path_shaped || is_existing
}

/// The root `impeccable --help` text (`cli.js`).
pub const ROOT_USAGE: &str = "Usage: impeccable <command> [options]

Commands:
  detect [file-or-dir-or-url...]   Scan for UI anti-patterns and design quality issues
  ignores                          Manage detector ignore rules, files, and values
  help                             List all available skills and commands
  install                          Install impeccable skills into your project or global harness
  link                             Symlink skills from a local checkout or submodule
  update                           Update skills to the latest version
  check                            Check if skill updates are available
  telemetry off|on|status          Turn the roll API's anonymous usage data off or on, or show it

Options:
  --help       Show this help message
  --version    Show version number

Compatibility:
  impeccable skills <command>       Legacy namespace; still supported.
";

/// The `impeccable init` mistake message (`cli.js`).
pub const INIT_MESSAGE: &str = "\"init\" is not a CLI command. Type /impeccable init in your AI coding agent's chat (Claude Code, Cursor, Codex, ...), not in this terminal.\n";