plonetheme-webpack-plugin

Plone Webpack Plugin

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

While this plugin can be used to build any kind of bundles with webpack, due to the lack of documentation, this best used with plonetheme.webpacktemplate.

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 versions shipped with Plone.

This plugin requires a running Plone site while executing the initial build (or webpack-dev-server) and does several things, which can be explained best with the following minimal webpack.config.js. After the initial build, the plugin can rely on its cache persisted at ./plone of the current working directory.

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 PUBLICPATH = process.env.PUBLICPATH || '/' + SITENAME + '/++theme++' + THEMENAME + '/';
 
const PATHS = {
  src: path.join(__dirname, 'src', THEMENAME),
  build: path.join(__dirname, 'theme', THEMENAME)
};
 
const PLONE = new PlonePlugin({
  portalUrl: 'http://localhost:8080/' + SITENAME,
  publicPath: PUBLICPATH,
  sourcePath: PATHS.src,
  momentLocales: ['ca', 'fi'],
  debug: false
});
 
const common = {
  entry: {
   'default': path.join(PATHS.src, 'default'),
  },
  output: {
    path: PATHS.build
  },
  resolve: {
    extensions: ['.js', '.json'],
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        use: [
          {
            loader: 'babel-loader',
            options: {
              cacheDirectory: true,
            }
          }
        ],
        include: PATHS.src
      }
    ]
  }
};
 
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')
      ]
    });
    break;
}
 
if (PLONE.config.debug) {
  console.log(module.exports);
}

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

See the plugin sources for the preset details.

Versions in 0.x series of this plugin were compatible with Webpack 1.x. Versions in 1.x series of this plugin were compatible with Webpack 2.x.