Skip to content

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

Closed
somework wants to merge 1 commit intomasterfrom
codex/fix-symlinks-command-not-found-error
Closed

Require composer-plugin-api ^2.1 and expand README troubleshooting for missing symlinks commands#29
somework wants to merge 1 commit intomasterfrom
codex/fix-symlinks-command-not-found-error

Conversation

@somework
Copy link
Copy Markdown
Owner

@somework somework commented Jan 25, 2026

Motivation

  • Users encountered There are no commands defined in the "symlinks" namespace when invoking the plugin commands, which indicates Composer may be running without command-provider support or with plugins disabled.
  • The plugin registers commands via the Composer command-provider capability which requires composer-plugin-api >= 2.1.
  • The README needed clearer, ordered troubleshooting steps and a fallback for environments still on Composer v2.0.

Description

  • Bumped the composer-plugin-api requirement in composer.json from ^2.0 to ^2.1.
  • Rewrote the README troubleshooting section to replace a terse warning with an ordered checklist covering Composer version requirements, a fallback for Composer v2.0 (composer install or composer run-script post-install-cmd), config.allow-plugins guidance, and avoiding --no-plugins.
  • Added an explicit example invocation composer symlinks:refresh in the README to illustrate the command usage.
  • Retained existing notes about dry-run and uninstall behavior while improving clarity around why the command namespace may be missing.

Testing

  • No automated tests were executed for these changes because they modify the package manifest and documentation only.

Codex Task

Summary by CodeRabbit

  • Documentation
    • Expanded "Execute composer" guidance with comprehensive explanations of plugin behavior and troubleshooting steps
    • Added detailed checklist for resolving common configuration issues
    • Clarified version requirements and plugin allowance settings
    • Updated dry run section with environment variable configuration instructions

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 25, 2026

📝 Walkthrough

Walkthrough

Documentation guidance for the "Execute composer" section is expanded with detailed plugin behavior explanations, troubleshooting steps, and environment variable usage. The composer-plugin-api dependency requirement is updated from ^2.0 to ^2.1.

Changes

Cohort / File(s) Summary
Documentation updates
README.md
Replaced terse warning with comprehensive multi-step checklist covering plugin behavior with --no-plugins flag, version requirements, plugin allowance, and refresh command execution. Updated dry run section to use SYMLINKS_DRY_RUN=1 environment variable.
Dependency version bump
composer.json
Updated composer-plugin-api requirement from ^2.0 to ^2.1.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A hop through the docs, a leap so grand,
With guidance so clear, now better planned,
A plugin dance, version two-point-one,
Fresh checklist wisdom for everyone!
The composer knows, the rabbit approves. ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately captures both main changes: bumping composer-plugin-api to ^2.1 and expanding README troubleshooting guidance for the symlinks command-not-found error.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@somework somework closed this Jan 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant