fix(taskfiles)!: Remove quotes when evaluating EXTRA_ARGS in CMake tasks, properly treating them as command flags. by PacificViking · Pull Request #66 · y-scope/yscope-dev-utils

PacificViking · 2025-06-11T11:41:22Z

Description

An empty string passed in EXTRA_ARGS throws an error in the previous version. This is undesirable for conditional extra arguments passed to cmake:install.

Checklist

The PR satisfies the contribution guidelines.
This is a breaking change and that has been indicated in the PR title, OR this isn't a
breaking change.
Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Ran linters and tests.

Summary by CodeRabbit

Bug Fixes
- Improved handling of extra arguments in the install process to ensure correct command-line parsing.
New Features
- Added support for specifying installation components to customize the install process.

EXTRA_ARGS in cmake:install

coderabbitai · 2025-06-11T11:41:30Z

Walkthrough

The update adds a new COMPONENT variable to the install task in cmake.yaml and conditionally includes a --component option in the cmake --install command. It also changes how EXTRA_ARGS elements are rendered by removing surrounding double quotes.

Changes

File(s)	Change Summary
exports/taskfiles/utils/cmake.yaml	Added `COMPONENT` variable; conditionally appended `--component` option; removed quotes around `EXTRA_ARGS` elements in the install command.

Possibly related PRs

feat(taskfiles): Add cmake-install-remote-tar; Fix optional lists to properly default to an empty list. #22: Both PRs modify how EXTRA_ARGS are handled in the cmake-install task, but this PR changes quoting while the related PR introduces vars definitions and a new remote install task.

Suggested reviewers

kirkrodrigues

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

davidlion

Let's handle components the same way targets is handled in generate (https://github.com/y-scope/yscope-dev-utils/blob/main/exports/taskfiles/utils/cmake.yaml#L27-L41).

PacificViking · 2025-06-12T10:29:27Z

It doesn't seem like CMake supports passing multiple --components arguments in install.

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c4bfd39 and 245a1ea.

📒 Files selected for processing (1)

exports/taskfiles/utils/cmake.yaml (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: unit-tests (ubuntu-24.04)
GitHub Check: unit-tests (ubuntu-22.04)

🔇 Additional comments (1)

exports/taskfiles/utils/cmake.yaml (1)

127-127: Verify conditional --component injection
Double-check that the folded >- block preserves spacing/newlines correctly when .COMPONENT is set or empty. Test the rendered command to ensure --component isn’t concatenated or omitted unexpectedly.

coderabbitai · 2025-06-12T10:36:51Z

+      COMPONENT: >-
+        {{default "" .COMPONENT}}


🧹 Nitpick (assertive)

Sync documentation for new COMPONENT variable
The newly added COMPONENT var isn’t reflected in the install task’s @param block. Please add an entry like @param {string} [COMPONENT] to the comment header to keep docs accurate.

🤖 Prompt for AI Agents

In exports/taskfiles/utils/cmake.yaml around lines 110 to 111, the new COMPONENT variable is missing from the install task's @param documentation block. Add a line `@param {string} [COMPONENT]` to the comment header of the install task to document this new variable and keep the documentation accurate and up to date.

davidlion

Sorry, I should have looked into --components closer. Your original solution was correct. Could you:

revert your change (sorry)
generalize the solution to all the cmake commands (unquote the other range EXTRA_ARGS usage)

This reverts commit 245a1ea.

PacificViking · 2025-06-16T02:08:23Z

Sorry, I forgot to request review again. Pretty sure the unit tests failing is a temporary internet problem, since they worked locally.

fix(taskfiles): Remove unnecessary double quotes when evaluating

c4bfd39

EXTRA_ARGS in cmake:install

PacificViking requested a review from a team as a code owner June 11, 2025 11:41

davidlion requested changes Jun 11, 2025

View reviewed changes

PacificViking added 2 commits June 12, 2025 06:12

Merge branch 'main' into john_extra_args_fix

a123ba9

add components as possible argument to cmake:install

245a1ea

PacificViking requested a review from davidlion June 12, 2025 10:29

coderabbitai Bot reviewed Jun 12, 2025

View reviewed changes

davidlion requested changes Jun 12, 2025

View reviewed changes

PacificViking added 2 commits June 12, 2025 14:47

Revert "add components as possible argument to cmake:install"

40445c9

This reverts commit 245a1ea.

unquote other EXTRA_ARGS lists in cmake

7b23e40

PacificViking requested a review from davidlion June 16, 2025 02:07

davidlion changed the title ~~fix(taskfiles): Remove unnecessary double quotes when evaluating EXTRA_ARGS in cmake:install~~ fix(taskfiles)!: Remove quotes when evaluating EXTRA_ARGS in CMake tasks, properly treating them as command flags. Jun 16, 2025

davidlion approved these changes Jun 16, 2025

View reviewed changes

davidlion merged commit fd7c42d into y-scope:main Jun 16, 2025

Navigation Menu

Uh oh!

fix(taskfiles)!: Remove quotes when evaluating EXTRA_ARGS in CMake tasks, properly treating them as command flags. - #66

fix(taskfiles)!: Remove quotes when evaluating EXTRA_ARGS in CMake tasks, properly treating them as command flags.#66
davidlion merged 5 commits into
y-scope:mainfrom
PacificViking:john_extra_args_fix

PacificViking commented Jun 11, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jun 11, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

davidlion left a comment

Uh oh!

PacificViking commented Jun 12, 2025

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

coderabbitai Bot Jun 12, 2025

Uh oh!

davidlion left a comment •

edited

Loading

Uh oh!

PacificViking commented Jun 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

PacificViking commented Jun 11, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Validation performed

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

davidlion left a comment

Choose a reason for hiding this comment

Uh oh!

PacificViking commented Jun 12, 2025

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

davidlion left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PacificViking commented Jun 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

PacificViking commented Jun 11, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

davidlion left a comment •

edited

Loading