asset-discovery

asset-discovery is a Composer-enabled PHP script to locate assets (JS, CSS, Coffee, SASS, images) across multiple PHP components which then can be copied automatically into generated stylesheets, scripts and image folders., _(*1)

Based on component-discovery., _(*2)

Configuring

First include asset-discovery as a requirement in your project composer.json, and run composer update to install it into your project:, _(*3)

{
  "require": {
    "soundasleep/asset-discovery": "dev-master"
  }
}

Now create a asset-discovery.json in your project, to define the types of assets to discover, and where to place source files:, _(*4)

{
  "src": ["vendor/*/*", "core"],
  "js": "site/generated/js/generated.js",
  "coffee": "site/generated/js/generated-coffee.coffee",
  "css": "site/generated/css/generated.css",
  "scss": "site/generated/css/generated-scss.scss",
  "images": "site/generated/images/"
}

asset-discovery will look in all the src folders for files called assets.json to find matching assets. Wildcards are supported. For example, in your vendor/my/package/assets.json:, _(*5)

{
  "scss": ["css/currencies.scss", "css/second.scss"],
  "coffee": ["js/*.coffee"],
  "images": ["images/*"]
}

Generated asset files, other than images, will be included in the source order specified., _(*6)

Building

Run the generate script, either with your build script or manually, with a given root directory:, _(*7)

php -f vendor/soundasleep/asset-discovery/generate.php .

This will generate various files under the directories defined in your asset-discovery.json config. These files can then be passed along to the next step in a build chain (e.g. compile SASS to CSS, minify, spritify, optimize images etc)., _(*8)