dev: Composer polish #42

justlevine · 2025-08-22T15:04:03Z

What

This PR polishes up #35 , making it usable as both a WordPress plugin and a Composer library.

How

Library type switched back to wordpress-plugin, allowing for plugin installation using composer.json:extra.
Removed the composer.json:autoload prop in favor of manually require_once, depending on if the user wants the REST API endpoints (and the rest of the plugin) or just the API classes and functions.
Restored the WP_ABILITIES_API_VERSION const for version targeting, moved into bootstrap.php
Added usage docs for both plugin and dependency, composer and non-composer usage.

More specific comments inline.

Additional notes

I'm not entirely sure the use case of wanting to require_once the classes but not hook the REST API endpoints. Without it, we dont need a separate "library vs plugin" bootstrap, devs can can just require_once the same root abilities-api.php as WordPress core would do if it was located in wp-content/plugins instead of my-plugin/vendor/*.

Left it in this PR to respect the Chesterton fence (though I'm like 95% sure it's just an artifact of from the prior art and not relevant here).

Copilot

Pull Request Overview

This PR polishes the Abilities API to function as both a WordPress plugin and a Composer library, providing flexible installation and usage options. The changes allow developers to either install the complete plugin with REST API endpoints or include just the core classes as a dependency.

Switched composer type back to wordpress-plugin to enable plugin installation via Composer
Removed autoload configuration in favor of manual require_once for better control over loading
Added comprehensive installation and usage documentation covering multiple scenarios

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
composer.json	Changed type to `wordpress-plugin` and removed autoload configuration
includes/bootstrap.php	Added version constant and updated documentation for library usage
docs/2.getting-started.md	Added comprehensive installation guides for plugin and dependency usage
abilities-api.php	Minor formatting cleanup (removed extra blank line)

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

includes/bootstrap.php

docs/2.getting-started.md

codecov · 2025-08-22T15:06:47Z

Codecov Report

❌ Patch coverage is 0% with 13 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (update/composer-configuration@8a58d04). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
includes/bootstrap.php	0.00%	10 Missing ⚠️
abilities-api.php	0.00%	3 Missing ⚠️

Additional details and impacted files

@@                       Coverage Diff                        @@
##             update/composer-configuration      #42   +/-   ##
================================================================
  Coverage                                 ?   91.61%           
  Complexity                               ?       93           
================================================================
  Files                                    ?        8           
  Lines                                    ?      513           
  Branches                                 ?        0           
================================================================
  Hits                                     ?      470           
  Misses                                   ?       43           
  Partials                                 ?        0

