bradstinson/assets

A simple assets library. Combine and minify your JS and CSS assets

Assets

, _(*1)

Assets is yet another CSS/JavaScript minificaton and combination library. However, unlike most other libraries (which rely on Assetic), this ones takes a more simplistic approach., _(*2)

Assets supports minifying and combining stylesheets and scripts, in an effort to reduce the number and size of http requests needed to load a given page. The generated file is also cached, which prevents an application from having to generate the same file for every new request., _(*3)

Basic usage

CSS

CSS files can be added using the following command, where "file1.css" and "file2.css" are the CSS files you want to include, and are located at assets/css/file1.css and assets/css/file2.css., _(*4)

Assets::css('file1.css');
Assets::css('file2.css');

You may also submit files as an array., _(*5)

Assets::css(array('file1.css', 'file2.css'));

Assets will minify both CSS files and combine them into a single file (which is written to 'assets/cache' directory). The proper tags will then be returned. To include this file in your page, use the following:, _(*6)

echo Assets::renderCss();
/*
Returns something like:
<link rel="stylesheet" href="/assets/cache/3cf89b9f723e22c1caf26f8d4d1fdc31.css">
*/

LESS

Less files can be added using the following command, where "file1.less" is the Less file you want to compile, and is located at assets/css/file1.less., _(*7)

Assets::less('file1.less');

You may also submit multiple files as an array., _(*8)

Assets::css(array('file1.less', 'file2.less'));

Your Less files will be automatically compiled and combined with your CSS files into a single file (which is written to 'assets/cache' directory). The proper tags will then be returned., _(*9)

JS

Javascript files can be added using the following command, where "file1.js" and "file2.js" are the javascript files you want to include, and are located at assets/js/file1.js and assets/js/file2.js., _(*10)

Assets::js('file1.js');
Assets::js('file2.js');

You may also submit files as an array., _(*11)

Assets::js(array('file1.js', 'file2.js'));

Assets will minify both JS files and combine them into a single file (which is written to 'assets/cache' directory). The proper tags will then be returned. To include this file in your page, use the following:, _(*12)

echo Assets::renderJs();
/*
Returns something like:
<script src="/assets/cache/9cf2803d8f075cb7d1ad31940738f35e.js"></script>
*/

CoffeeScript

CoffeeScript files can be added using the following command, where "file1.coffee" is the CoffeeScript file you want to compile, and is located at assets/js/file1.coffee., _(*13)

Assets::coffee('file1.coffee');

You may also submit multiple files as an array., _(*14)

Assets::coffee(array('file1.coffee', 'file2.coffee'));

Your CoffeeScript files will be automatically compiled and combined with your JS files into a single file (which is written to 'assets/cache' directory). The proper tags will then be returned., _(*15)

If you would like to generate the CSS and JS tags together, you can call:, _(*16)

echo Assets::render();
/*
Which will return:
<link rel="stylesheet" href="/assets/cache/3cf89b9f723e22c1caf26f8d4d1fdc31.css">
<script src="/assets/cache/9cf2803d8f075cb7d1ad31940738f35e.js"></script>
*/

Configuration

By default, this library assumes the following directory structure:, _(*17)

assets/
   css/
   js/
   cache/

However, you are now able to adjust the path to the assets directory (if needed):, _(*18)

Assets::setPath('public/assets/');

BaseURL

Assets::setBaseurl('/');

Groups

This library currently does not offer support for groups. This is because the project I was working on did not require it. If enough requests are made, this may be added in a future version., _(*19)

Thanks

This asset library was inspired by and uses components from the following libraries:, _(*20)

• Assets
• Assetic
• Basset
• CssMin
• LessPHP
• CoffeeScript PHP

Contributing

If you have any issues/complaints/suggestions, let me know and I will see if I can implement them as time permits. Also, pull requests are also welcome., _(*21)