Download the PHP package jkribeiro/composer-hydration without Composer
On this page you can find all versions of the php package jkribeiro/composer-hydration. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package composer-hydration
composer-hydration
Introduction
composer-hydration is a simple package that provides a Composer Script to be used as placeholder replacement, mostly used by 'skeletons' projects.
Example:
The script will search for the placeholders in file content
, file names
and folders
.
Before:
After:
Installation
Install Composer
Since composer-hydration is a Composer script, you need to install composer first.
Note: The instructions below refer to the global composer installation. You might need to replace
composer
withphp composer.phar
(or similar) for your setup.
Add package dependency
Add composer-hydration as package dependency of your project, updating your composer.json
:
Define the Composer Script
Define the Composer script, adding this entry to your composer.json
:
Install Project
Usage
There are some ways that you can execute this script:
Execute the command manually
After have the package installed, you can run the command manually to have your values placed.
Hydrate during the Composer Events
Composer fires some events during its execution process, useful to define on which step/event it will perform the hydration process.
In the example below, the hydration process will occur after the project installation:
Variables as Replacement values
Sometimes we need to use dynamic replacement values on composer.json
, not only hardcoded values like {FRUIT}:banana
, for these cases, there are two possibilities:
Environment Variables
composer.json
allows environment variables as replacement placeholder value, like {{PROJECT_NAMESPACE}}:$PROJECT_NAME"
, $PROJECT_NAME
is the variable name. You must define the variables before execute the Composer commands.
Example:
composer.json
Execution
"Magic Constants"
Using the same idea of PHP Magic constants, composer-hydration provides some Magic constants too.
{%BASENAME%}
: Returns the base folder name where the script is being executed, normally is the name of the project.{%UCFIRST_BASENAME%}
: Returns the base folder name with the first character capitalized.-
{%UPPER_CAMEL_CASE_BASENAME%}
,{%LOWER_CAMEL_CASE_BASENAME%}
: Returns the base folder name using the upper/lower camel case format. Only the folder name separators '-', '_' are allowed.Example:
Placeholders with
{{PROJECT_NAMESPACE}}
will be replaced bymyproject
.