Flag	Coverage Δ
unit	`91.61% <0.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

justlevine · 2025-08-22T15:06:37Z

docs/2.getting-started.md

 # 2. Getting Started

-## Installation Options
+## Installation


Personally I'd make this a separate INSTALLATION.md doc, but because the doc-files are # prefixed, I didnt want to blow up the diff here.

We can update that part after the package is available on Packagist.

justlevine · 2025-08-22T15:09:59Z

docs/2.getting-started.md

+
+### As a plugin
+
+The best and easiest way to try and use the Abilities API is to install it as a plugin by downloading the latest release from the [GitHub Releases page](https://github.com/WordPress/abilities-api/releases/latest).


This requires us to cut a release (but so does composer). Can use the path to trunk in the interim, I just didn't want to rewrite something that's anyway needs to be rewritten by a competent docs writer

justlevine · 2025-08-22T15:14:05Z

docs/2.getting-started.md

+
+Plugin authors and developers may wish to rely on the Abilities API as a dependency in their own projects, before it is merged into core. You can do that in one of the following ways.
+
+#### As a Plugin Dependency (Recommended)


Even without it being on .org (and therefore available to autoinstall), I believe this should still be Recommended , since we want to ensure people are testing with the latest versions for the next few months, and not some potentially-deconflicted library.

But if you disagree, drop it.

justlevine · 2025-08-22T15:14:34Z

docs/2.getting-started.md

+
+Until the plugin is available on Packagist, you will need to add the repository to your `composer.json` file.
+
+```jsonc
+{
+  "repositories": [
+    {
+      "type": "vcs",
+      "url": "https://github.com/WordPress/abilities-api.git"
+    }
+    // ... other repositories.
+  ],
+  // ... rest of your composer.json.
+}
+```


Removed once we're on packagist.

justlevine · 2025-08-22T15:15:21Z

includes/bootstrap.php

Mainly just cleaning up the composer specific comments.

justlevine · 2025-08-22T15:16:43Z

includes/bootstrap.php

+ * Useful to confirm you're using the latest version of the Abilities API.
+ */
+if ( ! defined( 'WP_ABILITIES_API_VERSION' ) ) {
+	define( 'WP_ABILITIES_API_VERSION', '0.1.0' );


Not sure if this was intentionally removed, but we need it for MCP Adapter / Experiments for the next 3 months if we want to be able to allow this library to evolve.

justlevine · 2025-08-22T15:19:29Z

docs/2.getting-started.md

+    "installer-paths": {
+      // This should match your WordPress+Composer setup.
+      "wp-content/plugins/{$name}/": [
+          "type:wordpress-plugin"


This is what we lose by making type: library instead of wordpress-plugin. We gain nothing.

composer.json

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

justlevine · 2025-08-22T15:40:04Z

docs/2.getting-started.md

NOTE: This is only here for reviewers because there seems to be some confusion about WordPress Plugins and composer usage (also in MCP Adapter... ) so I wanted clear illustration I could point to. Would recommend @jonathanbossenger or someone else better than I to review before final merge.

gziolo and others added 5 commits August 22, 2025 11:16

Chore: Configure the composer package for publishing

59c1bba

Apply feedback from review to .gitattributes file

7fd57a3

Do not use Composer autoloader internally in the WP plugin

98d19b0

Change composer type to library

55fab93

dev: Composer polish

2f3dab1

justlevine requested a review from Copilot August 22, 2025 15:04

Copilot AI reviewed Aug 22, 2025

View reviewed changes

includes/bootstrap.php Show resolved Hide resolved

docs/2.getting-started.md Outdated Show resolved Hide resolved

justlevine commented Aug 22, 2025

View reviewed changes

Update docs/2.getting-started.md

e6eab11

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

justlevine marked this pull request as ready for review August 22, 2025 15:24

justlevine mentioned this pull request Aug 22, 2025

Chore: Configure the composer package for publishing #35

Merged

justlevine requested a review from gziolo August 22, 2025 15:35

justlevine commented Aug 22, 2025

View reviewed changes

chore: update lockfile

ea946a9

gziolo added the [Tool] Issues related to development tooling, such as linting, testing, or CI label Aug 26, 2025

gziolo assigned justlevine Aug 26, 2025

gziolo requested review from emdashcodes, gziolo and jonathanbossenger and removed request for gziolo August 27, 2025 05:45

gziolo force-pushed the update/composer-configuration branch from 20d46e2 to 0cad3fe Compare August 28, 2025 07:18

gziolo deleted the branch WordPress:update/composer-configuration August 28, 2025 12:34

gziolo closed this Aug 28, 2025

justlevine mentioned this pull request Aug 28, 2025

docs: add installation steps for release #48

Merged


		### As a plugin

		The best and easiest way to try and use the Abilities API is to install it as a plugin by downloading the latest release from the [GitHub Releases page](https://github.com/WordPress/abilities-api/releases/latest).


		Plugin authors and developers may wish to rely on the Abilities API as a dependency in their own projects, before it is merged into core. You can do that in one of the following ways.

		#### As a Plugin Dependency (Recommended)

dev: Composer polish #42

dev: Composer polish #42

Uh oh!

Conversation

justlevine commented Aug 22, 2025

What

How

Additional notes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

justlevine Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Aug 22, 2025 •

edited

Loading

justlevine Aug 22, 2025 •

edited

Loading