lintspec 0.12.2

A blazingly fast linter for NatSpec comments in Solidity 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

//! The error and result types for lintspec
use std::path::PathBuf;

use crate::{
    definitions::Parent,
    textindex::{TextIndex, TextRange},
};

/// The result of a lintspec operation
pub type Result<T> = std::result::Result<T, Error>;

/// A lintspec error
#[derive(thiserror::Error, Debug)]
#[non_exhaustive]
pub enum Error {
    /// Solidity version is not supported
    #[error("the provided Solidity version is not supported: `{0}`")]
    SolidityUnsupportedVersion(String),

    #[error("there was an error while parsing {path}:{loc}:\n{message}")]
    ParsingError {
        path: PathBuf,
        loc: TextIndex,
        message: String,
    },

    /// Error during parsing of a version specifier string
    #[error("error parsing a semver string: {0}")]
    SemverParsingError(#[from] semver::Error),

    /// Error during parsing of a `NatSpec` comment
    #[error("error parsing a natspec comment: {message}")]
    NatspecParsingError {
        parent: Option<Parent>,
        span: TextRange,
        message: String,
    },

    /// [`Parse::get_sources`][crate::parser::Parse::get_sources] was called while other references (clones) still
    /// existed
    #[error("`Parse::get_sources` can only be called on the last parser instance")]
    DanglingParserReferences,

    /// IO error
    #[error("IO error for {path:?}: {err}")]
    IOError { path: PathBuf, err: std::io::Error },

    /// An unspecified error happening during parsing
    #[error("unknown error while parsing Solidity")]
    UnknownError,
}