Add `--line-length` option to `format` command #8363

zanieb · 2023-10-30T17:59:12Z

Restores the --line-length option removed in #8131

Closes #8362
Closes #8352

We removed this option because we did not feel it made sense for the format CLI to expose a single configuration option but not others.

However, there are a few arguments in favor of restoring this option:

It is the most asked for option (nobody has pointed out the other options are missing)
It is also available via the ruff check CLI
It is also available via the Black CLI
There is no way for a user to configure the line width without a configuration file yet
The line length is a unique formatter option; in that it is the most "restrictive" and not a toggle

While we intend to introduce override of general configuration options via the CLI, we have not built it yet. If we replace ruff check --line-length=... with a generic ruff check --setting line-length=... we'll need to manage a deprecation period anyway.

There remain some arguments against restoring this option:

If/when we deprecate this option in favor of a --setting flag, more users will be affected
Inconsistencies of the availability of configuration options via the CLI could be confusing
Should this be --line-width to match our terminology for measuring enforced line length?

This reverts commit 2f32a57.

github-actions · 2023-10-30T18:26:01Z

PR Check Results

Ecosystem

✅ ecosystem check detected no linter changes.

✅ ecosystem check detected no format changes.

T-256 · 2023-10-30T20:59:45Z

If/when we deprecate this option in favor of a --setting flag, more users will be affected

IMO, this approach would be neater instead of --settings {option-name}=value:

...

Format configuration:
      --{option-name} <VALUE>  see formatter settings for possible options

      # (also all settings can be auto generated in this section)

Log levels:
  -v, --verbose  Enable verbose logging
  -q, --quiet    Print diagnostics, but nothing else
  -s, --silent   Disable all logging (but still exit with status code "1" upon detecting diagnostics)

Then --line-length no need to deprecate in future.

charliermarsh

I know we discussed this synchronously but I support this change for the reasons outlined in the summary. Thank you for writing them up.

charliermarsh · 2023-10-30T21:02:11Z

crates/ruff_cli/src/args.rs

