deliverist/builder

Project builder.

Deliverist\Builder

, _(*1)

, _(*2)

Installation

Download a latest package or use Composer:, _(*3)

composer require deliverist/builder

Deliverist\Builder requires PHP 8.0 or later., _(*4)

Usage

``` php <?php, <sub>(*5)</sub>

use Deliverist\Builder\Builder; use Deliverist\Builder\Commands; use Deliverist\Builder\Loggers;, <sub>(*6)</sub>

$builder = new Builder('/path/to/source/code', [ 'composer-install' => new Commands\ComposerInstall, 'rename' => new Commands\Rename, 'remove' => new Commands\Remove, ], new Loggers\TextLogger);, <sub>(*7)</sub>

$builder->make('composer-install') ->make('rename', ['from' => 'index.php', 'to' => 'www/index.php']) ->make('remove', ['file' => 'composer.lock']) ->make('composer-install');, <sub>(*8)</sub>

## Commands

### ApacheImports

Expands clause `<!--#include file="file.txt" -->` in specified files.

``` php
$builder->make('apache-imports', ['file' => 'file-to-expand.txt']);
$builder->make('apache-imports', ['files' => [
    'admin.js',
    'front.js',
]]);

ComposerInstall

Runs composer install in composer.json directory., <sub>(*9)</sub>

``` php $builder->make('composer-install'); $builder->make('composer-install', ['composerFile' => 'path/to/composer.json']);, <sub>(*10)</sub>

### Copy

Copies specified files.

``` php
$builder->make('copy', ['from' => 'old.txt', 'to' => 'new.txt']);
$builder->make('copy', ['files' => [
    'old.txt' => 'new.txt',
]]);
$builder->make('copy', ['paths' => [
    'old/dir' => 'new/dir',
]]);

CreateDirectory

Creates specified directories., <sub>(*11)</sub>

``` php $builder->make('create-directory', ['directory' => 'new-directory']); $builder->make('create-directory', ['directories' => [ 'new-directory', 'new-directory-2', ]]);, <sub>(*12)</sub>

### CssExpandImports

Expands clause `@import 'file.css'` in specified files.

``` php
$builder->make('css-expand-imports', ['file' => 'file-to-expand.txt']);
$builder->make('css-expand-imports', ['files' => [
    'admin.css',
    'front.css',
]]);

GoogleAnalytics

Replaces placeholder with Google Analytics script in file., <sub>(*13)</sub>

``` php $builder->make('google-analytics', [ 'file' => 'path/to/file.php', 'code' => 'UA-9876-5', 'placeholder' => '%% GA %%', ]); // replaces placeholder '%% GA %%' in file $builder->make('google-analytics', ['file' => 'path/to/file.html', 'code' => 'UA-9876-5']); // uses placeholder '' in file $builder->make('google-analytics', ['file' => 'path/to/file.latte', 'code' => 'UA-9876-5']); // uses placeholder {* GA *} in file, <sub>(*14)</sub>

### GoogleClosureCompiler

Minifies files in online Google Closure Compiler.

``` php
$builder->make('google-closure-compiler', ['file' => 'script.js']);
$builder->make('google-closure-compiler', ['files' => [
    'script-1.js',
    'script-2.js',
]]);

LessCompile

Runs lessc for compiling of LESS files., <sub>(*15)</sub>

``` php $builder->make('less-compile', ['file' => 'styles.less']); $builder->make('less-compile', ['files' => [ 'style-1.less', 'style-2.less', ]]);, <sub>(*16)</sub>

### MinifyContent

Removes empty lines & whitespaces on start & end of lines.

``` php
$builder->make('minify-content', ['file' => 'file.txt']);
$builder->make('minify-content', ['files' => [
    'file-1.txt',
    'file-2.txt',
]]);

Example:, <sub>(*17)</sub>

Input:, <sub>(*18)</sub>

{block content}


Homepage



    <p>
        Lorem ipsum dolor sit amet.
    </p>
{/block}

Output:, <sub>(*19)</sub>

{block content}
<h1>Homepage</h1>
<p>
Lorem ipsum dolor sit amet.
</p>
{/block}

PingUrl

Opens URL and shows content., <sub>(*20)</sub>

``` php $builder->make('ping-url', ['url' => 'https://example.com/migrations.php']); $builder->make('ping-url', ['url' => 'https://example.com/migrations.php', 'validateSsl' => FALSE]); // disable SSL validation, <sub>(*21)</sub>

### Remove

Removes file or directory.

``` php
$builder->make('remove', ['file' => 'path/to/file.txt']);
$builder->make('remove', ['path' => 'path/to/directory']);
$builder->make('remove', ['files' => [
    'path/to/file.txt',
    'path/to/directory',
]]);
$builder->make('remove', ['paths' => [
    'path/to/file.txt',
    'path/to/directory',
]]);

Rename

Renames file or directory., <sub>(*22)</sub>

``` php $builder->make('rename', ['from' => 'old.txt', 'to' => 'new.txt']); $builder->make('rename', ['files' => [ 'old.txt' => 'new.txt', ]]);, <sub>(*23)</sub>

### ReplaceContent

Replaces content in file.

``` php
$builder->make('replace-content', [
    'file' => 'file.txt',
    'replacements' => [
        'from' => 'to',
        'old string' => 'new string',
    ],
]);

License: New BSD License
Author: Jan Pecha, https://www.janpecha.cz/, <sub>(*24)</sub>