Registry / devops / aem-sync-webpack-plugin

aem-sync-webpack-plugin

JSON →
library0.1.3jsnpmunverified

Webpack plugin that integrates with AEMSync to automatically upload files to Adobe Experience Manager (AEM) after manual changes or webpack build completion. Version 0.1.3 is the latest stable release, with no active development since 2016. It is a thin wrapper around the aemsync library and requires AEMSync to be installed separately. The plugin only triggers in webpack watch mode, making it ideal for local development workflows. Compared to other AEM upload plugins, it leverages the efficient aemsync delta-based sync mechanism.

npm install aem-sync-webpack-plugin
INSTALL
IMPORT
SIG · AEM-SYNC-WEBPACK-P
A
aem-sync-webpack-plugin
devopsjavascriptv0.1.3
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.

AemSyncPlugin
const AemSyncPlugin = require('aem-sync-webpack-plugin');
import AemSyncPlugin from 'aem-sync-webpack-plugin';
Plugin is CJS-only; ESM import is not supported.
AemSyncPlugin
plugins: [new AemSyncPlugin({...})]
plugins: [AemSyncPlugin({...})]
Must use the 'new' keyword to instantiate the plugin.
options.targets
targets: ['http://admin:admin@localhost:4502']
targets: 'http://admin:admin@localhost:4502'
Targets must be an array of strings, even if only one target.

Configures the AemSyncPlugin in webpack.config.js to upload files to AEM on changes when running webpack --watch.

// webpack.config.js const AemSyncPlugin = require('aem-sync-webpack-plugin'); module.exports = { // ...webpack config plugins: [ new AemSyncPlugin({ targets: [ 'http://admin:admin@localhost:4502' ], watchDir: './dist', exclude: '**/node_modules/**', pushInterval: 1000 }) ] }; // Run: webpack --watch
Debug
Known issues
gotchaPlugin only works in webpack watch mode; does nothing during a regular build (webpack without --watch).
fix
Ensure webpack is run with the --watch flag, e.g., webpack --watch.
affects: all
gotchaTarget URLs must include credentials (e.g., admin:admin) otherwise authentication fails silently.
fix
Include credentials in the target URL: http://username:password@host:port.
affects: all
gotchaThe exclude glob pattern is applied relative to watchDir; incorrect patterns may cause node_modules to be uploaded.
fix
Set exclude to a glob pattern like '**/node_modules/**' to exclude node_modules from sync.
affects: all
breakingThe aemsync library must be installed separately; it is not a dependency of this plugin.
fix
Run npm install aemsync --save-dev to ensure aemsync is available.
affects: all
Errors
Common errors & fixes
Cannot find module 'aemsync'
aemsync is not installed or not in node_modules.
fix
Install aemsync: npm install aemsync --save-dev
TypeError: targets is not iterable
targets option is not an array.
fix
Ensure targets is an array, e.g., targets: ['http://admin:admin@localhost:4502']
AemSyncPlugin is not a constructor
Missing 'new' keyword when instantiating the plugin.
fix
Use 'new AemSyncPlugin({...})' instead of 'AemSyncPlugin({...})'
Upgrade
Version history
0.1.3latest on npm
Audit
Dependencies
aemsyncrequiredCore dependency for syncing files to AEM; the plugin relies on aemsync's API.
Agent activity
44 hits · last 30 days
node
40
OpenAI (training)
1
Resources
aem-sync-webpack-plugin — npm install aem-sync-webpack-plugin · libregistry