@@ -409,6 +409,9 @@ pub struct FormatCommand {
    force_exclude: bool,
    #[clap(long, overrides_with("force_exclude"), hide = true)]
    no_force_exclude: bool,
+    /// Set the line-length.
+    #[arg(long, help_heading = "Format configuration")]
+    pub line_length: Option<LineLength>,


This is actually hidden on ruff check... We could consider doing the same here.

Oh.. hm... I don't think we should hide things from the help menu if they're intended to be used?

Agree. We should either expose and document it or not add it.

It would be nice if we could add a message saying that we recommend using the configuration but it probably doesn't fit in nicely with the CLI documentation (not enough space, not in line with other CLI options)

charliermarsh · 2023-10-30T21:03:00Z

Should this be --line-width to match our terminology for measuring enforced line length?

I believe we should change this if/when we change the terminology everywhere, and that for now, it's best to be consistent with the rest of the settings.

zanieb · 2023-10-30T21:16:07Z

@T-256 I'm not sure that scales well to all of the settings. I've created a separate issue for discussion on that topic #8368

MichaReiser

I remain concerned about re-introducing the option but I believe removing it and now re-adding it at least served its purpose: We learned more about the use case where people want this option (e.g. pre-commit without a configuration file, VS Code).

My main concern is that we should encourage users to commit their formatter configuration to get consistent results across teams and interfaces (VS Code, CLI, ...). Adding this option is a step back in that regard.

More details:

It is also available via the ruff check CLI: But it is hidden and we discussed removing it.

Adding a non-hidden line-length doesn't solve the inconsistency. It's differently inconsistent.
Using --line-length in VS code is rarely the right solution. The main advantage of a formatter is consistent formatting. Setting a user-specific --line-length doesn't achieve this goal (except if it is a workplace setting and committed). It further has the disadvantage that running ruff format on the CLI and in VS code produces different results. Understanding why VS code doesn't respect the line length (or configures code differently) may result in a lengthy debugging session.
Adding line-length unlocks the most common case, but it's still impossible to set all formatter configurations.
We're still not black compatible without exposing more options.

To sum it up. It unlocks some use cases but not all, nor does it fix any inconsistencies, it just changes them.

I fear we'll have a hard time justifying not adding other options. Adding them will, similarly, unlock the mentioned use cases for some users and fit the bill as nicely as --line-length. I'm okay with this moving forward but would prefer if we pursue alternatives (or justify why we won't) before exposing all formatter options.

MichaReiser · 2023-10-31T07:07:54Z

crates/ruff_cli/src/args.rs

@@ -409,6 +409,9 @@ pub struct FormatCommand {
    force_exclude: bool,
    #[clap(long, overrides_with("force_exclude"), hide = true)]
    no_force_exclude: bool,
+    /// Set the line-length.
+    #[arg(long, help_heading = "Format configuration")]
+    pub line_length: Option<LineLength>,


Agree. We should either expose and document it or not add it.

It would be nice if we could add a message saying that we recommend using the configuration but it probably doesn't fit in nicely with the CLI documentation (not enough space, not in line with other CLI options)

zanieb · 2023-10-31T18:43:59Z

Using --line-length in VS code is rarely the right solution.

While I agree with most of your points, many users use editors for Python files that do not belong to a real "project" and the usability of a formatter in this case is important.

MichaReiser · 2023-10-31T21:37:06Z

While I agree with most of your points, many users use editors for Python files that do not belong to a real "project" and the usability of a formatter in this case is important.

I agree that this is a real use case and that we don't have any other solution for it yet. What I would prefer is something similar to Prettier's VS Code extension, allowing to configure a fallback for projects not using Ruff.

zanieb · 2023-11-01T01:15:33Z

Oh interesting. I have a strong preference for that. However, I'm okay with merging this until we implement an alternative.

@charliermarsh I don't have the heart to do it though.

danielhollas · 2023-11-01T21:24:41Z

...Prettier's VS Code extension, allowing to configure a fallback for projects not using Ruff.

How would that that work for vi users?

MichaReiser · 2023-11-01T21:36:47Z

...Prettier's VS Code extension, allowing to configure a fallback for projects not using Ruff.

How would that that work for vi users?

I'm not that familiar with Vim but it would be an lsp setting that you can set.

Revert "Remove --line-length option from format command (#8131)"

7a4cd39

This reverts commit 2f32a57.

zanieb added cli Related to the command-line interface formatter Related to the formatter labels Oct 30, 2023

Unhide; fix heading

fc6a118

zanieb marked this pull request as ready for review October 30, 2023 18:09

zanieb requested review from MichaReiser and charliermarsh October 30, 2023 18:10

charliermarsh approved these changes Oct 30, 2023

View reviewed changes

MichaReiser reviewed Oct 31, 2023

View reviewed changes

dhruvmanila mentioned this pull request Nov 1, 2023

"RuntimeError: Ruff <0.2.0,>=0.0.291 required, but found 0.0.287" when trying to format astral-sh/ruff-lsp#305

Closed

zanieb merged commit 3a889f4 into main Nov 2, 2023
17 checks passed

zanieb deleted the zanie/format-ll branch November 2, 2023 01:39

This comment was marked as resolved.

Sign in to view

miccal mentioned this pull request Nov 3, 2023

ruff 0.1.4 Homebrew/homebrew-core#153286

Merged

BartolomeSintes mentioned this pull request Dec 12, 2023

is --line-length argument working? astral-sh/ruff-vscode#357

Closed

MichaReiser mentioned this pull request Dec 19, 2023

docstring code formatter: add a --docstring-code-format parameter to ruff format CLI #9186

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `--line-length` option to `format` command #8363

Add `--line-length` option to `format` command #8363

zanieb commented Oct 30, 2023 •

edited

github-actions bot commented Oct 30, 2023

T-256 commented Oct 30, 2023 •

edited

charliermarsh left a comment

charliermarsh Oct 30, 2023

zanieb Oct 30, 2023

MichaReiser Oct 31, 2023

charliermarsh commented Oct 30, 2023

zanieb commented Oct 30, 2023

MichaReiser left a comment •

edited

MichaReiser Oct 31, 2023

zanieb commented Oct 31, 2023

MichaReiser commented Oct 31, 2023

zanieb commented Nov 1, 2023

danielhollas commented Nov 1, 2023

MichaReiser commented Nov 1, 2023

This comment was marked as resolved.

Add --line-length option to format command #8363

Add --line-length option to format command #8363

Conversation

zanieb commented Oct 30, 2023 • edited

github-actions bot commented Oct 30, 2023

PR Check Results

Ecosystem

T-256 commented Oct 30, 2023 • edited

charliermarsh left a comment

Choose a reason for hiding this comment

charliermarsh Oct 30, 2023

Choose a reason for hiding this comment

zanieb Oct 30, 2023

Choose a reason for hiding this comment

MichaReiser Oct 31, 2023

Choose a reason for hiding this comment

charliermarsh commented Oct 30, 2023

zanieb commented Oct 30, 2023

MichaReiser left a comment • edited

Choose a reason for hiding this comment

MichaReiser Oct 31, 2023

Choose a reason for hiding this comment

zanieb commented Oct 31, 2023

MichaReiser commented Oct 31, 2023

zanieb commented Nov 1, 2023

danielhollas commented Nov 1, 2023

MichaReiser commented Nov 1, 2023

This comment was marked as resolved.

Add `--line-length` option to `format` command #8363

Add `--line-length` option to `format` command #8363

zanieb commented Oct 30, 2023 •

edited

T-256 commented Oct 30, 2023 •

edited

MichaReiser left a comment •

edited