Download the PHP package sweikenb/boundaries without Composer
On this page you can find all versions of the php package sweikenb/boundaries. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sweikenb/boundaries
More information about sweikenb/boundaries
Files in sweikenb/boundaries
Package boundaries
Short Description Project structure and sourcecode file-content checker.
License MIT
Informations about the package boundaries
Boundaries
This is a plugin for the Composer package-manager.
License: MIT
Project status: functional but WIP
Installation
Options:
Run the check
You can run this command locally or in your CI/CD pipelines, based on the exit-status of the script you can identify if violations where found:
If any violation is found, the corresponding errors will be printed and the script will exit with a non-zero status.
In case of no violations, the script will print a success message and exit with a zero status.
Configuration
Boundaries will look for its configuration file boundaries.yaml
in the composer working directory of the project.
Please refer to the template-config for further descriptions: boundaries.yaml
Add custom checks
In order to add custom checks, you have to create a composer plugin and register custom checks in the plugin:
Create your check
Create your own check by implementing \Sweikenb\Library\Boundaries\Api\CheckInterface
directly or extending the
abstract check (which is recommended):
Register your checks
You have to call the \Sweikenb\Library\Boundaries\Service\CheckService::registerChecks
static method to register you
checks in your plugin activation hook:
Troubleshoot
I want to add a custom check that validates the content of a file but $content
is always empty
You likely want to check contents of a file which name/filetype is not whitelisted for content loading.
Simply add your filename/-extension to the corresponding configuration of your boundaries.yaml
:
All versions of boundaries with dependencies
ext-json Version *
composer-plugin-api Version ^2.6
symfony/finder Version ^6.4 || ^7.0
symfony/yaml Version ^6.4 || ^7.0