veryl-metadata 0.20.0

A modern hardware description language
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

use crate::metadata::UrlPath;
use miette::{self, Diagnostic};
use semver::Version;
use std::path::{Path, PathBuf};
use thiserror::Error;
use url::Url;
use veryl_path::PathError;

#[derive(Error, Diagnostic, Debug)]
pub enum MetadataError {
    #[diagnostic(code(MetadataError::FileIO), help(""))]
    #[error("file I/O error ({path})")]
    FileIO {
        #[source]
        source: std::io::Error,
        path: PathBuf,
    },

    #[diagnostic(code(MetadataError::FileNotFound), help(""))]
    #[error("Veryl.toml is not found")]
    FileNotFound,

    #[diagnostic(code(MetadataError::Deserialize), help(""))]
    #[error("toml load failed")]
    Deserialize(#[from] toml::de::Error),

    #[diagnostic(code(MetadataError::InvalidSourceLocation), help(""))]
    #[error("source file \"{0}\" is outside the project")]
    InvalidSourceLocation(PathBuf),

    #[diagnostic(code(MetadataError::Git), help(""))]
    #[error("git operation failure: {0}")]
    Git(Box<dyn std::error::Error + Sync + Send>),

    #[diagnostic(
        code(MetadataError::InvalidProjectName),
        help("\"[a-zA-Z_][0-9a-zA-Z_]*\" can be used as project name")
    )]
    #[error("project name \"{0}\" is invalid")]
    InvalidProjectName(String),

    #[diagnostic(
        code(MetadataError::InvalidProjectName),
        help("an project name starting with `__` is reserved")
    )]
    #[error("project name \"{0}\" is reserved by system")]
    ReservedProjectName(String),

    #[diagnostic(
        code(MetadataError::InvalidLicense),
        help("license text should follow SPDX expression")
    )]
    #[error("license parse failed")]
    InvalidLicense(#[from] spdx::ParseError),

    #[diagnostic(code(MetadataError::PublishedVersion), help("bump up version"))]
    #[error("\"{0}\" is already published")]
    PublishedVersion(Version),

    #[diagnostic(code(MetadataError::ModifiedProject), help(""))]
    #[error("There are modified files in {0}")]
    ModifiedProject(PathBuf),

    #[diagnostic(code(MetadataError::Toml), help(""))]
    #[error("toml serialization error")]
    TomlSer(#[from] toml::ser::Error),

    #[diagnostic(code(MetadataError::VersionNotFound), help(""))]
    #[error("{version} @ {url} is not found")]
    VersionNotFound { url: UrlPath, version: String },

    #[diagnostic(code(MetadataError::ProjectNotFound), help(""))]
    #[error("{project} @ {url} is not found")]
    ProjectNotFound { url: UrlPath, project: String },

    #[diagnostic(code(MetadataError::InvalidDependency), help(""))]
    #[error("dependency to {name} is invalid because {cause}")]
    InvalidDependency { name: String, cause: String },

    #[diagnostic(code(MetadataError::GitSpec), help(""))]
    #[error("no version/rev/tag/branch specification of {0}")]
    GitSpec(Url),

    #[diagnostic(code(MetadataError::NameConflict), help(""))]
    #[error("project name \"{0}\" is used multiply in dependencies")]
    NameConflict(String),

    #[diagnostic(code(MetadataError::Path), help(""))]
    #[error("path error")]
    Path(#[from] PathError),

    #[diagnostic(code(MetadataError::MissingVersion), help(""))]
    #[error("Version field is required in Veryl.toml to publish")]
    MissingVersion,
}

impl MetadataError {
    pub fn file_io(source: std::io::Error, path: &Path) -> MetadataError {
        MetadataError::FileIO {
            source,
            path: path.into(),
        }
    }
}