@platformatic/generators 1.37.1 → 1.39.0

package/README.md

@@ -61,7 +61,3 @@ Called from `prepare` function. You have already access to the current `fastify`
 #### `_afterPrepare`
 
 Called at the end of `prepare` function body
-
-#### `_generateEnv`
-
-The `BaseGenerator` will create an empty `.env` file. In this function you can customize and append other values that may be needed. The values in `this.config.env` object will be automatically appended after this method is called.

package/lib/base-generator.d.ts

@@ -94,7 +94,6 @@ export namespace BaseGenerator {
     setEnvVars(env?: Env): void
 
     getDefaultConfig(): { [x: string]: JSONValue }
-    getDefaultEnv(): Env
 
     getFastifyVersion(): Promise<string>
     getPlatformaticVersion(): Promise<string>
@@ -119,8 +118,6 @@ export namespace BaseGenerator {
     _beforePrepare(): Promise<void>
     _afterPrepare(): Promise<void | JSONValue>
     _getConfigFileContents(): Promise<{ [x: string]: BaseGenerator.JSONValue }>
-    _generateEnv(): Promise<void>
-    appendConfigEnv(): Promise<void>
 
     postInstallActions(): Promise<void>
   }

package/lib/base-generator.js

@@ -61,6 +61,7 @@ class BaseGenerator extends FileGenerator {
       serviceName: '',
       envPrefix: '',
       env: {},
+      defaultEnv: {},
       isUpdating: false
     }
   }
@@ -88,10 +89,6 @@ class BaseGenerator extends FileGenerator {
     }
   }
 
