Collect preview lint behaviors in separate module #17646
Conversation
|
|
You could probably do a |
Unfortunately that's not an allowed visibility (it has to be an ancestor module). But if you think it's okay to not enforce this statically, then I'm on board too! |
There was a problem hiding this comment.
Nice. Thanks for going through all existing preview checks. I'm surprised that there aren't more.
Would the visibility restriction work if you moved preview.rs to settings/preview?
As an "alternative", we could consider making preview private and instead expose it as a preview method and document that it's recommended to add a new function to preview.rs.
So I tried something like this, but the issue was:
So it's less about controlling the visibility of querying preview, and more about figuring out how to deal with the resulting difficulty in setting preview. I'm also happy to leave this as is for now if there isn't a simple solution, or if we want to do a follow up later. |
|
Oh, I missed that. I'm fine leaving it |
* main: (37 commits) [red-knot] Revert blanket `clippy::too_many_arguments` allow (#17688) Add config option to disable `typing_extensions` imports (#17611) ruff_db: render file paths in diagnostics as relative paths if possible Bump mypy_primer pin (#17685) red_knot_python_semantic: improve `not-iterable` diagnostic [red-knot] Allow all callables to be assignable to @Todo-signatures (#17680) [`refurb`] Mark fix as safe for `readlines-in-for` (`FURB129`) (#17644) Collect preview lint behaviors in separate module (#17646) Upgrade Salsa to a more recent commit (#17678) [red-knot] TypedDict: No errors for introspection dunder attributes (#17677) [`flake8-pyi`] Ensure `Literal[None,] | Literal[None,]` is not autofixed to `None | None` (`PYI061`) (#17659) [red-knot] No errors for definitions of `TypedDict`s (#17674) Update actions/download-artifact digest to d3f86a1 (#17664) [red-knot] Use 101 exit code when there's at least one diagnostic with severity 'fatal' (#17640) [`pycodestyle`] Fix duplicated diagnostic in `E712` (#17651) [airflow] fix typos `AIR312` (#17673) [red-knot] Don't ignore hidden files by default (#17655) Update pre-commit hook astral-sh/ruff-pre-commit to v0.11.7 (#17670) Update docker/build-push-action digest to 14487ce (#17665) Update taiki-e/install-action digest to ab3728c (#17666) ...
This PR collects all behavior gated under preview into a new module
ruff_linter::previewthat exposes functions likeis_my_new_feature_enabled- just as is done in the formatter crate.One thing I'd like to do before moving this out of draft is see if there is a way to enforce that
ruff_linter::rulescan never access thepreviewfield inLinterSettings.Here is one approach to this:
previewfield privateQueryPreviewwith one memberfn preview(&self) -> PreviewMode;, then implement this member forLinterSettingsruff_linter::preview, import the trait. But don't import it inruff_linter::rulesThe downside of this approach is that there are several places where we initialize
LinterSettingsby specifying all of its fields. So we'd have to change those to builder methods.I would not be surprised if there is a simple and standard way to enforce the visibility I'm after, I just don't quite know which
pub(in ...),pub(super),pub(crate), etc. thing I should be doing that would basically makepreviewaccessible everywhere except inruff_linter::rules. Suggestions?