Registry / web-framework / aem-clientlib-generator-webpack-plugin

aem-clientlib-generator-webpack-plugin

JSON →
library1.0.0jsnpmunverified

Webpack plugin that integrates aem-clientlib-generator into your webpack build pipeline. It allows generation of AEM Client Libraries (clientlibs) from a single frontend source, supporting dependencies, embeds, and all clientlib properties via a configuration file (clientlib.config.js) or inline options. Version 1.0.0 is stable with moderate release cadence. Key differentiator: seamlessly combines the power of aem-clientlib-generator with webpack's compilation and asset processing, eliminating the need for separate build steps.

npm install aem-clientlib-generator-webpack-plugin
INSTALL
IMPORT
SIG · AEM-CLIENTLIB-GENE
A
aem-clientlib-generator-webpack-plugin
web-frameworkjavascriptv1.0.0
Install
Import
Disk
Pass rate
0/ 6
Env Coverage0 / 6
glibc
1822
musl
1822
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18226 runs
build_error
glibc
node 18226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

AemClientlibGeneratorPlugin
const AemClientlibGeneratorPlugin = require('aem-clientlib-generator-webpack-plugin');
import AemClientlibGeneratorPlugin from 'aem-clientlib-generator-webpack-plugin';
CommonJS only, as it's a webpack plugin; ESM import may fail due to lack of default export.
AemClientlibGeneratorPlugin (default import)
import AemClientlibGeneratorPlugin from 'aem-clientlib-generator-webpack-plugin';
import { AemClientlibGeneratorPlugin } from 'aem-clientlib-generator-webpack-plugin';
Package uses module.exports, so default import works in ESM, but named import does not.
Plugin options
new AemClientlibGeneratorPlugin({ /* options */ })
new AemClientlibGeneratorPlugin() // without config and no clientlib.config.js found
If called with no arguments, it requires a clientlib.config.js file in the project root.

Shows basic webpack configuration with the plugin, including client library definition with assets, dependencies, and serialization.

// webpack.config.js const AemClientlibGeneratorPlugin = require('aem-clientlib-generator-webpack-plugin'); const path = require('path'); module.exports = { entry: './src/index.js', output: { path: path.resolve(__dirname, 'dist'), filename: 'bundle.js' }, plugins: [ new AemClientlibGeneratorPlugin({ // Options same as aem-clientlib-generator basePath: 'dist', clientLibRoot: path.resolve(__dirname, 'aem-clientlib'), libs: { name: 'mylib', categories: ['mycategory'], dependencies: ['jquery'], jsProcessor: ['min:gcc'], serialization: 'xml', assets: { js: ['bundle.js'] } } }) ] };
Debug
Known issues
gotchaPlugin requires aem-clientlib-generator to be installed as a dependency.
fix
npm install aem-clientlib-generator
affects: >=1.0.0
gotchaIf no options passed, plugin looks for clientlib.config.js in the project root. If missing, it throws an error.
fix
Provide options directly or create clientlib.config.js
affects: >=1.0.0
gotchaAll options must be compatible with aem-clientlib-generator's schema. Mistyped option names cause silent failures.
fix
Double-check the option names against aem-clientlib-generator documentation.
affects: >=1.0.0
Errors
Common errors & fixes
Module not found: Can't resolve 'aem-clientlib-generator'
Missing peer dependency aem-clientlib-generator
fix
npm install aem-clientlib-generator --save-dev
TypeError: AemClientlibGeneratorPlugin is not a constructor
Incorrect import: using named import instead of default import in ES module context
fix
Use 'const AemClientlibGeneratorPlugin = require('aem-clientlib-generator-webpack-plugin');' or 'import AemClientlibGeneratorPlugin from ...'
Error: Cannot find module 'clientlib.config.js'
No clientlib.config.js found in project root and no options provided
fix
Create clientlib.config.js in project root or pass options object to the plugin.
Upgrade
Version history
1.0.0latest on npm
Audit
Dependencies
aem-clientlib-generatorrequiredCore library for generating AEM Client Libraries
Agent activity
49 hits · last 30 days
node
40
OpenAI (training)
3
Resources
aem-clientlib-generator-webpack-plugin — npm install aem-clientlib-generator-webpack-plugin · libregistry