Misleading error hint about unknown configuration file keys

[pradyunsg]

Version: 0.5.2

Reproduction instructions

1. Create a ruff.toml file with the contents:

   extend-select = [
       "W", # pycodestyle warnings
       "I", # isort
       "N", # pep8-naming
       "D", # pydocstyle
       "B", # flake8-bugbear
       "PYI" # flake8-pyi
   ]
   
   # Group errors by file.
   output-format = "grouped"
   
   # Show source context of error.
   show-source = true
   
   # Show summary of fixes.
   show-fixes = true

2. Create a src/foo.py file with no contents.

3. Run ruff check and see the problematic error message.

Output

❯ ruff check
ruff failed
  Cause: Failed to parse /Users/[...]/ruff.toml
  Cause: TOML parse error at line 1, column 1
  |
1 | extend-select = [
  | ^^^^^^^^^^^^^^^^^
unknown field `show-source`

The error message points to the line about extend-select when complaining about show-source as the key that is unknown. It would be better for the error to point at line 14 entirely OR, ideally, point only at show-source part of that line since that's the key in the key-value pair in the configuration file that is unknown.

[MichaReiser]

That makes sense. Although I don't think there's much that we can do about it other than writing our own toml parser. The error message comes directly from the toml crate

ruff/crates/ruff_workspace/src/pyproject.rs

Lines 52 to 55 in 117203f

	let contents = std::fs::read_to_string(path.as_ref())
	.with_context(|| format!("Failed to read {}", path.as_ref().display()))?;
	toml::from_str(&contents)
	.with_context(|| format!("Failed to parse {}", path.as_ref().display()))

[MichaReiser]

Could be related to toml-rs/toml#589

[charliermarsh]

Yeah that's a shame. Thanks @pradyunsg.