alef 0.23.71

Opinionated polyglot binding generator for Rust libraries
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

//! No-op validators for "documentation" languages — `text`, `mermaid`, `powershell`, `xml`, `docker`.
//!
//! These languages either lack a viable syntax checker without heavy external toolchains
//! (mermaid, powershell, xml, docker) or are pure prose (text). Snippets in these fences
//! pass automatically; their value is that the audit subcommand stops reporting them as
//! `UnknownLanguage`. Use a stricter validator (or an external linter) when you really need
//! to verify the contents.

use crate::snippets::error::Result;
use crate::snippets::types::{Language, Snippet, SnippetStatus, ValidationLevel};
use crate::snippets::validators::SnippetValidator;

macro_rules! documentation_validator {
    ($name:ident, $lang:ident) => {
        pub struct $name;

        impl SnippetValidator for $name {
            fn language(&self) -> Language {
                Language::$lang
            }

            fn is_available(&self) -> bool {
                true
            }

            fn validate(
                &self,
                _snippet: &Snippet,
                _level: ValidationLevel,
                _timeout_secs: u64,
            ) -> Result<(SnippetStatus, Option<String>)> {
                Ok((SnippetStatus::Pass, None))
            }

            fn max_level(&self) -> ValidationLevel {
                ValidationLevel::Syntax
            }
        }
    };
}

documentation_validator!(TextValidator, Text);
documentation_validator!(MermaidValidator, Mermaid);
documentation_validator!(PowerShellValidator, PowerShell);
documentation_validator!(XmlValidator, Xml);
documentation_validator!(DockerValidator, Docker);