dprint 0.8.0

Binary for dprint.
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
127
128

use dprint_core::configuration::ConfigurationDiagnostic;
use crate::utils::get_table_text;

/// Checks if the configuration has a missing "project type" property.
///
/// This is done to encourage companies to support the project. They obviously aren't required to though.
/// Please discuss this with me if you have strong reservations about this. Note that this application took a lot of
/// time, effort, and previous built up knowledge and I'm happy to give it away for free to open source projects,
/// but would like to see companies support it financially even if it's only in a small way.
pub fn handle_project_type_diagnostic(project_type: &Option<String>) -> Option<ConfigurationDiagnostic> {
    let property_name = "projectType";
    let project_type_infos = get_project_type_infos();
    let has_project_type_config = match project_type {
        Some(project_type) => project_type_infos.iter().any(|info| info.name.to_lowercase() == project_type.to_lowercase()),
        _ => false,
    };

    if has_project_type_config {
        None
    } else {
        Some(ConfigurationDiagnostic {
            property_name: String::from(property_name),
            message: build_message(&project_type_infos, property_name),
        })
    }
}

fn build_message(project_type_infos: &Vec<ProjectTypeInfo>, property_name: &str) -> String {
    let mut message = String::new();
    message.push_str(&format!("The '{}' property is missing in the configuration file.\n\n", property_name));
    message.push_str("You may specify any of the following values and that will suppress this error:\n");
    let option_texts = get_table_text(project_type_infos.iter().map(|info| (info.name, info.description)).collect(), 3);
    for option_text in option_texts {
        message.push_str(&format!("\n * {}", option_text))
    }
    message.push_str("\n\nMore information: https://dprint.dev/sponsor");
    message
}

pub struct ProjectTypeInfo {
    pub name: &'static str,
    pub description: &'static str,
}

pub fn get_project_type_infos() -> Vec<ProjectTypeInfo> {
    vec![ProjectTypeInfo {
        name: "commercialEvaluation",
        description: concat!(
            "Dprint is formatting a project whose primary maintainer is a for-profit\n",
            "company or individual and it is being evaluated for 30 days.",
        )
    }, ProjectTypeInfo {
        name: "commercialSponsored",
        description: concat!(
            "Dprint is formatting a project whose primary maintainer is a for-profit\n",
            "company or individual AND the primary maintainer sponsored the project.\n",
            "Thank you for being part of moving this project forward!"
        ),
    }, ProjectTypeInfo {
        name: "openSource",
        description: concat!(
            "Dprint is formatting an open source project whose primary\n",
            "maintainer is not a for-profit company (no sponsorship requirement)."
        )
    }, ProjectTypeInfo {
        name: "educational",
        description: concat!(
            "Dprint is formatting a project run by a student or being used for\n",
            "educational purposes (no sponsorship requirement)."
        )
    }, ProjectTypeInfo {
        name: "nonProfit",
        description: concat!(
            "Dprint is formatting a project whose primary maintainer is a non-profit\n",
            "organization (no sponsorship requirement)."
        )
    }]
}

#[cfg(test)]
mod tests {
    use pretty_assertions::assert_eq;
    use super::handle_project_type_diagnostic;

    #[test]
    fn it_should_handle_when_project_type_exists() {
        let result = handle_project_type_diagnostic(&Some(String::from("openSource")));
        assert_eq!(result.is_none(), true);
    }

    #[test]
    fn it_should_be_case_insensitive() {
        // don't get people too upset :)
        let result = handle_project_type_diagnostic(&Some(String::from("opensource")));
        assert_eq!(result.is_none(), true);
    }

    #[test]
    fn it_should_handle_when_project_type_not_exists() {
        let result = handle_project_type_diagnostic(&None);
        assert_eq!(result.is_some(), true);
        let result = result.unwrap();
        assert_eq!(result.property_name, "projectType");
        assert_eq!(result.message, r#"The 'projectType' property is missing in the configuration file.

You may specify any of the following values and that will suppress this error:

 * commercialEvaluation Dprint is formatting a project whose primary maintainer is a for-profit
                        company or individual and it is being evaluated for 30 days.
 * commercialSponsored  Dprint is formatting a project whose primary maintainer is a for-profit
                        company or individual AND the primary maintainer sponsored the project.
                        Thank you for being part of moving this project forward!
 * openSource           Dprint is formatting an open source project whose primary
                        maintainer is not a for-profit company (no sponsorship requirement).
 * educational          Dprint is formatting a project run by a student or being used for
                        educational purposes (no sponsorship requirement).
 * nonProfit            Dprint is formatting a project whose primary maintainer is a non-profit
                        organization (no sponsorship requirement).

More information: https://dprint.dev/sponsor"#);
    }

    #[test]
    fn it_should_handle_when_project_type_not_valid_option() {
        let result = handle_project_type_diagnostic(&Some(String::from("test")));
        assert_eq!(result.is_some(), true);
    }
}