perfectionist 0.0.0-rc.18

Additional linting rules for Rust projects
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

use super::*;

#[test]
fn https_url_passes_through() {
    assert_eq!(
        normalize("https://github.com/owner/repo").as_deref(),
        Some("https://github.com/owner/repo"),
    );
}

#[test]
fn http_scheme_is_preserved() {
    assert_eq!(
        normalize("http://git.example.com/owner/repo").as_deref(),
        Some("http://git.example.com/owner/repo"),
    );
}

#[test]
fn dot_git_suffix_is_dropped() {
    assert_eq!(
        normalize("https://github.com/owner/repo.git").as_deref(),
        Some("https://github.com/owner/repo"),
    );
}

#[test]
fn trailing_slash_is_dropped() {
    assert_eq!(
        normalize("https://github.com/owner/repo/").as_deref(),
        Some("https://github.com/owner/repo"),
    );
}

#[test]
fn scp_like_maps_to_https() {
    assert_eq!(
        normalize("git@github.com:owner/repo.git").as_deref(),
        Some("https://github.com/owner/repo"),
    );
}

#[test]
fn scp_like_without_user_or_dot_git() {
    assert_eq!(
        normalize("github.com:owner/repo").as_deref(),
        Some("https://github.com/owner/repo"),
    );
}

#[test]
fn ssh_url_drops_userinfo_and_port() {
    assert_eq!(
        normalize("ssh://git@github.com:22/owner/repo.git").as_deref(),
        Some("https://github.com/owner/repo"),
    );
}

#[test]
fn deep_subgroup_path_is_kept() {
    // GitLab subgroups nest beyond owner/repo.
    assert_eq!(
        normalize("git@gitlab.com:group/subgroup/repo.git").as_deref(),
        Some("https://gitlab.com/group/subgroup/repo"),
    );
}

#[test]
fn single_segment_path_is_rejected() {
    // An owner with no repository can't yield issue / PR links.
    assert_eq!(normalize("https://github.com/owner"), None);
    assert_eq!(normalize("git@github.com:owner"), None);
}

#[test]
fn missing_path_is_rejected() {
    assert_eq!(normalize("https://github.com"), None);
}

#[test]
fn empty_host_is_rejected() {
    // A port-only authority has no host — reject it (the kept
    // `:port` must not masquerade as a host under `keep_port`).
    assert_eq!(normalize("https://:8443/owner/repo"), None);
    assert_eq!(normalize("ssh://:22/owner/repo"), None);
}

#[test]
fn query_and_fragment_are_stripped() {
    // A pasted browser URL may carry `?tab=...` / `#anchor`;
    // neither belongs in the repo path or the generated links.
    assert_eq!(
        normalize("https://github.com/owner/repo?tab=readme").as_deref(),
        Some("https://github.com/owner/repo"),
    );
    assert_eq!(
        normalize("https://github.com/owner/repo#section").as_deref(),
        Some("https://github.com/owner/repo"),
    );
    // `.git` followed by a query is still stripped to the repo.
    assert_eq!(
        normalize("https://github.com/owner/repo.git?x=1").as_deref(),
        Some("https://github.com/owner/repo"),
    );
}

#[test]
fn query_before_path_is_rejected() {
    // A `?`/`#` ahead of the path is malformed; stripping it
    // leaves no `owner/repo`, so the URL is rejected rather than
    // leaking the query into the host and emitting a broken link.
    assert_eq!(normalize("https://github.com?x=1/owner/repo"), None);
}

#[test]
fn unparseable_input_is_rejected() {
    assert_eq!(normalize("not a url"), None);
    assert_eq!(normalize(""), None);
}

#[test]
fn http_port_is_preserved() {
    // A self-hosted forge on a non-default web port must keep it,
    // or every suggested link points at the wrong (default) port.
    assert_eq!(
        normalize("https://git.example.com:8443/owner/repo").as_deref(),
        Some("https://git.example.com:8443/owner/repo"),
    );
}

#[test]
fn ssh_port_is_dropped() {
    // The SSH port is not the web port, so the web base drops it.
    assert_eq!(
        normalize("ssh://git@git.example.com:2222/owner/repo.git").as_deref(),
        Some("https://git.example.com/owner/repo"),
    );
}

#[test]
fn scheme_match_is_case_insensitive() {
    // RFC 3986 §3.1: schemes are case-insensitive. A valid
    // uppercase scheme must parse, not fall through to a panic.
    assert_eq!(
        normalize("HTTPS://github.com/owner/repo").as_deref(),
        Some("https://github.com/owner/repo"),
    );
    assert_eq!(
        normalize("SSH://git@github.com/owner/repo.git").as_deref(),
        Some("https://github.com/owner/repo"),
    );
}