Skip to content

docs: wrap quotes around commands that use the caret symbol#7237

Merged
rfay merged 2 commits into
ddev:mainfrom
nmangold:patch-1
Apr 29, 2025
Merged

docs: wrap quotes around commands that use the caret symbol#7237
rfay merged 2 commits into
ddev:mainfrom
nmangold:patch-1

Conversation

@nmangold

@nmangold nmangold commented Apr 28, 2025

Copy link
Copy Markdown
Contributor

The Issue

When using Zsh, the composer create ... command will fail if using a caret symbol to specify the project version.

Drupal Slack conversation: https://drupal.slack.com/archives/C5TQRQZRR/p1745774586216839

Zsh issue:

How This PR Solves The Issue

Wrapping the project and version number in quotes will prevent Zsh from globbing, and allow the command to execute as expected.

Manual Testing Instructions

Review https://ddev--7237.org.readthedocs.build/en/7237/users/quickstart/

@nmangold nmangold requested a review from a team as a code owner April 28, 2025 03:07

@rfay rfay left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for studying this and then updating more than just the drupal example! I note that we already had this for laravel, I think we stumbled over it years ago for PowerShell (which also uses ^ as a special character). But I can't believe with all the zsh usage over the years we haven't had a mention on a stumble on this.

I'll add a commit to make the quickstart tests work the same.

nmangold and others added 2 commits April 28, 2025 12:55
Wrap quotes around commands that use the caret symbol to prevent ZSH globbing.
@rfay

rfay commented Apr 28, 2025

Copy link
Copy Markdown
Member

Added quickstart tests and rebased

@rfay rfay requested a review from rpkoller April 28, 2025 20:51

@rfay rfay left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, passed quickstart tests.

@rpkoller rpkoller left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding the double quotes looks good to me. the fail save approach.

@GuySartorelli

Copy link
Copy Markdown
Contributor

Oh that's what causes it! Thank you for raising this. I occasionally stumble on this but never bothered to find out what part of the command causes it - I just quoted all the args and moved on.

@rfay rfay merged commit 94cd4cc into ddev:main Apr 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants