Add is-installed subcommand

[baizmandesign]

This pull request is in connection with #210.

When I ran the Behat tests for features/package-install.feature locally, a number of them failed. I'm not sure if that was just my computer's fault. If not, we may need to tweak some of the tests. (I wasn't able to troubleshoot why the tests failed locally. I know the tests are run in a temporary directory deep in /var/folders, but I wasn't sure how to run wp package commands that used an alternative composer.json, or where that alternative composer.json might live.)

[github-actions]

Hello! 👋

Thanks for opening this pull request! Please check out our contributing guidelines. We appreciate you taking the initiative to contribute to this project.

Contributing isn't limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

Here are some useful Composer commands to get you started:

• composer install: Install dependencies.
• composer test: Run the full test suite.
• composer phpcs: Check for code style violations.
• composer phpcbf: Automatically fix code style violations.
• composer phpunit: Run unit tests.
• composer behat: Run behavior-driven tests.

To run a single Behat test, you can use the following command:

# Run all tests in a single file
composer behat features/some-feature.feature

# Run only a specific scenario (where 123 is the line number of the "Scenario:" title)
composer behat features/some-feature.feature:123

You can find a list of all available Behat steps in our handbook.

[gemini-code-assist]

Summary of Changes

Hello @baizmandesign, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the wp package command by adding an is-installed subcommand. This new command provides a programmatic way to determine if a WP-CLI package is present, returning a clear exit status that can be utilized in scripts and automated workflows. The changes include updates to documentation, command registration, and thorough testing to ensure reliability and ease of use.

Highlights

• New Subcommand: Introduced a new wp package is-installed <name> subcommand to check if a specific package is installed, returning an exit code of 0 for installed and 1 for uninstalled.
• Documentation Update: The README.md file has been updated to include comprehensive documentation for the new is-installed subcommand, detailing its usage, options, and examples.
• Composer Integration: The composer.json file was modified to register the newly added package is-installed subcommand, making it available within the WP-CLI ecosystem.
• Test Coverage: Extensive Behat tests were added and updated in features/package-install.feature to validate the functionality of the is-installed subcommand across various installation and uninstallation scenarios.
• Code Refinement: The src/Package_Command.php file was refactored to implement the public is_installed method and remove the now redundant private is_package_installed method, streamlining the package status check logic.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new wp package is-installed subcommand, which is a useful addition for scripting and checking the state of packages. The implementation is straightforward and includes comprehensive documentation and test coverage. My review includes a couple of suggestions to improve code conciseness and test maintainability.

[codecov]

Codecov Report

❌ Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/Package_Command.php	0.00%	3 Missing ⚠️

📢 Thoughts on this report? Let us know!

[baizmandesign]

@swissspidy Please see the comment attached to the pull request.

[swissspidy]

When you expect return code 1, you need to use "try" instead of "run"

[swissspidy]

I wasn't able to troubleshoot why the tests failed locally. I know the tests are run in a temporary directory deep in /var/folders, but I wasn't sure how to run wp package commands that used an alternative composer.json, or where that alternative composer.json might live.)

When a test fails it will print the working directory like so:

001 Scenario: Install a package with an http package index url in package composer.json # features/package-install.feature:7
      When I run `wp package is-installed wp-cli/restful`                               # features/package-install.feature:49
        $ wp package is-installed wp-cli/restful

        cwd: /var/folders/44/hnwfklt963g865t5yf7yn5jw00lhhc/T/wp-cli-test-run--696f473689a729.89872360/
        run time: 0.25183796882629
        exit status: 1 (RuntimeException)

That's where you find all the files created during the test (such as composer.json). You can then run commands inside that directory to see what's going on (e.g. cd /var/folders/...; WP_CLI_PACKAGES_DIR=. wp package list) or do something like vendor/bin/wp --path=/var/folders/44/hnwfklt963g865t5yf7yn5jw00lhhc/T/wp-cli-test-run--696f473689a729.89872360/ package is-installed .... Using vendor/bin/wp ensures that you're really using the version from your branch with the new command.

Happy to elaborate on Slack if needed.

[baizmandesign]

Thanks for all of your help @swissspidy! I really appreciate it. :-)