Skip to content

fix: use ddev describe to check for a project #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stasadev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: use ddev describe to check for a project #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,13 @@ Tools covered:
## Installation

```bash
# Install from GitHub (current)
# Install from GitHub
ddev add-on get UltraBob/ddev-drupal-code-quality

# If/when published to the add-on registry:
# ddev add-on get ddev-drupal-code-quality
ddev restart

# Or, for local development
ddev add-on get /path/to/ddev-drupal-code-quality
ddev restart
```

## Related add-ons and overlap
Expand All @@ -44,9 +43,9 @@ the project type each one is designed for.

| Add-on | Best for | Typical project layout |
| --- | --- | --- |
| `UltraBob/ddev-drupal-code-quality` | Full Drupal website projects where your site repo already contains Drupal code and custom code. | Existing site/project repo; installs code-quality configs and IDE shims in-place. |
| `ddev/ddev-drupal-contrib` | Drupal contrib module/theme development where the contrib project is the center of the repo. | Contrib project repo with Drupal scaffolded around it (symlink workflow). |
| `justafish/ddev-drupal-core-dev` / `joachim-n/ddev-drupal-core-dev` | Drupal core development. | Drupal core checkout or core-dev project template. |
| [`UltraBob/ddev-drupal-code-quality`](https://github.com/UltraBob/ddev-drupal-code-quality) | Full Drupal website projects where your site repo already contains Drupal code and custom code. | Existing site/project repo; installs code-quality configs and IDE shims in-place. |
| [`ddev/ddev-drupal-contrib`](https://github.com/ddev/ddev-drupal-contrib) | Drupal contrib module/theme development where the contrib project is the center of the repo. | Contrib project repo with Drupal scaffolded around it (symlink workflow). |
| [`justafish/ddev-drupal-core-dev`](https://github.com/justafish/ddev-drupal-core-dev) / [`joachim-n/ddev-drupal-core-dev`](https://github.com/joachim-n/ddev-drupal-core-dev) | Drupal core development. | Drupal core checkout or core-dev project template. |

### Practical guidance

Expand Down
8 changes: 4 additions & 4 deletions dcq-install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1713,14 +1713,14 @@ if [ "$non_interactive" -eq 1 ] || [ "$recommended_mode" -eq 1 ]; then
set_default_env "DCQ_INSTALL_GITIGNORE" "add"
fi

# Fail loudly if ddev exec cannot resolve a project. Silent skips later are
# Fail loudly if ddev describe cannot resolve a project. Silent skips later are
# usually caused by running in a context where DDEV can't find .ddev/config.yaml.
ddev_cmd="${DDEV_EXECUTABLE:-ddev}"
if command_available "$ddev_cmd"; then
if ! "$ddev_cmd" exec true >/dev/null 2>&1; then
emit 'ERROR: ddev exec could not resolve a project from %s.\n' "${PWD:-.}"
if ! "$ddev_cmd" describe >/dev/null 2>&1; then
emit 'ERROR: ddev describe could not resolve a project from %s.\n' "${PWD:-.}"
emit 'Run the installer from the target project (for add-on installs, this should be automatic).\n'
emit 'Try: cd %s && ddev exec true\n' "$app_root"
emit 'Try: cd %s && ddev describe\n' "$app_root"
exit 1
fi
fi
Expand Down