Initial logic commit

Author: amessinger

README.md

@@ -1,67 +1,114 @@
-# ember-cli-deploy-manifest-json
+# ember-cli-deploy-index-json
 
-> An Ember CLI Deploy plugin to ....... (you could add a tag line for your plugin here)
+> An Ember CLI Deploy plugin to use a JSON index rather than an HTML one as provided by [`ember-cli-deploy-s3-index`](https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index).
 
-[TODO] You could write a short summary of your plugin here
+This JSON index file is meant to be consumed by some application embedding yours.
+
+```
+$ ember deploy production
+$ cat tmp/deploy-dist/index.json
+{
+  "assets/dummy.css": "assets/dummy-d41d8cd98f00b204e9800998ecf8427e.css",
+  "assets/dummy.js": "assets/dummy-f1caa4785f44f7dc0ca9118458c120f8.js",
+  "assets/vendor.js": "assets/vendor-b3a3b580d0c1bf83382792291e35020b.js",
+  "assets/vendor.css": "assets/vendor-d41d8cd98f00b204e9800998ecf8427e.css",
+  "crossdomain.xml": "crossdomain.xml",
+  "robots.txt": "robots.txt"
+}
+```
 
 ## What is an Ember CLI Deploy plugin?
 
 A plugin is an addon that can be executed as a part of the Ember CLI Deploy pipeline. A plugin will implement one or more of the Ember CLI Deploy's pipeline hooks.
 
 For more information on what plugins are and how they work, please refer to the [Plugin Documentation][1].
 
-## Quick Start
+## Setup
+
+- Requirements
+
+You'll first have to [setup `ember-cli-deploy-s3-index`](https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index#quick-start).
 
 - Install this plugin
 
 ```bash
-$ ember install ember-cli-deploy-manifest-json
+$ ember install ember-cli-deploy-index-json
 ```
 
-[TODO] You could add some sensible default config examples needed to quickly run your plugin
+- Configuration
 
-- Run the pipeline
+Edit `config/deploy.js` so that your configuration looks like the snippet below.
 
