ENYO-3012: use packagejs: instead of source: in deploy.json

- the `source:` property of `deploy.json` did not make sense as it was
  always refering  to the  folder where `deploy.json`  is.  it  is now
  replaced by a `packagejs:`  property (default: `"package.js"`) which
  indicates  where   is  the   relative  location  of   the  top-level
  `package.js` from the project root folder.

Enyo-DCO-1.1-Signed-off-by: Francois-Xavier KOWALSKI <[email protected]>

Author: Francois-Xavier KOWALSKI

deploy.json

@@ -1,6 +1,6 @@
 {
-	"enyo": "enyo",
-	"source": ".",
-	"assets": ["icon.png", "index.html", "assets"],
-	"libs": ["lib/onyx", "lib/layout"]
+	"enyo": "./enyo",
+	"packagejs": "./package.js",
+	"assets": ["./icon.png", "./index.html", "./assets"],
+	"libs": ["./lib/onyx", "./lib/layout"]
 }

deploy.md

@@ -19,34 +19,99 @@ Instead, the CSS url paths are fixed up to reference the new path from the build
 
 ### 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`.
+To compress your application, you must run the script named `deploy.js` that comes with Enyo, as `node enyo/tools/deploy.js`.  Bootplate provides 2 wrappers scripts to shorten the minification learning curve.  You can just run:
 
-    $ node enyo/tools/deploy.js -h
+    C:\path\to\bootplate\> cd tools
+    C:\path\to\bootplate\tools> deploy.bat
+
+or (on Mac & Linux):
+
+    $ cd /path/to/bootplate/tools
+    $ bash ./deploy.sh
 
-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.
+This script will run the minification tool located in `enyo/tools/minifier/deploy.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.
+**NOTE:** `deploy.js` expects to find a `deploy.json` manifest in the root-folder of your application. This manifest then defines where are (1) the top-level `package.js`, (2) the location of the Enyo framework within the applicatio source & what are the various libraries & assets.  A typical default `package.json` contains:
+
+```json
+{
+	"enyo": "./enyo",
+	"packagejs": "./package.js",
+	"assets": ["./icon.png", "./index.html", "./assets"],
+	"libs": ["./lib/onyx", "./lib/layout"]
+}
+```
 
 ### 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.
+After running the `deploy.bat|sh` script, two new folders (`build` and `deploy`) will be located next to your `source` directory.
+
+#### Minification test folder - build
+
+```
+build
+├── app.css
+├── app.js
+├── enyo.css
+└── enyo.js
+```
 
-In it will be 4 files:
-- enyo.css
-- enyo.js
-- app.css
-- app.js
+These generated files will be loaded in the given order by `index.html`.
 
-These files will be loaded in the given order by `index.html`.
+#### Deployment folder - deploy
 
-The output of the `deploy` scripts will minify your appliaction, and copy the necessary files into `deploy/<appname>/`.
+The `deploy` folder contains a ready-to-be-shipped minified version of your application, including its declared assets & libraries in addition to the content of the `build folder`.
 
-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 the libraries have a compatible `deploy.json` (use to be `deploy.sh` or `deploy.bat` scripts), they will be used, 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 no `deploy.(json|sh|bat)` script is found for the libraries, all of each library is copied into the `deploy/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 you are adding a library, please add a `deploy.json` file similar to the ones in `lib/onyx` or `lib/layout`.
+
+If no images or files are needed from the library, just include the following (the same as `lib/layout`):
+
+```json
+{
+	"packagejs": "./package.js",
+	"assets": [],
+	"libs": []
+}
+```
+
+**NOTE:** In case you want full control of the minification process (target folders... etc), get familiar with the underlying Node.js script using:
+
+    $ node enyo/tools/deploy.js -h
 
-If no images or files are needed from the library, just include blank (and executable) copies of the deploy scripts.
+**NOTE:** For reference, the minification of an un-modified `bootplate` results in the following `deploy/` tree:
+
+```
+deploy
+├── assets
+│   └── favicon.ico
+├── build
+│   ├── app.css
+│   ├── app.js
+│   ├── enyo.css
+│   └── enyo.js
+├── icon.png
+├── index.html
+└── lib
+    └── onyx
+        ├── LICENSE-2.0.txt
+        └── images
+            ├── checkbox.png
+            ├── close-active.png
+            ├── close-inactive.png
+            ├── grabbutton.png
+            ├── gradient-invert.png
+            ├── gradient.png
+            ├── more.png
+            ├── progress-button-cancel.png
+            ├── search-input-cancel.png
+            ├── search-input-search.png
+            ├── slider-handle.png
+            ├── spinner-dark.gif
+            └── spinner-light.gif
+```