sneridagh / plonetheme-webpack-plugin

Webpack plugin and presets for bundling themes for Plone 5

Plone Webpack Plugin

plonetheme-webpack-plugin provides a Webpack (1.x) plugin and presets for building completely Webpack managed themes for Plone 5, using the resources shipped with a Plone release.

Please, see plonetheme.webpacktemplate for an example of use.

In short, this package makes it possible to build Plone-themes with Webpack so that all possible frontend resources are managed by Webpack and are built from the package versionis shipped with Plone.

This plugin is still a work in progress and not all available Plone patterns may be supported yet, though, all the default ones should be.

This plugin requires a running Plone site while executing the build (or webpack-dev-server) and does several things, which can be explained best with the following minimal webpack.config.js:

const webpack = require('webpack');
const path = require('path');
const merge = require('webpack-merge');

const PlonePlugin = require('plonetheme-webpack-plugin');

const SITENAME = process.env.SITENAME || 'Plone';
const THEMENAME = process.env.THEMENAME || 'mytheme';

const PATHS = {
  src: path.join(__dirname, 'src', THEMENAME),
  build: path.join(__dirname, 'theme', THEMENAME)
};

const PLONE = new PlonePlugin({
  portalUrl: 'http://localhost:8080/' + SITENAME,
  publicPath: '/' + SITENAME + '/++theme++' + THEMENAME + '/',
  sourcePath: PATHS.src
});

const common = {
  entry: {
   'default': path.join(PATHS.src, 'default'),
   'logged-in': path.join(PATHS.src, 'logged-in')
  },
  output: {
    path: PATHS.build
  },
  devServer: {
    outputPath: PATHS.build
  }
};

switch(path.basename(process.argv[1])) {
  case 'webpack':
    module.exports = merge(PLONE.production, common);
    break;

  case 'webpack-dev-server':
    module.exports = merge(PLONE.development, common, {
      entry: [
        path.join(PATHS.src, 'default'),
        path.join(PATHS.src, 'logged-in')
      ]
    });
    break;
}
console.log(module.exports);

0. This example expects a Plone theme source at ./src/mytheme and it builds a complete theme into ./theme/mytheme.
1. At first, PloneWebpackPlugin is initialized with the address for the running Plone site and other required information.
2. While initializing itself, PloneWebpackPlugin reads RequireJS and LESS configuration from Plone and prepares mergeable Webpack presets into the plugin instance. The presets already include the plugin itself.
3. A common Webpack configuration is defined with the bundles to build. Please, see plonetheme.webpacktemplate for example bundles and example theme mockups (where final bundles get injected).
4. Finally, PloneWebpackPlugin-presets for production and development are merged with the custom configuration (which may also override values in those presets).

Please, see the plugin sources for the preset details.

The plugin includes all the recommended plugins as its dependencies, but the required loaders must be added as dependency for own theme, as in the following package.json example:

{
  "name": "plonetheme.mytheme",
  "version": "0.0.0",
  "devDependencies": {
    "css-loader": "^0.14.5",
    "exports-loader": "^0.6.3",
    "expose-loader": "^0.7.1",
    "fast-sass-loader": "^1.1.0",
    "file-loader": "^0.9.0",
    "imports-loader": "^0.6.5",
    "less": "^2.7.1",
    "less-loader": "^2.2.3",
    "node-sass": "^3.13.0",
    "plonetheme-webpack-plugin": "^0.0.4",
    "style-loader": "^0.13.1",
    "text-loader": "0.0.1",
    "url-loader": "^0.5.7",
    "webpack": "^1.13.1",
    "webpack-dev-server": "^1.14.1",
    "webpack-merge": "^0.14.0"
  },
  "dependencies": {
    "brace": "^0.8.0"
  }
}

Please, note that version 0.14.5 of css-loader is recommended, because of performance issues with the newer versions.