Use lint setting or not ?

[wu-clan]

what is the difference between [ruff] and [ruff.lint] in the configuration? I don't seem to see documentation on this.

[tjkuson]

[ruff] is for configurations for the entire tool (such as files for Ruff to ignore), whereas [ruff.lint] is for configuring specifically the linter (such as which lint checks to enable). Similarly, [ruff.format] is for the Ruff formatter configurations, such as whether to use single or double quotes.

[abravalheri]

Thank you very much @charliermarsh!

[DimitriPapadopoulos]

@charliermarsh The current documentation shows us all Top-level settings such as ignore at the tool root level, i.e.:

• pyproject.toml

  [tool.ruff]
  # Skip unused variable rules (`F841`).
  ignore = ["F841"]

• ruff.toml

  # Skip unused variable rules (`F841`).
  ignore = ["F841"]

Should the documentation change? Current documentation should show the currently recommended location under [lint], not the backwards compatible "global" location that may become obsolete in the future.

[MichaReiser]

I'm sorry for the confusion that the lint / format sections have created. The idea was to release them as experimental and collect feedback before making them the recommended configuration option. That's why the documentation defaults to the global options today (because lint is still considered experimental).

I think we should make the switch over soon, but keeping backward compatibility by changing the documentation to recommend the usage of lint and remove the experimental note from the lint section.

[DimitriPapadopoulos]

No worries, it all works well for us.

I have a related question though. In the long term, will you remove the possibility to have a top-level exclude setting?

exclude #

A list of file patterns to exclude from formatting and linting.

It might make sense to keep some settings at top-level. Or perhaps not to avoid confusion 😄 I am asking because I had to duplicate the exclude setting, which is shared by the linter and the formatter in this specific project.

[MichaReiser]

We'll keep the top-level exclude setting. The idea is that:

• The top-level exclude: Configures the files of your entire project
• Lint/Formatter level: Configure the files to exclude for each individual tool