Read user configuration from `~/.config/ruff/ruff.toml` on macOS by charliermarsh · Pull Request #11115 · astral-sh/ruff

charliermarsh · 2024-04-23T20:08:24Z

Summary

This PR moves Ruff's user-specific configuration from ~/Library/Application Support/ruff/ruff.toml to ~/.config/ruff/ruff.toml.

Many other tools do this. On my machine alone: dagger, zed, gatsby, gh, wandb, etc.

I also polled Twitter and it won in a landslide:

Let's ship this in v0.5.0, along with a deprecation warning (so we'll continue to respect ~/Library/Application Support/ruff/ruff.toml, but log a warning).

Closes #10739.

Test Plan

Created a file with an unused import.
Ran cargo check foo.py.
Verified that the deprecated configuration was loaded and respected, with a warning:

warning: Reading configuration from `~/Library/Application Support` is deprecated. Please move your configuration to `/Users/crmarsh/.config/ruff/ruff/ruff.toml`.
[2024-04-23][16:09:10][ruff::resolve][DEBUG] Using configuration file (via cwd) at: /Users/crmarsh/Library/Application Support/ruff/ruff.toml

Created ~/.config/ruff/ruff.toml.
Verified that the new configuration was loaded:

[2024-04-23][16:10:23][ruff::resolve][DEBUG] Using configuration file (via cwd) at: /Users/crmarsh/.config/ruff/ruff.toml

charliermarsh · 2024-04-23T20:28:17Z

Cargo.toml

 dirs = { version = "5.0.0" }
 drop_bomb = { version = "0.1.5" }
 env_logger = { version = "0.11.0" }
+etcetera = { version = "0.8.0" }


@konstin suggested this crate, and it does what we want across Windows and Linux / macOS, but open to other suggestions.

charliermarsh · 2024-04-23T20:28:37Z

Cargo.toml

@@ -34,6 +34,7 @@ crossbeam = { version = "0.8.4" }
 dirs = { version = "5.0.0" }


We can remove dirs in a future release, but it stays around for now for backwards compatibility.

github-actions · 2024-04-23T20:45:59Z

`ruff-ecosystem` results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

Formatter (stable)

✅ ecosystem check detected no format changes.

Formatter (preview)

✅ ecosystem check detected no format changes.

MichaReiser · 2024-04-24T07:28:12Z

Sooo, we're doing twitter driven development now 😂

konstin · 2024-04-24T11:36:22Z

I would change the reasoning/description: Follow the XDG specification on all Unix platforms. Ruff will now use the XDG config directory to read user-level configuration (default: ~/.config/ruff/ruff.toml) over Library/Application Support/ruff/ruff.toml on macOS.

MichaReiser · 2024-06-24T12:23:11Z

crates/ruff_workspace/src/pyproject.rs

-        return Some(path);
+    // On macOS, we used to support reading from `/Users/Alice/Library/Application Support`.
+    if cfg!(target_os = "macos") {
+        let deprecated_config_dir = dirs::config_dir()?.join("ruff");


Could we use https://docs.rs/etcetera/latest/etcetera/app_strategy/struct.Apple.html here and remove the dirs dependency (trading one dependency for another ;))

Okay I checked, we can use the Apple strategy but we need to use the data_dir to map to the Application Support folder (hardcoded).

The etcetera crate clearly documents that config_dir shouldn't be used on Mac when the config is user editable. I'm going to make this change.

From the dirs documentation:

// Mac: Some(/Users/Alice/Library/Application Support) dirs::config_dir();

From the etcetera documentation:

assert_eq!( base_strategy.data_dir().strip_prefix(&home_dir), Ok(Path::new("Library/Application Support/")) );

Interesting. Feel free to merge.

codspeed-hq · 2024-06-24T12:50:08Z

CodSpeed Performance Report

Merging #11115 will degrade performances by 4.69%

_{Comparing charlie/xdg (c4d143a) with ruff-0.5 (9348821)}

Summary

❌ 1 regressions
✅ 29 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

	Benchmark	`ruff-0.5`	`charlie/xdg`	Change
❌	`linter/default-rules[pydantic/types.py]`	1.8 ms	1.9 ms	-4.69%

MichaReiser · 2024-06-24T13:03:51Z

I ran through the test plan and verified the deprecation message.

) Co-authored-by: Micha Reiser <[email protected]> Closes #10739.

## Summary In #11115 we moved from defaulting to $HOME/Library/Application Support to $XDG_HOME on macOS and added a deprecation warning if we find files in the old location. So this PR removes the warning closes #19145 ## Test Plan Ran `cargo test`

charliermarsh force-pushed the charlie/xdg branch from a663349 to 72b3e76 Compare April 23, 2024 20:11

