@platformatic/generators 1.21.1 → 1.23.0

package/index.d.ts

@@ -1,8 +1,7 @@
-import { BaseGenerator } from "./lib/base-generator";
-import { generateTests } from "./lib/create-plugin";
-import addPrefixToEnv from "./lib/utils"
+import { BaseGenerator } from './lib/base-generator'
+import { generateTests } from './lib/create-plugin'
+
 export {
-  addPrefixToEnv,
   BaseGenerator,
-  generateTests,
+  generateTests
 }

package/index.js

@@ -3,9 +3,8 @@
 const { BaseGenerator } = require('./lib/base-generator')
 const { StackableGenerator } = require('./lib/stackable-generator')
 const { generateTests } = require('./lib/create-plugin')
-const { addPrefixToEnv } = require('./lib/utils')
+
 module.exports = {
-  addPrefixToEnv,
   BaseGenerator,
   StackableGenerator,
   generateTests

package/lib/base-generator.d.ts

@@ -7,8 +7,9 @@ export namespace BaseGenerator {
     inquirer?: object
   }
 
+  export type EnvVarValue = string | number | boolean
   export type Env = {
-    [key: string]: string | number | boolean
+    [key: string]: EnvVarValue
   }
   type KeyValue = {
     [key: string]: string | number | undefined | null | boolean | object
@@ -61,13 +62,18 @@ export namespace BaseGenerator {
     default: string
     type: 'number' | 'string' | 'boolean' | 'path'
     configValue?: 'string'
-
   }
+
   type ConfigField = {
     var: string
     configValue?: 'string'
     value: 'string'
   }
+
+  type AddEnvVarOptions = {
+    overwrite: boolean
+  }
+
   export class BaseGenerator extends FileGenerator.FileGenerator {
     logger: BaseLogger
     platformaticVersion: string
@@ -80,7 +86,12 @@ export namespace BaseGenerator {
     constructor(opts?: BaseGeneratorOptions)
 
     setConfig(config?: BaseGeneratorConfig): void
-    setEnv(env?: Env): void
+    
+    getEnvVarName (envVarName: string): string
+    addEnvVars (envVars: Env, opts: AddEnvVarOptions): void
+    addEnvVar (envVarName: string, envVarValue: EnvVarValue, opts: AddEnvVarOptions): void
+    getEnvVar (envVarName: string): EnvVarValue
+    setEnvVars(env?: Env): void
 
     getDefaultConfig(): JSONValue
     getDefaultEnv(): Env

package/lib/base-generator.js

@@ -4,7 +4,6 @@ const { readFile } = require('node:fs/promises')
 const {
   stripVersion,
   convertServiceNameToPrefix,
-  addPrefixToEnv,
   extractEnvVariablesFromText,
   getPackageConfigurationObject,
   PLT_ROOT,
@@ -76,7 +75,7 @@ class BaseGenerator extends FileGenerator {
     for (const field of fields) {
       if (shouldHandleConfigField(field)) {
         if (field.var) {
-          this.config.env[field.var] = field.value
+          this.addEnvVar(field.var, field.value)
         }
         if (field.configValue) {
           this.config[field.configValue] = field.value
@@ -89,12 +88,40 @@ class BaseGenerator extends FileGenerator {
     return {}
   }
 
-  setEnv (env) {
-    if (this.config.isRuntimeContext) {
-      this.config.env = addPrefixToEnv(this.config.env, this.config.envPrefix)
-    } else {
-      this.config.env = env
+  getEnvVarName (envVarName) {
+    const envVarPrefix = 'PLT_' + this.config.envPrefix + '_'
+    if (this.config.isRuntimeContext && !envVarName.startsWith(envVarPrefix)) {
+      if (envVarName.startsWith('PLT_')) {
+        return envVarName.replace('PLT_', envVarPrefix)
+      }
+      return envVarPrefix + envVarName
     }
+    return envVarName
+  }
+
+  addEnvVars (envVars, opts = {}) {
+    for (const envVarName of Object.keys(envVars)) {
+      const envVarValue = envVars[envVarName]
+      this.addEnvVar(envVarName, envVarValue, opts)
+    }
+  }
+
+  addEnvVar (envVarName, envVarValue, opts = {}) {
+    opts.overwrite ??= true
+    envVarName = this.getEnvVarName(envVarName)
+    if (opts.overwrite || !this.config.env[envVarName]) {
+      this.config.env[envVarName] = envVarValue
+    }
+  }
+
+  getEnvVar (envVarName) {
+    envVarName = this.getEnvVarName(envVarName)
+    return this.config.env[envVarName]
+  }
+
+  setEnvVars (envVars) {
+    this.config.env = {}
+    this.addEnvVars(envVars)
   }
 
   setConfig (config) {
@@ -116,10 +143,8 @@ class BaseGenerator extends FileGenerator {
       if (this.config.serviceName && !this.config.envPrefix) {
         this.config.envPrefix = convertServiceNameToPrefix(this.config.serviceName)
       }
-
-      // modify env
-      this.config.env = addPrefixToEnv(this.config.env, this.config.envPrefix)
     }
+    this.setEnvVars(this.config.env)
 
     if (this.config.targetDirectory) {
       this.targetDirectory = this.config.targetDirectory
@@ -213,8 +238,8 @@ class BaseGenerator extends FileGenerator {
   checkEnvVariablesInConfigFile () {
     const excludedEnvs = [PLT_ROOT]
     const configFileName = 'platformatic.json'
-    const fileOjbect = this.getFileObject(configFileName)
-    const envVars = extractEnvVariablesFromText(fileOjbect.contents)
+    const fileObject = this.getFileObject(configFileName)
+    const envVars = extractEnvVariablesFromText(fileObject.contents)
     const envKeys = Object.keys(this.config.env)
     if (envVars.length > 0) {
       for (const ev of envVars) {
@@ -298,12 +323,7 @@ class BaseGenerator extends FileGenerator {
           Object.entries(packageConfigOutput.env).forEach((kv) => {
             envForPackages[kv[0]] = kv[1]
           })
-          if (this.config.isRuntimeContext) {
-            this.config.env = {
-              ...this.config.env,
-              ...addPrefixToEnv(envForPackages, this.config.envPrefix)
-            }
-          }
+          this.addEnvVars(envForPackages)
         }
         return {
           name: packageDefinition.name,

package/lib/create-stackable-cli.js

@@ -6,11 +6,11 @@ function getJsStackableStartCli () {
   return `\
 #!/usr/bin/env node
 'use strict'
-  
+
 const stackable = require('../index')
 const { start } = require('@platformatic/service')
 const { printAndExitLoadConfigError } = require('@platformatic/config')
-  
+
 start(stackable, process.argv.splice(2)).catch(printAndExitLoadConfigError)
 `
 }
@@ -32,48 +32,44 @@ function getJsStackableCreateCli (stackableName) {
 'use strict'
 
 const { join } = require('node:path')
-const pino = require('pino')
-const pretty = require('pino-pretty')
-const minimist = require('minimist')
+const { parseArgs } = require('node:util')
 const { Generator } = require('../lib/generator')
-  
+
 async function execute () {
-  const logger = pino(pretty({
-    translateTime: 'SYS:HH:MM:ss',
-    ignore: 'hostname,pid'
-  }))
-  
-  const args = minimist(process.argv.slice(2), {
-    string: ['dir', 'port', 'hostname'],
-    boolean: ['typescript', 'install', 'plugin', 'git'],
-    default: {
-      dir: join(process.cwd(), '${kebabCase(stackableName + '-app')}'),
-      port: 3042,
-      hostname: '0.0.0.0',
-      plugin: true,
-      typescript: false,
-      git: false,
-      install: true
+  const args = parseArgs({
+    args: process.argv.slice(2),
+    options: {
+      dir: {
+        type: 'string',
+        default: join(process.cwd(), '${kebabCase(stackableName + '-app')}')
+      },
+      port: { type: 'string', default: '3042' },
+      hostname: { type: 'string', default: '0.0.0.0' },
+      plugins: { type: 'boolean', default: true },
+      tests: { type: 'boolean', default: true },
+      typescript: { type: 'boolean', default: false },
+      git: { type: 'boolean', default: false },
+      install: { type: 'boolean', default: true }
     }
   })
-  
-  const generator = new Generator({ logger })
-  
+
+  const generator = new Generator()
+
   generator.setConfig({
-    port: args.port,
-    hostname: args.hostname,
-    plugin: args.plugin,
-    tests: args.plugin,
-    typescript: args.typescript,
-    initGitRepository: args.git,
-    targetDirectory: args.dir
+    port: parseInt(args.values.port),
+    hostname: args.values.hostname,
+    plugins: args.values.plugins,
+    tests: args.values.tests,
+    typescript: args.values.typescript,
+    initGitRepository: args.values.git,
+    targetDirectory: args.values.dir
   })
-  
+
   await generator.run()
-  
-  logger.info('Application created successfully! Run \`npm run start\` to start an application.')
+
+  console.log('Application created successfully! Run \`npm run start\` to start an application.')
 }
-  
+
 execute()
 `
 }
@@ -82,46 +78,42 @@ function getTsStackableCreateCli (stackableName) {
   return `\
 #!/usr/bin/env node
 import { join } from 'node:path'
-import pino from 'pino'
-import pretty from 'pino-pretty'
-import minimist from 'minimist'
+import { parseArgs } from 'node:util'
 import { Generator } from '../lib/generator'
 
 async function execute () {
-  const logger = pino(pretty({
-    translateTime: 'SYS:HH:MM:ss',
-    ignore: 'hostname,pid'
-  }))
-
-  const args = minimist(process.argv.slice(2), {
-    string: ['dir', 'port', 'hostname'],
-    boolean: ['typescript', 'install', 'plugin', 'git'],
-    default: {
-      dir: join(process.cwd(), '${kebabCase(stackableName + '-app')}'),
-      port: 3042,
-      hostname: '0.0.0.0',
-      plugin: true,
-      typescript: false,
-      git: false,
-      install: true
+  const args = parseArgs({
+    args: process.argv.slice(2),
+    options: {
+      dir: {
+        type: 'string',
+        default: join(process.cwd(), '${kebabCase(stackableName + '-app')}')
+      },
+      port: { type: 'string', default: '3042' },
+      hostname: { type: 'string', default: '0.0.0.0' },
+      plugins: { type: 'boolean', default: true },
+      tests: { type: 'boolean', default: true },
+      typescript: { type: 'boolean', default: false },
+      git: { type: 'boolean', default: false },
+      install: { type: 'boolean', default: true }
     }
   })
 
-  const generator = new Generator({ logger })
+  const generator = new Generator()
 
   generator.setConfig({
-    port: args.port,
-    hostname: args.hostname,
-    plugin: args.plugin,
-    tests: args.plugin,
-    typescript: args.typescript,
-    initGitRepository: args.git,
-    targetDirectory: args.dir
+    port: parseInt(args.values.port as string),
+    hostname: args.values.hostname,
+    plugins: args.values.plugins,
+    tests: args.values.tests,
+    typescript: args.values.typescript,
+    initGitRepository: args.values.git,
+    targetDirectory: args.values.dir
   })
 
   await generator.run()
 
-  logger.info('Application created successfully! Run \`npm run start\` to start an application.')
+  console.log('Application created successfully! Run \`npm run start\` to start an application.')
 }
 
 execute()

package/lib/create-stackable-files.js

@@ -28,7 +28,7 @@ stackable.configManagerConfig = {
     allErrors: true,
     strict: false
   },
-  transformConfig: async () => {}
+  async transformConfig () {}
 }
 
 // break Fastify encapsulation
@@ -67,7 +67,7 @@ stackable.configManagerConfig = {
     allErrors: true,
     strict: false
   },
-  transformConfig: async () => {}
+  async transformConfig () {}
 }
 
 // break Fastify encapsulation
@@ -181,7 +181,7 @@ class ${stackableGeneratorType} extends ServiceGenerator {
       $schema: './stackable.schema.json',
       module: packageJson.name,
       greeting: {
-        text: '{PLT_GREETING_TEXT}'
+        text: \`{\${this.getEnvVarName('PLT_GREETING_TEXT')}}\`
       }
     }
     return Object.assign({}, baseConfig, config)
@@ -190,10 +190,9 @@ class ${stackableGeneratorType} extends ServiceGenerator {
   async _beforePrepare () {
     super._beforePrepare()
 
-    this.config.env = {
-      PLT_GREETING_TEXT: this.config.greeting ?? 'Hello world!',
-      ...this.config.env
-    }
+    this.addEnvVars({
+      PLT_GREETING_TEXT: this.config.greeting ?? 'Hello world!'
+    }, { overwrite: false })
 
     const packageJson = await this.getStackablePackageJson()
 
@@ -226,7 +225,7 @@ class ${stackableGeneratorType} extends ServiceGenerator {
       if (!packageJson.name) {
         throw new Error('Missing package name in package.json')
       }
-  
+
       if (!packageJson.version) {
         throw new Error('Missing package version in package.json')
       }
@@ -290,7 +289,7 @@ class ${stackableGeneratorType} extends ServiceGenerator {
       $schema: './stackable.schema.json',
       module: packageJson.name,
       greeting: {
-        text: '{PLT_GREETING_TEXT}'
+        text: \`{\${this.getEnvVarName('PLT_GREETING_TEXT')}}\`
       }
     }
     return Object.assign({}, baseConfig, config)
@@ -299,10 +298,9 @@ class ${stackableGeneratorType} extends ServiceGenerator {
   async _beforePrepare () {
     super._beforePrepare()
 
-    this.config.env = {
-      PLT_GREETING_TEXT: this.config.greeting ?? 'Hello world!',
-      ...this.config.env
-    }
+    this.addEnvVars({
+      PLT_GREETING_TEXT: this.config.greeting ?? 'Hello world!'
+    }, { overwrite: false })
 
     const packageJson = await this.getStackablePackageJson()
 
@@ -335,7 +333,7 @@ class ${stackableGeneratorType} extends ServiceGenerator {
       if (!packageJson.name) {
         throw new Error('Missing package name in package.json')
       }
-  
+
       if (!packageJson.version) {
         throw new Error('Missing package version in package.json')
       }

package/lib/stackable-generator.js

@@ -205,11 +205,7 @@ class StackableGenerator extends FileGenerator {
     const dependencies = {
       '@platformatic/config': `^${this.platformaticVersion}`,
       '@platformatic/service': `^${this.platformaticVersion}`,
-      'json-schema-to-typescript': '^13.0.0',
-      pino: '^8.0.0',
-      'pino-pretty': '^10.0.0',
-      minimist: '^1.2.0',
-      platformatic: `^${this.platformaticVersion}`
+      'json-schema-to-typescript': '^13.0.0'
     }
 
     const devDependencies = {
@@ -237,9 +233,11 @@ class StackableGenerator extends FileGenerator {
           'build:config': 'node ./dist/lib/schema.js | json2ts > config.d.ts',
           clean: 'rm -fr ./dist'
         },
+        engines: {
+          node: '^18.8.0 || >=20.6.0'
+        },
         devDependencies: {
           ...devDependencies,
-          '@types/minimist': '^1.2.5',
           typescript: typescriptVersion,
           ...this.config.devDependencies
         },
@@ -248,8 +246,8 @@ class StackableGenerator extends FileGenerator {
           '@platformatic/generators': `^${this.platformaticVersion}`,
           ...this.config.dependencies
         },
-        engines: {
-          node: '^18.8.0 || >=20.6.0'
+        overrides: {
+          minimatch: '^5.0.0'
         }
       }
     }
@@ -263,18 +261,20 @@ class StackableGenerator extends FileGenerator {
         [startStackableCommand]: './cli/start.js'
       },
       scripts: {
-        'build:config': 'node lib/schema.js | json2ts > config.d.ts'
+        'build:config': 'node lib/schema.js | json2ts > config.d.ts',
+        lint: 'standard'
+      },
+      engines: {
+        node: '^18.8.0 || >=20.6.0'
       },
       devDependencies: {
         ...devDependencies,
+        standard: '^17.0.0',
         ...this.config.devDependencies
       },
       dependencies: {
         ...dependencies,
         ...this.config.dependencies
-      },
-      engines: {
-        node: '^18.8.0 || >=20.6.0'
       }
     }
   }

package/lib/utils.d.ts

@@ -12,8 +12,6 @@ export namespace GeneratorUtils {
   export function safeMkdir(dir: string): Promise<void>
   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

@@ -46,24 +46,6 @@ function addPrefixToString (input, prefix) {
     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]
-    }
-  })
-  return newEnv
-}
 
 function envObjectToString (env) {
   const output = []
@@ -152,7 +134,6 @@ async function getLatestNpmVersion (pkg) {
 }
 
 module.exports = {
-  addPrefixToEnv,
   addPrefixToString,
   convertServiceNameToPrefix,
   getPackageConfigurationObject,

package/package.json

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

package/test/utils.test.js

@@ -2,7 +2,14 @@
 
 const { test, describe } = require('node:test')
 const assert = require('node:assert')
-const { stripVersion, convertServiceNameToPrefix, addPrefixToEnv, envObjectToString, extractEnvVariablesFromText, getPackageConfigurationObject, addPrefixToString } = require('../lib/utils')
+const {
+  stripVersion,
+  convertServiceNameToPrefix,
+  envObjectToString,
+  extractEnvVariablesFromText,
+  getPackageConfigurationObject,
+  addPrefixToString
+} = require('../lib/utils')
 
 describe('utils', () => {
   describe('stripVersion', async () => {
@@ -33,42 +40,6 @@ describe('utils', () => {
     })
   })
 
-  describe('addPrefixToEnv', () => {
-    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, ''), {
-          FOO: 'bar',
-          PLT_MY_SERVICE_NAME: 'service',
-          DATABASE_URL: 'foobar',
-          PLT_ANOTHER_VALUE: 'anotherValue'
-        })
-      }
-    })
-  })
-
   describe('envObjectToString', () => {
     test('should convert env object to string', async () => {
       const env = {
@@ -176,7 +147,7 @@ describe('utils', () => {
       assert.fail()
     } catch (err) {
       assert.equal(err.code, 'PLT_GEN_WRONG_TYPE')
-      assert.equal(err.message, 'Invalid value type. Accepted values are \'string\', \'number\' and \'boolean\', found \'object\'.')
+      assert.equal(err.message, "Invalid value type. Accepted values are 'string', 'number' and 'boolean', found 'object'.")
     }
   })