Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 2.69 KB

readme.md

File metadata and controls

61 lines (43 loc) · 2.69 KB
Raw

ColdBox Elixir Webpack Integration

This extension brings Webpack support to ColdBox Elixir, version 2 and up.

Step 1: Install

npm install coldbox-elixir-webpack --save-dev

Step 2: Usage

Similar to Browserify, the webpack method may be used to compile and bundle ECMAScript 2015 into plain JavaScript. This function accepts a file, relative to the resources/assets/js directory, and generates a single bundled file in the includes/js directory:

elixir( function( mix ) {
    mix.webpack( "app.js" );
} );

To choose a different output or base directory, simply specify your desired paths as the second and third arguments, respectively.

elixir( function( mix ) {
    mix.webpack( "app.js", "public/dist", "app/assets/js" );
} );

This will compile app/assets/js/app.js to public/dist/app.js.

If you'd like to leverage more of Webpack's functionality, Elixir will read any webpack.config.js file in your project root, and factor its configuration into the build process. Alternatively, you may pass your Webpack-specific configuration as the fourth argument to mix.webpack().

Step 3: Plugins

If you've created a plugin, and need to hook your own Webpack config into Elixir's defaults, add the following to your script:

Elixir.webpack.mergeConfig( {
    babel: {
        presets: [ "es2015" ],
        plugins: [ "transform-runtime" ],
    },
    module: {
        loaders: [ {
            test: /\.vue$/,
            loader: "vue"
        } ]
    }
} );

Elixir.webpack.mergeConfig(newConfig) will recursively merge your provided configuration with ours. It also properly merges any nested arrays, so as not to override important default configuration. For example, in the code snippet above, the addition of the Vue loader will not overwrite the default loaders that we provide.

Contributions and Bugs

Project tracking for this project can be found at the Ortus Solutions Jira. Please log all bugs, improvements, and features there.

Pull requests are welcome and encouraged. Please check on the Jira page before starting any large amount of work so your time isn't wasted.

Brad Wood (@bdw429s) has a great guide on submitting pull requests. If you are unsure where to go, in need of help, or have a question, come ask in the #box-products channel on the CFML Slack.