Add linting and type checking #4
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joelspadin
force-pushed
the
type-checking
branch
from
4ddfabe
to
3d2c998
Compare
Added a GitHub workflow to run pre-commit, pylint, and pyright. pylint and pyright are not included as pre-commit checks, because they need to analyze the project as a whole, not just the changed files, and they do not work correctly in an isolated environment without having access to dependencies. Adjusted the pylint configuration to ignore diagnostics that are either not useful or duplicate those reported by pyright. Fixed all type errors reported by pyright. Added VS Code extension recommendations for all the formatting and linting tools, and enabled type checking in VS Code. Fixes zmkfirmware#3
Added a "dev" group of optional dependencies to install pre-commit, pylint, and pyright. (Black and isort are run from pre-commit, so they are not included.) Added some basic documentation for how to set up the development environment.
Ran all files through pyupgrade --py310-plus.
joelspadin
force-pushed
the
type-checking
branch
from
c999420
to
93651b0
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a GitHub workflow to run pre-commit, pylint, and pyright.
pylint and pyright are not included as pre-commit checks, because they need to analyze the project as a whole, not just the changed files, and they do not work correctly in an isolated environment without having access to dependencies.
Adjusted the pylint configuration to ignore diagnostics that are either not useful or duplicate those reported by pyright.
Fixed all type errors reported by pyright.
Added VS Code extension recommendations for all the formatting and linting tools, and enabled type checking in VS Code.
Fixes #3