fix(taskfiles): Use empty list as default for optional task arguments passed via a ref (fixes 14).
#15
Conversation
…passing it to a task via a ref (fixes 14).
WalkthroughThe pull request introduces changes to the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ValidateChecksum
participant ComputeChecksum
User->>ValidateChecksum: Trigger validate-checksum task
ValidateChecksum->>ValidateChecksum: Reference EXCLUDE_PATHS
ValidateChecksum->>User: Validation result
User->>ComputeChecksum: Trigger compute-checksum task
ComputeChecksum->>ComputeChecksum: Compute checksum
ComputeChecksum->>User: Checksum result
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
taskfiles/utils.yml (1)
53-53: Consider enhancing the parameter documentation.While the fix is solid, it would be beneficial to update the parameter documentation to explicitly mention the default behaviour:
-# @param {[]string} [EXCLUDE_PATHS] A list of paths, relative to `DATA_DIR`, to exclude from the -# checksum. +# @param {[]string} [EXCLUDE_PATHS] A list of paths, relative to `DATA_DIR`, to exclude from the +# checksum. Defaults to an empty list if not specified.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
taskfiles/utils.yml(1 hunks)
🔇 Additional comments (1)
taskfiles/utils.yml (1)
53-53: LGTM! Excellent fix for the Go iteration issue.
The change to use default (list) effectively addresses the issue where undefined variables were being treated as empty strings. This ensures proper handling in Go by defaulting to an empty list instead.
| @@ -50,7 +50,7 @@ tasks: | |||
| vars: | |||
| DATA_DIR: "{{.DATA_DIR}}" | |||
| EXCLUDE_PATHS: | |||
| ref: ".EXCLUDE_PATHS" | |||
| ref: "default (list) .EXCLUDE_PATHS" | |||
There was a problem hiding this comment.
I looked at https://taskfile.dev/reference/templating/#default-functions and believe our usage matches the explanations there.
Description
As #14 describes, the behaviour of
taskhas changed w.r.t. passing optional (undefined) variables viaref. It seems thattaskwill now treat it as an empty string rather than leaving it as an undefined variable. Go is unhappy when trying to iterate over a variable which contains an empty string, but Go seems to skip iterating entirely if the variable is undefined.I'll report this issue to the
taskdevs, but in the meantime, this PR defines a default empty list for task parameters that we pass via therefattribute.Validation performed
task lint:checkcurrently fails inclp-ffi-jstask lint:checknow succeeds.Summary by CodeRabbit
EXCLUDE_PATHSvariable in thevalidate-checksumtask for improved clarity.compute-checksumtask.