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

setup.cfg: are linters/tools applicable to having configurations moved in? #3341

Closed
7 tasks
tony opened this issue Dec 1, 2017 · 4 comments
Closed
7 tasks
Labels
Needed: patch A pull request is required

Comments

@tony
Copy link
Contributor

tony commented Dec 1, 2017

I use most of these utilities on my personal projects and have everything in setup.cfg. It would take more input than just me to justify/check on moving to setup.cfg, but it would clean up the root directory significantly.

Applicable?

  • docformatter
  • pytest
  • flake8
  • yapf
  • isort
  • autopep8
  • unify

For any of the above, any chance of workflows breaking?

@tony tony changed the title setup.cfg: find linters/tools applicable to move over setup.cfg: are linters/tools applicable to having configurations moved in? Dec 1, 2017
@RichardLitt RichardLitt added the Needed: design decision A core team decision is required label Dec 1, 2017
@agjohnson agjohnson added Needed: patch A pull request is required and removed Needed: design decision A core team decision is required labels Dec 11, 2017
@agjohnson
Copy link
Contributor

I'd be interested in this change. We have a number of repositories that we'd like to copy our autolinting to, but maintaining many copies of these files would be a headache.

The biggest win for us would be having prospector pick up on some of these files too, so our rules matches our auto-lint and lint steps.

If you have an example of this, we'd definitely me interested in a PR!

@tony
Copy link
Contributor Author

tony commented Dec 11, 2017

@agjohnson

Greetings. I have a lot on my plate at the moment.

As a preliminary, let me show you my setup.cfg I use on my projects (Switched some names around)

[flake8]
inline-quotes = single
max-line-length = 100
max-complexity = 10
exclude = .git,
          __pycache__,
          readthedocs/static,
          my/node_modules

[tool:pytest]
DJANGO_SETTINGS_MODULE=readthedocs.settings.test
addopts=--ignore my/node_modules/ --ignore other/node_modules/

[isort]
combine_as_imports= true
default_section = THIRDPARTY
include_trailing_comma = true
multi_line_output = 3
known_django = django
known_pytest = pytest,py
known_docutils = docutils
known_first_party = readthedocs
sections = FUTURE,STDLIB,PYTEST,DJANGO,DOCUTILS,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
line_length = 79
not_skip = __init__.py

[mypy]
show_column_numbers = True
show_error_context = True
ignore_missing_imports = True
follow_imports = skip
incremental = True
check_untyped_defs = True
warn_unused_ignores = True

The biggest win for us would be having prospector pick up on some of these files too, so our rules matches our auto-lint and lint steps.

It's my first time hearing about it. Careful about pulling it in as a dependency, it's GPLv2.

I will follow up on this ASAP. I have to square away some things on my end first

@stsewd
Copy link
Member

stsewd commented May 17, 2018

We have the common repo now, is this issue still relevant?

@tony
Copy link
Contributor Author

tony commented May 17, 2018

@stsewd I think it's good to close. I'm going to go ahead and do that now.

@tony tony closed this as completed May 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: patch A pull request is required
Projects
None yet
Development

No branches or pull requests

4 participants