https://github.com/coldbox-elixir/extension-webpack

ColdBox Elixir Webpack Extension
https://github.com/coldbox-elixir/extension-webpack

build-tool cfml coldbox coldbox-elixir webpack

Last synced: 4 months ago
JSON representation

ColdBox Elixir Webpack Extension

• Host: GitHub
• URL: https://github.com/coldbox-elixir/extension-webpack
• Owner: coldbox-elixir
• Fork: true (JeffreyWay/laravel-elixir-webpack-official)
• Created: 2016-09-27T17:11:33.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-08-11T01:40:13.000Z (over 7 years ago)
• Last Synced: 2024-09-25T08:33:06.289Z (4 months ago)
• Topics: build-tool, cfml, coldbox, coldbox-elixir, webpack
• Language: JavaScript
• Homepage:
• Size: 78.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# ColdBox Elixir Webpack Integration

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

### Step 1: Install

```js

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](https://babeljs.io/docs/learn-es2015/) 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:

```javascript

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.

```javascript

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](https://webpack.github.io/docs/configuration.html) 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:

```js

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](https://ortussolutions.atlassian.net/projects/ELIXIR/summary).  Please log all bugs, improvements, and features there.

Pull requests are welcome and encouraged.  Please [check on the Jira page](https://ortussolutions.atlassian.net/projects/ELIXIR/issues/ELIXIR-2?filter=allissues) before starting any large amount of work so your time isn't wasted.

Brad Wood (@bdw429s) has a [great guide on submitting pull requests.](https://www.ortussolutions.com/blog/submit-your-first-pull-request-to-an-open-source-project)  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](http://cfml-slack.herokuapp.com/).