feat: Replace underscores with hyphens in project-name, fixes #6206 #6210
Conversation
|
@rfay I'm not sure how to create a test for a working directory containing underscores. I'm also not sure if this is the correct approach to a solution, but I figured that normalizing the name in as few locations as possible would be best. Passing names containing underscores for |
|
Download the artifacts for this pull request:
See Testing a PR.
|
|
@rfay I added a test that creates a docroot with underscores, then uses the default suggested --project-name in the CLI. |
|
@rfay I updated the branch with the most recent changes, and suddenly more stuff is broken. I don't understand it, so you can take it from here. |
|
Here's a situation where your code couldn't compile locally, I don't think, so where manual testing is so critical. I'm pretty sure It's also a place where you want to use the rebase workflow instead of merging master in, which hides so many things. I'm quite sure that if you look at this you'll understand what happened to |
mbomb007
force-pushed
the
20240517_mbomb007_normalize_sitename
branch
from
86fc29f
to
71ec9f3
Compare
|
@rfay I got the checks to pass with a new test. |
|
Congrats! |
|
Would you mind adding a commit to this making the project name lower-case as well? docker-compose needs that. We also remove dots/periods for docker-compose project name, but I don't think people would like removing those from the project name. |
|
@rfay Sure. If you really want that part covered by the tests as well, we can change one of the names in the test matrix to have a capital letter, so that the folder has a capital letter. |
|
Improving tests would be awesome. |
rfay
changed the title
|
@mbomb007 somewhere you made a mess, I think by using the "merge" option on the github UI instead of rebase. Anyway, there are an enormous number of conflicts here now. I started to rebase it, but I'm hoping you remember what you were trying to do and you can successfully rebase it. I don't know if the default "update branch" (does a merge) will get you where you want to go now, but I'm certainly hesitant. Please do what you need to do, try "update branch" with merge commit if you want, but make sure you're getting the results you were aiming for. |
|
We can also fix this by simply rebasing it into a single commit and we'll get it fixed that way. |
|
I don't have any knowledge of how to update my fork aside from clicking the button in the UI. I also have no relevant experience with rebasing. |
|
I'll fix it. |
|
I am wondering what is the best way to squash all the commits here into one. My strategy would be to do a soft reset to the point where this branch started, commit, rebase on master and resolve the conflicts. BTW, the tests fail on |
|
Yes, I think just squashing and then fixing. I think their merge did update it, but merge commits are pretty squirrely. But... Github offers them as the default! |
rfay
force-pushed
the
20240517_mbomb007_normalize_sitename
branch
from
d919798
to
4e7c633
Compare
|
I squashed this into one commit, but then reverted the ToLower() as it had unknown consequences. |
mbomb007
force-pushed
the
20240517_mbomb007_normalize_sitename
branch
from
4e7c633
to
e567fd3
Compare
rfay
changed the title
The Issue
Drupal modules frequently contain underscores in the project names. It's annoying to have to specify a different project name, or manually convert underscores to hyphens, each time I create a DDEV project for one. It seems a bit arbitrary that underscores aren't allowed.
How This PR Solves The Issue
When getting the project name from the directory name, underscores are replaced with hyphens.
Manual Testing Instructions
Automated Testing Overview
This needs an additional test to ensure that a project directory containing underscores now has the default project-name working.
Related Issue Link(s)
#6206
Release/Deployment Notes