Repository navigation
Add stricter linting to CI #996
Description
There are several common kinds of mistakes in typeshed code that can be detected by a static linter. I wrote a small tool the other day to detect some: https://github.com/JelleZijlstra/stublint. It currently detects certain problems with platform and version checks, typevars that aren't marked private, extraneous code inside functions, and some missing annotations.
How should we incorporate these checks in to typeshed's CI? A few options:
- Extend https://github.com/ambv/flake8-pyi with more checks (currently it doesn't add any stub-specific checks). This would automatically get us flake8 core features like control over what error codes to enable, but it would require me to rewrite much of stublint's checks.
- Move stublint's code into typeshed and run it in CI. Using a single repo makes it easier to coordinate changes: we're seeing pretty frequently that changes to some subset of mypy, typing, and typeshed need to be coordinated. Putting typeshed's linter in the same repo avoids that kind of difficulty. It also makes it easier to justify writing checks that are very specific to typeshed, but overall it seems better to stick to a single linting tool (flake8) to run in CI.
I feel like extending flake8-pyi is the better option, but would like to hear from others.
Activity
ambv commentedon Mar 14, 2017
I like to set everything up as flake8 plugins as this enables us to do the following:
You wouldn't have to rewrite that much, you're still going to use your visitor. You just need to assign error codes and adopt the class API that a plugin expects. Look here for instance how this is implemented:
JelleZijlstra commentedon Mar 14, 2017
Thanks, sounds good. I'll start sending you some PRs.
JelleZijlstra commentedon Mar 18, 2017
A couple of ideas we came up with during the sprint:
JelleZijlstra commentedon Jun 28, 2020
We have flake8-pyi and stubtest now, this issue doesn't add much.