@platformatic/generators 1.13.5 → 1.13.6

package/lib/base-generator.js

@@ -359,6 +359,7 @@ class BaseGenerator extends FileGenerator {
 
   addPackage (pkg) {
     this.packages.push(pkg)
+    this.config.dependencies[pkg.name] = 'latest'
   }
 
   // implement in the subclass

package/lib/utils.d.ts

@@ -13,6 +13,7 @@ export namespace GeneratorUtils {
   export function stripVersion(version: string): string
   export function convertServiceNameToPrefix(serviceName: string): string
   export function addPrefixToEnv(env: Env, prefix: string): Env
+  export function addPrefixToEnv(input: string, prefix: string): string
   export function envObjectToString(env: Env): string
   export function extractEnvVariablesFromText(text: string): string[]
   export function getPackageConfigurationObject(config: PackageConfiguration[]): object

package/lib/utils.js

@@ -29,11 +29,30 @@ function convertServiceNameToPrefix (serviceName) {
   return serviceName.replace(/-/g, '_').toUpperCase()
 }
 
+function addPrefixToString (input, prefix) {
+  if (!prefix) {
+    return input
+  }
+  const prefixRegExp = new RegExp(`^PLT_${prefix}_`)
+  if (!input.match(prefixRegExp)) {
+    // strip PLT_ if needed
+    input = input.replace(/^PLT_/, '')
+    return [`PLT_${prefix}_${input}`]
+  } else {
+    return input
+  }
+}
 function addPrefixToEnv (env, prefix) {
   const newEnv = {}
+  if (!prefix) {
+    // return original env
+    return env
+  }
   const prefixRegExp = new RegExp(`^PLT_${prefix}_`)
   Object.entries(env).forEach((kv) => {
     if (!kv[0].match(prefixRegExp)) {
+      // strip PLT_ if needed
+      kv[0] = kv[0].replace(/^PLT_/, '')
       newEnv[`PLT_${prefix}_${kv[0]}`] = kv[1]
     } else {
       newEnv[kv[0]] = kv[1]
@@ -59,27 +78,38 @@ function extractEnvVariablesFromText (text) {
   }
   return []
 }
-function getPackageConfigurationObject (config) {
-  const output = {}
-  let current = output
+function getPackageConfigurationObject (config, serviceName = '') {
+  const output = {
+    config: {},
+    env: {}
+  }
+  let current = output.config
   for (const param of config) {
     const props = param.path.split('.')
     props.forEach((prop, idx) => {
       if (idx === props.length - 1) {
+        let value
         switch (param.type) {
           case 'string' :
-            current[prop] = param.value.toString()
+            value = param.value.toString()
             break
           case 'number':
-            current[prop] = parseInt(param.value)
+            value = parseInt(param.value)
             break
           case 'boolean':
-            current[prop] = (param.value === 'true')
+            value = (param.value === 'true')
             break
           default:
             throw new WrongTypeError(param.type)
         }
-        current = output
+        if (!param.name) {
+          current[prop] = value
+        } else {
+          const key = addPrefixToString(param.name, convertServiceNameToPrefix(serviceName))
+          current[prop] = `{${key}}`
+          output.env[key] = value
+        }
+        current = output.config
       } else {
         if (!current[prop]) {
           current[prop] = {}
@@ -92,6 +122,7 @@ function getPackageConfigurationObject (config) {
 }
 module.exports = {
   addPrefixToEnv,
+  addPrefixToString,
   convertServiceNameToPrefix,
   getPackageConfigurationObject,
   envObjectToString,

package/package.json

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

package/test/utils.test.js

@@ -2,7 +2,7 @@
 
 const { test, describe } = require('node:test')
 const assert = require('node:assert')
-const { stripVersion, convertServiceNameToPrefix, addPrefixToEnv, envObjectToString, extractEnvVariablesFromText, getPackageConfigurationObject } = require('../lib/utils')
+const { stripVersion, convertServiceNameToPrefix, addPrefixToEnv, envObjectToString, extractEnvVariablesFromText, getPackageConfigurationObject, addPrefixToString } = require('../lib/utils')
 
 describe('utils', () => {
   describe('stripVersion', async () => {
@@ -34,18 +34,38 @@ describe('utils', () => {
   })
 
   describe('addPrefixToEnv', () => {
-    test('Should convert env and add prefix, if neede', async (t) => {
-      const testEnv = {
-        FOO: 'bar',
-        PLT_MY_SERVICE_NAME: 'service',
-        DATABASE_URL: 'foobar'
+    test('Should convert env and add prefix, if needed', async (t) => {
+      {
+        const testEnv = {
+          FOO: 'bar',
+          PLT_MY_SERVICE_NAME: 'service',
+          DATABASE_URL: 'foobar',
+          PLT_ANOTHER_VALUE: 'anotherValue'
+        }
+
+        assert.deepEqual(addPrefixToEnv(testEnv, 'MY_SERVICE'), {
+          PLT_MY_SERVICE_FOO: 'bar',
+          PLT_MY_SERVICE_NAME: 'service',
+          PLT_MY_SERVICE_DATABASE_URL: 'foobar',
+          PLT_MY_SERVICE_ANOTHER_VALUE: 'anotherValue'
+        })
       }
+      {
+        // empty service name, return same env
+        const testEnv = {
+          FOO: 'bar',
+          PLT_MY_SERVICE_NAME: 'service',
+          DATABASE_URL: 'foobar',
+          PLT_ANOTHER_VALUE: 'anotherValue'
+        }
 
-      assert.deepEqual(addPrefixToEnv(testEnv, 'MY_SERVICE'), {
-        PLT_MY_SERVICE_FOO: 'bar',
-        PLT_MY_SERVICE_NAME: 'service',
-        PLT_MY_SERVICE_DATABASE_URL: 'foobar'
-      })
+        assert.deepEqual(addPrefixToEnv(testEnv, ''), {
+          FOO: 'bar',
+          PLT_MY_SERVICE_NAME: 'service',
+          DATABASE_URL: 'foobar',
+          PLT_ANOTHER_VALUE: 'anotherValue'
+        })
+      }
     })
   })
 
@@ -103,6 +123,12 @@ describe('utils', () => {
         value: 'value2',
         type: 'string'
       },
+      {
+        path: 'foo.fooOption3',
+        value: 'value3',
+        type: 'string',
+        name: 'THE_FOO_OPTION_3'
+      },
       {
         path: 'foobar',
         value: '123',
@@ -119,12 +145,13 @@ describe('utils', () => {
         type: 'boolean'
       }
     ]
-    const config = getPackageConfigurationObject(input)
-    assert.deepEqual(config, {
+    const output = getPackageConfigurationObject(input)
+    assert.deepEqual(output.config, {
       prefix: '/foo',
       foo: {
         fooOption1: 'value1',
-        fooOption2: 'value2'
+        fooOption2: 'value2',
+        fooOption3: '{THE_FOO_OPTION_3}'
       },
       foobar: 123,
       boolean: {
@@ -133,6 +160,10 @@ describe('utils', () => {
       }
     })
 
+    assert.deepEqual(output.env, {
+      THE_FOO_OPTION_3: 'value3'
+    })
+
     // should throw
     try {
       getPackageConfigurationObject([
@@ -148,4 +179,12 @@ describe('utils', () => {
       assert.equal(err.message, 'Invalid value type. Accepted values are \'string\', \'number\' and \'boolean\', found \'object\'.')
     }
   })
+
+  describe('addPrefixToString', () => {
+    test('should add prefix to string', async () => {
+      assert.equal(addPrefixToString('PLT_SERVICE_FOO', 'SERVICE'), 'PLT_SERVICE_FOO')
+      assert.equal(addPrefixToString('FOO', 'SERVICE'), 'PLT_SERVICE_FOO')
+      assert.equal(addPrefixToString('FOO', ''), 'FOO')
+    })
+  })
 })