README

Package skeleton demo using Shudd3r/Skeletons

Skeleton package built to illustrate how it can be managed by script that uses shudd3r/skeletons library.

Installation

It is recommended to use it globally as an exacutable application - downloaded example-skeleton.phar archive from the latest release asset files and placed it in one of the operating system's PATH directories. More on Windows executable .phar files here.

During deployment process or for a small number of projects you can install this package with Composer as one of package's dev dependencies:

composer require --dev shudd3r/skeleton-example

Note that using this method will require you to download this package for each project using the skeleton.

Basic Usage

To use skeleton application, run the script from the root directory of your project. If you installed it globally as example-skeleton.phar and made it executable by your operating system, you can simply run example-skeleton instead of vendor/bin/example-skeleton in the examples below.

• Display help message with usage details (help command is optional):

  vendor/bin/example-skeleton help

• Initialize package with skeleton files providing template replacement values through interactive shell:

  vendor/bin/example-skeleton init

• Validate project's consistency with skeleton (can be added to CI workflow):

  vendor/bin/example-skeleton check

• Update placeholders through interactive shell or using provided argument:

  vendor/bin/example-skeleton update
  vendor/bin/example-skeleton update ns=UpdatedNamespace\Package

• Synchronize files with template:

  vendor/bin/example-skeleton sync

Windows executable

To run the script globally from console with simple example-skeleton command:

1. You need to place downloaded .phar file in one of (executable) PATH directories or add new one to directory list in %PATH% environment variable. You can change environment variables by running:

   SystemPropertiesAdvanced.exe

2. Windows doesn't support shebang parsing, so files that can't be executed directly need to be assigned to their interpreter manually. The easiest way to make concrete .phar file executable is to create .bat runner file with the following command:

   echo '@php "%~dp0example-skeleton.phar" %*' > example-skeleton.bat