Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing isort rules in setup.cfg configuration #1934

Closed
koutsenko opened this issue Mar 9, 2021 · 4 comments · Fixed by #2216
Closed

Missing isort rules in setup.cfg configuration #1934

koutsenko opened this issue Mar 9, 2021 · 4 comments · Fixed by #2216
Assignees
Labels
bug Something isn't working documentation Docs related task good first issue Entrypoint to the project help wanted Extra attention is needed level:starter Good for newcomers

Comments

@koutsenko
Copy link

koutsenko commented Mar 9, 2021

What's wrong

You have an README https://github.com/wemake-services/wemake-python-styleguide/blob/master/README.md .

The setup.cfg configuration link points to https://wemake-python-stylegui.de/en/latest/pages/usage/configuration.html .
Only the [flake8] section described here, no [isort] configuration.
So, if you launch isort from CLI with default rules, e.g. for multiline imports, you'll get WPS warnings.

As result, it's too hard to fix WPS isort issues.

How it should be

Add the [isort] section to setup docs according to
https://github.com/wemake-services/wemake-python-styleguide/blob/master/setup.cfg#L68-L76

[isort]
include_trailing_comma = true
use_parentheses = true
multi_line_output = 3
line_length = 80

Flake8 version and plugins

Latest

pip information

Latest

OS information

Win10x64

@koutsenko koutsenko added the bug Something isn't working label Mar 9, 2021
@orsinium
Copy link
Collaborator

AFAIK, the configuration docs mention the following:

We also use flake8-isort to style our imports. You will need to update your configuration with the following lines: Otherwise, your isort will complain about your imports. Our isort.toml file is available with the core settings for isort.

@sobolevn sobolevn added documentation Docs related task good first issue Entrypoint to the project help wanted Extra attention is needed level:starter Good for newcomers labels Mar 10, 2021
@sobolevn
Copy link
Member

I agree that we should empathize more that there are other tools to configure.
Tools we use with their own configuration: darglint, isort

@lensvol
Copy link
Collaborator

lensvol commented Oct 9, 2021

Can I take this?

@sobolevn
Copy link
Member

sobolevn commented Oct 9, 2021

@lensvol yes, please!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Docs related task good first issue Entrypoint to the project help wanted Extra attention is needed level:starter Good for newcomers
Projects
None yet
4 participants