Blog

Luis Majano

June 07, 2016

Spread the word


Share your thoughts

 

We are very excited today to formally announce the availability of ColdBox Elixir, coldbox/elixir. ColdBox Elixir provides a clean, fluent API for defining basic Gulp tasks for your ColdBox applications.

 

This project was forked from the Laravel Elixir project, so many many thanks for all their hard work and ideas.

 

Overview

We wanted to provide ColdBox developers and easy way to approach an asset pipeline and task executor. The elixir project accomplished this and we have extended it to match the conventions used in ColdBox but also took it a step further to make it compatible with TestBox and CommandBox. This way you can have a full task runner available to you than can integrate with CommandBox recipes, package management, command execution and also TestBox executions.

How it works

Elixir supports several common CSS, JavaScript pre-processors, and TestBox runner integrations. By leveraging Gulp and a Gulpfile.js configuration file in the root of your application, you can use method chaining and Elixir will allow you to fluently define your asset pipeline using conventions.

Conventions

All resources in your ColdBox application will be stored under the resources/assets folder. Under this folder you can find several sub-sections:

  • css - Where you can store your css
  • js - Where you can store your js, vue.js and more
  • less - Where you can store your less files
  • sass - Where you can store your sass files

Depending on the formulas you mix up in the Gulpfile.js using Elixir, you will end up with all your assets linted, minified, etc in their appropriate destination in the includes folder:

  • css - Destination for css
  • js - Destination for js
  • build - Destination for versioned assets

For example:

var elixir = require( 'coldbox-elixir' );
elixir( function( mix ) {
	// Look in the 'resources/sass' folder
    mix.sass( 'app.scss' )
    	// Look in the 'resourcess/css` folder
       .styles( 'modules.css' );
       
   // Elixir will then output all assets to ColdBox 'includes' folder by convention.
});

Fully Documented

We are serious about our software, but we are also serious about our documentation. As with any product we do at Ortus, it is fully documented and a gitbook has been created: ColdBox Elixir Documentation

ColdBox Application Templates

We have created a new Github organization: coldbox-templates https://github.com/coldbox-templates to host all the new ColdBox application templates. You can also collaborate and create new ones if desired. All application templates will now include the ability to use elixir. Here are the links to those:

Manual Installation

ColdBox Elixir is a node package and can be installed by a simple command on any project: npm install coldbox-elixir. You can then create your Gulpfile.js and start mixing your assets.

Extensibility

ColdBox Elixir is fully customizable and extensible. Please check out the documentation for further information on extensibility: http://coldbox-elixir.ortusbooks.com/writing_elixir_extensions.html

Add Your Comment

Recent Entries

ColdBox Mail Services 2.0 - Fluent Mail For All

ColdBox Mail Services 2.0 - Fluent Mail For All

We are so excited to bring you a major release of our cbmailservices module. This module has been around since our initial versions of ColdBox and it has now matured into a modern and fluent library for sending mail.

Luis Majano
Luis Majano
November 08, 2021
FORGEBOX 6 has landed!

FORGEBOX 6 has landed!

After several months of work, we are proud to announce the release of FORGEBOX 6. This has been a major undertaking spawning several months worth of work, a complete UI revamp for registered users, many bug fixes, multi-key API, and much more. We have also introduced our new Business Accounts with the ability for organizations to have a simple and human way of managing their final package releases and their teams.

Javier Quintero
Javier Quintero
October 26, 2021
CommandBox 5.4.2 Released!

CommandBox 5.4.2 Released!

There is a new update for CommandBox CLI available.  Version 5.4.2 is a patch update that contains a few bug fixes including two important ones. 

  • There is a fix for a regression introduced in 5.4.0 where updating the version of a CF engine doesn't work without forgetting the server first. 
  • There is also an important security impro...

Brad Wood
Brad Wood
October 07, 2021