moonwave 1.3.0

Moonwave is a tool for generating documentation from comments in Lua source code.
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use std::{error, fmt};

use crate::{doc_comment::DocComment, span::Span};
use codespan_reporting::diagnostic::{Diagnostic as CodeSpanDiagnostic, Label};
use serde::Serialize;

#[derive(Debug, Default, Serialize)]
pub struct Diagnostic {
    pub text: String,
    pub start: usize,
    pub len: usize,
    pub file_id: usize,
    pub additional_diagnostics: Vec<Diagnostic>,
}

impl Diagnostic {
    pub fn from_span<S: Into<String>>(text: S, span: Span) -> Self {
        Self {
            text: text.into(),
            start: span.start + span.source_offset,
            len: span.len,
            file_id: span.file_id,
            ..Default::default()
        }
    }

    pub fn from_doc_comment<S: Into<String>>(text: S, doc_comment: &DocComment) -> Self {
        Self {
            text: text.into(),
            start: doc_comment.start,
            len: doc_comment.comment.len(),
            file_id: doc_comment.file_id,
            ..Default::default()
        }
    }

    pub fn attach_diagnostic(&mut self, diagnostic: Diagnostic) -> &Self {
        self.additional_diagnostics.push(diagnostic);

        self
    }
}

impl error::Error for Diagnostic {}

impl fmt::Display for Diagnostic {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.text)
    }
}

impl From<Diagnostic> for CodeSpanDiagnostic<usize> {
    fn from(diagnostic: Diagnostic) -> Self {
        let mut labels = vec![Label::primary(
            diagnostic.file_id,
            diagnostic.start..(diagnostic.start + diagnostic.len),
        )
        .with_message(&diagnostic.text)];

        for additional_diagnostic in diagnostic.additional_diagnostics {
            labels.push(
                Label::secondary(
                    additional_diagnostic.file_id,
                    additional_diagnostic.start
                        ..(additional_diagnostic.start + additional_diagnostic.len),
                )
                .with_message(&additional_diagnostic.text),
            )
        }

        CodeSpanDiagnostic::error()
            .with_message(&diagnostic.text)
            .with_labels(labels)
    }
}

#[derive(Debug)]
pub struct Diagnostics {
    errors: Vec<Diagnostic>,
}

impl Diagnostics {
    pub fn into_iter(self) -> impl Iterator<Item = Diagnostic> {
        self.errors.into_iter()
    }

    pub fn is_empty(&self) -> bool {
        self.errors.is_empty()
    }
}

impl From<Vec<Diagnostic>> for Diagnostics {
    fn from(errors: Vec<Diagnostic>) -> Self {
        Self { errors }
    }
}

impl error::Error for Diagnostics {}
impl fmt::Display for Diagnostics {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let text = self
            .errors
            .iter()
            .map(|e| e.to_string())
            .collect::<Vec<String>>()
            .join("\n");

        write!(f, "{}", text)
    }
}