feat: added addEnvironment to ConfigBuilder

godaddy · Jan 13, 2025 · 4e86643 · 4e86643
1 parent ee81693
commit 4e86643
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 1 deletion.
diff --git a/packages/create-gasket-app/lib/index.d.ts b/packages/create-gasket-app/lib/index.d.ts
@@ -136,6 +136,25 @@ export interface ConfigBuilder<Config> {
    */
   addPlugin(pluginImport: string, pluginName: string): void;
 
+  /**
+   * addEnvironment - Add environments to the gasket file and use the value in the plugins array
+   * @param {string} key - name of the environment - `local.analyze`
+   * @param {object} value - configuration for the environment - `{
+   *   dynamicPlugins: [
+   *     '@gasket/plugin-analyze',
+   *   ]
+   * }`
+   * @example
+   *   environments: {
+   *    'local.analyze': {
+   *      dynamicPlugins: [
+   *        '@gasket/plugin-analyze',
+   *      ]
+   *     }
+   *   },
+   */
+  addEnvironment(key:string, value: object): void;
+
   /**
    * addImport - Add a non-plugin import to the gasket file
    * @param {string} importName - name of the import used as a value - `import fs...`

diff --git a/packages/create-gasket-app/lib/scaffold/config-builder.js b/packages/create-gasket-app/lib/scaffold/config-builder.js
@@ -238,6 +238,29 @@ export class ConfigBuilder {
     this.add('pluginImports', { [pluginImport]: pluginName });
   }
 
+  /**
+   * addEnvironment - Add environments to the gasket file and use the value in the plugins array
+   * @param {string} key - name of the environment - `local.analyze`
+   * @param {object} value - configuration for the environment - `{
+   *   dynamicPlugins: [
+   *     '@gasket/plugin-analyze',
+   *   ]
+   * }`
+   * @example
+   *   environments: {
+   *    'local.analyze': {
+   *      dynamicPlugins: [
+   *        '@gasket/plugin-analyze',
+   *      ]
+   *     }
+   *   },
+   */
+  addEnvironment(key, value) {
+    this.add(`environments`, {
+      [key]: value
+    });
+  }
+
   /**
    * addImport - Add a non-plugin import to the gasket file
    * @param {string} importName - name of the import used as a value - `import fs...`

diff --git a/packages/create-gasket-app/lib/scaffold/create-context.js b/packages/create-gasket-app/lib/scaffold/create-context.js
@@ -90,7 +90,7 @@ export function makeCreateContext(argv = [], options = {}) {
   /**
    * Input context which will be appended by prompts and passed to create hooks
    * @type {import('../internal').PartialCreateContext}
-  */
+   */
   const context = new CreateContext({
     destOverride: true,
     cwd,

diff --git a/packages/create-gasket-app/test/unit/scaffold/config-builder.test.js b/packages/create-gasket-app/test/unit/scaffold/config-builder.test.js
@@ -511,4 +511,32 @@ describe('ConfigBuilder', () => {
       expect(warnings).toHaveLength(1);
     });
   });
+
+
+  describe('.addEnvironment', () => {
+    let gasketConfig;
+    beforeEach(() => {
+      gasketConfig = new ConfigBuilder();
+    });
+
+    it('adds an environment to gasketConfig', () => {
+      gasketConfig.addEnvironment('test.env', { test: 'config ' });
+      expect(gasketConfig.fields.environments).toEqual({ 'test.env': { test: 'config ' } });
+    });
+
+    it('adds values to an environment in gasketConfig', () => {
+      gasketConfig.addEnvironment('test.env', { test: 'config ' });
+      gasketConfig.addEnvironment('test.env', { test2: 'config 2' });
+      expect(gasketConfig.fields.environments).toEqual({ 'test.env': { test: 'config ', test2: 'config 2' } });
+    });
+
+    it('adds multiple environments to gasketConfig', () => {
+      gasketConfig.addEnvironment('test.env', { test: 'config ' });
+      gasketConfig.addEnvironment('prod.env', { prod: 'config ' });
+      expect(gasketConfig.fields.environments).toEqual({
+        'test.env': { test: 'config ' },
+        'prod.env': { prod: 'config ' }
+      });
+    });
+  });
 });