Clean up taskfile #243
Merged
Clean up taskfile #243
Conversation
This file contains hidden or 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
per1234
added
type: enhancement
Codecov Report
@@ Coverage Diff @@
## main #243 +/- ##
=======================================
Coverage 89.85% 89.85%
=======================================
Files 43 43
Lines 6320 6320
=======================================
Hits 5679 5679
Misses 530 530
Partials 111 111
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
The uses of these was eliminated in the updates to the formatting and documentation infrastructure, but I forgot to remove them from the taskfile at that time.
There is an established practice of providing the developer with convenience tasks which collect all the domain-specific tasks of a given class. This has a couple of benefits: - Provides an alternative to manually running multiple tasks - Provides a standardized interface to the project, independent from its unique underlying details However, I have come to the conclusion that these benefits lessen as the number of such convenience tasks increases. At the same time, the maintenance burden increases. In the end, I think there are only three distinct classes of tasks that can be consolidated in this manner: - "build" (build the application) - "check" (check for problems with the project) - "fix" (automatically fix problems with the project)
I originally set out to establish some logical order to the tasks, based partly on the Arduino CLI taskfile, as that project was used as a model, then on some indecipherable criteria of my own devizing in cases where the model did not provide guidance. In the end, it resulted in a jumble. Alphabetical order is completely objective and it results in a fairly logical order in the end due to the the use of prefixes on the task names according to their domain. The exception is that the convenience "umbrella" tasks have been left at the top (in their own alphabetical order) so that they will have the maximum visibility as the most useful tasks. Even that is not completely inconsistent, since these don't have a namespace prefix, and so might be imagined to have a null global namespace prefix that would be sorted first.
silvanocerza
approved these changes
Aug 6, 2021
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.
Some housekeeping and streamlining of the Task configuration file that provides common development operations for this project.