https://github.com/jrohde/smarty-ass
https://github.com/jrohde/smarty-ass
minify smarty-plugins
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jrohde/smarty-ass
- Owner: jrohde
- License: mit
- Created: 2017-06-19T09:34:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-31T12:08:44.000Z (almost 9 years ago)
- Last Synced: 2025-05-15T05:07:48.824Z (about 1 year ago)
- Topics: minify, smarty-plugins
- Language: PHP
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Smarty 3+ plugin to bundle and minify js and/or css files.
This Smarty plugin uses [Matthias Mullie's Minify](https://github.com/matthiasmullie/minify) library to do it's minifications and bundling.
It automatically checks for (JS/CSS) file/code changes and then rebuild's the minified/bundled output file.
**Table of Contents**
1. [Installation](#install)
2. [Parameters](#params)
3. [Usage/Examples](#usage)
Use [Composer](http://getcomposer.org/) to include the library into your project:
$ composer.phar require jrohde/smarty-ass
Now add the plugin dir to your Smarty instance:
```
$smarty = new \Smarty();
$smarty->addPluginsDir('./path/to/vendor/rohdej/smarty-ass/');
```
You can check if the correct path was added by using:
```
var_dump($smarty->getPluginsDir());
```
- **in** (array) - absolute path('s) to local JS or CCS files, inline or tags and/or external JS or css files.
- **out** (string) - absolute path to the minified and bundled file output (must be writable by the webserver/php user!). This parameter is optional and defaults to '/assets/(js/css)/${smarty_template_name}_combined.(css/js)'.
- **ttl** (integer) - time to live in of cached files in seconds. This is the maximum time a minified/combined file may exist before a complete rebuild. Note that when source files are modified the output file is regenerated, regardless of this value. This parameter is optional and defaults to '31536000' (a.k.a: 1 year).
- **gzip** (boolean) - gzip's the output file. Make sure your PHP/Webserver supports this! This parameter is optional and defaults to 'false'
- **debug** (boolean) - disables compilation and just output all as normal if set to: 'true'. This parameter is optional and defaults to 'false'
### Usage (in Smarty 3+ templates)
```
{ass in=['file1.js','file2.js'] out='/assets/combined_and_minified.js' ttl='3600' gzip='false' debug=false}
```
You may also use external js/css/cdn's like:
```
{ass in=[
'https://code.jquery.com/jquery-git.min.js',
'https://code.jquery.com/ui/1.12.1/jquery-ui.min.js'
] out='/assets/combined_and_minified.js' ttl='3600' gzip='false' debug=false}
```
Use/add inline css or js (but make sure to escape single/double quotes!):
```
{ass in=["
var cool = 'awesome';
"] out='/assets/combined_and_minified.js' ttl='3600' gzip='false' debug=false}
```
Or even mix it all together:
```
{ass in=[
'https://code.jquery.com/jquery-git.min.js',
'https://code.jquery.com/ui/1.12.1/jquery-ui.min.js',
'file1.js',
'file2.js',
'
var cool = \'awesome\';
'
] out='/assets/combined_and_minified.js' gzip='true'}
```