Skip to content

Latest commit

 

History

History
52 lines (29 loc) · 2.32 KB

deploy.md

File metadata and controls

52 lines (29 loc) · 2.32 KB
Raw

Minification and Deployment

Understanding and Using Minification

Enyo comes with a minification tool based on UglifyJS, run by Node.js.

This tool can be used to compress the framework, other libraries, and applications, and will keep load order intact as well as correct url paths in css.

Why compress?

Compressing enyo apps greatly reduces load times of applications, as well as reducing overall code size.

This way, you can be very verbose in the documentation of your source code, without that impacting the performance of your application in production.

What is compressed

For enyo, the libraries, and your code: external assets such as images will not be copied or moved.

Instead, the CSS url paths are fixed up to reference the new path from the build location.

How to compress

To compress your application, you must run the Node.js script named deploy.js that comes with Enyo, as enyo/tools/deploy.js.

$ node enyo/tools/deploy.js -h

This script will run the minification tool located in enyo/tools/minifier/minify.js, and make a build of enyo, then a build of your app.

Any libraries referenced in your package.js manifest will be built into your app's built code.

NOTE: deploy.js expects to find a package.js in the root-folder of your application. It only references your app's package.js to keep paths correct. Do not modify this.

What comes out?

After running the deploy.js script, a new folder build (you change this using the -b flag of the deploy.js script) will be located next to your source directory.

In it will be 4 files:

  • enyo.css
  • enyo.js
  • app.css
  • app.js

These files will be loaded in the given order by index.html.

The output of the deploy scripts will minify your appliaction, and copy the necessary files into deploy/<appname>/.

If the libraries have a compatible deploy.sh or deploy.bat script, they will be executed, and a minimal copy will be placed in the deployment's lib folder.

If no deploy.(sh|bat) script is found for the library, all of the library is copied into the lib folder to provide maximum safety.

If you are adding a library, please add a deploy.sh file and deploy.bat file similar to the ones in lib/onyx.

If no images or files are needed from the library, just include blank (and executable) copies of the deploy scripts.