1use std::collections::HashMap;
8use std::path::{Path, PathBuf};
9
10use serde::Deserialize;
11#[cfg(feature = "cli")]
12use serde::Serialize;
13
14use crate::config::{
15 CaseStyle, Config, DangleAlign, FractionalTabPolicy, LineEnding, PerCommandConfig,
16};
17use crate::error::{Error, FileParseError, Result};
18
19#[derive(Debug, Clone, Deserialize, Default)]
24#[cfg_attr(feature = "cli", derive(schemars::JsonSchema))]
25#[cfg_attr(feature = "cli", schemars(title = "cmakefmt configuration"))]
26#[serde(default, deny_unknown_fields)]
27struct FileConfig {
28 #[serde(rename = "$schema")]
31 #[cfg_attr(feature = "cli", schemars(skip))]
32 _schema: Option<String>,
33 #[cfg_attr(feature = "cli", schemars(skip))]
35 commands: Option<serde_yaml::Value>,
36 format: FormatSection,
38 markup: MarkupSection,
40 #[serde(rename = "per_command_overrides")]
42 per_command_overrides: HashMap<String, PerCommandConfig>,
43 #[serde(rename = "per_command")]
44 #[cfg_attr(feature = "cli", schemars(skip))]
45 legacy_per_command: HashMap<String, PerCommandConfig>,
46}
47
48#[derive(Debug, Clone, Deserialize, Default)]
49#[cfg_attr(feature = "cli", derive(schemars::JsonSchema))]
50#[serde(default)]
51#[serde(deny_unknown_fields)]
52struct FormatSection {
53 disable: Option<bool>,
55 line_ending: Option<LineEnding>,
57 line_width: Option<usize>,
59 tab_size: Option<usize>,
61 use_tabs: Option<bool>,
63 fractional_tab_policy: Option<FractionalTabPolicy>,
65 max_empty_lines: Option<usize>,
67 max_hanging_wrap_lines: Option<usize>,
69 max_hanging_wrap_positional_args: Option<usize>,
71 max_hanging_wrap_groups: Option<usize>,
73 max_rows_cmdline: Option<usize>,
75 always_wrap: Option<Vec<String>>,
77 require_valid_layout: Option<bool>,
79 dangle_parens: Option<bool>,
81 dangle_align: Option<DangleAlign>,
83 min_prefix_length: Option<usize>,
85 max_prefix_length: Option<usize>,
87 space_before_control_paren: Option<bool>,
89 space_before_definition_paren: Option<bool>,
91 command_case: Option<CaseStyle>,
93 keyword_case: Option<CaseStyle>,
95}
96
97#[derive(Debug, Clone, Deserialize, Default)]
98#[cfg_attr(feature = "cli", derive(schemars::JsonSchema))]
99#[serde(default)]
100#[serde(deny_unknown_fields)]
101struct MarkupSection {
102 enable_markup: Option<bool>,
104 reflow_comments: Option<bool>,
106 first_comment_is_literal: Option<bool>,
108 literal_comment_pattern: Option<String>,
110 bullet_char: Option<String>,
112 enum_char: Option<String>,
114 fence_pattern: Option<String>,
116 ruler_pattern: Option<String>,
118 hashruler_min_length: Option<usize>,
120 canonicalize_hashrulers: Option<bool>,
122 explicit_trailing_pattern: Option<String>,
124}
125
126const CONFIG_FILE_NAME_TOML: &str = ".cmakefmt.toml";
127const CONFIG_FILE_NAME_YAML: &str = ".cmakefmt.yaml";
128const CONFIG_FILE_NAME_YML: &str = ".cmakefmt.yml";
129const CONFIG_FILE_NAMES: &[&str] = &[
130 CONFIG_FILE_NAME_YAML,
131 CONFIG_FILE_NAME_YML,
132 CONFIG_FILE_NAME_TOML,
133];
134
135#[derive(Debug, Clone, Copy, PartialEq, Eq)]
136pub(crate) enum ConfigFileFormat {
137 Toml,
138 Yaml,
139}
140
141impl ConfigFileFormat {
142 pub(crate) fn as_str(self) -> &'static str {
143 match self {
144 Self::Toml => "TOML",
145 Self::Yaml => "YAML",
146 }
147 }
148}
149
150#[cfg(feature = "cli")]
152#[derive(Debug, Clone, Copy, PartialEq, Eq, clap::ValueEnum)]
153pub enum DumpConfigFormat {
154 Yaml,
156 Toml,
158}
159
160#[cfg(feature = "cli")]
161pub fn default_config_template_for(format: DumpConfigFormat) -> String {
167 match format {
168 DumpConfigFormat::Yaml => default_config_template_yaml(),
169 DumpConfigFormat::Toml => default_config_template_toml(),
170 }
171}
172
173#[cfg(feature = "cli")]
174pub fn render_effective_config(config: &Config, format: DumpConfigFormat) -> Result<String> {
179 let view = EffectiveConfigFile::from(config);
180 match format {
181 DumpConfigFormat::Yaml => serde_yaml::to_string(&view).map_err(|err| {
182 Error::Formatter(format!("failed to render effective config as YAML: {err}"))
183 }),
184 DumpConfigFormat::Toml => toml::to_string_pretty(&view).map_err(|err| {
185 Error::Formatter(format!("failed to render effective config as TOML: {err}"))
186 }),
187 }
188}
189
190pub fn default_config_template() -> String {
192 default_config_template_yaml()
193}
194
195#[cfg(feature = "cli")]
196pub fn generate_json_schema() -> String {
201 let schema = schemars::schema_for!(FileConfig);
202 serde_json::to_string_pretty(&schema).expect("JSON schema serialization failed")
203}
204
205#[cfg(feature = "cli")]
206fn default_config_template_toml() -> String {
207 format!(
208 concat!(
209 "# Default cmakefmt configuration.\n",
210 "# Copy this to .cmakefmt.toml and uncomment the optional settings\n",
211 "# you want to customize.\n\n",
212 "[format]\n",
213 "# Disable formatting entirely (return source unchanged).\n",
214 "# disable = true\n\n",
215 "# Output line-ending style: unix (LF), windows (CRLF), or auto (detect from input).\n",
216 "# line_ending = \"windows\"\n\n",
217 "# Maximum rendered line width before cmakefmt wraps a call.\n",
218 "line_width = {line_width}\n\n",
219 "# Number of spaces per indentation level when use_tabs is false.\n",
220 "tab_size = {tab_size}\n\n",
221 "# Indent with tab characters instead of spaces.\n",
222 "# use_tabs = true\n\n",
223 "# How to handle fractional indentation when use_tabs is true: use-space or round-up.\n",
224 "# fractional_tab_policy = \"round-up\"\n\n",
225 "# Maximum number of consecutive blank lines to preserve.\n",
226 "max_empty_lines = {max_empty_lines}\n\n",
227 "# Maximum wrapped lines to tolerate before switching to a more vertical layout.\n",
228 "max_hanging_wrap_lines = {max_lines_hwrap}\n\n",
229 "# Maximum positional arguments to keep in a hanging-wrap layout.\n",
230 "max_hanging_wrap_positional_args = {max_pargs_hwrap}\n\n",
231 "# Maximum keyword/flag subgroups to keep in a hanging-wrap layout.\n",
232 "max_hanging_wrap_groups = {max_subgroups_hwrap}\n\n",
233 "# Maximum rows a hanging-wrap positional group may consume before nesting is forced.\n",
234 "max_rows_cmdline = {max_rows_cmdline}\n\n",
235 "# Commands that must always use vertical (wrapped) layout.\n",
236 "# always_wrap = [\"target_link_libraries\"]\n\n",
237 "# Return an error if any formatted line exceeds line_width.\n",
238 "# require_valid_layout = true\n\n",
239 "# Put the closing ')' on its own line when a call wraps.\n",
240 "dangle_parens = {dangle_parens}\n\n",
241 "# Alignment strategy for a dangling ')': prefix, open, or close.\n",
242 "dangle_align = \"{dangle_align}\"\n\n",
243 "# Lower heuristic bound used when deciding between compact and wrapped layouts.\n",
244 "min_prefix_length = {min_prefix_chars}\n\n",
245 "# Upper heuristic bound used when deciding between compact and wrapped layouts.\n",
246 "max_prefix_length = {max_prefix_chars}\n\n",
247 "# Insert a space before '(' for control-flow commands like if/foreach.\n",
248 "# space_before_control_paren = true\n\n",
249 "# Insert a space before '(' for function() and macro() definitions.\n",
250 "# space_before_definition_paren = true\n\n",
251 "# Output casing for command names: lower, upper, or unchanged.\n",
252 "command_case = \"{command_case}\"\n\n",
253 "# Output casing for recognized keywords and flags: lower, upper, or unchanged.\n",
254 "keyword_case = \"{keyword_case}\"\n\n",
255 "[markup]\n",
256 "# Enable markup-aware comment handling.\n",
257 "enable_markup = {enable_markup}\n\n",
258 "# Reflow plain line comments to fit within the configured line width.\n",
259 "# reflow_comments = true\n\n",
260 "# Preserve the first comment block in a file literally.\n",
261 "first_comment_is_literal = {first_comment_is_literal}\n\n",
262 "# Preserve comments matching a custom regex literally.\n",
263 "# literal_comment_pattern = \"^\\\\s*NOTE:\"\n\n",
264 "# Preferred bullet character when normalizing markup lists.\n",
265 "bullet_char = \"{bullet_char}\"\n\n",
266 "# Preferred punctuation for numbered lists when normalizing markup.\n",
267 "enum_char = \"{enum_char}\"\n\n",
268 "# Regex describing fenced literal comment blocks.\n",
269 "fence_pattern = '{fence_pattern}'\n\n",
270 "# Regex describing ruler-style comments that should be treated specially.\n",
271 "ruler_pattern = '{ruler_pattern}'\n\n",
272 "# Minimum ruler length before a hash-only line is treated as a ruler.\n",
273 "hashruler_min_length = {hashruler_min_length}\n\n",
274 "# Normalize ruler comments when markup handling is enabled.\n",
275 "canonicalize_hashrulers = {canonicalize_hashrulers}\n\n",
276 "# Regex pattern for inline comments that are explicitly trailing their preceding\n",
277 "# argument (rendered on the same line). Default: '#<'.\n",
278 "# explicit_trailing_pattern = \"#<\"\n\n",
279 "# Uncomment and edit a block like this to override formatting knobs\n",
280 "# for a specific command. This changes layout behavior for that\n",
281 "# command name only; it does not define new command syntax.\n",
282 "#\n",
283 "# [per_command_overrides.my_custom_command]\n",
284 "# Override the line width just for this command.\n",
285 "# line_width = 120\n\n",
286 "# Override command casing just for this command.\n",
287 "# command_case = \"unchanged\"\n\n",
288 "# Override keyword casing just for this command.\n",
289 "# keyword_case = \"upper\"\n\n",
290 "# Override indentation width just for this command.\n",
291 "# tab_size = 4\n\n",
292 "# Override dangling-paren placement just for this command.\n",
293 "# dangle_parens = false\n\n",
294 "# Override dangling-paren alignment just for this command.\n",
295 "# dangle_align = \"prefix\"\n\n",
296 "# Override the positional-argument hanging-wrap threshold just for this command.\n",
297 "# max_hanging_wrap_positional_args = 8\n\n",
298 "# Override the subgroup hanging-wrap threshold just for this command.\n",
299 "# max_hanging_wrap_groups = 3\n\n",
300 "# TOML custom-command specs live under [commands.<name>]. For\n",
301 "# user config, prefer YAML once these specs grow beyond a couple\n",
302 "# of simple flags/kwargs.\n",
303 "# Command specs tell the formatter which tokens are positional\n",
304 "# arguments, standalone flags, and keyword sections.\n",
305 "#\n",
306 "# Example: one positional argument, one flag, and two keyword\n",
307 "# sections that each take one or more values.\n",
308 "#\n",
309 "# [commands.my_custom_command]\n",
310 "# pargs = 1\n",
311 "# flags = [\"QUIET\"]\n",
312 "# kwargs = {{ SOURCES = {{ nargs = \"+\" }}, LIBRARIES = {{ nargs = \"+\" }} }}\n",
313 ),
314 line_width = Config::default().line_width,
315 tab_size = Config::default().tab_size,
316 max_empty_lines = Config::default().max_empty_lines,
317 max_lines_hwrap = Config::default().max_lines_hwrap,
318 max_pargs_hwrap = Config::default().max_pargs_hwrap,
319 max_subgroups_hwrap = Config::default().max_subgroups_hwrap,
320 max_rows_cmdline = Config::default().max_rows_cmdline,
321 dangle_parens = Config::default().dangle_parens,
322 dangle_align = "prefix",
323 min_prefix_chars = Config::default().min_prefix_chars,
324 max_prefix_chars = Config::default().max_prefix_chars,
325 command_case = "lower",
326 keyword_case = "upper",
327 enable_markup = Config::default().enable_markup,
328 first_comment_is_literal = Config::default().first_comment_is_literal,
329 bullet_char = Config::default().bullet_char,
330 enum_char = Config::default().enum_char,
331 fence_pattern = Config::default().fence_pattern,
332 ruler_pattern = Config::default().ruler_pattern,
333 hashruler_min_length = Config::default().hashruler_min_length,
334 canonicalize_hashrulers = Config::default().canonicalize_hashrulers,
335 )
336}
337
338#[cfg(feature = "cli")]
339#[derive(Debug, Clone, Serialize)]
340struct EffectiveConfigFile {
341 format: EffectiveFormatSection,
342 markup: EffectiveMarkupSection,
343 per_command_overrides: HashMap<String, PerCommandConfig>,
344}
345
346#[derive(Debug, Clone, Serialize)]
347#[cfg(feature = "cli")]
348struct EffectiveFormatSection {
349 #[serde(skip_serializing_if = "std::ops::Not::not")]
350 disable: bool,
351 line_ending: LineEnding,
352 line_width: usize,
353 tab_size: usize,
354 use_tabs: bool,
355 fractional_tab_policy: FractionalTabPolicy,
356 max_empty_lines: usize,
357 max_hanging_wrap_lines: usize,
358 max_hanging_wrap_positional_args: usize,
359 max_hanging_wrap_groups: usize,
360 max_rows_cmdline: usize,
361 #[serde(skip_serializing_if = "Vec::is_empty")]
362 always_wrap: Vec<String>,
363 #[serde(skip_serializing_if = "std::ops::Not::not")]
364 require_valid_layout: bool,
365 dangle_parens: bool,
366 dangle_align: DangleAlign,
367 min_prefix_length: usize,
368 max_prefix_length: usize,
369 space_before_control_paren: bool,
370 space_before_definition_paren: bool,
371 command_case: CaseStyle,
372 keyword_case: CaseStyle,
373}
374
375#[derive(Debug, Clone, Serialize)]
376#[cfg(feature = "cli")]
377struct EffectiveMarkupSection {
378 enable_markup: bool,
379 reflow_comments: bool,
380 first_comment_is_literal: bool,
381 literal_comment_pattern: String,
382 bullet_char: String,
383 enum_char: String,
384 fence_pattern: String,
385 ruler_pattern: String,
386 hashruler_min_length: usize,
387 canonicalize_hashrulers: bool,
388 explicit_trailing_pattern: String,
389}
390
391#[cfg(feature = "cli")]
392impl From<&Config> for EffectiveConfigFile {
393 fn from(config: &Config) -> Self {
394 Self {
395 format: EffectiveFormatSection {
396 disable: config.disable,
397 line_ending: config.line_ending,
398 line_width: config.line_width,
399 tab_size: config.tab_size,
400 use_tabs: config.use_tabchars,
401 fractional_tab_policy: config.fractional_tab_policy,
402 max_empty_lines: config.max_empty_lines,
403 max_hanging_wrap_lines: config.max_lines_hwrap,
404 max_hanging_wrap_positional_args: config.max_pargs_hwrap,
405 max_hanging_wrap_groups: config.max_subgroups_hwrap,
406 max_rows_cmdline: config.max_rows_cmdline,
407 always_wrap: config.always_wrap.clone(),
408 require_valid_layout: config.require_valid_layout,
409 dangle_parens: config.dangle_parens,
410 dangle_align: config.dangle_align,
411 min_prefix_length: config.min_prefix_chars,
412 max_prefix_length: config.max_prefix_chars,
413 space_before_control_paren: config.separate_ctrl_name_with_space,
414 space_before_definition_paren: config.separate_fn_name_with_space,
415 command_case: config.command_case,
416 keyword_case: config.keyword_case,
417 },
418 markup: EffectiveMarkupSection {
419 enable_markup: config.enable_markup,
420 reflow_comments: config.reflow_comments,
421 first_comment_is_literal: config.first_comment_is_literal,
422 literal_comment_pattern: config.literal_comment_pattern.clone(),
423 bullet_char: config.bullet_char.clone(),
424 enum_char: config.enum_char.clone(),
425 fence_pattern: config.fence_pattern.clone(),
426 ruler_pattern: config.ruler_pattern.clone(),
427 hashruler_min_length: config.hashruler_min_length,
428 canonicalize_hashrulers: config.canonicalize_hashrulers,
429 explicit_trailing_pattern: config.explicit_trailing_pattern.clone(),
430 },
431 per_command_overrides: config.per_command_overrides.clone(),
432 }
433 }
434}
435
436fn default_config_template_yaml() -> String {
437 format!(
438 concat!(
439 "# yaml-language-server: $schema=https://cmakefmt.dev/schemas/latest/schema.json\n",
440 "# Default cmakefmt configuration.\n",
441 "# Copy this to .cmakefmt.yaml and uncomment the optional settings\n",
442 "# you want to customize.\n\n",
443 "format:\n",
444 " # Disable formatting entirely (return source unchanged).\n",
445 " # disable: true\n\n",
446 " # Output line-ending style: unix (LF), windows (CRLF), or auto (detect from input).\n",
447 " # line_ending: windows\n\n",
448 " # Maximum rendered line width before cmakefmt wraps a call.\n",
449 " line_width: {line_width}\n\n",
450 " # Number of spaces per indentation level when use_tabs is false.\n",
451 " tab_size: {tab_size}\n\n",
452 " # Indent with tab characters instead of spaces.\n",
453 " # use_tabs: true\n\n",
454 " # How to handle fractional indentation when use_tabs is true: use-space or round-up.\n",
455 " # fractional_tab_policy: round-up\n\n",
456 " # Maximum number of consecutive blank lines to preserve.\n",
457 " max_empty_lines: {max_empty_lines}\n\n",
458 " # Maximum wrapped lines to tolerate before switching to a more vertical layout.\n",
459 " max_hanging_wrap_lines: {max_lines_hwrap}\n\n",
460 " # Maximum positional arguments to keep in a hanging-wrap layout.\n",
461 " max_hanging_wrap_positional_args: {max_pargs_hwrap}\n\n",
462 " # Maximum keyword/flag subgroups to keep in a hanging-wrap layout.\n",
463 " max_hanging_wrap_groups: {max_subgroups_hwrap}\n\n",
464 " # Maximum rows a hanging-wrap positional group may consume before nesting is forced.\n",
465 " max_rows_cmdline: {max_rows_cmdline}\n\n",
466 " # Commands that must always use vertical (wrapped) layout.\n",
467 " # always_wrap:\n",
468 " # - target_link_libraries\n\n",
469 " # Return an error if any formatted line exceeds line_width.\n",
470 " # require_valid_layout: true\n\n",
471 " # Put the closing ')' on its own line when a call wraps.\n",
472 " dangle_parens: {dangle_parens}\n\n",
473 " # Alignment strategy for a dangling ')': prefix, open, or close.\n",
474 " dangle_align: {dangle_align}\n\n",
475 " # Lower heuristic bound used when deciding between compact and wrapped layouts.\n",
476 " min_prefix_length: {min_prefix_chars}\n\n",
477 " # Upper heuristic bound used when deciding between compact and wrapped layouts.\n",
478 " max_prefix_length: {max_prefix_chars}\n\n",
479 " # Insert a space before '(' for control-flow commands like if/foreach.\n",
480 " # space_before_control_paren: true\n\n",
481 " # Insert a space before '(' for function() and macro() definitions.\n",
482 " # space_before_definition_paren: true\n\n",
483 " # Output casing for command names: lower, upper, or unchanged.\n",
484 " command_case: {command_case}\n\n",
485 " # Output casing for recognized keywords and flags: lower, upper, or unchanged.\n",
486 " keyword_case: {keyword_case}\n\n",
487 "markup:\n",
488 " # Enable markup-aware comment handling.\n",
489 " enable_markup: {enable_markup}\n\n",
490 " # Reflow plain line comments to fit within the configured line width.\n",
491 " # reflow_comments: true\n\n",
492 " # Preserve the first comment block in a file literally.\n",
493 " first_comment_is_literal: {first_comment_is_literal}\n\n",
494 " # Preserve comments matching a custom regex literally.\n",
495 " # literal_comment_pattern: '^\\s*NOTE:'\n\n",
496 " # Preferred bullet character when normalizing markup lists.\n",
497 " bullet_char: '{bullet_char}'\n\n",
498 " # Preferred punctuation for numbered lists when normalizing markup.\n",
499 " enum_char: '{enum_char}'\n\n",
500 " # Regex describing fenced literal comment blocks.\n",
501 " fence_pattern: '{fence_pattern}'\n\n",
502 " # Regex describing ruler-style comments that should be treated specially.\n",
503 " ruler_pattern: '{ruler_pattern}'\n\n",
504 " # Minimum ruler length before a hash-only line is treated as a ruler.\n",
505 " hashruler_min_length: {hashruler_min_length}\n\n",
506 " # Normalize ruler comments when markup handling is enabled.\n",
507 " canonicalize_hashrulers: {canonicalize_hashrulers}\n\n",
508 " # Regex pattern for inline comments that are explicitly trailing their preceding\n",
509 " # argument (rendered on the same line). Default: '#<'.\n",
510 " # explicit_trailing_pattern: '#<'\n\n",
511 "# Uncomment and edit a block like this to override formatting knobs\n",
512 "# for a specific command. This changes layout behavior for that\n",
513 "# command name only; it does not define new command syntax.\n",
514 "#\n",
515 "# per_command_overrides:\n",
516 "# my_custom_command:\n",
517 "# # Override the line width just for this command.\n",
518 "# line_width: 120\n",
519 "#\n",
520 "# # Override command casing just for this command.\n",
521 "# command_case: unchanged\n",
522 "#\n",
523 "# # Override keyword casing just for this command.\n",
524 "# keyword_case: upper\n",
525 "#\n",
526 "# # Override indentation width just for this command.\n",
527 "# tab_size: 4\n",
528 "#\n",
529 "# # Override dangling-paren placement just for this command.\n",
530 "# dangle_parens: false\n",
531 "#\n",
532 "# # Override dangling-paren alignment just for this command.\n",
533 "# dangle_align: prefix\n",
534 "#\n",
535 "# # Override the positional-argument hanging-wrap threshold just for this command.\n",
536 "# max_hanging_wrap_positional_args: 8\n",
537 "#\n",
538 "# # Override the subgroup hanging-wrap threshold just for this command.\n",
539 "# max_hanging_wrap_groups: 3\n\n",
540 "# YAML custom-command specs live under commands:<name>. Command\n",
541 "# specs tell the formatter which tokens are positional arguments,\n",
542 "# standalone flags, and keyword sections.\n",
543 "#\n",
544 "# Example: one positional argument, one flag, and two keyword\n",
545 "# sections that each take one or more values.\n",
546 "#\n",
547 "# commands:\n",
548 "# my_custom_command:\n",
549 "# pargs: 1\n",
550 "# flags:\n",
551 "# - QUIET\n",
552 "# kwargs:\n",
553 "# SOURCES:\n",
554 "# nargs: \"+\"\n",
555 "# LIBRARIES:\n",
556 "# nargs: \"+\"\n",
557 ),
558 line_width = Config::default().line_width,
559 tab_size = Config::default().tab_size,
560 max_empty_lines = Config::default().max_empty_lines,
561 max_lines_hwrap = Config::default().max_lines_hwrap,
562 max_pargs_hwrap = Config::default().max_pargs_hwrap,
563 max_subgroups_hwrap = Config::default().max_subgroups_hwrap,
564 max_rows_cmdline = Config::default().max_rows_cmdline,
565 dangle_parens = Config::default().dangle_parens,
566 dangle_align = "prefix",
567 min_prefix_chars = Config::default().min_prefix_chars,
568 max_prefix_chars = Config::default().max_prefix_chars,
569 command_case = "lower",
570 keyword_case = "upper",
571 enable_markup = Config::default().enable_markup,
572 first_comment_is_literal = Config::default().first_comment_is_literal,
573 bullet_char = Config::default().bullet_char,
574 enum_char = Config::default().enum_char,
575 fence_pattern = Config::default().fence_pattern,
576 ruler_pattern = Config::default().ruler_pattern,
577 hashruler_min_length = Config::default().hashruler_min_length,
578 canonicalize_hashrulers = Config::default().canonicalize_hashrulers,
579 )
580}
581
582impl Config {
583 pub fn for_file(file_path: &Path) -> Result<Self> {
590 let config_paths = find_config_files(file_path);
591 Self::from_files(&config_paths)
592 }
593
594 pub fn from_file(path: &Path) -> Result<Self> {
596 let paths = [path.to_path_buf()];
597 Self::from_files(&paths)
598 }
599
600 pub fn from_files(paths: &[PathBuf]) -> Result<Self> {
604 let mut config = Config::default();
605 for path in paths {
606 let file_config = load_config_file(path)?;
607 config.apply(file_config);
608 }
609 config.validate_patterns().map_err(Error::Formatter)?;
610 Ok(config)
611 }
612
613 pub fn from_yaml_str(yaml: &str) -> Result<Self> {
619 Ok(parse_yaml_config(yaml)?.config)
620 }
621
622 #[cfg_attr(not(target_arch = "wasm32"), allow(dead_code))]
625 pub(crate) fn from_yaml_str_with_commands(yaml: &str) -> Result<(Self, Option<Box<str>>)> {
626 let parsed = parse_yaml_config(yaml)?;
627 Ok((parsed.config, parsed.commands_yaml))
628 }
629
630 pub fn config_sources_for(file_path: &Path) -> Vec<PathBuf> {
636 find_config_files(file_path)
637 }
638
639 fn apply(&mut self, fc: FileConfig) {
640 if let Some(v) = fc.format.disable {
642 self.disable = v;
643 }
644 if let Some(v) = fc.format.line_ending {
645 self.line_ending = v;
646 }
647 if let Some(v) = fc.format.line_width {
648 self.line_width = v;
649 }
650 if let Some(v) = fc.format.tab_size {
651 self.tab_size = v;
652 }
653 if let Some(v) = fc.format.use_tabs {
654 self.use_tabchars = v;
655 }
656 if let Some(v) = fc.format.fractional_tab_policy {
657 self.fractional_tab_policy = v;
658 }
659 if let Some(v) = fc.format.max_empty_lines {
660 self.max_empty_lines = v;
661 }
662 if let Some(v) = fc.format.max_hanging_wrap_lines {
663 self.max_lines_hwrap = v;
664 }
665 if let Some(v) = fc.format.max_hanging_wrap_positional_args {
666 self.max_pargs_hwrap = v;
667 }
668 if let Some(v) = fc.format.max_hanging_wrap_groups {
669 self.max_subgroups_hwrap = v;
670 }
671 if let Some(v) = fc.format.max_rows_cmdline {
672 self.max_rows_cmdline = v;
673 }
674 if let Some(v) = fc.format.always_wrap {
675 self.always_wrap = v.into_iter().map(|s| s.to_ascii_lowercase()).collect();
676 }
677 if let Some(v) = fc.format.require_valid_layout {
678 self.require_valid_layout = v;
679 }
680 if let Some(v) = fc.format.dangle_parens {
681 self.dangle_parens = v;
682 }
683 if let Some(v) = fc.format.dangle_align {
684 self.dangle_align = v;
685 }
686 if let Some(v) = fc.format.min_prefix_length {
687 self.min_prefix_chars = v;
688 }
689 if let Some(v) = fc.format.max_prefix_length {
690 self.max_prefix_chars = v;
691 }
692 if let Some(v) = fc.format.space_before_control_paren {
693 self.separate_ctrl_name_with_space = v;
694 }
695 if let Some(v) = fc.format.space_before_definition_paren {
696 self.separate_fn_name_with_space = v;
697 }
698 if let Some(v) = fc.format.command_case {
699 self.command_case = v;
700 }
701 if let Some(v) = fc.format.keyword_case {
702 self.keyword_case = v;
703 }
704
705 if let Some(v) = fc.markup.enable_markup {
707 self.enable_markup = v;
708 }
709 if let Some(v) = fc.markup.reflow_comments {
710 self.reflow_comments = v;
711 }
712 if let Some(v) = fc.markup.first_comment_is_literal {
713 self.first_comment_is_literal = v;
714 }
715 if let Some(v) = fc.markup.literal_comment_pattern {
716 self.literal_comment_pattern = v;
717 }
718 if let Some(v) = fc.markup.bullet_char {
719 self.bullet_char = v;
720 }
721 if let Some(v) = fc.markup.enum_char {
722 self.enum_char = v;
723 }
724 if let Some(v) = fc.markup.fence_pattern {
725 self.fence_pattern = v;
726 }
727 if let Some(v) = fc.markup.ruler_pattern {
728 self.ruler_pattern = v;
729 }
730 if let Some(v) = fc.markup.hashruler_min_length {
731 self.hashruler_min_length = v;
732 }
733 if let Some(v) = fc.markup.canonicalize_hashrulers {
734 self.canonicalize_hashrulers = v;
735 }
736 if let Some(v) = fc.markup.explicit_trailing_pattern {
737 self.explicit_trailing_pattern = v;
738 }
739
740 for (name, overrides) in fc.per_command_overrides {
742 self.per_command_overrides.insert(name, overrides);
743 }
744 }
745}
746
747#[cfg_attr(not(target_arch = "wasm32"), allow(dead_code))]
748#[derive(Debug, Clone)]
749pub(crate) struct ParsedYamlConfig {
750 pub(crate) config: Config,
751 pub(crate) commands_yaml: Option<Box<str>>,
752}
753
754fn parse_yaml_config(yaml: &str) -> Result<ParsedYamlConfig> {
755 let file_config: FileConfig = serde_yaml::from_str(yaml).map_err(|source| {
756 Error::Config(crate::error::ConfigError {
757 path: std::path::PathBuf::from("<yaml-string>"),
758 details: FileParseError {
759 format: "yaml",
760 message: source.to_string().into_boxed_str(),
761 line: source.location().map(|loc| loc.line()),
762 column: source.location().map(|loc| loc.column()),
763 },
764 })
765 })?;
766 if !file_config.legacy_per_command.is_empty() {
767 return Err(Error::Config(crate::error::ConfigError {
768 path: std::path::PathBuf::from("<yaml-string>"),
769 details: FileParseError {
770 format: "yaml",
771 message: "`per_command` has been renamed to `per_command_overrides`"
772 .to_owned()
773 .into_boxed_str(),
774 line: None,
775 column: None,
776 },
777 }));
778 }
779 let commands_yaml = file_config
780 .commands
781 .as_ref()
782 .filter(|commands| !commands.is_null())
783 .map(serialize_commands_yaml)
784 .transpose()?;
785 let mut config = Config::default();
786 config.apply(file_config);
787 config.validate_patterns().map_err(|msg| {
788 Error::Config(crate::error::ConfigError {
789 path: std::path::PathBuf::from("<yaml-string>"),
790 details: FileParseError {
791 format: "yaml",
792 message: msg.into_boxed_str(),
793 line: None,
794 column: None,
795 },
796 })
797 })?;
798 Ok(ParsedYamlConfig {
799 config,
800 commands_yaml,
801 })
802}
803
804fn serialize_commands_yaml(commands: &serde_yaml::Value) -> Result<Box<str>> {
805 let key = serde_yaml::Value::String("commands".into());
806 let mut wrapper = serde_yaml::Mapping::new();
807 wrapper.insert(key, commands.clone());
808 serde_yaml::to_string(&wrapper)
809 .map(|yaml| yaml.into_boxed_str())
810 .map_err(|source| {
811 Error::Config(crate::error::ConfigError {
812 path: std::path::PathBuf::from("<yaml-string>"),
813 details: FileParseError {
814 format: "yaml",
815 message: format!("failed to serialize commands overrides: {source}")
816 .into_boxed_str(),
817 line: None,
818 column: None,
819 },
820 })
821 })
822}
823
824fn load_config_file(path: &Path) -> Result<FileConfig> {
825 let contents = std::fs::read_to_string(path).map_err(Error::Io)?;
826 let config: FileConfig = match detect_config_format(path)? {
827 ConfigFileFormat::Toml => toml::from_str(&contents).map_err(|source| {
828 let (line, column) = toml_line_col(&contents, source.span().map(|span| span.start));
829 Error::Config(crate::error::ConfigError {
830 path: path.to_path_buf(),
831 details: FileParseError {
832 format: ConfigFileFormat::Toml.as_str(),
833 message: source.to_string().into_boxed_str(),
834 line,
835 column,
836 },
837 })
838 }),
839 ConfigFileFormat::Yaml => serde_yaml::from_str(&contents).map_err(|source| {
840 let location = source.location();
841 let line = location.as_ref().map(|loc| loc.line());
842 let column = location.as_ref().map(|loc| loc.column());
843 Error::Config(crate::error::ConfigError {
844 path: path.to_path_buf(),
845 details: FileParseError {
846 format: ConfigFileFormat::Yaml.as_str(),
847 message: source.to_string().into_boxed_str(),
848 line,
849 column,
850 },
851 })
852 }),
853 }?;
854
855 if !config.legacy_per_command.is_empty() {
856 return Err(Error::Formatter(format!(
857 "{}: `per_command` has been renamed to `per_command_overrides`",
858 path.display()
859 )));
860 }
861
862 Ok(config)
863}
864
865fn find_config_files(file_path: &Path) -> Vec<PathBuf> {
872 let start_dir = if file_path.is_dir() {
873 file_path.to_path_buf()
874 } else {
875 file_path
876 .parent()
877 .map(Path::to_path_buf)
878 .unwrap_or_else(|| PathBuf::from("."))
879 };
880
881 let mut dir = Some(start_dir.as_path());
882 while let Some(d) = dir {
883 if let Some(candidate) = preferred_config_in_dir(d) {
884 return vec![candidate];
885 }
886
887 if d.join(".git").exists() {
888 break;
889 }
890
891 dir = d.parent();
892 }
893
894 if let Some(home) = home_dir() {
895 if let Some(home_config) = preferred_config_in_dir(&home) {
896 return vec![home_config];
897 }
898 }
899
900 Vec::new()
901}
902
903pub(crate) fn detect_config_format(path: &Path) -> Result<ConfigFileFormat> {
904 let file_name = path
905 .file_name()
906 .and_then(|name| name.to_str())
907 .unwrap_or_default();
908 if file_name == CONFIG_FILE_NAME_TOML
909 || path.extension().and_then(|ext| ext.to_str()) == Some("toml")
910 {
911 return Ok(ConfigFileFormat::Toml);
912 }
913 if matches!(file_name, CONFIG_FILE_NAME_YAML | CONFIG_FILE_NAME_YML)
914 || matches!(
915 path.extension().and_then(|ext| ext.to_str()),
916 Some("yaml" | "yml")
917 )
918 {
919 return Ok(ConfigFileFormat::Yaml);
920 }
921
922 Err(Error::Formatter(format!(
923 "{}: unsupported config format; use .cmakefmt.yaml, .cmakefmt.yml, or .cmakefmt.toml",
924 path.display()
925 )))
926}
927
928fn preferred_config_in_dir(dir: &Path) -> Option<PathBuf> {
929 CONFIG_FILE_NAMES
930 .iter()
931 .map(|name| dir.join(name))
932 .find(|candidate| candidate.is_file())
933}
934
935pub(crate) fn toml_line_col(
936 contents: &str,
937 offset: Option<usize>,
938) -> (Option<usize>, Option<usize>) {
939 let Some(offset) = offset else {
940 return (None, None);
941 };
942 let mut line = 1usize;
943 let mut column = 1usize;
944 for (index, ch) in contents.char_indices() {
945 if index >= offset {
946 break;
947 }
948 if ch == '\n' {
949 line += 1;
950 column = 1;
951 } else {
952 column += 1;
953 }
954 }
955 (Some(line), Some(column))
956}
957
958fn home_dir() -> Option<PathBuf> {
959 std::env::var_os("HOME")
960 .or_else(|| std::env::var_os("USERPROFILE"))
961 .map(PathBuf::from)
962}
963
964#[cfg(test)]
965mod tests {
966 use super::*;
967 use std::fs;
968
969 #[test]
970 fn parse_empty_config() {
971 let config: FileConfig = toml::from_str("").unwrap();
972 assert!(config.format.line_width.is_none());
973 }
974
975 #[test]
976 fn parse_full_config() {
977 let toml_str = r#"
978[format]
979line_width = 120
980tab_size = 4
981use_tabs = true
982max_empty_lines = 2
983dangle_parens = true
984dangle_align = "open"
985space_before_control_paren = true
986space_before_definition_paren = true
987max_hanging_wrap_positional_args = 3
988max_hanging_wrap_groups = 1
989command_case = "upper"
990keyword_case = "lower"
991
992[markup]
993enable_markup = false
994hashruler_min_length = 20
995
996[per_command_overrides.message]
997dangle_parens = true
998line_width = 100
999"#;
1000 let config: FileConfig = toml::from_str(toml_str).unwrap();
1001 assert_eq!(config.format.line_width, Some(120));
1002 assert_eq!(config.format.tab_size, Some(4));
1003 assert_eq!(config.format.use_tabs, Some(true));
1004 assert_eq!(config.format.dangle_parens, Some(true));
1005 assert_eq!(config.format.dangle_align, Some(DangleAlign::Open));
1006 assert_eq!(config.format.command_case, Some(CaseStyle::Upper));
1007 assert_eq!(config.format.keyword_case, Some(CaseStyle::Lower));
1008 assert_eq!(config.markup.enable_markup, Some(false));
1009
1010 let msg = config.per_command_overrides.get("message").unwrap();
1011 assert_eq!(msg.dangle_parens, Some(true));
1012 assert_eq!(msg.line_width, Some(100));
1013 }
1014
1015 #[test]
1016 fn old_format_key_aliases_are_rejected() {
1017 let toml_str = r#"
1018[format]
1019use_tabchars = true
1020max_lines_hwrap = 4
1021max_pargs_hwrap = 3
1022max_subgroups_hwrap = 2
1023min_prefix_chars = 5
1024max_prefix_chars = 11
1025separate_ctrl_name_with_space = true
1026separate_fn_name_with_space = true
1027"#;
1028 let err = toml::from_str::<FileConfig>(toml_str)
1029 .unwrap_err()
1030 .to_string();
1031 assert!(err.contains("unknown field"));
1032 }
1033
1034 #[test]
1035 fn config_from_file_applies_overrides() {
1036 let dir = tempfile::tempdir().unwrap();
1037 let config_path = dir.path().join(CONFIG_FILE_NAME_TOML);
1038 fs::write(
1039 &config_path,
1040 r#"
1041[format]
1042line_width = 100
1043tab_size = 4
1044command_case = "upper"
1045"#,
1046 )
1047 .unwrap();
1048
1049 let config = Config::from_file(&config_path).unwrap();
1050 assert_eq!(config.line_width, 100);
1051 assert_eq!(config.tab_size, 4);
1052 assert_eq!(config.command_case, CaseStyle::Upper);
1053 assert!(!config.use_tabchars);
1055 assert_eq!(config.max_empty_lines, 1);
1056 }
1057
1058 #[test]
1059 fn default_yaml_config_template_parses() {
1060 let template = default_config_template();
1061 let parsed: FileConfig = serde_yaml::from_str(&template).unwrap();
1062 assert_eq!(parsed.format.line_width, Some(Config::default().line_width));
1063 assert_eq!(
1064 parsed.format.command_case,
1065 Some(Config::default().command_case)
1066 );
1067 assert_eq!(
1068 parsed.markup.enable_markup,
1069 Some(Config::default().enable_markup)
1070 );
1071 }
1072
1073 #[test]
1074 fn toml_config_template_parses() {
1075 let template = default_config_template_for(DumpConfigFormat::Toml);
1076 let parsed: FileConfig = toml::from_str(&template).unwrap();
1077 assert_eq!(parsed.format.line_width, Some(Config::default().line_width));
1078 assert_eq!(
1079 parsed.format.command_case,
1080 Some(Config::default().command_case)
1081 );
1082 assert_eq!(
1083 parsed.markup.enable_markup,
1084 Some(Config::default().enable_markup)
1085 );
1086 }
1087
1088 #[test]
1089 fn missing_config_file_uses_defaults() {
1090 let dir = tempfile::tempdir().unwrap();
1091 let fake_file = dir.path().join("CMakeLists.txt");
1092 fs::write(&fake_file, "").unwrap();
1093
1094 let config = Config::for_file(&fake_file).unwrap();
1095 assert_eq!(config, Config::default());
1096 }
1097
1098 #[test]
1099 fn config_file_in_parent_is_found() {
1100 let dir = tempfile::tempdir().unwrap();
1101 fs::create_dir(dir.path().join(".git")).unwrap();
1103 fs::write(
1104 dir.path().join(CONFIG_FILE_NAME_TOML),
1105 "[format]\nline_width = 120\n",
1106 )
1107 .unwrap();
1108
1109 let subdir = dir.path().join("src");
1110 fs::create_dir(&subdir).unwrap();
1111 let file = subdir.join("CMakeLists.txt");
1112 fs::write(&file, "").unwrap();
1113
1114 let config = Config::for_file(&file).unwrap();
1115 assert_eq!(config.line_width, 120);
1116 }
1117
1118 #[test]
1119 fn closer_config_wins() {
1120 let dir = tempfile::tempdir().unwrap();
1121 fs::create_dir(dir.path().join(".git")).unwrap();
1122 fs::write(
1123 dir.path().join(CONFIG_FILE_NAME_TOML),
1124 "[format]\nline_width = 120\ntab_size = 4\n",
1125 )
1126 .unwrap();
1127
1128 let subdir = dir.path().join("src");
1129 fs::create_dir(&subdir).unwrap();
1130 fs::write(
1131 subdir.join(CONFIG_FILE_NAME_TOML),
1132 "[format]\nline_width = 100\n",
1133 )
1134 .unwrap();
1135
1136 let file = subdir.join("CMakeLists.txt");
1137 fs::write(&file, "").unwrap();
1138
1139 let config = Config::for_file(&file).unwrap();
1140 assert_eq!(config.line_width, 100);
1142 assert_eq!(config.tab_size, Config::default().tab_size);
1143 }
1144
1145 #[test]
1146 fn from_files_merges_in_order() {
1147 let dir = tempfile::tempdir().unwrap();
1148 let first = dir.path().join("first.toml");
1149 let second = dir.path().join("second.toml");
1150 fs::write(&first, "[format]\nline_width = 120\ntab_size = 4\n").unwrap();
1151 fs::write(&second, "[format]\nline_width = 100\n").unwrap();
1152
1153 let config = Config::from_files(&[first, second]).unwrap();
1154 assert_eq!(config.line_width, 100);
1155 assert_eq!(config.tab_size, 4);
1156 }
1157
1158 #[test]
1159 fn yaml_config_from_file_applies_overrides() {
1160 let dir = tempfile::tempdir().unwrap();
1161 let config_path = dir.path().join(CONFIG_FILE_NAME_YAML);
1162 fs::write(
1163 &config_path,
1164 "format:\n line_width: 100\n tab_size: 4\n command_case: upper\n",
1165 )
1166 .unwrap();
1167
1168 let config = Config::from_file(&config_path).unwrap();
1169 assert_eq!(config.line_width, 100);
1170 assert_eq!(config.tab_size, 4);
1171 assert_eq!(config.command_case, CaseStyle::Upper);
1172 }
1173
1174 #[test]
1175 fn yml_config_from_file_applies_overrides() {
1176 let dir = tempfile::tempdir().unwrap();
1177 let config_path = dir.path().join(CONFIG_FILE_NAME_YML);
1178 fs::write(
1179 &config_path,
1180 "format:\n keyword_case: lower\n line_width: 90\n",
1181 )
1182 .unwrap();
1183
1184 let config = Config::from_file(&config_path).unwrap();
1185 assert_eq!(config.line_width, 90);
1186 assert_eq!(config.keyword_case, CaseStyle::Lower);
1187 }
1188
1189 #[test]
1190 fn yaml_is_preferred_over_toml_during_discovery() {
1191 let dir = tempfile::tempdir().unwrap();
1192 fs::create_dir(dir.path().join(".git")).unwrap();
1193 fs::write(
1194 dir.path().join(CONFIG_FILE_NAME_TOML),
1195 "[format]\nline_width = 120\n",
1196 )
1197 .unwrap();
1198 fs::write(
1199 dir.path().join(CONFIG_FILE_NAME_YAML),
1200 "format:\n line_width: 90\n",
1201 )
1202 .unwrap();
1203
1204 let file = dir.path().join("CMakeLists.txt");
1205 fs::write(&file, "").unwrap();
1206
1207 let config = Config::for_file(&file).unwrap();
1208 assert_eq!(config.line_width, 90);
1209 assert_eq!(
1210 Config::config_sources_for(&file),
1211 vec![dir.path().join(CONFIG_FILE_NAME_YAML)]
1212 );
1213 }
1214
1215 #[test]
1216 fn invalid_config_returns_error() {
1217 let dir = tempfile::tempdir().unwrap();
1218 let path = dir.path().join(CONFIG_FILE_NAME_TOML);
1219 fs::write(&path, "this is not valid toml {{{").unwrap();
1220
1221 let result = Config::from_file(&path);
1222 assert!(result.is_err());
1223 let err = result.unwrap_err();
1224 assert!(err.to_string().contains("config error"));
1225 }
1226
1227 #[test]
1228 fn config_from_yaml_file_applies_all_sections_and_overrides() {
1229 let dir = tempfile::tempdir().unwrap();
1230 let config_path = dir.path().join(CONFIG_FILE_NAME_YAML);
1231 fs::write(
1232 &config_path,
1233 r#"
1234format:
1235 line_width: 96
1236 tab_size: 3
1237 use_tabs: true
1238 max_empty_lines: 2
1239 max_hanging_wrap_lines: 4
1240 max_hanging_wrap_positional_args: 7
1241 max_hanging_wrap_groups: 5
1242 dangle_parens: true
1243 dangle_align: open
1244 min_prefix_length: 2
1245 max_prefix_length: 12
1246 space_before_control_paren: true
1247 space_before_definition_paren: true
1248 command_case: unchanged
1249 keyword_case: lower
1250markup:
1251 enable_markup: false
1252 reflow_comments: true
1253 first_comment_is_literal: false
1254 literal_comment_pattern: '^\\s*KEEP'
1255 bullet_char: '-'
1256 enum_char: ')'
1257 fence_pattern: '^\\s*(```+).*'
1258 ruler_pattern: '^\\s*={5,}\\s*$'
1259 hashruler_min_length: 42
1260 canonicalize_hashrulers: false
1261per_command_overrides:
1262 my_custom_command:
1263 line_width: 101
1264 tab_size: 5
1265 dangle_parens: false
1266 dangle_align: prefix
1267 max_hanging_wrap_positional_args: 8
1268 max_hanging_wrap_groups: 9
1269"#,
1270 )
1271 .unwrap();
1272
1273 let config = Config::from_file(&config_path).unwrap();
1274 assert_eq!(config.line_width, 96);
1275 assert_eq!(config.tab_size, 3);
1276 assert!(config.use_tabchars);
1277 assert_eq!(config.max_empty_lines, 2);
1278 assert_eq!(config.max_lines_hwrap, 4);
1279 assert_eq!(config.max_pargs_hwrap, 7);
1280 assert_eq!(config.max_subgroups_hwrap, 5);
1281 assert!(config.dangle_parens);
1282 assert_eq!(config.dangle_align, DangleAlign::Open);
1283 assert_eq!(config.min_prefix_chars, 2);
1284 assert_eq!(config.max_prefix_chars, 12);
1285 assert!(config.separate_ctrl_name_with_space);
1286 assert!(config.separate_fn_name_with_space);
1287 assert_eq!(config.command_case, CaseStyle::Unchanged);
1288 assert_eq!(config.keyword_case, CaseStyle::Lower);
1289 assert!(!config.enable_markup);
1290 assert!(config.reflow_comments);
1291 assert!(!config.first_comment_is_literal);
1292 assert_eq!(config.literal_comment_pattern, "^\\\\s*KEEP");
1293 assert_eq!(config.bullet_char, "-");
1294 assert_eq!(config.enum_char, ")");
1295 assert_eq!(config.fence_pattern, "^\\\\s*(```+).*");
1296 assert_eq!(config.ruler_pattern, "^\\\\s*={5,}\\\\s*$");
1297 assert_eq!(config.hashruler_min_length, 42);
1298 assert!(!config.canonicalize_hashrulers);
1299 let per_command = config
1300 .per_command_overrides
1301 .get("my_custom_command")
1302 .unwrap();
1303 assert_eq!(per_command.line_width, Some(101));
1304 assert_eq!(per_command.tab_size, Some(5));
1305 assert_eq!(per_command.dangle_parens, Some(false));
1306 assert_eq!(per_command.dangle_align, Some(DangleAlign::Prefix));
1307 assert_eq!(per_command.max_pargs_hwrap, Some(8));
1308 assert_eq!(per_command.max_subgroups_hwrap, Some(9));
1309 }
1310
1311 #[test]
1312 fn detect_config_format_supports_yaml_and_rejects_unknown() {
1313 assert!(matches!(
1314 detect_config_format(Path::new(".cmakefmt.yml")).unwrap(),
1315 ConfigFileFormat::Yaml
1316 ));
1317 assert!(matches!(
1318 detect_config_format(Path::new("tooling/settings.yaml")).unwrap(),
1319 ConfigFileFormat::Yaml
1320 ));
1321 assert!(matches!(
1322 detect_config_format(Path::new("project.toml")).unwrap(),
1323 ConfigFileFormat::Toml
1324 ));
1325 let err = detect_config_format(Path::new("config.json")).unwrap_err();
1326 assert!(err.to_string().contains("unsupported config format"));
1327 }
1328
1329 #[test]
1330 fn yaml_config_with_legacy_per_command_key_is_rejected() {
1331 let dir = tempfile::tempdir().unwrap();
1332 let config_path = dir.path().join(CONFIG_FILE_NAME_YAML);
1333 fs::write(
1334 &config_path,
1335 "per_command:\n message:\n line_width: 120\n",
1336 )
1337 .unwrap();
1338 let err = Config::from_file(&config_path).unwrap_err();
1339 assert!(err
1340 .to_string()
1341 .contains("`per_command` has been renamed to `per_command_overrides`"));
1342 }
1343
1344 #[test]
1345 fn invalid_yaml_reports_line_and_column() {
1346 let dir = tempfile::tempdir().unwrap();
1347 let config_path = dir.path().join(CONFIG_FILE_NAME_YAML);
1348 fs::write(&config_path, "format:\n line_width: [\n").unwrap();
1349
1350 let err = Config::from_file(&config_path).unwrap_err();
1351 match err {
1352 Error::Config(config_err) => {
1353 let details = &config_err.details;
1354 assert_eq!(details.format, "YAML");
1355 assert!(details.line.is_some());
1356 assert!(details.column.is_some());
1357 }
1358 other => panic!("expected config parse error, got {other:?}"),
1359 }
1360 }
1361
1362 #[test]
1363 fn toml_line_col_returns_none_when_offset_is_missing() {
1364 assert_eq!(toml_line_col("line = true\n", None), (None, None));
1365 }
1366
1367 #[test]
1370 fn from_yaml_str_parses_format_section() {
1371 let config = Config::from_yaml_str("format:\n line_width: 120\n tab_size: 4").unwrap();
1372 assert_eq!(config.line_width, 120);
1373 assert_eq!(config.tab_size, 4);
1374 }
1375
1376 #[test]
1377 fn from_yaml_str_parses_casing_in_format_section() {
1378 let config = Config::from_yaml_str("format:\n command_case: upper").unwrap();
1379 assert_eq!(config.command_case, CaseStyle::Upper);
1380 }
1381
1382 #[test]
1383 fn from_yaml_str_parses_markup_section() {
1384 let config = Config::from_yaml_str("markup:\n enable_markup: false").unwrap();
1385 assert!(!config.enable_markup);
1386 }
1387
1388 #[test]
1389 fn from_yaml_str_with_commands_extracts_serialized_commands_block() {
1390 let (_, commands_yaml) =
1391 Config::from_yaml_str_with_commands("commands:\n my_cmd:\n pargs: 1").unwrap();
1392 let commands_yaml = commands_yaml.expect("expected serialized commands YAML");
1393 assert!(commands_yaml.contains("commands:"));
1394 assert!(commands_yaml.contains("my_cmd:"));
1395 }
1396
1397 #[test]
1398 fn from_yaml_str_rejects_unknown_top_level_field() {
1399 let result = Config::from_yaml_str("bogus_section:\n foo: bar");
1400 assert!(result.is_err());
1401 }
1402
1403 #[test]
1404 fn from_yaml_str_rejects_unknown_format_field() {
1405 let result = Config::from_yaml_str("format:\n nonexistent: 42");
1406 assert!(result.is_err());
1407 }
1408
1409 #[test]
1410 fn from_yaml_str_rejects_invalid_yaml() {
1411 let result = Config::from_yaml_str("{{invalid");
1412 assert!(result.is_err());
1413 }
1414
1415 #[test]
1416 fn from_yaml_str_empty_string_returns_defaults() {
1417 let config = Config::from_yaml_str("").unwrap();
1418 assert_eq!(config.line_width, Config::default().line_width);
1419 }
1420
1421 #[test]
1422 fn from_yaml_str_multiple_sections() {
1423 let config =
1424 Config::from_yaml_str("format:\n line_width: 100\n command_case: upper").unwrap();
1425 assert_eq!(config.line_width, 100);
1426 assert_eq!(config.command_case, CaseStyle::Upper);
1427 }
1428
1429 #[test]
1430 fn from_yaml_str_rejects_legacy_per_command() {
1431 let result = Config::from_yaml_str("per_command:\n message:\n line_width: 120");
1432 assert!(result.is_err());
1433 let err = result.unwrap_err().to_string();
1434 assert!(
1435 err.contains("per_command_overrides"),
1436 "error should mention the new key name: {err}"
1437 );
1438 }
1439}