feat: insert empty example in the .env.example

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

Hide file tree

Showing 5 changed files with 32 additions and 10 deletions.
diff --git a/commands/env/add.ts b/commands/env/add.ts
@@ -8,8 +8,8 @@
  */
 
 import { CommandOptions } from '../../types/ace.js'
-import { args, BaseCommand, flags } from '../../modules/ace/main.js'
 import stringHelpers from '../../src/helpers/string.js'
+import { args, BaseCommand, flags } from '../../modules/ace/main.js'
 
 const ALLOWED_TYPES = ['string', 'boolean', 'number', 'enum'] as const
 type AllowedTypes = (typeof ALLOWED_TYPES)[number]
@@ -98,8 +98,10 @@ export default class EnvAdd extends BaseCommand {
      */
     const codemods = await this.createCodemods()
     const transformedName = stringHelpers.snakeCase(this.name).toUpperCase()
-
-    await codemods.defineEnvVariables({ [transformedName]: this.value })
+    await codemods.defineEnvVariables(
+      { [transformedName]: this.value },
+      { withEmptyExampleValue: true }
+    )
 
     /**
      * Add the environment variable to the `start/env.ts` file

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

diff --git a/package.json b/package.json
@@ -123,7 +123,7 @@
     "@adonisjs/bodyparser": "^10.0.2",
     "@adonisjs/config": "^5.0.2",
     "@adonisjs/encryption": "^6.0.2",
-    "@adonisjs/env": "^6.0.1",
+    "@adonisjs/env": "^6.1.0",
     "@adonisjs/events": "^9.0.2",
     "@adonisjs/fold": "^10.1.2",
     "@adonisjs/hash": "^9.0.3",

diff --git a/tests/ace/codemods.spec.ts b/tests/ace/codemods.spec.ts
@@ -66,6 +66,23 @@ test.group('Codemods | environment variables', (group) => {
     await assert.fileContains('.env', 'CORS_ENABLED=true')
   })
 
+  test('do not insert env value in .env.example if specified', async ({ assert, fs }) => {
+    const ace = await new AceFactory().make(fs.baseUrl)
+    await ace.app.init()
+    ace.ui.switchMode('raw')
+
+    /**
+     * Creating .env file so that we can update it.
+     */
+    await fs.create('.env', '')
+    await fs.create('.env.example', '')
+
+    const codemods = new Codemods(ace.app, ace.ui.logger)
+    await codemods.defineEnvVariables({ SECRET_VALUE: 'secret' }, { withEmptyExampleValue: true })
+    await assert.fileContains('.env', 'SECRET_VALUE=secret')
+    await assert.fileContains('.env.example', 'SECRET_VALUE=')
+  })
+
   test('do not define env variables when file does not exists', async ({ assert, fs }) => {
     const ace = await new AceFactory().make(fs.baseUrl)
     await ace.app.init()

diff --git a/tests/commands/env_add.spec.ts b/tests/commands/env_add.spec.ts
@@ -30,7 +30,7 @@ test.group('Env Add command', () => {
     await command.exec()
 
     await assert.fileContains('.env', 'VARIABLE=value')
-    await assert.fileContains('.env.example', 'VARIABLE=value')
+    await assert.fileContains('.env.example', 'VARIABLE=')
     await assert.fileContains('./start/env.ts', 'VARIABLE: Env.schema.string()')
   })
 
@@ -52,7 +52,7 @@ test.group('Env Add command', () => {
     await command.exec()
 
     await assert.fileContains('.env', 'STRIPE_API_KEY=value')
-    await assert.fileContains('.env.example', 'STRIPE_API_KEY=value')
+    await assert.fileContains('.env.example', 'STRIPE_API_KEY=')
     await assert.fileContains('./start/env.ts', 'STRIPE_API_KEY: Env.schema.string()')
   })
 
@@ -80,7 +80,7 @@ test.group('Env Add command', () => {
     await command.exec()
 
     await assert.fileContains('.env', 'VARIABLE=bar')
-    await assert.fileContains('.env.example', 'VARIABLE=bar')
+    await assert.fileContains('.env.example', 'VARIABLE=')
     await assert.fileContains(
       './start/env.ts',
       "VARIABLE: Env.schema.enum(['foo', 'bar'] as const)"
@@ -110,7 +110,7 @@ test.group('Env Add command', () => {
     await command.exec()
 
     await assert.fileContains('.env', 'MY_VARIABLE_NAME=my_value')
-    await assert.fileContains('.env.example', 'MY_VARIABLE_NAME=my_value')
+    await assert.fileContains('.env.example', 'MY_VARIABLE_NAME=')
     await assert.fileContains('./start/env.ts', 'MY_VARIABLE_NAME: Env.schema.string()')
   })
 })