Update infrastructure for linting and add for formatting Python files #62
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
The Taskfile contains convenience tasks that allow the contributor to run all tasks of a given type with a single command: - check: run all tasks that check for problems with the project - fix: run all tasks that automatically fix problems with the project Some task that were added to the file were appropriate for inclusion in these "umbrella" tasks, but were not added.
Previously linting of the Python code was done in the "libraries/report-size-deltas workflow" GitHub Actions workflow. This system is replaced by a dedicated workflow for detecting Python code problems, leaving the "libraries/report-size-deltas workflow" solely for running unit tests. A task is used, which will allow the contributor to run the same check locally via a common interface as done by the CI system. Infrastructure for formatting the Python code, and enforcing compliance with the standardized formatting style is also added. Like the linting infrastructure, this is task-based.
With the exception of increasing the maximum line length from the antiquated default value, the default style of the Black code formatter tool is used as standard in Arduino tooling projects.
per1234
added
type: enhancement
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #62 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 732 732
=========================================
Hits 732 732 ☔ View full report in Codecov by Sentry. |
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.
Previously linting of the Python code was done in the "libraries/report-size-deltas workflow" GitHub Actions workflow.
This system is replaced by a dedicated workflow for detecting Python code problems, leaving the "libraries/report-size-deltas workflow" solely for running unit tests. A task is used, which will allow the contributor to run the same check locally via a common interface as done by the CI system.
Infrastructure for formatting the Python code, and enforcing compliance with the standardized formatting style is also added. Like the linting infrastructure, this is task-based.