Skip to content

Support phpactor #980

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
mariano-dagostino wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Support phpactor #980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aaba805
Support phpactor
mariano-dagostino Jan 29, 2026
44e29d6
Provide a template instead of defining the configs in the repo .phpac…
mariano-dagostino Feb 3, 2026
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ web/private/
# Ignore files generated by vim
/tags

# Ignore custom phpactor settings
.phpactor.json

# Pantheon
web/sites/default/default.services.pantheon.preproduction.yml
pantheon_config.sh
Expand Down
16 changes: 16 additions & 0 deletions .phpactor.json.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"$schema": "~/bin/phpactor/phpactor.schema.json",
"indexer.supported_extensions": [
"php",
"inc",
"module"
],
"indexer.include_patterns": [
"/**/*.php",
"/**/*.inc",
"/**/*.module"
],
"language_server_phpstan.enabled": false,
"php_code_sniffer.enabled": false,
"prophecy.enabled": true
}
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ To run PHPUnit tests for the `migrate_tools` contributed module, you would use:
ddev phpunit-contrib migrate_tools
```

## Debugging
## Debugging and IDE config

## Visual Studio Code instructions

Expand All @@ -267,6 +267,13 @@ ddev phpunit-contrib migrate_tools
Check the [DDEV documentation](https://ddev.readthedocs.io/en/latest/users/debugging-profiling/step-debugging/)
if you are using other IDE or want to know more about this feature.

## Phpactor integration

Copy .phpactor.json.example to .phpactor.json to integrate
with [phpactor](https://phpactor.readthedocs.io/) in your IDE.

Then run `phpactor config:init` to set your repository as trusted.

## Deploy to Pantheon

### Pantheon Setup
Expand Down Expand Up @@ -393,17 +400,17 @@ In order to deploy upon every merge automatically using GitHub Actions, you shal
1. `git commit -m "Deployment secrets and configuration"`
1. Add the public key in `pantheon-key.pub` to the newly created dummy [Pantheon user](https://pantheon.io/docs/ssh-keys)
1. Set up the following in your GitHub repository settings:

**GitHub Secrets** (Settings → Secrets and variables → Actions → Secrets):
- `TERMINUS_TOKEN`: Your Pantheon machine token
- `PANTHEON_DEPLOY_KEY`: The SSH private key for deployment
- `GH_TOKEN`: GitHub personal access token for posting deployment comments

**GitHub Variables** (Settings → Secrets and variables → Actions → Variables):
- `PANTHEON_GIT_URL`: The Pantheon Git URL for your project
- `ROLLBAR_SERVER_TOKEN`: Your Rollbar server token (optional)
- `DEPLOY_EXCLUDE_WARNING`: Warnings to exclude from deployment notifications (optional)

1. Actualize `public static string $githubProject = 'Gizra/the-client';` in the `RoboFile.php`.

Optionally you can specify which target branch you'd like to push on Pantheon, by default it's `master`, so the target is the DEV environment, but alternatively you can issue:
Expand Down
13 changes: 13 additions & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@
"drupal/devel": "^5",
"drupal/drupal_test_assertions": "^1.0",
"drupal/potx": "^1.0@alpha",
"fenetikm/autoload-drupal": "^1.0",
"gettext/gettext": "^5.7",
"mikey179/vfsstream": "^1.6",
"mink/webdriver-classic-driver": "^1.1",
Expand Down Expand Up @@ -140,6 +141,7 @@
"dealerdirect/phpcodesniffer-composer-installer": true,
"drupal/core-composer-scaffold": true,
"drupal/core-project-message": true,
"fenetikm/autoload-drupal": true,
"mglaman/composer-drupal-lenient": true,
"oomphinc/composer-installers-extender": true,
"php-http/discovery": true,
Expand Down Expand Up @@ -186,6 +188,17 @@
"web/modules/contrib/webform/composer.libraries.json"
]
},
"extra": {
"autoload-drupal": {
"modules": [
"app/modules/contrib/",
Copy link
Member

@AronNovak AronNovak Jan 30, 2026

Choose a reason for hiding this comment

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

https://phpactor.readthedocs.io/en/master/integrations/drupal8.html#option-1-bootstrap-drupal-on-the-fly-to-generate-the-autoloader

I see that there are two ways to use it. This is option 2). It seems to be more invasive. But might be fine, just asking why option 1) isn't chosen here.

Copy link
Collaborator Author

@mariano-dagostino mariano-dagostino Feb 2, 2026

Choose a reason for hiding this comment

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

@AronNovak Honestly I haven't tried option 1 to see if it works fine with ddev. Based on the frequency of installing new modules it seems a faster option to go with a static approach, if the db is broken this should still work.

"app/modules/custom/",
"app/themes/contrib/",
"app/themes/custom/",
"app/core/modules/"
]
}
},
"drupal-core-project-message": {
"include-keys": ["homepage", "support"],
"post-create-project-cmd-message": [
Expand Down
Loading
Loading