vize_canon

The Canon - TypeScript type checking for Vue SFCs

Name Origin

Canon (/ˈkænən/) in art refers to a set of ideal proportions or standards that define aesthetic perfection. Ancient Greek sculptors like Polykleitos established the "Canon" - mathematical ratios for the ideal human figure that became the standard for classical sculpture.

In the art world, a canon:

• Defines standards - Establishes rules for correctness
• Measures perfection - Evaluates against ideal proportions
• Guides creation - Ensures harmony and balance

Similarly, vize_canon provides:

• Type checking - Validates TypeScript types in Vue SFCs
• Error detection - Identifies type mismatches and inconsistencies
• Code correctness - Ensures your Vue components follow type contracts

Features

• Template type checking - Validate expressions in {{ }}
• Directive validation - Type-check v-bind, v-on, etc.
• Props inference - Infer component prop types
• Emit validation - Check event handler types

Usage

use vize_canon::{TypeChecker, TypeContext};

let checker = TypeChecker::new();
let ctx = TypeContext::from_sfc(&descriptor);

// Check template for type errors
let diagnostics = checker.check_template(&ctx);

// Get type at position
if let Some(info) = checker.get_type_at(&ctx, offset) {
    println!("Type: {}", info.display());
}

Error Codes

Part of the Vize Art Collection

vize_canon is part of the Vize compiler's art-themed crate collection:

License

MIT License