git.iko.soy/bat
on v0.18.2 help sign in
bat/src/syntax_mapping.rs
215 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 .iter()
105 {
106 mapping.insert(glob, MappingTarget::MapTo("INI")).unwrap();
107 }
109 // pacman hooks
110 mapping
111 .insert("*.hook", MappingTarget::MapTo("INI"))
112 .unwrap();
114 if let Some(xdg_config_home) = std::env::var_os("XDG_CONFIG_HOME") {
115 let git_config_path = Path::new(&xdg_config_home).join("git");
117 mapping
118 .insert(
119 &git_config_path.join("config").to_string_lossy(),
120 MappingTarget::MapTo("Git Config"),
121 )
122 .ok();
124 mapping
125 .insert(
126 &git_config_path.join("ignore").to_string_lossy(),
127 MappingTarget::MapTo("Git Ignore"),
128 )
129 .ok();
131 mapping
132 .insert(
133 &git_config_path.join("attributes").to_string_lossy(),
134 MappingTarget::MapTo("Git Attributes"),
135 )
136 .ok();
137 }
139 mapping
140 }
142 pub fn insert(&mut self, from: &str, to: MappingTarget<'a>) -> Result<()> {
143 let glob = GlobBuilder::new(from)
144 .case_insensitive(false)
145 .literal_separator(true)
146 .build()?;
147 self.mappings.push((glob.compile_matcher(), to));
148 Ok(())
149 }
151 pub fn mappings(&self) -> &[(GlobMatcher, MappingTarget<'a>)] {
152 &self.mappings
153 }
155 pub(crate) fn get_syntax_for(&self, path: impl AsRef<Path>) -> Option<MappingTarget<'a>> {
156 let candidate = Candidate::new(path.as_ref());
157 let candidate_filename = path.as_ref().file_name().map(Candidate::new);
158 for (ref glob, ref syntax) in self.mappings.iter().rev() {
159 if glob.is_match_candidate(&candidate)
160 || candidate_filename
161 .as_ref()
162 .map_or(false, |filename| glob.is_match_candidate(filename))
163 {
164 return Some(*syntax);
165 }
166 }
167 None
168 }
171#[test]
172fn basic() {
173 let mut map = SyntaxMapping::empty();
174 map.insert("/path/to/Cargo.lock", MappingTarget::MapTo("TOML"))
175 .ok();
176 map.insert("/path/to/.ignore", MappingTarget::MapTo("Git Ignore"))
177 .ok();
179 assert_eq!(
180 map.get_syntax_for("/path/to/Cargo.lock"),
181 Some(MappingTarget::MapTo("TOML"))
182 );
183 assert_eq!(map.get_syntax_for("/path/to/other.lock"), None);
185 assert_eq!(
186 map.get_syntax_for("/path/to/.ignore"),
187 Some(MappingTarget::MapTo("Git Ignore"))
188 );
191#[test]
192fn user_can_override_builtin_mappings() {
193 let mut map = SyntaxMapping::builtin();
195 assert_eq!(
196 map.get_syntax_for("/etc/profile"),
197 Some(MappingTarget::MapTo("Bourne Again Shell (bash)"))
198 );
199 map.insert("/etc/profile", MappingTarget::MapTo("My Syntax"))
200 .ok();
201 assert_eq!(
202 map.get_syntax_for("/etc/profile"),
203 Some(MappingTarget::MapTo("My Syntax"))
204 );
207#[test]
208fn builtin_mappings() {
209 let map = SyntaxMapping::builtin();
211 assert_eq!(
212 map.get_syntax_for("/path/to/build"),
213 Some(MappingTarget::MapToUnknown)
214 );