Skip to content

Update "format" Keyword in pyproject.toml to "output-format" #622

@Dridi-Hichem

Description

@Dridi-Hichem

Issue:

The style in which violation messages are presented by Ruff is indicated by the keyword "format" inside pyproject.toml, as shown below:

[tool.ruff]
format = "grouped"

Previously, this configuration used to work in our template. However, recently, it causes a failure with the following error:

Cause: TOML parse error at line 126, column 10
        |
126  | format = "grouped"
        |
invalid type: string "grouped", expected struct FormatOptions

Upon investigating the documentation, I found that the correct keyword should be "output-format" instead of "format".

Proposal:

I suggest updating the configuration in pyproject.toml to reflect the correct keyword "output-format" as follows:

[tool.ruff]
output-format = "grouped"

This change should resolve the parsing error and align with the documentation's requirements.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions