chore(crate): add pub engine

README.md

@@ -6,7 +6,7 @@ The Rust web accessibility engine.
 
 ```toml
 [dependencies]
-accessibility-rs = "^0.0.26"
+accessibility-rs = "^0.0.30"
 ```
 
 ```rs

accessibility-rs/Cargo.toml

@@ -1,14 +1,14 @@
 [package]
 name = "accessibility-rs"
-version = "0.0.26"
+version = "0.0.30"
 authors = ["The A11yWatch Project Developers", "Jeff Mendez <[email protected]>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"
 description = "Web accessibility engine for Rust."
 repository = "https://github.com/a11ywatch/accessibility-rs"
 categories = ["accessibility"]
 documentation = "https://docs.rs/accessibility-rs"
-include = ["/src", "../LICENSE_MIT", "../LICENSE_APACHE", "README.md", "locales"]
+include = ["/src", "../LICENSE_MIT", "../LICENSE_APACHE", "../README.md", "locales"]
 
 [features]
 default = []

accessibility-rs/src/engine/audit/wcag.rs

@@ -5,11 +5,11 @@ use crate::Auditor;
 
 /// baseline for all rules
 #[derive(Default)]
-pub struct WCAG3AA;
+pub struct WCAGAAA;
 
 /// wcag rules to test for
-impl WCAG3AA {
-    /// init the rules
+impl WCAGAAA {
+    /// audit html against WCAGAAA standards
     pub fn audit(auditor: &Auditor<'_>) -> Vec<Issue> {
         // TODO: push rules found to MAP that are different across nodes to combine the selectors
         let mut issues: Vec<Issue> = Vec::new();

accessibility-rs/src/engine/rules/techniques.rs

@@ -3,7 +3,7 @@ use strum_macros::IntoStaticStr;
 #[derive(PartialOrd, Ord, std::cmp::Eq, PartialEq, Hash, Debug, IntoStaticStr)]
 /// techniques for WCAG <https://www.w3.org/TR/WCAG20-TECHS/>
 pub enum Techniques {
-    /// <https://www.w3.org/TR/WCAG20-TECHS/H25.html>
+    /// <https://www.w3.org/TR/WCAG20-TECHS/H25>
     H25,
     /// <https://www.w3.org/TR/WCAG20-TECHS/H32.html>
     H32,

accessibility-rs/src/engine/rules/utils/mod.rs

@@ -1 +1,2 @@
+/// utilities for node extracting
 pub mod nodes;

accessibility-rs/src/engine/rules/wcag_rule_map.rs

@@ -11,9 +11,8 @@ use std::collections::BTreeMap;
 use std::collections::HashMap;
 use std::ops::Add;
 
-// todo: validate each element and add a shape that can prevent repitiion
 lazy_static! {
-    /// a list of rules that should be applied for WCAG1 A-AAA
+    /// a list of rules that should be applied for WCAG2.0 A-AAA
     pub static ref RULES_A: BTreeMap<&'static str, Vec<Rule>> =
         vec![
             ("html", Vec::from([

accessibility-rs/src/engine/styles/errors.rs

@@ -8,7 +8,9 @@ use selectors::parser::SelectorParseErrorKind;
 //     UnknownUnit(CowRcStr<'i>),
 // }
 
+/// rule parsing errors
 pub enum RuleParseErrorKind<'i> {
+    /// selector parse error
     Selector(SelectorParseErrorKind<'i>),
 }
 

accessibility-rs/src/engine/styles/rules.rs

@@ -4,23 +4,30 @@ use cssparser::{AtRuleParser, ParseError, QualifiedRuleParser};
 use std::sync::Arc;
 
 #[derive(Debug)]
+/// Css rules to match selectors
 pub enum CssRule {
+    /// the style rules for css
     StyleRule {
+        /// css selectors list with selector trait
         selectors: selectors::SelectorList<Simple>,
+        /// a css block parsed
         block: Arc<String>,
     },
 }
 
+/// css parser
 pub struct Parser;
 
 impl<'i> selectors::parser::Parser<'i> for Parser {
     type Impl = Simple;
     type Error = RuleParseErrorKind<'i>;
 }
 
+/// css selector list
 pub type SelectorList = selectors::SelectorList<Simple>;
 // pub type Selector = selectors::parser::Selector<Simple>;
 
+/// css rules parser
 pub struct RulesParser;
 
 impl<'i> QualifiedRuleParser<'i> for RulesParser {
@@ -51,7 +58,6 @@ impl<'i> QualifiedRuleParser<'i> for RulesParser {
 impl<'i> AtRuleParser<'i> for RulesParser {
     type PreludeBlock = ();
     type PreludeNoBlock = ();
-
     type AtRule = CssRule;
     type Error = RuleParseErrorKind<'i>;
 }

accessibility-rs/src/i18n/locales.rs

@@ -25,6 +25,7 @@ pub struct Messages {
     hi: M,
 }
 
+/// the languages for auditing results
 pub enum Langs {
     /// english
     En,

accessibility-rs/src/lib.rs

@@ -37,10 +37,10 @@ extern crate lazy_static;
 #[macro_use]
 extern crate rust_i18n;
 
-/// the main engine for audits.
-mod engine;
+/// the main engine for accessibility auditing.
+pub mod engine;
 /// locales for translations.
-mod i18n;
+pub mod i18n;
 
 use crate::engine::audit::auditor::Auditor;
 use crate::engine::issue::Issue;
@@ -92,5 +92,5 @@ pub fn audit(config: AuditConfig) -> Vec<Issue> {
         config.bounding_box,
         config.locale,
     );
-    engine::audit::wcag::WCAG3AA::audit(&auditor)
+    engine::audit::wcag::WCAGAAA::audit(&auditor)
 }