Skip to content

strivex-commons.xml.md

Latest commit

 

History

History
79 lines (57 loc) · 4.4 KB

strivex-commons.xml.md

File metadata and controls

79 lines (57 loc) · 4.4 KB

Build File Strivex Commons

How to use the strivex-commons.xml build file.

To take advantage of the strivex-commons.xml build file, import it to your own build file.

Setup your build file.

Before you import the strivex-commons.xml, you can set several properties. When you omit them, they will be asked for or they will use some default value.

Name Type Default value Required Description
package.name String ${phing.project.name} yes Path to the Git executable
exe.git String n/a yes Path to the Git executable
exe.phing String n/a yes Path to the Phing executable
file.autoload String n/a yes Path to the autoload.php

Example:

<?xml version="1.0" encoding="UTF-8" ?>
<project name="YourProject">
    
    <!-- Set properties being used in strivex-commons.xml to avoid inputs -->
    <resolvepath propertyName="exe.git" value="./../git.exe" />
    <resolvepath propertyName="exe.phing" value="./../vendor/phing/phing/bin/phing" />
    <resolvepath propertyName="file.autoload" value="./../vendor/autoload.php" />
    
    <import file="./../strivex-phing/buildfiles/strivex-commons.xml" />
    
    <!-- Do your thing! -->
    
</project>

Available custom tasks.

When using the strivex-commons.xml build file in your build files, you will get some custom task definitions. For more information on those custom tasks definitions, please read the README.md for the specific definitions.

Available properties.

You have access to some properties created in strivex-commons.xml.

Name Type Value Description Availability
text.tab String Value of a tab yes
text.enter String Value of a new line yes
file.autoload 1 String user defined Path to the autoload file yes
exe.git 1 String user defined Path to the Git executable yes
exe.phing 1 string user defined Path to the Phing executable yes
package.name String user defined Name of the package yes
package.name.lowercase String Name of the package in lowercase yes, after params.init
package.name.uppercase String Name of the package in UPPERCASE yes, after params.init
package.name.pascalcase String Name of the package in PascalCase yes, after params.init
package.name.camelcase String Name of the package in camelCase yes, after params.init
package.name.snakecase String Name of the package in snake_case yes, after params.init
package.name.kebabcase String Name of the package in kebab-case yes, after params.init

1. These properties can be set before importing strivex-commons.xml.

Target: params.init

In the strivex-commons.xml is a target params.init. In this target we will extend some properties that can be used in your targets. Also some required properties will be checked and when needed be asked for.

Use this target as the last dependency in your targets, so you always have all the properties! You can use the same setup in your own build scripts. Create a params.init target that will call the params.init in the strivex-commons.xml and use your magic there. Use your params.init as the last dependencies in your targets.