mcaskill / composer-exclude-files
Exclude files from autoload_files.php
Installs: 781 231
Dependents: 10
Suggesters: 0
Security: 0
Stars: 36
Watchers: 4
Forks: 6
Open Issues: 0
Type:composer-plugin
Requires
- php: ^7.2.5 || ^8.0
- composer-plugin-api: ^2.3
Requires (Dev)
- composer/composer: ^2.3
- phpstan/phpstan: ^1.11
- symfony/phpunit-bridge: ^7.1
README
A Composer plugin for excluding files required by packages using the files
autoloading mechanism.
This is useful for ignoring files required for bootstrapping a package or that provide PHP functions, for example.
Resolves composer/composer#5029
Installation
The plugin can be installed locally or globally.
composer require mcaskill/composer-exclude-files
As of Composer 2.2.0, for additional security, you
should declare the allow-plugins
config to allow Composer to run the plugin.
composer config allow-plugins.mcaskill/composer-exclude-files true
Usage
You can only ignore files from the root
composer.json
. File exclusions of dependencies'composer.json
are ignored.
From the root composer.json
, add the exclude-from-files
property to the
extra
section. The list of paths must be relative to this Composer manifest's
vendor directory: <vendor-name>/<project-name>/<file-path>
.
This plugin supports a subset of special characters used by
the glob()
function to match exclude paths
matching a pattern:
*
— Matches zero or more characters.?
— Matches exactly one character (any character).
This plugin is invoked before the autoloader is dumped, such as with the
commands install
, update
, and dump-autoload
.
Example 1: Excluding one file from illuminate/support
{ "require": { "illuminate/support": "^9.6" }, "extra": { "exclude-from-files": [ "illuminate/support/helpers.php" ] }, "config": { "allow-plugins": { "mcaskill/composer-exclude-files": true } } }
Example 2: Excluding many files from laravel/framework
{ "require": { "laravel/framework": "^9.6" }, "extra": { "exclude-from-files": [ "laravel/framework/src/*/helpers.php" ] }, "config": {…} }
Example 3: Excluding all files
{ "require": {…}, "extra": { "exclude-from-files": [ "*" ] }, "config": {…} }
The plugin will traverse each package and remove all files in the paths configured above from the prepared autoload map. The vendor files themselves are not removed. The root package is ignored.
The resulting effect is the specified files are never included in
vendor/composer/autoload_files.php
.
License
This is licensed under MIT.