Allow to provide a default value for plugin options

serverless · Jun 18, 2017 · da9d7c2 · da9d7c2
1 parent 6a9e996
commit da9d7c2
Show file tree

Hide file tree

Showing 3 changed files with 4,049 additions and 0 deletions.
diff --git a/lib/classes/PluginManager.js b/lib/classes/PluginManager.js
@@ -241,6 +241,7 @@ class PluginManager {
     const command = this.getCommand(commandsArray, allowEntryPoints);
 
     this.convertShortcutsIntoOptions(command);
+    this.assignDefaultOptions(command);
     this.validateOptions(command);
 
     const events = this.getEvents(command);
@@ -352,6 +353,13 @@ class PluginManager {
     });
   }
 
+  assignDefaultOptions(command) {
+    _.forEach(command.options, (value, key) => {
+      if (value.default && (!this.cliOptions[key] || this.cliOptions[key] === true)) {
+        this.cliOptions[key] = value.default;
+      }
+    });
+  }
 }
 
 module.exports = PluginManager;
diff --git a/lib/classes/PluginManager.test.js b/lib/classes/PluginManager.test.js
@@ -888,6 +888,45 @@ describe('PluginManager', () => {
     });
   });
 
+  describe('#assignDefaultOptions()', () => {
+    it('should assign default values to empty options', () => {
+      pluginManager.commands = {
+        foo: {
+          options: {
+            bar: {
+              required: true,
+              default: 'foo',
+            },
+          },
+        },
+      };
+
+      const foo = pluginManager.commands.foo;
+      pluginManager.assignDefaultOptions(foo);
+
+      expect(pluginManager.cliOptions.bar).to.equal(foo.options.bar.default);
+    });
+
+    it('should not assign default values to non-empty options', () => {
+      pluginManager.commands = {
+        foo: {
+          options: {
+            bar: {
+              required: true,
+              default: 'foo',
+            },
+          },
+        },
+      };
+
+      const foo = pluginManager.commands.foo;
+      pluginManager.setCliOptions({ bar: 100 });
+      pluginManager.assignDefaultOptions(foo);
+
+      expect(pluginManager.cliOptions.bar).to.equal(100);
+    });
+  });
+
   describe('#validateOptions()', () => {
     it('should throw an error if a required option is not set', () => {
       pluginManager.commands = {