-```bash
-$ ember deploy
+```js
+s3: {},
+'revision-data': {
+  filePattern: 'index.json',
+  type: 'version-commit'
+},
+'s3-index': {
+  filePattern: 'index.json'
+}
 ```
 
-## Installation
-Run the following command in your terminal:
+*In depth:* The idea is that `revision-data`, `s3-index` and `index-json` have the same `filePattern` value. `index-json` is not present in this example because we're using its default `filePattern` value.
 
-```bash
-ember install ember-cli-deploy-manifest-json
-```
+## Usage
+
+- Deploy version to production environment
+
+`ember deploy production`
+
+- List versions on production environment
+
+`ember deploy:list production`
+
+- Activate a version on the production environment
+
+`ember deploy:activate --revision <revision-key>`
 
 ## Ember CLI Deploy Hooks Implemented
 
 For detailed information on what plugin hooks are and how they work, please refer to the [Plugin Documentation][1].
 
-[TODO] You should add a list of the pipeline hooks that your plugin implements here, for example:
-
-- `configure`
-- `build`
-- `upload`
+- `willUpload`
 
 ## Configuration Options
 
 For detailed information on how configuration of plugins works, please refer to the [Plugin Documentation][1].
 
-[TODO] You should describe the config options your plugin accepts here, for example:
+### filePattern
 
-### someConfigProperty
+Files matching this pattern will be included in the index.
 
-[TODO] Some description of this config property should go here
+*Default:* `'**/*.{js,css,png,gif,ico,jpg,map,xml,txt,svg,swf,eot,ttf,woff,woff2}'`
 
-*Default:* `'some sensible default could go here'`
+### fileIgnorePattern
 
-## Prerequisites
+Files matching this pattern will *not* be included in the index even if they match filePattern.
+
+*Default:* `null`
+
+### indexPath
+
+The JSON index file name. If changed, you should adapt `revision-data` and `s3-index` plugins configs accordingly.
+
+*Default:* `'index.json'`
 
-The following properties are expected to be present on the deployment context object:
+### distDir
 
-[TODO] You should describe which context properties your plugin depends on, for example:
+Directory where assets have been written to
+
+*Default:* the `distDir` property of the deployment context
+
+### distFiles
+
+The Array of built assets.
+
+*Default:* the `distFiles` property of the deployment context
+
+## Prerequisites
 
-- `distDir` (provided by [ember-cli-deploy-build][2])
+No properties are expected to be present on the deployment context object.
 
 ## Tests
 

index.js

@@ -1,11 +1,20 @@
 /*eslint-env node*/
 'use strict';
 
-//const RSVP = require('rsvp');
+const RSVP = require('rsvp');
+const fs = require('fs');
+const path = require('path');
+const minimatch = require('minimatch');
+const jsonfile = require('jsonfile');
 const DeployPluginBase = require('ember-cli-deploy-plugin');
 
+// removes the md5 hash from the filename
+function getOriginalFilename(filename) {
+  return filename.replace(/(-[a-f0-9]{32})(\..+)$/g, '$2');
+}
+
 module.exports = {
-  name: 'ember-cli-deploy-manifest-json',
+  name: 'ember-cli-deploy-index-json',
 
   createDeployPlugin: function(options) {
     let DeployPlugin = DeployPluginBase.extend({
@@ -17,10 +26,17 @@ module.exports = {
        * http://ember-cli-deploy.com/docs/v1.0.x/creating-a-plugin/#validating-plugin-config
        */
 
-      defaultConfig: {
-        meaningOfLife: 42 // Example default config. Remove this.
-      },
-      requiredConfig: ['isInNeedOfSleep'], // Example required config. Remove this;
+       defaultConfig: {
+         filePattern: '**/*.{js,css,png,gif,ico,jpg,map,xml,txt,svg,swf,eot,ttf,woff,woff2}',
+         fileIgnorePattern: null,
+         indexPath: 'index.json',
+         distDir: function(context) {
+           return context.distDir;
+         },
+         distFiles: function(context) {
+           return context.distFiles || [];
+         }
+       },
 
       /*
        * Implement any pipeline hooks here
@@ -39,9 +55,35 @@ module.exports = {
       //  };
       //},
 
-      //willDeploy(context) {
-      //  return RSVP.resolve(); // Return a promise if you'd like the pipeline to wait until the hook has performed some function
-      //},
+      willUpload: function(/* context */) {
+        let filePattern = this.readConfig('filePattern');
+        let distDir = this.readConfig('distDir');
+        let distFiles = this.readConfig('distFiles');
+        let indexPath = this.readConfig('indexPath');
+        let fileIgnorePattern = this.readConfig('fileIgnorePattern');
+
+        this.log('generating manifest at `' + indexPath + '`', { verbose: true });
+        try {
+          let filesToInclude = distFiles.filter(minimatch.filter(filePattern, { matchBase: true }));
+          if (fileIgnorePattern != null) {
+            filesToInclude = filesToInclude.filter(function(path) {
+              return !minimatch(path, fileIgnorePattern, { matchBase: true });
+            });
+          }
+          filesToInclude.sort();
+          let mappedFilesToInclude = {};
+          filesToInclude.forEach((filename)=> {
+            mappedFilesToInclude[getOriginalFilename(filename)] = filename;
+          });
+          let outputPath = path.join(distDir, indexPath);
+          jsonfile.writeFileSync(outputPath, mappedFilesToInclude, { spaces: 2 });
+          this.log('generated manifest including ' + filesToInclude.length + ' files ok', { verbose: true });
+          return { indexPath };
+        } catch (error) {
+          this.log(error, { color: 'red' });
+          return RSVP.reject(error);
+        }
+      }
 
       //willBuild(context) {},
       //build(context) {},