Add `[format|lint].exclude` options by MichaReiser · Pull Request #8000 · astral-sh/ruff

MichaReiser · 2023-10-17T03:01:00Z

Summary

This PR introduces the new options lint.exclude and format.exclude that allow excluding files from linting or formatting only.

Being able to exclude entire files is useful when:

you have generated code that you only want to format but not lint (or the other way round)
you have sub modules that you only want to lint because the code isn't using a formatter yet (but the rest of the project is)

Closes #7645

Considerations

The check command (and now the format command) exposes the exclude option. This is the global exclude and not the lint.exclude or format.exclude. Only exposing the global exclude option should be sufficient and make little difference except if the user wants to clear out the lint|format.exclude option via the CLI.

Only exposing the global exclude option makes sense for me, considering that we plan to unify linting and formatting under the check command in the future. Whether this is the right design for format is less clear to me but I think it's in line with check and we can still decide to add a format-exclude CLI option if it proves necessary.

Test Plan

I added new integration tests that test the tool specific exclusion.

I played around with the airflow repository and excluded files for linting or formatting only and verified that they are only excluded for the specific tool (and the result is the same as when excluding the files globally). Verified that a file passed directly gets linted/formated regardless if it is excluded or not.

MichaReiser · 2023-10-17T03:01:11Z

Current dependencies on/for this PR:

main
- PR Add [format|lint].exclude options #8000 👈
  - PR Add lint.preview #8002
    - PR Document lint.preview and format.preview #8032
    - PR Respect tab-size setting in formatter #8006
      - PR Respect #(deprecated) attribute in configuration options #8035
        
        PR Rename *-length options to -width #8010
        
        PR Rename tab-size to indent-width #8082
        
        PR Warn about incompatible formatter options #8088
        
        PR New pycodestyle.max-line-length option #8039
      - PR Options: Support #[serde(alias = name)] #8031

This comment was auto-generated by Graphite.

MichaReiser · 2023-10-17T03:06:14Z

crates/ruff_cli/src/commands/check_stdin.rs

            return Ok(Diagnostics::default());
        }
+
+        let lint_settings = &pyproject_config.settings.linter;


It's a bit annoying that we have to duplicate this check everywhere. It would be nice to have a single CLI logic that handles the traversal of all files and decides if a file is eligible for a specific tool... Another day

MichaReiser · 2023-10-17T03:09:16Z

crates/ruff_workspace/src/options.rs

    /// The lint sections specified at the top level.
    #[serde(flatten)]
-    pub lint_top_level: LintOptions,
+    pub lint_top_level: LintCommonOptions,


The LintCommonOptions is necessary because we don't want to flatten the exclude option into the top-level settings (would conflict with the global exclude setting)

Can this be removed when we remove the top-level lint options support?

I think that's the plan!

I think we should probably wait a while to drop support for top-level lint options though, maybe 0.3? maybe later? We should open a tracking issue we can add todos to

Can this be removed when we remove the top-level lint options support?
Yes

I think we should probably wait a while to drop support for top-level lint options though, maybe 0.3? maybe later? We should open a tracking issue we can add todos to

I don't know the timeline yet but my thinking is:

Not before we ship the stable formatter (the main goal of the beta is to get feedback on the configuration)

Promote the lint section over the formatter section (by changing the documentation)

Deprecate the top-level settings

Eventually, remove support for top-level lint settings

I expect this to be 0.3+, maybe even 1.0

MichaReiser · 2023-10-17T03:10:42Z

crates/ruff_workspace/src/resolver.rs

    pyproject_config: &PyprojectConfig,
    transformer: &dyn ConfigurationTransformer,
