Mixing in tasks from ColdBox Modules

ColdBox Modules can be an excellent way to structure your project, and ColdBox Elixir is the perfect companion. Use all the Elixir methods you know and love in your modules, and Elixir will build them all for you with just one command.
1
const elixir = require("coldbox-elixir");
2
​
3
module.exports = elixir(mix => {
4
    mix.modules();
5
});
Copied!
elixir-module.js
To specify what Elixir functions to run a module needs to define an elixir-module.js file. This file looks very similar to your webpack.config.js. Here is an example of one:
1
module.exports = mix => {
2
    mix.sass("app.scss");
3
};
Copied!
The function here is exactly the same function you would write inside the elixir call in your main webpack.config.js file. Every method installed in your main webpack.config.js file is available here.
Elixir will scope the changes to the current module's directory. This means, for example, that:
1
mix.sass("app.scss");
Copied!
Inside of a module with a path /modules_app/my-module/elixir-module.js will look for an app.scss file inside of /modules_app/my-module/resources/assets/sass/app.scss and compile it to /modules_app/my-module/includes/css/app.css.
Includes, Excludes, and File name
You can specify and array of folders to include, folders to exclude, or change the default file name if you wish:
Argument
Default Value
includes
["modules_app"]
excludes
[]
fileName
elixir-module.js
Running a Single Module
You can compile a single module's assets by using mix.module() passing in the module's name:
1
// /gulpfile.js
2
elixir(mix => {
3
    mix.module("my-module");
4
});
Copied!
This will look for the following file: /modules_app/my-module/elixir-module.js and add the resulting mix function to the gulp tasks. If the file does not exist or is not a function, Elixir will show an error and continue on with the other build tasks.
The second parameter is a configuration object to change the folderName or fileName to look for:
1
elixir(mix => {
2
    mix.module("my-module", {
3
        folderName: "new_base_directory",
4
        fileName: "new-filename.js"
5
    });
6
});
Copied!
This would look in /new_base_directory/my-module/new-filename.js for the mix function.
Module alias
If you want use alias for your import in a module, you must use:
1
import store from '@moduleName/store.js'
Copied!
​

Versioning Cache Busting

ContentBox Integration

Last modified 3mo ago

Copy link

Contents

elixir-module.js

Includes, Excludes, and File name

Running a Single Module

Module alias