git.iko.soy/bat
on 0b63ad5 help sign in
bat/src/syntax_mapping.rs
213 lines 6.0 kB history raw
1use std::path::Path;
3use crate::error::Result;
5use globset::{Candidate, GlobBuilder, GlobMatcher};
7#[derive(Debug, Clone, Copy, PartialEq)]
8pub enum MappingTarget<'a> {
9 MapTo(&'a str),
10 MapToUnknown,
13#[derive(Debug, Clone, Default)]
14pub struct SyntaxMapping<'a> {
15 mappings: Vec<(GlobMatcher, MappingTarget<'a>)>,
18impl<'a> SyntaxMapping<'a> {
19 pub fn empty() -> SyntaxMapping<'a> {
20 Default::default()
21 }
23 pub fn builtin() -> SyntaxMapping<'a> {
24 let mut mapping = Self::empty();
25 mapping.insert("*.h", MappingTarget::MapTo("C++")).unwrap();
26 mapping.insert("*.fs", MappingTarget::MapTo("F#")).unwrap();
27 mapping
28 .insert("build", MappingTarget::MapToUnknown)
29 .unwrap();
30 mapping
31 .insert("**/.ssh/config", MappingTarget::MapTo("SSH Config"))
32 .unwrap();
33 mapping
34 .insert(
35 "**/bat/config",
36 MappingTarget::MapTo("Bourne Again Shell (bash)"),
37 )
38 .unwrap();
39 mapping
40 .insert(
41 "/etc/profile",
42 MappingTarget::MapTo("Bourne Again Shell (bash)"),
43 )
44 .unwrap();
45 mapping
46 .insert("*.pac", MappingTarget::MapTo("JavaScript (Babel)"))
47 .unwrap();
49 // See #1008
50 mapping
51 .insert("rails", MappingTarget::MapToUnknown)
52 .unwrap();
54 // Nginx and Apache syntax files both want to style all ".conf" files
55 // see #1131 and #1137
56 mapping
57 .insert("*.conf", MappingTarget::MapToUnknown)
58 .unwrap();
60 // Re-insert a mapping for resolv.conf, see #1510
61 mapping
62 .insert("resolv.conf", MappingTarget::MapTo("resolv"))
63 .unwrap();
65 for glob in &[
66 "/etc/nginx/**/*.conf",
67 "/etc/nginx/sites-*/**/*",
68 "nginx.conf",
69 "mime.types",
70 ] {
71 mapping.insert(glob, MappingTarget::MapTo("nginx")).unwrap();
72 }
74 for glob in &[
75 "/etc/apache2/**/*.conf",
76 "/etc/apache2/sites-*/**/*",
77 "httpd.conf",
78 ] {
79 mapping
80 .insert(glob, MappingTarget::MapTo("Apache Conf"))
81 .unwrap();
82 }
84 for glob in &[
85 "**/systemd/**/*.conf",
86 "**/systemd/**/*.example",
87 "*.automount",
88 "*.device",
89 "*.dnssd",
90 "*.link",
91 "*.mount",
92 "*.netdev",
93 "*.network",
94 "*.nspawn",
95 "*.path",
96 "*.service",
97 "*.scope",
98 "*.slice",
99 "*.socket",
100 "*.swap",
101 "*.target",
102 "*.timer",
103 ] {
104 mapping.insert(glob, MappingTarget::MapTo("INI")).unwrap();
105 }
107 // pacman hooks
108 mapping
109 .insert("*.hook", MappingTarget::MapTo("INI"))
110 .unwrap();
112 if let Some(xdg_config_home) = std::env::var_os("XDG_CONFIG_HOME") {
113 let git_config_path = Path::new(&xdg_config_home).join("git");
115 mapping
116 .insert(
117 &git_config_path.join("config").to_string_lossy(),
118 MappingTarget::MapTo("Git Config"),
119 )
120 .ok();
122 mapping
123 .insert(
124 &git_config_path.join("ignore").to_string_lossy(),
125 MappingTarget::MapTo("Git Ignore"),
126 )
127 .ok();
129 mapping
130 .insert(
131 &git_config_path.join("attributes").to_string_lossy(),
132 MappingTarget::MapTo("Git Attributes"),
133 )
134 .ok();
135 }
137 mapping
138 }
140 pub fn insert(&mut self, from: &str, to: MappingTarget<'a>) -> Result<()> {
141 let glob = GlobBuilder::new(from)
142 .case_insensitive(false)
143 .literal_separator(true)
144 .build()?;
145 self.mappings.push((glob.compile_matcher(), to));
146 Ok(())
147 }
149 pub fn mappings(&self) -> &[(GlobMatcher, MappingTarget<'a>)] {
150 &self.mappings
151 }
153 pub(crate) fn get_syntax_for(&self, path: impl AsRef<Path>) -> Option<MappingTarget<'a>> {
154 let candidate = Candidate::new(&path);
155 let candidate_filename = path.as_ref().file_name().map(Candidate::new);
156 for (ref glob, ref syntax) in self.mappings.iter().rev() {
157 if glob.is_match_candidate(&candidate)
158 || candidate_filename
159 .as_ref()
160 .map_or(false, |filename| glob.is_match_candidate(filename))
161 {
162 return Some(*syntax);
163 }
164 }
165 None
166 }
169#[test]
170fn basic() {
171 let mut map = SyntaxMapping::empty();
172 map.insert("/path/to/Cargo.lock", MappingTarget::MapTo("TOML"))
173 .ok();
174 map.insert("/path/to/.ignore", MappingTarget::MapTo("Git Ignore"))
175 .ok();
177 assert_eq!(
178 map.get_syntax_for("/path/to/Cargo.lock"),
179 Some(MappingTarget::MapTo("TOML"))
180 );
181 assert_eq!(map.get_syntax_for("/path/to/other.lock"), None);
183 assert_eq!(
184 map.get_syntax_for("/path/to/.ignore"),
185 Some(MappingTarget::MapTo("Git Ignore"))
186 );
189#[test]
190fn user_can_override_builtin_mappings() {
191 let mut map = SyntaxMapping::builtin();
193 assert_eq!(
194 map.get_syntax_for("/etc/profile"),
195 Some(MappingTarget::MapTo("Bourne Again Shell (bash)"))
196 );
197 map.insert("/etc/profile", MappingTarget::MapTo("My Syntax"))
198 .ok();
199 assert_eq!(
200 map.get_syntax_for("/etc/profile"),
201 Some(MappingTarget::MapTo("My Syntax"))
202 );
205#[test]
206fn builtin_mappings() {
207 let map = SyntaxMapping::builtin();
209 assert_eq!(
210 map.get_syntax_for("/path/to/build"),
211 Some(MappingTarget::MapToUnknown)
212 );