Gassetic

Summary

Gassetic is an [Assetic] (https://github.com/kriswallsmith/assetic) replacement which is based on the gulp build tool for more comfortable frontend development and dependency management

Advantages over assetic

• CSS live reload (injects modified css files into page without refreshing page)
• Easy to setup
• Use a package manager like Bower for JS dependencies
• Use the gulp.js ecosystem to build your frontend assets
• Less magic! Easy to follow development flow

How it works

Gassetic makes it easy to manage your frontend assets. You can install JS and CSS libs through a package manager like Bower and then compile them using tools from gulp.js

Gassetic replaces "" strings in your templates with your generated CSS and JS files. In your gassetic.yml file you can specify which files and tasks to run on the input files and the names of the output files.

Gulp has literally hundreds of plugins that you can include in your gulpfile and process on your frontend assets.

Installation

1. Create your gassetic config

yaml example with gassetic.yml

mimetypes:
    # This section contains the formatters for the css files
    css:
        # In 'prod' mode, use these settings
        prod:
            outputFolder: web/compiled/css  # The output folder for your saving your compiled files
            webPath:      /compiled/css     # The web path for the compiled files
            # Run these tasks on your compiled files
            tasks:
                - { name: less }
                - { name: minify }
                - { name: concat, args: '%filename%' }
                
        # This is the list of source files to apply the above settings
        files:
            frontend.css: # This is the output filename
                - assets/css/animate.min.css
                - assets/css/swipebox.css
                - assets/vendor/bootstrap-daterangepicker/daterangepicker-bs3.css
                - assets/vendor/bootstrap3-wysihtml5-bower/dist/bootstrap3-wysihtml5.css
                - assets/vendor/jquery-simplecolorpicker/jquery.simplecolorpicker.css
                - vendors/oh/emoji-bundle/Oh/EmojiBundle/vendor/emoji.css
            backend.css:
                - assets/vendor/bootstrap-daterangepicker/daterangepicker-bs3.css
                - assets/css/backend.css
                
        # Watch these files for changes (optional)
        watch:
            - assets/**/*.less
            - assets/**/*.css


    # This section contains the formatters for your JS files
    js:
        prod:
            outputFolder: web/compiled/js  # Save the files here
            webPath:      /compiled/js     # Specify the web path
            tasks:
                - { name: concat, args: '%filename%' }
                - { name: uglify, args: { mangle: false } }
        
        # Here is a list of files to apply the above tasks to
        files:
            jquery.js: # This is the output filename
                - assets/vendor/jquery/jquery.js
            app.js:
                - web/html5lightbox/html5lightbox.js
                - assets/vendor/angular/angular.js
                - assets/vendor/angular-route/angular-route.js
                - assets/vendor/angular-sanitize/angular-sanitize.js
                - assets/js/tmp/angularApp.js/**/*.js

# This is the list of files/paths to search and find the replacement tags to insert the
# generated <script> or stylesheet tags
replacementPaths:
    - web/*.html
    - includes/**/*.html

default:
    - js
    - css

2. Create gulpfile.js

var modules;

// install all the modules you need with npm install $module --save
modules = {};
modules.concat = require("gulp-concat");
modules.less = less = require("gulp-less");
modules.minify = require("gulp-minify-css");
modules.uglify = require("gulp-uglify");

// you don't need to edit anything below this line ----------------------

var config, env, fs, gassetic, gulp, gutil, jsYaml, less, modules, yargs;

fs = require("fs");
gulp = require("gulp");
gutil = require("gulp-util");
jsYaml = require("js-yaml");
yargs = require("yargs");
gassetic = require("gassetic");

// load the config
config = jsYaml.safeLoad(fs.readFileSync('gassetic.yml', 'utf8'));

env = yargs.argv.env || 'prod';

gulp.task('default', function() {
	var ga = new gassetic(config, 'dev', modules);
	ga.clean().then(function() {
		ga.build().then(function() {
			ga.watch();
		});
	});
});

gulp.task('build', function() {
	var ga = new gassetic(config, env, modules);
	ga.clean().then(function() {
		ga.build();
	});
});

gulp.task('clean', function() {
  var ga = new gassetic(config, env, modules);
  ga.clean();
});

3. Within root of your project run:

   npm install gassetic --save

4. Update your templates from

To:

<!-- prod:frontend.css --><!--endbuild-->

The strings "" will be searched for in the 'replacementPaths' list in the settings and replaced with the generated tags and files

5. run gulp for watching and livereloading the files

6. run gulp build for production build

7. run gulp build --env=custom for custom build

Done.

More docs

• Using Gassetic with Symfony2
• [Advanced usage: Multiple environments] (https://github.com/ollietb/gassetic/blob/master/Resources/doc/MultipleEnvironments.md)
• Advanced usage: Managing dependencies

@todo:

• better readme

The MIT License (MIT)

Copyright (c) 2014 Roman Schejbal