-) -> Result<(Vec<Result<DirEntry, ignore::Error>>, Resolver)> {
+) -> Result<(Vec<Result<ResolvedFile, ignore::Error>>, Resolver)> {


I had to introduce a new ResolvedFile type to know whether the file was explicitly passed to the CLI or not. I could have used DirEntry::depth but I found that it leaks internal details about python_files_in_path

github-actions · 2023-10-17T03:45:31Z

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

MichaReiser · 2023-10-17T06:54:56Z

@charliermarsh what's your preferred way to incorporate these extensions to the documentation? Should I open a PR to your documentation PR or do you want to write the documentation yourself?

crates/ruff_cli/src/commands/check.rs

konstin · 2023-10-17T09:09:49Z

crates/ruff_cli/src/commands/check.rs

+    let (mut all_diagnostics, checked_files) = diagnostics_per_file
+        .fold(
+            || (Diagnostics::default(), 0u64),
+            |(all_diagnostics, checked_files), file_diagnostics| {
+                (all_diagnostics + file_diagnostics, checked_files + 1)
+            },
+        )
+        .reduce(
+            || (Diagnostics::default(), 0u64),
+            |a, b| (a.0 + b.0, a.1 + b.1),
+        );


This needs a comment what it does

crates/ruff_cli/tests/format.rs

crates/ruff_workspace/src/options.rs

crates/ruff_workspace/src/resolver.rs

Allow excluding files from the formatter and linter.

MichaReiser commented Oct 17, 2023

View reviewed changes

MichaReiser force-pushed the format-lint-exclude-option branch 2 times, most recently from dafec38 to e7ec415 Compare October 17, 2023 03:28

MichaReiser added formatter Related to the formatter configuration Related to settings and configuration labels Oct 17, 2023

MichaReiser force-pushed the format-lint-exclude-option branch from e7ec415 to b3df3f8 Compare October 17, 2023 06:29

MichaReiser marked this pull request as ready for review October 17, 2023 06:29

MichaReiser requested review from charliermarsh and konstin October 17, 2023 06:30

MichaReiser force-pushed the format-lint-exclude-option branch from b3df3f8 to fe03d95 Compare October 17, 2023 06:48

MichaReiser mentioned this pull request Oct 17, 2023

Add lint.preview #8002

Merged

konstin approved these changes Oct 17, 2023

View reviewed changes

This was referenced Oct 17, 2023

Respect tab-size setting in formatter #8006

Merged

Rename *-length options to -width #8010

Closed

Options: Support #[serde(alias = name)] #8031

Closed

Rework the documentation to incorporate the Ruff formatter #7732

Merged

Add [format|lint].exclude options

499200f

Allow excluding files from the formatter and linter.

MichaReiser force-pushed the format-lint-exclude-option branch from fe03d95 to 499200f Compare October 18, 2023 01:05

MichaReiser enabled auto-merge (squash) October 18, 2023 01:05

MichaReiser mentioned this pull request Oct 18, 2023

Document lint.preview and format.preview #8032

Merged

MichaReiser merged commit fe485d7 into main Oct 18, 2023

MichaReiser deleted the format-lint-exclude-option branch October 18, 2023 01:15

MichaReiser restored the format-lint-exclude-option branch October 18, 2023 01:16

This was referenced Oct 18, 2023

Respect #(deprecated) attribute in configuration options #8035

Merged

New pycodestyle.max-line-length option #8039

Merged

p-linnane mentioned this pull request Oct 19, 2023

ruff 0.1.1 Homebrew/homebrew-core#151871

Merged

MichaReiser mentioned this pull request Oct 20, 2023

Rename tab-size to indent-width #8082

Merged

MichaReiser mentioned this pull request Oct 20, 2023

Warn about incompatible formatter options #8088

Merged

MichaReiser deleted the format-lint-exclude-option branch January 16, 2024 10:03

Conversation

MichaReiser commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Considerations

Test Plan

Uh oh!

MichaReiser commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MichaReiser Oct 17, 2023

Choose a reason for hiding this comment

Uh oh!

MichaReiser Oct 17, 2023

Choose a reason for hiding this comment

Uh oh!

charliermarsh Oct 17, 2023

Choose a reason for hiding this comment

Uh oh!

zanieb Oct 17, 2023

Choose a reason for hiding this comment

Uh oh!

zanieb Oct 17, 2023

Choose a reason for hiding this comment

Uh oh!

MichaReiser Oct 17, 2023 • 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!

MichaReiser Oct 17, 2023

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Check Results

Ecosystem

Uh oh!

MichaReiser commented Oct 17, 2023

Uh oh!

Uh oh!

konstin Oct 17, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MichaReiser commented Oct 17, 2023 •

edited

Loading

MichaReiser commented Oct 17, 2023 •

edited

Loading

MichaReiser Oct 17, 2023 •

edited

Loading

github-actions bot commented Oct 17, 2023 •

edited

Loading