feat: add secret type to env:add command (#5157)

Author: batosai

commands/env/add.ts

@@ -11,7 +11,7 @@ import { type CommandOptions } from '../../types/ace.ts'
 import stringHelpers from '../../src/helpers/string.ts'
 import { args, BaseCommand, flags } from '../../modules/ace/main.ts'
 
-const ALLOWED_TYPES = ['string', 'boolean', 'number', 'enum'] as const
+const ALLOWED_TYPES = ['string', 'secret', 'boolean', 'number', 'enum'] as const
 type AllowedTypes = (typeof ALLOWED_TYPES)[number]
 
 /**
@@ -23,7 +23,7 @@ type AllowedTypes = (typeof ALLOWED_TYPES)[number]
  * ```
  * ace env:add
  * ace env:add DATABASE_URL postgres://localhost:5432/mydb
- * ace env:add API_KEY secret --type=string
+ * ace env:add API_KEY secret --type=secret
  * ace env:add PORT 3333 --type=number
  * ace env:add DEBUG true --type=boolean
  * ace env:add LOG_LEVEL info --type=enum --enum-values=debug,info,warn,error
@@ -65,7 +65,7 @@ export default class EnvAdd extends BaseCommand {
   declare value: string
 
   /**
-   * Data type of the environment variable (string, boolean, number, enum)
+   * Data type of the environment variable (string, secret, boolean, number, enum)
    */
   @flags.string({ description: 'Type of the variable' })
   declare type: AllowedTypes
@@ -150,6 +150,7 @@ export default class EnvAdd extends BaseCommand {
      */
     const validation = {
       string: 'Env.schema.string()',
+      secret: 'Env.schema.secret()',
       number: 'Env.schema.number()',
       boolean: 'Env.schema.boolean()',
       enum: `Env.schema.enum(['${this.enumValues.join("','")}'] as const)`,

tests/commands/env_add.spec.ts

@@ -34,6 +34,53 @@ test.group('Env Add command', () => {
     await assert.fileContains('./start/env.ts', 'VARIABLE: Env.schema.string()')
   })
 
+  test('add secret env variable using the type flag', async ({ assert, fs }) => {
+    await fs.createJson('tsconfig.json', {})
+    await fs.create('.env', '')
+    await fs.create('.env.example', '')
+    await fs.create(
+      './start/env.ts',
+      `import { Env } from '@adonisjs/core/env'
+      export default await Env.create(new URL('../', import.meta.url), {})`
+    )
+
+    const ace = await new AceFactory().make(fs.baseUrl)
+    await ace.app.init()
+    ace.ui.switchMode('raw')
+
+    const command = await ace.create(EnvAdd, ['api_key', 'my_secret', '--type=secret'])
+    await command.exec()
+
+    await assert.fileContains('.env', 'API_KEY=my_secret')
+    await assert.fileContains('.env.example', 'API_KEY=')
+    await assert.fileNotContains('.env.example', 'my_secret')
+    await assert.fileContains('./start/env.ts', 'API_KEY: Env.schema.secret()')
+  })
+
+  test('select secret type from the prompt', async ({ assert, fs }) => {
+    await fs.createJson('tsconfig.json', {})
+    await fs.create('.env', '')
+    await fs.create('.env.example', '')
+    await fs.create(
+      './start/env.ts',
+      `import { Env } from '@adonisjs/core/env'
+      export default await Env.create(new URL('../', import.meta.url), {})`
+    )
+
+    const ace = await new AceFactory().make(fs.baseUrl)
+    await ace.app.init()
+    ace.ui.switchMode('raw')
+
+    const command = await ace.create(EnvAdd, ['api_key', 'my_secret'])
+    command.prompt.trap('Select the variable type').replyWith('secret')
+    await command.exec()
+
+    await assert.fileContains('.env', 'API_KEY=my_secret')
+    await assert.fileContains('.env.example', 'API_KEY=')
+    await assert.fileNotContains('.env.example', 'my_secret')
+    await assert.fileContains('./start/env.ts', 'API_KEY: Env.schema.secret()')
+  })
+
   test('convert variable to screaming snake case', async ({ assert, fs }) => {
     await fs.createJson('tsconfig.json', {})
     await fs.create('.env', '')