Initial commit

Author: lukemelia

.gitignore

@@ -0,0 +1 @@
+node_modules/

README.md

@@ -0,0 +1,60 @@
+# ember-cli-deploy-plugin
+
+This NPM module exposes a base class that can be used by ember-cli-deploy plugins to streamline
+implementation of a plugin.
+
+## Usage
+
+In your plugin's directory:
+
+`npm install ember-cli-deploy-plugin --save`
+
+In your plugin's `index.js` file:
+
+```js
+/* jshint node: true */
+'use strict';
+
+var DeployPluginBase = require('ember-cli-deploy-plugin');
+
+module.exports = {
+  name: 'ember-cli-deploy-awesomeness',
+
+  createDeployPlugin: function(options) {
+    var DeployPlugin = DeployPluginBase.extend({
+      name: options.name,
+
+      // note: most plugins can simply implement these next two properties and use
+      // the base class' implementation of the `configure` hook
+      defaultConfig: {
+        someKey: 'defaultValue',
+        anotherKey: function(context) {
+          return context.anotherKey; // to use data added to the context by another plugin
+        }
+      },
+      requiredConfig: ['awesomeApiKey'], // throw an error if this is not configured
+
+      // implement any hooks appropriate for your plugin
+      willUpload: function(context) {
+        // Use the `readConfig` method for uniform access to this plugin's config,
+        // whether via a dynamic function or a configured value
+        var someValue     = this.readConfig('someKey');
+        var anotherValue  = this.readConfig('anotherKey');
+        var awesomeApiKey = this.readConfig('awesomeApiKey');
+
+        // Use the `log` method to generate output consistent with the tree style
+        // of ember-cli-deploy
+        this.log('unleashing awesomeness');
+
+        // Need to do something async? You can return a promise.
+        // Need to fail out? Throw an error or return a promise which becomes rejected
+        return Promise.resolve();
+      },
+    });
+    return new DeployPlugin();
+  }
+};
+
+## TODO
+
+Tests

index.js

@@ -0,0 +1,54 @@
+var CoreObject     = require('core-object');
+var chalk = require('chalk');
+var blue  = chalk.blue;
+
+var DeployPluginBase = CoreObject.extend({
+  context: null,
+  ui: null,
+  project: null,
+  pluginConfig: null,
+  defaultConfig: {},
+  configure: function(context) {
+    this.log('validating config');
+    var defaultProps = Object.keys(this.defaultConfig || {});
+    defaultProps.forEach(this.applyDefaultConfigProperty.bind(this));
+    var requiredProps = this.requiredConfig || [];
+    requiredProps.forEach(this.ensureConfigPropertySet.bind(this));
+    this.log('config ok');
+  },
+  applyDefaultConfigProperty: function(propertyName){
+    if (!this.pluginConfig[propertyName]) {
+      var value = this.defaultConfig[propertyName];
+      this.pluginConfig[propertyName] = value;
+      var description = value;
+      if (typeof description === "function") {
+        description = "[Function]";
+      }
+      this.log('Missing config: `' + propertyName + '`, using default: `' + description + '`', { color: 'yellow' });
+    }
+  },
+  ensureConfigPropertySet: function(propertyName){
+    if (!this.pluginConfig[propertyName]) {
+      var message = 'Missing required config: `' + propertyName + '`';
+      this.log(message, { color: 'red' });
+      throw new Error(message);
+    }
+  },
+  readConfig: function(property){
+    var configuredValue = this.pluginConfig[property];
+    if (typeof configuredValue === 'function') {
+      return configuredValue(this.context);
+    }
+    return configuredValue;
+  },
+  log: function(message, opts) {
+    opts = opts || { color: 'blue' }
+    opts['color'] = opts['color'] || 'blue';
+
+    this.ui.write(blue('|    '));
+    var chalkColor = chalk[opts.color];
+    this.ui.writeLine(chalkColor('- ' + message));
+  }
+});
+
+module.exports = DeployPluginBase;

package.json

@@ -0,0 +1,17 @@
+{
+  "name": "ember-cli-deploy-plugin",
+  "version": "0.1.0",
+  "description": "For building plugins for ember-cli-deploy",
+  "repository": "https://github.com/lukemelia/ember-cli-deploy-plugin",
+  "engines": {
+    "node": ">= 0.10.0"
+  },
+  "author": "Luke Melia",
+  "license": "MIT",
+  "devDependencies": {
+  },
+  "dependencies": {
+    "chalk": "^1.0.0",
+    "core-object": "0.0.2"
+  }
+}