Skip to content

Require composer-plugin-api ^2.1 and expand README troubleshooting for missing symlinks commands #29

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

Closed
somework wants to merge 1 commit into from
Closed

Require composer-plugin-api ^2.1 and expand README troubleshooting for missing symlinks commands #29

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
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,26 @@ $ composer symlinks:status --json --strict

### 4. Execute composer

DO NOT use --no-plugins for composer install or update
Composer disables plugins when running with `--no-plugins` and the commands
registered by this package will not be available. If you see
`There are no commands defined in the "symlinks" namespace`, check the
following in order:

1. **Composer version**: the `symlinks:*` commands require Composer v2.1+
(command provider capability). With Composer v2.0 the plugin still runs
automatically during `composer install`/`update`, but the manual command
namespace is not available. In that case, re-run `composer install` or call
the hook directly via `composer run-script post-install-cmd`.
2. **Plugin allowance**: `somework/composer-symlinks` must be listed under
`config.allow-plugins` (e.g. `composer config allow-plugins.somework/composer-symlinks true`).
3. **Plugins enabled**: ensure you are not using `--no-plugins` when invoking
Composer.

Example:

```bash
$ composer symlinks:refresh
```

### Dry run

Expand Down
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
},
"require": {
"php": ">=7.4",
"composer-plugin-api": "^2.0"
"composer-plugin-api": "^2.1"
},
"require-dev": {
"friendsofphp/php-cs-fixer": "@stable",
Expand Down