allenlinatoc/assetmon

A quick asset monitoring and compression PHP script

ASSETMON

An open-source automated web asset monitoring and compilation tool written in PHP., _(*1)

This tool recursively monitors and compiles all web assets so that web applications will have to load one single file., _(*2)

Getting started

1. Configure assetmon.json

Note: assetmon.json is the default configuration file of assetmon., _(*3)

The snippet below is the default content of assetmon.json:, _(*4)

{

    "extensions": [
        "js",
        "css"
    ],

    "directories" : [
        "./"
    ],

    "destination" : "./assets",

    "recursive" : true

}

Configuration directives, _(*5)

1. extensions (array)

   Default: [ "js", "css" ], _(*6)

   An array of file extensions to be included in asset monitoring., _(*7)

2. directories (array)

   Default: [ "./" ], _(*8)

   An array of existing directories to be included in recursive file monitoring. Symbolic paths are allowed., _(*9)

3. destination (string)

   Default: "./assets", _(*10)

   The path to destination folder. If path does not exist, it will automatically be created. Symbolic paths are allowed., _(*11)

4. recursive (boolean)

   Default: true, _(*12)

   Boolean value if assets (from directories) will be recursively monitored., _(*13)

2. Start assetmon

Copy assetmon to your current working directory and make sure that assetmon.json is properly configured and is in the same directory., _(*14)

Note: assetmon file is a GZip compressed PHP archive, _(*15)

Optionally, you can specify the configuration to be used through config argument., _(*16)

Console command syntax, _(*17)

$ php assetmon [config]

If you work with an existing assetmon.json config file, you can follow the simple syntax below:, _(*18)

$ php assetmon/assetmon

The output asset files will vary based on what is specified in extensions and destination., _(*19)

Sample scenario

Example, _(*20)

Given the sample configuration below:, _(*21)

{

    "extensions": [
        "js",
        "css"
    ],

    "directories" : [
        "./resources",
        "./dev/resources"
    ],

    "destination" : "./public/assets",

    "recursive" : true

}

In this example, it will do a recursive monitoring and compilation of js and css files., _(*22)

The process starts by checking if directories ./resources and ./dev/resources exists., _(*23)

Only existing directories/paths will be processed in recursive monitoring., _(*24)

Outputs expected are ./public/assets/all.js and ./public/assets/all.css, respectively., _(*25)

Note: Whether the script found such file extensions from the given directories, it will still produce the mentioned files with respect to the specified extensions., _(*26)