Crate lucid_lint 

lucid-lint

A cognitive accessibility linter for prose. Built on cognitive load research. Bilingual EN/FR. CI-native.

User documentation lives outside docs.rs:

• 📖 Guide & rules reference — https://bastien-gallay.github.io/lucid-lint
• 📋 Rule catalogue — https://github.com/bastien-gallay/lucid-lint/blob/main/RULES.md
• 🛠 Source & issues — https://github.com/bastien-gallay/lucid-lint

This page (docs.rs) documents the Rust API for embedding lucid-lint as a library. For CLI usage, configuration profiles, and the rule taxonomy, follow the links above.

Quick overview

• config — profiles and rule configuration
• parser — Markdown and plain text parsing
• language — language detection
• rules — lint rules
• output — diagnostic formatters
• types — core domain types (Diagnostic, Severity, Location, etc.)

Example

use lucid_lint::{Engine, Profile};

let engine = Engine::with_profile(Profile::Public);
let report = engine.lint_str("Your text here.");
println!("score: {}/{}", report.scorecard.global.value, report.scorecard.global.max);
for diag in &report.diagnostics {
    println!("{}", diag.message);
}

Re-exports

pub use condition::ConditionTag;

pub use config::Profile;

pub use scoring::CategoryScore;

pub use scoring::Score;

pub use scoring::Scorecard;

pub use scoring::ScoringConfig;

pub use types::Category;

pub use types::Diagnostic;

pub use types::Language;

pub use types::Location;

pub use types::Severity;

Modules

condition

Rule condition tags (F71).

config

Configuration: profiles and per-rule settings.

explain

lucid-lint explain <rule-id> — print the bundled rule documentation.

language

Language detection and language-specific data.

output

Output formatters for diagnostics.

parser

Parsing of input text into a structured Document model.

rules

Lint rules.

scoring

Hybrid scoring model (F14).

types

Core domain types used across the crate.

Structs

Engine

The linting engine.

Report

Aggregated result of a lint run over a single document.

Enums

EngineError

Errors returned by the engine.