refactor: defineEnvVariables with omitFromExample

adonisjs · Apr 29, 2024 · 9cd7183 · 9cd7183
1 parent 5a1a4e9
commit 9cd7183
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/commands/env/add.ts b/commands/env/add.ts
@@ -100,7 +100,7 @@ export default class EnvAdd extends BaseCommand {
     const transformedName = stringHelpers.snakeCase(this.name).toUpperCase()
     await codemods.defineEnvVariables(
       { [transformedName]: this.value },
-      { withEmptyExampleValue: true }
+      { omitFromExample: [transformedName] }
     )
 
     /**

diff --git a/modules/ace/codemods.ts b/modules/ace/codemods.ts
@@ -101,16 +101,16 @@ export class Codemods extends EventEmitter {
   /**
    * Define one or more environment variables
    */
-  async defineEnvVariables(
-    environmentVariables: Record<string, number | string | boolean>,
-    options?: { withEmptyExampleValue?: boolean }
+  async defineEnvVariables<T extends Record<string, number | string | boolean>>(
+    environmentVariables: T,
+    options?: { omitFromExample?: Array<keyof T> }
   ) {
     const editor = new EnvEditor(this.#app.appRoot)
     await editor.load()
 
     Object.keys(environmentVariables).forEach((key) => {
       const value = environmentVariables[key]
-      editor.add(key, value, options?.withEmptyExampleValue)
+      editor.add(key, value, options?.omitFromExample?.includes(key))
     })
 
     await editor.save()

diff --git a/tests/ace/codemods.spec.ts b/tests/ace/codemods.spec.ts
@@ -78,7 +78,10 @@ test.group('Codemods | environment variables', (group) => {
     await fs.create('.env.example', '')
 
     const codemods = new Codemods(ace.app, ace.ui.logger)
-    await codemods.defineEnvVariables({ SECRET_VALUE: 'secret' }, { withEmptyExampleValue: true })
+    await codemods.defineEnvVariables(
+      { SECRET_VALUE: 'secret' },
+      { omitFromExample: ['SECRET_VALUE'] }
+    )
     await assert.fileContains('.env', 'SECRET_VALUE=secret')
     await assert.fileContains('.env.example', 'SECRET_VALUE=')
   })