Minification of the JavaScript files

Last update: 2023-05-03
  • Created for:
  • User
CAUTION

AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

Minification removes from the source code the redundant characters, such as white space, new line, and comments. This improves the performance by reducing the size of the code. While minification does not impact the functionality, it reduces the readability of the code.

To generate minified code for semantic changes follow these steps.

  1. Copy client-html/src/main/webapp/js from src-package on filesystem.

    NOTE

    See Introduction to Customizing AEM Forms workspace for more details about the packages.

  2. Update paths in main.js located under client-html/src/main/webapp/js, for added/updated models/views.

    For example, addition of a new Sharequeue model, say mySharequeue, change:

    sharequeuemodel : pathprefix + 'runtime/models/sharequeue',
    
    To
    
    sharequeuemodel : pathprefix + 'runtime/myModels/mySharequeue',
    
  3. Update registry-config.xml, located at client-html/src/main/webapp/js/resource_generator, in case there is change/addition of alias in main.js.

    For example, addition of a new Sharequeue model, say mySharequeue, change:

    <sharequeue
                name="sharequeue"
                path="runtime/models/sharequeue.js"
                service="service"/>
    
    To
    
    <sharequeue
                name="sharequeue"
                path="runtime/myModels/mySharequeue.js"
                service="service"/>
    
  4. At client-html/src/main/webapp/js/minifier, run command:

    mvn clean install
    

    It generates a folder minified-files, under client-html/src/main/webapp/js with minified main.js and registry.js.

NOTE

Minification will only work on 64-bit JVM.

NOTE

If you minify, upgrade is impacted.

On this page