lucid-lint 0.2.1

A cognitive accessibility linter for prose. Bilingual EN/FR. CI-native.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//! # lucid-lint
//!
//! A cognitive accessibility linter for prose. Built on cognitive load research.
//! Bilingual EN/FR. CI-native.
//!
//! ## 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
//!
//! ```no_run
//! 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);
//! }
//! ```

#![warn(missing_docs)]
#![warn(unreachable_pub)]
#![forbid(unsafe_code)]

pub mod condition;
pub mod config;
pub mod explain;
pub mod language;
pub mod output;
pub mod parser;
pub mod rules;
pub mod scoring;
pub mod types;

mod engine;

pub use condition::ConditionTag;
pub use config::Profile;
pub use engine::{Engine, EngineError, Report};
pub use scoring::{CategoryScore, Score, Scorecard, ScoringConfig};
pub use types::{Category, Diagnostic, Language, Location, Severity};