-  getDefaultEnv () {
-    return {}
-  }
-
   getEnvVarName (envVarName) {
     const envVarPrefix = 'PLT_' + this.config.envPrefix + '_'
     if (this.config.isRuntimeContext && !envVarName.startsWith(envVarPrefix)) {
@@ -112,10 +109,15 @@ class BaseGenerator extends FileGenerator {
 
   addEnvVar (envVarName, envVarValue, opts = {}) {
     opts.overwrite ??= true
+    opts.default ??= false
+
     envVarName = this.getEnvVarName(envVarName)
     if (opts.overwrite || !this.config.env[envVarName]) {
       this.config.env[envVarName] = envVarValue
     }
+    if ((opts.overwrite || !this.config.defaultEnv[envVarName]) && opts.default) {
+      this.config.defaultEnv[envVarName] = envVarValue
+    }
   }
 
   getEnvVar (envVarName) {
@@ -123,9 +125,10 @@ class BaseGenerator extends FileGenerator {
     return this.config.env[envVarName]
   }
 
-  setEnvVars (envVars) {
+  setEnvVars (envVars, opts) {
     this.config.env = {}
-    this.addEnvVars(envVars)
+    this.config.defaultEnv = {}
+    this.addEnvVars(envVars, opts)
   }
 
   setConfig (config) {
@@ -167,19 +170,6 @@ class BaseGenerator extends FileGenerator {
     }
   }
 
-  /* c8 ignore stop */
-  appendConfigEnv () {
-    const dotEnvFile = this.getFileObject('.env')
-    let dotEnvFileContents = dotEnvFile.contents
-
-    if (this.config.env) {
-      Object.entries(this.config.env).forEach((kv) => {
-        dotEnvFileContents += `${kv[0]}=${kv[1]}\n`
-      })
-      dotEnvFile.contents = dotEnvFileContents
-    }
-  }
-
   async prepare () {
     try {
       this.reset()
@@ -416,20 +406,26 @@ class BaseGenerator extends FileGenerator {
 
   async generateEnv () {
     if (!this.config.isRuntimeContext) {
-      // generate an empty .env file
       this.addFile({
         path: '',
         file: '.env',
-        contents: ''
+        contents: serializeEnvVars(this.config.env)
       })
-      await this._generateEnv()
-      this.appendConfigEnv()
 
-      const { contents } = this.getFileObject('.env')
+      const emptyEnvVars = {}
+      for (const envVarName of Object.keys(this.config.env)) {
+        if (!this.config.defaultEnv[envVarName]) {
+          emptyEnvVars[envVarName] = ''
+        }
+      }
+
       this.addFile({
         path: '',
         file: '.env.sample',
-        contents
+        contents: serializeEnvVars({
+          ...this.config.defaultEnv,
+          ...emptyEnvVars
+        })
       })
     }
   }
@@ -501,7 +497,15 @@ class BaseGenerator extends FileGenerator {
   async _beforePrepare () {}
   async _afterPrepare () {}
   async _getConfigFileContents () { return {} }
-  async _generateEnv () {}
+}
+
+function serializeEnvVars (envVars) {
+  let envVarsString = ''
+  for (const envVarName of Object.keys(envVars)) {
+    const envVarValue = envVars[envVarName]
+    envVarsString += `${envVarName}=${envVarValue}\n`
+  }
+  return envVarsString
 }
 
 module.exports = BaseGenerator

package/lib/create-stackable-files.js

@@ -193,7 +193,7 @@ class ${stackableGeneratorType} extends ServiceGenerator {
 
     this.addEnvVars({
       PLT_GREETING_TEXT: this.config.greeting ?? 'Hello world!'
-    }, { overwrite: false })
+    }, { overwrite: false, default: true })
 
     const packageJson = await this.getStackablePackageJson()
 
@@ -301,7 +301,7 @@ class ${stackableGeneratorType} extends ServiceGenerator {
 
     this.addEnvVars({
       PLT_GREETING_TEXT: this.config.greeting ?? 'Hello world!'
-    }, { overwrite: false })
+    }, { overwrite: false, default: true })
 
     const packageJson = await this.getStackablePackageJson()
 

package/lib/stackable-generator.js

@@ -311,7 +311,6 @@ class StackableGenerator extends FileGenerator {
   async _beforePrepare () {}
   async _afterPrepare () {}
   async _getConfigFileContents () { return {} }
-  async _generateEnv () {}
 }
 
 module.exports = StackableGenerator

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/generators",
-  "version": "1.37.1",
+  "version": "1.39.0",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],

package/test/base-generator.test.js

@@ -95,6 +95,7 @@ test('setConfig', async (t) => {
     staticWorkspaceGitHubActions: false,
     dynamicWorkspaceGitHubActions: false,
     env: {},
+    defaultEnv: {},
     dependencies: {},
     devDependencies: {},
     isRuntimeContext: false,
@@ -123,6 +124,7 @@ test('setConfig', async (t) => {
     staticWorkspaceGitHubActions: false,
     dynamicWorkspaceGitHubActions: false,
     env: {},
+    defaultEnv: {},
     dependencies: {},
     devDependencies: {},
     isRuntimeContext: false,
@@ -143,6 +145,7 @@ test('setConfig', async (t) => {
     staticWorkspaceGitHubActions: false,
     dynamicWorkspaceGitHubActions: false,
     env: {},
+    defaultEnv: {},
     dependencies: {},
     devDependencies: {},
     isRuntimeContext: false,
@@ -171,6 +174,7 @@ test('setConfig', async (t) => {
     staticWorkspaceGitHubActions: false,
     dynamicWorkspaceGitHubActions: false,
     env: {},
+    defaultEnv: {},
     dependencies: {},
     devDependencies: {},
     isRuntimeContext: false,
@@ -197,7 +201,30 @@ test('should append env values', async (t) => {
   assert.equal(dotEnvFile.contents.trim(), 'FOO=bar')
 
   const dotEnvSampleFile = bg.getFileObject('.env.sample')
-  assert.equal(dotEnvSampleFile.contents.trim(), 'FOO=bar')
+  assert.equal(dotEnvSampleFile.contents.trim(), 'FOO=')
+})
+
+test('should add a default env var to the .env.sample config', async (t) => {
+  const bg = new BaseGenerator({
+    module: '@platformatic/service'
+  })
+  // partial config with defaults
+  bg.setConfig({
+    env: {
+      FOO: 'bar'
+    }
+  })
+
+  bg.addEnvVars({
+    BAR: 'baz'
+  }, { overwrite: false, default: true })
+
+  await bg.prepare()
+  const dotEnvFile = bg.getFileObject('.env')
+  assert.equal(dotEnvFile.contents.trim(), 'FOO=bar\nBAR=baz')
+
+  const dotEnvSampleFile = bg.getFileObject('.env.sample')
+  assert.equal(dotEnvSampleFile.contents.trim(), 'BAR=baz\nFOO=')
 })
 
 test('should prepare the questions', async (t) => {