English | 中文文档
super-kernel/composer-source-reference-plugin is a Composer plugin that gives super-kernel/* packages installed from local path repositories a lock reference derived from their production source, so that composer update records every change to that source in composer.lock.
composer require super-kernel/composer-source-reference-pluginThe package needs Composer 2 with plugins enabled, and the project must permit it in config.allow-plugins. It only matters for super-kernel/* packages installed from path repositories; packages installed from Packagist keep their own references.
- A
dist.referenceof the formsk-source-v1-<hash>for eachsuper-kernel/*path package that Composer resolves. - A hash of the package's production autoload sources,
psr-0,psr-4,classmap, andfiles, with their package-relative paths and bytes. - The same reference for the same source, whatever the checkout location, file times, or directory order.
- A failed update, instead of a stale reference, when a source cannot be read safely.
It does not:
- change the root package, packages from other vendors, or packages from other repository types;
- include
autoload-dev, tests, documentation, or other files outside the production autoload rules; - run when Composer runs with
--no-plugins; - scan anything when the application starts.
Install a local super-kernel/* package through a path repository, here a copy of super-kernel/filesystem next to the project, and permit the plugin. A path package takes its version from its directory, such as dev-main, so require it with *. Save the project's manifest as composer.json:
{
"name": "acme/billing",
"type": "project",
"repositories": [
{
"type": "path",
"url": "../packages/filesystem"
}
],
"require": {
"super-kernel/composer-source-reference-plugin": "^1.0.0-alpha.2",
"super-kernel/filesystem": "*"
},
"minimum-stability": "dev",
"prefer-stable": true,
"config": {
"allow-plugins": {
"super-kernel/composer-source-reference-plugin": true
}
}
}Update twice, the first time to install the plugin and the second to let it compute the reference:
composer update
composer updatecomposer.lock then records the path package with a dist.reference of sk-source-v1- followed by 64 hexadecimal digits.
| Name | Kind | Purpose |
|---|---|---|
config.allow-plugins |
Composer key | Must permit super-kernel/composer-source-reference-plugin, or Composer does not run it. |
SuperKernel\ComposerSourceReferencePlugin\Plugin |
Class | The plugin Composer activates; it computes the references while Composer builds its dependency pool. |
- The plugin must be installed before Composer builds the dependency pool, so introducing it takes one
composer updateto install it and a second to compute the references; afterwards onecomposer updatedoes both. - Only packages that the update resolves are processed: locked or fixed packages, aliases, and path packages without a reference keep theirs.
- Changing, adding, or deleting a production autoload file changes the reference at the next update, and so changes
composer.lock; files thatexclude-from-classmapexcludes do not count. composer update --no-pluginswrites Composer's own references instead; do not use it to update the lock of a project that relies on these references.- An unsafe or unreadable autoload path fails the update with a
RuntimeException, such asAutoload paths must not contain ".." segments. - Run
skernel buildafter the update: a changedcomposer.lockmakes the project's build metadata out of date.
The developer documentation describes which packages and files count, bootstrapping the plugin, how the reference reaches the build, and every error message: SuperKernel Composer Source Reference Plugin.
Released under the MIT License. See LICENSE.