@platformatic/generators 2.63.3 → 2.64.0

package/index.d.ts

@@ -1,8 +1,5 @@
 import { BaseGenerator } from './lib/base-generator'
-import { generateTests, generatePlugins } from './lib/create-plugin'
+import { generatePlugins, generateTests } from './lib/create-plugin'
+import { FileGenerator } from './lib/file-generator'
 
-export {
-  BaseGenerator,
-  generateTests,
-  generatePlugins,
-}
+export { BaseGenerator, FileGenerator, generatePlugins, generateTests }

package/lib/base-generator.js

@@ -20,11 +20,11 @@ const { flattenObject } = require('./utils')
 const { envStringToObject } = require('./utils')
 /* c8 ignore start */
 const fakeLogger = {
-  info: () => {},
-  warn: () => {},
-  debug: () => {},
-  trace: () => {},
-  error: () => {},
+  info: () => { },
+  warn: () => { },
+  debug: () => { },
+  trace: () => { },
+  error: () => { },
 }
 /* c8 ignore start */
 
@@ -40,6 +40,7 @@ class BaseGenerator extends FileGenerator {
     this.config = this.getDefaultConfig()
     this.packages = []
     this.module = opts.module
+    this.runtimeConfig = opts.runtimeConfig ?? 'platformatic.json'
     if (!this.module) {
       throw ModuleNeeded()
     }
@@ -175,8 +176,8 @@ class BaseGenerator extends FileGenerator {
       if (this.config.isUpdating) {
         // only the packages options may have changed, let's update those
         await this.generateConfigFile()
-        const generatedConfigFile = JSON.parse(this.getFileObject('platformatic.json', '').contents)
-        const fileFromDisk = await this.loadFile({ file: 'platformatic.json', path: '' })
+        const generatedConfigFile = JSON.parse(this.getFileObject(this.runtimeConfig, '').contents)
+        const fileFromDisk = await this.loadFile({ file: this.runtimeConfig, path: '' })
         const currentConfigFile = JSON.parse(fileFromDisk.contents)
         if (currentConfigFile.plugins) {
           if (generatedConfigFile.plugins && generatedConfigFile.plugins.packages) {
@@ -189,7 +190,7 @@ class BaseGenerator extends FileGenerator {
         this.reset()
         this.addFile({
           path: '',
-          file: 'platformatic.json',
+          file: this.runtimeConfig,
           contents: JSON.stringify(currentConfigFile, null, 2),
         })
       } else {
@@ -251,7 +252,7 @@ class BaseGenerator extends FileGenerator {
 
   checkEnvVariablesInConfigFile () {
     const excludedEnvs = [PLT_ROOT]
-    const configFileName = 'platformatic.json'
+    const configFileName = this.runtimeConfig
     const fileObject = this.getFileObject(configFileName)
     const envVars = extractEnvVariablesFromText(fileObject.contents)
     const envKeys = Object.keys(this.config.env)
@@ -323,7 +324,7 @@ class BaseGenerator extends FileGenerator {
   }
 
   async generateConfigFile () {
-    const configFileName = 'platformatic.json'
+    const configFileName = this.runtimeConfig
     const contents = await this._getConfigFileContents()
     // handle packages
     if (this.packages.length > 0) {
@@ -392,7 +393,7 @@ class BaseGenerator extends FileGenerator {
         ...this.config.dependencies,
       },
       engines: {
-        node: '^18.8.0 || >=20.6.0',
+        node: '^22.14.0 || ^20.6.0',
       },
     }
 
@@ -451,7 +452,7 @@ class BaseGenerator extends FileGenerator {
   }
 
   async loadFromDir (serviceName, runtimeRootPath) {
-    const runtimePkgConfigFileData = JSON.parse(await readFile(join(runtimeRootPath, 'platformatic.json'), 'utf-8'))
+    const runtimePkgConfigFileData = JSON.parse(await readFile(join(runtimeRootPath, this.runtimeConfig), 'utf-8'))
     const servicesPath = runtimePkgConfigFileData.autoload.path
     const servicePkgJsonFileData = JSON.parse(await readFile(join(runtimeRootPath, servicesPath, serviceName, 'platformatic.json'), 'utf-8'))
     const runtimeEnv = envStringToObject(await readFile(join(runtimeRootPath, '.env'), 'utf-8'))
@@ -494,9 +495,9 @@ class BaseGenerator extends FileGenerator {
 
   // implement in the subclass
   /* c8 ignore next 1 */
-  async postInstallActions () {}
-  async _beforePrepare () {}
-  async _afterPrepare () {}
+  async postInstallActions () { }
+  async _beforePrepare () { }
+  async _afterPrepare () { }
   async _getConfigFileContents () { return {} }
 }
 

package/lib/file-generator.js

@@ -61,7 +61,7 @@ class FileGenerator {
     }
     await createDirectory(this.targetDirectory)
     for (const fileToWrite of this.files) {
-      if (fileToWrite.contents.length === 0) {
+      if (fileToWrite.contents.length === 0 && !fileToWrite.file.match(/^\..+keep$/)) {
         continue
       }
       const baseDir = join(this.targetDirectory, fileToWrite.path)

package/lib/utils.js

@@ -18,6 +18,7 @@ function stripVersion (version) {
   if (match) {
     return match[0]
   }
+  /* c8 ignore next */
   return version
 }
 
@@ -70,7 +71,7 @@ function extractEnvVariablesFromText (text) {
 function getPackageConfigurationObject (config, serviceName = '') {
   const output = {
     config: {},
-    env: {},
+    env: {}
   }
   let current = output.config
   for (const param of config) {
@@ -172,6 +173,7 @@ function flattenObject (ob) {
 function getServiceTemplateFromSchemaUrl (schemaUrl) {
   const splitted = schemaUrl.split('/')
 
+  /* c8 ignore next 3 - Legacy interface */
   if (schemaUrl.startsWith('https://platformatic.dev/schemas')) {
     return `@platformatic/${splitted[splitted.length - 1]}`
   }
@@ -190,5 +192,5 @@ module.exports = {
   createDirectory,
   stripVersion,
   PLT_ROOT,
-  getLatestNpmVersion,
+  getLatestNpmVersion
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/generators",
-  "version": "2.63.3",
+  "version": "2.64.0",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],
@@ -12,7 +12,7 @@
     "fastify": "^5.0.0",
     "pino": "^9.0.0",
     "undici": "^7.0.0",
-    "@platformatic/utils": "2.63.3"
+    "@platformatic/utils": "2.64.0"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.7",