dprint 0.11.1

Binary for dprint code formatter—a pluggable and configurable code formatting platform.
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

use dprint_core::plugins::PluginInfo;
use dprint_core::types::ErrBox;
use dprint_cli_core::checksums::parse_checksum_path_or_url;

use crate::utils::{PathSource, resolve_url_or_file_path_to_path_source};

#[derive(Clone)]
pub struct CompilationResult {
    pub bytes: Vec<u8>,
    pub plugin_info: PluginInfo,
}

#[derive(Clone, Debug, PartialEq)]
pub struct PluginSourceReference {
    pub path_source: PathSource,
    pub checksum: Option<String>,
}

impl PluginSourceReference {
    pub fn display(&self) -> String {
        self.path_source.display()
    }

    pub fn is_wasm_plugin(&self) -> bool {
        self.path_source.is_wasm_plugin()
    }

    pub fn is_process_plugin(&self) -> bool {
        self.path_source.is_process_plugin()
    }

    #[cfg(test)]
    pub fn new_local(path: std::path::PathBuf) -> PluginSourceReference {
        PluginSourceReference {
            path_source: PathSource::new_local(path),
            checksum: None,
        }
    }

    #[cfg(test)]
    pub fn new_remote_from_str(url: &str) -> PluginSourceReference {
        PluginSourceReference {
            path_source: PathSource::new_remote_from_str(url),
            checksum: None,
        }
    }
}

pub fn parse_plugin_source_reference(text: &str, base: &PathSource) -> Result<PluginSourceReference, ErrBox> {
    let checksum_reference = parse_checksum_path_or_url(text);
    let path_source = resolve_url_or_file_path_to_path_source(&checksum_reference.path_or_url, base)?;

    if !path_source.is_wasm_plugin() && checksum_reference.checksum.is_none() {
        return err!(
            concat!(
                "The plugin '{0}' must have a checksum specified for security reasons ",
                "since it is not a WASM plugin. You may specify one by writing \"{0}@checksum-goes-here\" ",
                "when providing the url in the configuration file. Check the plugin's release notes for what ",
                "the checksum is or calculate it yourself if you trust the source (it's SHA-256)."
            ),
            path_source.display()
        );
    }

    Ok(PluginSourceReference {
        path_source,
        checksum: checksum_reference.checksum,
    })
}

#[cfg(test)]
mod tests {
    use std::path::PathBuf;
    use super::*;

    #[test]
    fn it_should_parse_plugin_without_checksum() {
        let result = parse_plugin_source_reference("http://dprint.dev/wasm_plugin.wasm", &PathSource::new_local(PathBuf::from("./"))).unwrap();
        assert_eq!(result, PluginSourceReference {
            path_source: PathSource::new_remote_from_str("http://dprint.dev/wasm_plugin.wasm"),
            checksum: None,
        });
    }

    #[test]
    fn it_should_parse_plugin_with_checksum() {
        let result = parse_plugin_source_reference("http://dprint.dev/wasm_plugin.wasm@checksum", &PathSource::new_local(PathBuf::from("./"))).unwrap();
        assert_eq!(result, PluginSourceReference {
            path_source: PathSource::new_remote_from_str("http://dprint.dev/wasm_plugin.wasm"),
            checksum: Some(String::from("checksum")),
        });
    }

    #[test]
    fn it_should_not_error_multiple_at_symbols() {
        let plugin_text = "http://dprint.dev/wasm_plugin.wasm@other@checksum";
        let result = parse_plugin_source_reference(&plugin_text, &PathSource::new_local(PathBuf::from("./"))).unwrap();
        assert_eq!(result, PluginSourceReference {
            path_source: PathSource::new_remote_from_str("http://dprint.dev/wasm_plugin.wasm@other"),
            checksum: Some(String::from("checksum")),
        });
    }

    #[test]
    fn it_should_parse_non_wasm_plugin_with_checksum() {
        let result = parse_plugin_source_reference("http://dprint.dev/plugin.exe-plugin@checksum", &PathSource::new_local(PathBuf::from("./"))).unwrap();
        assert_eq!(result, PluginSourceReference {
            path_source: PathSource::new_remote_from_str("http://dprint.dev/plugin.exe-plugin"),
            checksum: Some(String::from("checksum")),
        });
    }

    #[test]
    fn it_should_error_for_non_wasm_plugin_no_checksum() {
        let err = parse_plugin_source_reference("http://dprint.dev/plugin.exe-plugin", &PathSource::new_local(PathBuf::from("./"))).err().unwrap();
        assert_eq!(
            err.to_string(),
            concat!(
                "The plugin 'http://dprint.dev/plugin.exe-plugin' must have a checksum specified for security reasons ",
                "since it is not a WASM plugin. You may specify one by writing \"http://dprint.dev/plugin.exe-plugin@checksum-goes-here\" ",
                "when providing the url in the configuration file. Check the plugin's release notes for what ",
                "the checksum is or calculate it yourself if you trust the source (it's SHA-256)."
            )
        );
    }
}