CI: add ruff linter / formattter / import sorter and codespell jobs #8
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
Signed-off-by: Chris Fiege <[email protected]>
…uild Signed-off-by: Leonard Göhrs <[email protected]>
1 task
SmithChart
requested changes
Mar 19, 2024
These settings configure the ruff auto formatter and linter. Signed-off-by: Leonard Göhrs <[email protected]> Signed-off-by: Chris Fiege <[email protected]>
With this change a simple `make qa` will run `ruff format` and `ruff check` as if it would be running in CI. Signed-off-by: Leonard Göhrs <[email protected]> Signed-off-by: Chris Fiege <[email protected]>
The black and ruff auto formatters mostly agree about how python code should be formatted, but there are some subtle differences. Re-format using ruff. Signed-off-by: Leonard Göhrs <[email protected]>
Signed-off-by: Leonard Göhrs <[email protected]>
The main benefit of ruff is that it includes a formatter, import sorter and linter all in one _and without them fighting about what is correct_. Signed-off-by: Leonard Göhrs <[email protected]>
Signed-off-by: Leonard Göhrs <[email protected]> Signed-off-by: Chris Fiege <[email protected]>
Signed-off-by: Leonard Göhrs <[email protected]>
Signed-off-by: Leonard Göhrs <[email protected]>
Signed-off-by: Leonard Göhrs <[email protected]> Signed-off-by: Chris Fiege <[email protected]>
SmithChart
approved these changes
Mar 20, 2024
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.
This PR is based on #6 and intended to replace it.
This changes the recommended auto formatter from
blacktoruff. The main benefit of this change is thatruffalso includes a linter and an import sorter, that do not need configuration to work together without fighting.The linter and import sorting features of
ruffare then used to and added to the CI to make sure that best practices are followed in all pull requests.Lastly this also adds a CI job that runs codespell to fix new typos from entering the codebase.