mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-29 05:14:52 +00:00
796819e7a0
## Summary We use the `System` abstraction in ty to abstract away the host/system on which ty runs. This has a few benefits: * Tests can run in full isolation using a memory system (that uses an in-memory file system) * The LSP has a custom implementation where `read_to_string` returns the content as seen by the editor (e.g. unsaved changes) instead of always returning the content as it is stored on disk * We don't require any file system polyfills for wasm in the browser However, it does require extra care that we don't accidentally use `std::fs` or `std::env` (etc.) methods in ty's code base (which is very easy). This PR sets up Clippy and disallows the most common methods, instead pointing users towards the corresponding `System` methods. The setup is a bit awkward because clippy doesn't support inheriting configurations. That means, a crate can only override the entire workspace configuration or not at all. The approach taken in this PR is: * Configure the disallowed methods at the workspace level * Allow `disallowed_methods` at the workspace level * Enable the lint at the crate level using the warn attribute (in code) The obvious downside is that it won't work if we ever want to disallow other methods, but we can figure that out once we reach that point. What about false positives: Just add an `allow` and move on with your life :) This isn't something that we have to enforce strictly; the goal is to catch accidental misuse. ## Test Plan Clippy found a place where we incorrectly used `std::fs::read_to_string`
43 lines
1.9 KiB
TOML
43 lines
1.9 KiB
TOML
doc-valid-idents = [
|
|
"..",
|
|
"CodeQL",
|
|
"CPython",
|
|
"FastAPI",
|
|
"IPython",
|
|
"LangChain",
|
|
"LibCST",
|
|
"McCabe",
|
|
"NumPy",
|
|
"SCREAMING_SNAKE_CASE",
|
|
"SQLAlchemy",
|
|
"StackOverflow",
|
|
"PyCharm",
|
|
"SNMPv1",
|
|
"SNMPv2",
|
|
"SNMPv3",
|
|
"PyFlakes",
|
|
]
|
|
|
|
ignore-interior-mutability = [
|
|
# Interned is read-only. The wrapped `Rc` never gets updated.
|
|
"ruff_formatter::format_element::Interned",
|
|
# The expression is read-only.
|
|
"ruff_python_ast::hashable::HashableExpr",
|
|
]
|
|
|
|
disallowed-methods = [
|
|
{ path = "std::env::var", reason = "Use System::env_var instead in ty crates" },
|
|
{ path = "std::env::current_dir", reason = "Use System::current_directory instead in ty crates" },
|
|
{ path = "std::fs::read_to_string", reason = "Use System::read_to_string instead in ty crates" },
|
|
{ path = "std::fs::metadata", reason = "Use System::path_metadata instead in ty crates" },
|
|
{ path = "std::fs::canonicalize", reason = "Use System::canonicalize_path instead in ty crates" },
|
|
{ path = "dunce::canonicalize", reason = "Use System::canonicalize_path instead in ty crates" },
|
|
{ path = "std::fs::read_dir", reason = "Use System::read_directory instead in ty crates" },
|
|
{ path = "std::fs::write", reason = "Use WritableSystem::write_file instead in ty crates" },
|
|
{ path = "std::fs::create_dir_all", reason = "Use WritableSystem::create_directory_all instead in ty crates" },
|
|
{ path = "std::fs::File::create_new", reason = "Use WritableSystem::create_new_file instead in ty crates" },
|
|
# Path methods that have System trait equivalents
|
|
{ path = "std::path::Path::exists", reason = "Use System::path_exists instead in ty crates" },
|
|
{ path = "std::path::Path::is_dir", reason = "Use System::is_directory instead in ty crates" },
|
|
{ path = "std::path::Path::is_file", reason = "Use System::is_file instead in ty crates" },
|
|
]
|