Add precommit for linting and formatting #9123
Open
+123
−1
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
kdaily
force-pushed
the
kdaily-add-precommit-hook
branch
6 times, most recently
from
85393a5 to
f932015
Compare
kdaily
force-pushed
the
kdaily-add-precommit-hook
branch
4 times, most recently
from
0fb1fd7 to
6156454
Compare
First pass at adding a pre-commit hook to enforce
formatting and linting standards.
This adds the pre-commit command to run on a
limited set of directories. Subsequent changes
will remove excluded folders and run formatting on
them as well.
The command will use the standard pre-commit hooks
for yaml, whitespace, and end of line linting.
It also uses `ruff` configured identically to
the develop branch, except for disabling
unused import checks ("F401"), as there are known
imports that are unused in the module but imported
in other modules. This is common in `compat` but
in other places as well.
It also uses `isort`, also configured identically
to the develop branch.
The intention is to start enforcing formatting and
linting standards on edited code. Running the
pre-commit hook manually will make numerous
changes that should be broken into multiple
phases. Additional PRs will work to get the
codebase up-to-date passing all standards.
kdaily
force-pushed
the
kdaily-add-precommit-hook
branch
from
6156454 to
46cb394
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.
Description of changes:
First in a series of commits to lint and format the
v2branch of this repository.Adds a precommit hook configuration file and enables whitespace linting,
isortfor imports, andruffto lint and format. It adds configuration topyproject.tomlforruffas well with the same configuration as thedevelopbranch, with the exception of ignoring unused imports (F401). This exception will be dropped at a later date.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.