charliermarsh added this to the v0.5.0 milestone Apr 23, 2024

charliermarsh added breaking Breaking API change configuration Related to settings and configuration and removed breaking Breaking API change labels Apr 23, 2024

charliermarsh requested review from konstin and zanieb April 23, 2024 20:11

charliermarsh force-pushed the charlie/xdg branch from 72b3e76 to a1f871d Compare April 23, 2024 20:27

charliermarsh commented Apr 23, 2024

View reviewed changes

MichaReiser approved these changes Apr 24, 2024

View reviewed changes

konstin approved these changes Apr 24, 2024

View reviewed changes

MichaReiser reviewed Jun 24, 2024

View reviewed changes

Read user configuration from ~/.config/ruff/ruff.toml on macOS

59dd18d

MichaReiser force-pushed the charlie/xdg branch from a1f871d to 59dd18d Compare June 24, 2024 12:25

MichaReiser changed the base branch from main to ruff-0.5 June 24, 2024 12:26

MichaReiser self-assigned this Jun 24, 2024

Remove dirs dependency

38199c3

MichaReiser added 2 commits June 24, 2024 14:58

Fix WASM build

d681e49

Fix deprecation message

c4d143a

MichaReiser merged commit 25efb82 into ruff-0.5 Jun 24, 2024

MichaReiser deleted the charlie/xdg branch June 24, 2024 13:20

MichaReiser added the breaking Breaking API change label Jun 24, 2024

MichaReiser mentioned this pull request Jun 26, 2024

Ruff 0.5 #12005

Merged

MichaReiser added a commit that referenced this pull request Jun 27, 2024

Read user configuration from ~/.config/ruff/ruff.toml on macOS (#11115

3ce9d6a

) Co-authored-by: Micha Reiser <[email protected]> Closes #10739.

MichaReiser added a commit that referenced this pull request Jun 27, 2024

Read user configuration from ~/.config/ruff/ruff.toml on macOS (#11115

117203f

) Co-authored-by: Micha Reiser <[email protected]> Closes #10739.

ntBre mentioned this pull request Jul 4, 2025

Consider removing deprecated macOS config file discovery #19145

Closed

This was referenced Jul 8, 2025

refactor(ruff_workspace): remove macOS deprecation warning #19209

Closed

Remove deprecated macOS config file discovery #19210

Merged

delafthi mentioned this pull request Jul 22, 2025

Support XDG_CONFIG_HOME on macOS for config directory resolution ulyssa/iamb#478

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Read user configuration from `~/.config/ruff/ruff.toml` on macOS#11115

Read user configuration from `~/.config/ruff/ruff.toml` on macOS#11115
MichaReiser merged 4 commits intoruff-0.5from
charlie/xdg

charliermarsh commented Apr 23, 2024 •

edited

Loading

Uh oh!

charliermarsh Apr 23, 2024

Uh oh!

charliermarsh Apr 23, 2024

Uh oh!

github-actions bot commented Apr 23, 2024 •

edited

Loading

Uh oh!

MichaReiser commented Apr 24, 2024 •

edited

Loading

Uh oh!

konstin commented Apr 24, 2024

Uh oh!

MichaReiser Jun 24, 2024

Uh oh!

MichaReiser Jun 24, 2024 •

edited

Loading

Uh oh!

charliermarsh Jun 24, 2024

Uh oh!

codspeed-hq bot commented Jun 24, 2024 •

edited

Loading

Uh oh!

MichaReiser commented Jun 24, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -34,6 +34,7 @@ crossbeam = { version = "0.8.4" }
		dirs = { version = "5.0.0" }

Comments

Conversation

charliermarsh commented Apr 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test Plan

Uh oh!

charliermarsh Apr 23, 2024

Choose a reason for hiding this comment

Uh oh!

charliermarsh Apr 23, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ruff-ecosystem results

Linter (stable)

Linter (preview)

Formatter (stable)

Formatter (preview)

Uh oh!

MichaReiser commented Apr 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

konstin commented Apr 24, 2024

Uh oh!

MichaReiser Jun 24, 2024

Choose a reason for hiding this comment

Uh oh!

MichaReiser Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

charliermarsh Jun 24, 2024

Choose a reason for hiding this comment

Uh oh!

codspeed-hq bot commented Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #11115 will degrade performances by 4.69%

Summary

Benchmarks breakdown

Uh oh!

MichaReiser commented Jun 24, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

charliermarsh commented Apr 23, 2024 •

edited

Loading

github-actions bot commented Apr 23, 2024 •

edited

Loading

`ruff-ecosystem` results

MichaReiser commented Apr 24, 2024 •

edited

Loading

MichaReiser Jun 24, 2024 •

edited

Loading

codspeed-hq bot commented Jun 24, 2024 •

edited

Loading