@platformatic/generators 2.0.0-alpha.1 → 2.0.0-alpha.11

package/eslint.config.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require('neostandard')({ ts: true })

package/index.d.ts

@@ -4,5 +4,5 @@ import { generateTests, generatePlugins } from './lib/create-plugin'
 export {
   BaseGenerator,
   generateTests,
-  generatePlugins
+  generatePlugins,
 }

package/index.js

@@ -1,12 +1,10 @@
 'use strict'
 
 const { BaseGenerator } = require('./lib/base-generator')
-const { StackableGenerator } = require('./lib/stackable-generator')
 const { generateTests } = require('./lib/create-plugin')
 const utils = require('./lib/utils')
 module.exports = {
   BaseGenerator,
-  StackableGenerator,
   generateTests,
-  ...utils
+  ...utils,
 }

package/index.test-d.ts

@@ -1,20 +1,20 @@
 import { expectAssignable } from 'tsd'
-import { BaseGenerator } from './lib/base-generator';
+import { BaseGenerator } from './lib/base-generator'
 import { generatePlugins, generateTests } from './index'
-import { FileGenerator } from './lib/file-generator';
+import { FileGenerator } from './lib/file-generator'
 
 expectAssignable<BaseGenerator.ConfigFieldDefinition>({
   label: 'PLT_TESTING',
   var: 'testing',
   default: 'hello world',
   type: 'string',
-  configValue: 'someConfigValue'
+  configValue: 'someConfigValue',
 })
 
 expectAssignable<BaseGenerator.ConfigField>({
   var: 'testing',
   configValue: 'someConfigValue',
-  value: 'asd123'
+  value: 'asd123',
 })
 
 expectAssignable<FileGenerator.FileObject[]>(generatePlugins(true))

package/lib/base-generator.d.ts

@@ -81,42 +81,42 @@ export namespace BaseGenerator {
     questions: Array<object>
 
     packages: PackageConfiguration[]
-    constructor(opts?: BaseGeneratorOptions)
+    constructor (opts?: BaseGeneratorOptions)
+
+    setConfig (config?: BaseGeneratorConfig): void
 
-    setConfig(config?: BaseGeneratorConfig): 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
+    setEnvVars (env?: Env): void
 
-    getDefaultConfig(): { [x: string]: JSONValue }
+    getDefaultConfig (): { [x: string]: JSONValue }
 
-    getFastifyVersion(): Promise<string>
-    getPlatformaticVersion(): Promise<string>
+    getFastifyVersion (): Promise<string>
+    getPlatformaticVersion (): Promise<string>
 
-    addPackage(pkg: PackageDefinition): Promise<void>
+    addPackage (pkg: PackageDefinition): Promise<void>
 
-    loadFromDir(dir: string): Promise<void>
-    prepare(): Promise<GeneratorMetadata>
-    run(): Promise<GeneratorMetadata>
-    addQuestion(question: any, where?: WhereClause): Promise<void>
-    removeQuestion(variableName: string): void
-    getTSConfig(): { [x: string]: JSONValue }
+    loadFromDir (dir: string): Promise<void>
+    prepare (): Promise<GeneratorMetadata>
+    run (): Promise<GeneratorMetadata>
+    addQuestion (question: any, where?: WhereClause): Promise<void>
+    removeQuestion (variableName: string): void
+    getTSConfig (): { [x: string]: JSONValue }
 
-    getConfigFieldsDefinitions(): ConfigFieldDefinition[]
-    setConfigFields(fields: ConfigField[]): void
+    getConfigFieldsDefinitions (): ConfigFieldDefinition[]
+    setConfigFields (fields: ConfigField[]): void
 
-    generateConfigFile(): Promise<void>
-    readPackageJsonFile(): Promise<JSONValue>
-    generatePackageJson(): Promise<{ [x: string]: JSONValue }>
-    getConfigFileName(): string
-    checkEnvVariablesInConfigFile(): boolean
-    _beforePrepare(): Promise<void>
-    _afterPrepare(): Promise<void | JSONValue>
-    _getConfigFileContents(): Promise<{ [x: string]: BaseGenerator.JSONValue }>
+    generateConfigFile (): Promise<void>
+    readPackageJsonFile (): Promise<JSONValue>
+    generatePackageJson (): Promise<{ [x: string]: JSONValue }>
+    getConfigFileName (): string
+    checkEnvVariablesInConfigFile (): boolean
+    _beforePrepare (): Promise<void>
+    _afterPrepare (): Promise<void | JSONValue>
+    _getConfigFileContents (): Promise<{ [x: string]: BaseGenerator.JSONValue }>
 
-    postInstallActions(): Promise<void>
+    postInstallActions (): Promise<void>
   }
 }

package/lib/base-generator.js

@@ -2,12 +2,11 @@
 
 const { readFile } = require('node:fs/promises')
 const {
-  stripVersion,
   convertServiceNameToPrefix,
   extractEnvVariablesFromText,
   getPackageConfigurationObject,
   PLT_ROOT,
-  getLatestNpmVersion
+  getLatestNpmVersion,
 } = require('./utils')
 const { join } = require('node:path')
 const { FileGenerator } = require('./file-generator')
@@ -24,7 +23,7 @@ const fakeLogger = {
   warn: () => {},
   debug: () => {},
   trace: () => {},
-  error: () => {}
+  error: () => {},
 }
 /* c8 ignore start */
 
@@ -60,7 +59,7 @@ class BaseGenerator extends FileGenerator {
       envPrefix: '',
       env: {},
       defaultEnv: {},
-      isUpdating: false
+      isUpdating: false,
     }
   }
 
@@ -137,7 +136,7 @@ class BaseGenerator extends FileGenerator {
     this.config = {
       ...this.getDefaultConfig(),
       ...oldConfig,
-      ...config
+      ...config,
     }
 
     if (this.config.isRuntimeContext) {
@@ -163,7 +162,7 @@ class BaseGenerator extends FileGenerator {
       const newConfig = await this.inquirer.prompt(this.questions)
       this.setConfig({
         ...this.config,
-        ...newConfig
+        ...newConfig,
       })
     }
   }
@@ -190,7 +189,7 @@ class BaseGenerator extends FileGenerator {
         this.addFile({
           path: '',
           file: 'platformatic.json',
-          contents: JSON.stringify(currentConfigFile, null, 2)
+          contents: JSON.stringify(currentConfigFile, null, 2),
         })
       } else {
         await this.getFastifyVersion()
@@ -203,7 +202,7 @@ class BaseGenerator extends FileGenerator {
         this.addFile({
           path: '',
           file: 'package.json',
-          contents: JSON.stringify(template, null, 2)
+          contents: JSON.stringify(template, null, 2),
         })
 
         await this.generateConfigFile()
@@ -215,7 +214,7 @@ class BaseGenerator extends FileGenerator {
           this.addFile({
             path: '',
             file: 'tsconfig.json',
-            contents: JSON.stringify(this.getTsConfig(), null, 2)
+            contents: JSON.stringify(this.getTsConfig(), null, 2),
           })
         }
 
@@ -236,7 +235,7 @@ class BaseGenerator extends FileGenerator {
       }
       return {
         targetDirectory: this.targetDirectory,
-        env: this.config.env
+        env: this.config.env,
       }
     } catch (err) {
       if (err.code?.startsWith('PLT_GEN')) {
@@ -280,15 +279,16 @@ class BaseGenerator extends FileGenerator {
         noEmitOnError: true,
         incremental: true,
         strict: true,
-        outDir: 'dist'
+        outDir: 'dist',
+        skipLibCheck: true,
       },
       watchOptions: {
         watchFile: 'fixedPollingInterval',
         watchDirectory: 'fixedPollingInterval',
         fallbackPolling: 'dynamicPriority',
         synchronousWatchDirectory: true,
-        excludeDirectories: ['**/node_modules', 'dist']
-      }
+        excludeDirectories: ['**/node_modules', 'dist'],
+      },
     }
   }
 
@@ -299,7 +299,7 @@ class BaseGenerator extends FileGenerator {
         this.questions.push({
           type: 'input',
           name: 'targetDirectory',
-          message: 'Where would you like to create your project?'
+          message: 'Where would you like to create your project?',
         })
       }
 
@@ -309,14 +309,14 @@ class BaseGenerator extends FileGenerator {
         name: 'typescript',
         message: 'Do you want to use TypeScript?',
         default: false,
-        choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+        choices: [{ name: 'yes', value: true }, { name: 'no', value: false }],
       })
 
       // port
       this.questions.push({
         type: 'input',
         name: 'port',
-        message: 'What port do you want to use?'
+        message: 'What port do you want to use?',
       })
     }
   }
@@ -340,7 +340,7 @@ class BaseGenerator extends FileGenerator {
         }
         return {
           name: packageDefinition.name,
-          options: packageConfigOutput.config
+          options: packageConfigOutput.config,
         }
       })
     }
@@ -348,7 +348,7 @@ class BaseGenerator extends FileGenerator {
     this.addFile({
       path: '',
       file: configFileName,
-      contents: JSON.stringify(contents, null, 2)
+      contents: JSON.stringify(contents, null, 2),
     })
   }
 
@@ -367,12 +367,12 @@ class BaseGenerator extends FileGenerator {
 
   async getFastifyVersion () {
     const pkgData = await this.readPackageJsonFile()
-    this.fastifyVersion = stripVersion(pkgData.dependencies.fastify)
+    this.fastifyVersion = pkgData.dependencies.fastify
   }
 
   async getPlatformaticVersion () {
     const pkgData = await this.readPackageJsonFile()
-    this.platformaticVersion = stripVersion(pkgData.version)
+    this.platformaticVersion = pkgData.version
   }
 
   async generatePackageJson () {
@@ -380,19 +380,19 @@ class BaseGenerator extends FileGenerator {
       name: `${this.config.serviceName}`,
       scripts: {
         start: 'platformatic start',
-        test: 'borp'
+        test: 'borp',
       },
       devDependencies: {
         fastify: `^${this.fastifyVersion}`,
         borp: `${this.pkgData.devDependencies.borp}`,
-        ...this.config.devDependencies
+        ...this.config.devDependencies,
       },
       dependencies: {
-        ...this.config.dependencies
+        ...this.config.dependencies,
       },
       engines: {
-        node: '^18.8.0 || >=20.6.0'
-      }
+        node: '^18.8.0 || >=20.6.0',
+      },
     }
 
     if (this.config.typescript) {
@@ -409,7 +409,7 @@ class BaseGenerator extends FileGenerator {
       this.addFile({
         path: '',
         file: '.env',
-        contents: serializeEnvVars(this.config.env)
+        contents: serializeEnvVars(this.config.env),
       })
 
       const emptyEnvVars = {}
@@ -424,8 +424,8 @@ class BaseGenerator extends FileGenerator {
         file: '.env.sample',
         contents: serializeEnvVars({
           ...this.config.defaultEnv,
-          ...emptyEnvVars
-        })
+          ...emptyEnvVars,
+        }),
       })
     }
   }
@@ -461,7 +461,7 @@ class BaseGenerator extends FileGenerator {
         const flattened = flattenObject(pkg)
         const output = {
           name: flattened.name,
-          options: []
+          options: [],
         }
         if (pkg.options) {
           Object.entries(flattened)
@@ -473,7 +473,7 @@ class BaseGenerator extends FileGenerator {
                 name: serviceEnvVarKey,
                 path: key.replace('options.', ''),
                 type: 'string',
-                value: runtimeEnv[runtimeEnvVarKey]
+                value: runtimeEnv[runtimeEnvVarKey],
               }
               output.options.push(option)
             })
@@ -487,7 +487,7 @@ class BaseGenerator extends FileGenerator {
       name: serviceName,
       template: getServiceTemplateFromSchemaUrl(servicePkgJsonFileData.$schema),
       fields: [],
-      plugins
+      plugins,
     }
   }
 

package/lib/create-gitignore.js

@@ -33,10 +33,10 @@ function generateGitignore () {
   return {
     path: '',
     file: '.gitignore',
-    contents: gitignore
+    contents: gitignore,
   }
 }
 
 module.exports = {
-  generateGitignore
+  generateGitignore,
 }

package/lib/create-plugin.d.ts

@@ -7,7 +7,7 @@ type HelperCustomization = {
   requires: string
 }
 
-export function generatePluginWithTypesSupport(typescript: boolean): FileGenerator.FileObject
-export function generateRouteWithTypesSupport(typescript: boolean): FileGenerator.FileObject
-export function generateTests(typescript: boolean, type: string, customization?: HelperCustomization): Array<FileGenerator.FileObject>
-export function generatePlugins(typescript: boolean): Array<FileGenerator.FileObject>
+export function generatePluginWithTypesSupport (typescript: boolean): FileGenerator.FileObject
+export function generateRouteWithTypesSupport (typescript: boolean): FileGenerator.FileObject
+export function generateTests (typescript: boolean, type: string, customization?: HelperCustomization): Array<FileGenerator.FileObject>
+export function generatePlugins (typescript: boolean): Array<FileGenerator.FileObject>

package/lib/create-plugin.js

@@ -184,7 +184,7 @@ function generatePluginWithTypesSupport (typescript) {
   return {
     path: 'plugins',
     file: pluginName,
-    contents: pluginTemplate
+    contents: pluginTemplate,
   }
 }
 
@@ -198,7 +198,7 @@ function generateRouteWithTypesSupport (typescript) {
   return {
     path: 'routes',
     file: routesName,
-    contents: routesTemplate
+    contents: routesTemplate,
   }
 }
 
@@ -208,33 +208,33 @@ function generateTests (typescript, mod, customizations) {
     output.push({
       path: 'test',
       file: 'helper.ts',
-      contents: testHelperTS(mod, customizations)
+      contents: testHelperTS(mod, customizations),
     })
     output.push({
       path: join('test', 'plugins'),
       file: 'example.test.ts',
-      contents: TEST_PLUGIN_TS
+      contents: TEST_PLUGIN_TS,
     })
     output.push({
       path: join('test', 'routes'),
       file: 'root.test.ts',
-      contents: TEST_ROUTES_TS
+      contents: TEST_ROUTES_TS,
     })
   } else {
     output.push({
       path: 'test',
       file: 'helper.js',
-      contents: testHelperJS(mod, customizations)
+      contents: testHelperJS(mod, customizations),
     })
     output.push({
       path: join('test', 'plugins'),
       file: 'example.test.js',
-      contents: TEST_PLUGIN_JS
+      contents: TEST_PLUGIN_JS,
     })
     output.push({
       path: join('test', 'routes'),
       file: 'root.test.js',
-      contents: TEST_ROUTES_JS
+      contents: TEST_ROUTES_JS,
     })
   }
   return output
@@ -251,5 +251,5 @@ module.exports = {
   generatePluginWithTypesSupport,
   generateRouteWithTypesSupport,
   generatePlugins,
-  generateTests
+  generateTests,
 }

package/lib/errors.js

@@ -8,5 +8,5 @@ module.exports = {
   ModuleNeeded: createError(`${ERROR_PREFIX}_PREPARE_ERROR`, 'The module which the package will be published to must be specified'),
   PrepareError: createError(`${ERROR_PREFIX}_PREPARE_ERROR`, 'Error while generating the files: %s.'),
   MissingEnvVariable: createError(`${ERROR_PREFIX}_MISSING_ENV_VAR`, 'Env variable %s is defined in config file %s, but not in config.env object.'),
-  WrongTypeError: createError(`${ERROR_PREFIX}_WRONG_TYPE`, 'Invalid value type. Accepted values are \'string\', \'number\' and \'boolean\', found \'%s\'.')
+  WrongTypeError: createError(`${ERROR_PREFIX}_WRONG_TYPE`, 'Invalid value type. Accepted values are \'string\', \'number\' and \'boolean\', found \'%s\'.'),
 }

package/lib/file-generator.d.ts

@@ -4,27 +4,27 @@ export namespace FileGenerator {
   export type FileGeneratorOptions = {
     logger?: BaseLogger
   }
-  
+
   export type FileObject = {
     path: string,
     file: string,
     contents: string
   }
-  
+
   export class FileGenerator {
     files: FileObject[]
     targetDirectory: string
-  
-    constructor(opts?: FileGeneratorOptions)
-  
-    setTargetDirectory(dir: string): void
-    addFile(file: FileObject): void
-    appendfile(file: FileObject): void
-    reset(): void
-    writeFiles(): Promise<void>
-    listFiles(): FileObject
-    loadFile(): Promise<FileObject>
-    getFileObject(file: string, path?: string): FileObject
+
+    constructor (opts?: FileGeneratorOptions)
+
+    setTargetDirectory (dir: string): void
+    addFile (file: FileObject): void
+    appendfile (file: FileObject): void
+    reset (): void
+    writeFiles (): Promise<void>
+    listFiles (): FileObject
+    loadFile (): Promise<FileObject>
+    getFileObject (file: string, path?: string): FileObject
   }
-  
+
 }

package/lib/file-generator.js

@@ -1,5 +1,5 @@
 'use strict'
-const { safeMkdir } = require('./utils')
+const { createDirectory } = require('@platformatic/utils')
 const { join } = require('node:path')
 const { writeFile, readFile } = require('node:fs/promises')
 
@@ -9,7 +9,7 @@ const fakeLogger = {
   warn: () => {},
   debug: () => {},
   trace: () => {},
-  error: () => {}
+  error: () => {},
 }
 /* c8 ignore start */
 
@@ -59,14 +59,14 @@ class FileGenerator {
     if (!this.targetDirectory) {
       throw new Error('No target directory set.')
     }
-    await safeMkdir(this.targetDirectory)
+    await createDirectory(this.targetDirectory)
     for (const fileToWrite of this.files) {
       if (fileToWrite.contents.length === 0) {
         continue
       }
       const baseDir = join(this.targetDirectory, fileToWrite.path)
       if (fileToWrite.path !== '') {
-        await safeMkdir(baseDir)
+        await createDirectory(baseDir)
       }
       const fullFilePath = join(baseDir, fileToWrite.file)
       await writeFile(fullFilePath, fileToWrite.contents, fileToWrite.options)

package/lib/utils.d.ts

@@ -9,14 +9,13 @@ export type PackageConfiguration = {
 }
 
 export namespace GeneratorUtils {
-  export function safeMkdir(dir: string): Promise<void>
-  export function stripVersion(version: string): string
-  export function convertServiceNameToPrefix(serviceName: string): string
-  export function envObjectToString(env: Env): string
-  export function envStringToObject(env: string): Env
-  export function extractEnvVariablesFromText(text: string): string[]
-  export function getPackageConfigurationObject(config: PackageConfiguration[]): object
-  export function flattenObject(obj: object): object
-  export function getServiceTemplateFromSchemaUrl(schemaUrl: string): string
+  export function stripVersion (version: string): string
+  export function convertServiceNameToPrefix (serviceName: string): string
+  export function envObjectToString (env: Env): string
+  export function envStringToObject (env: string): Env
+  export function extractEnvVariablesFromText (text: string): string[]
+  export function getPackageConfigurationObject (config: PackageConfiguration[]): object
+  export function flattenObject (obj: object): object
+  export function getServiceTemplateFromSchemaUrl (schemaUrl: string): string
   export const PLT_ROOT: string
 }

package/lib/utils.js

@@ -1,33 +1,12 @@
 'use strict'
 
-const { mkdir } = require('node:fs/promises')
 const { WrongTypeError } = require('./errors')
 const { join } = require('node:path')
 const { request } = require('undici')
 const { setTimeout } = require('timers/promises')
 const PLT_ROOT = 'PLT_ROOT'
 const { EOL } = require('node:os')
-async function safeMkdir (dir) {
-  try {
-    await mkdir(dir, { recursive: true })
-    /* c8 ignore next 3 */
-  } catch (err) {
-    // do nothing
-  }
-}
-
-/**
- * Strip all extra characters from a simple semver version string
- * @param {string} version
- * @returns string
- */
-function stripVersion (version) {
-  const match = version.match(/(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)/)
-  if (match) {
-    return match[0]
-  }
-  return version
-}
+const { createDirectory } = require('@platformatic/utils')
 
 function convertServiceNameToPrefix (serviceName) {
   return serviceName.replace(/-/g, '_').toUpperCase()
@@ -49,7 +28,7 @@ function addPrefixToString (input, prefix) {
 
 function envObjectToString (env) {
   const output = []
-  Object.entries(env).forEach((kv) => {
+  Object.entries(env).forEach(kv => {
     output.push(`${kv[0]}=${kv[1]}`)
   })
   return output.join(EOL)
@@ -57,12 +36,12 @@ function envObjectToString (env) {
 
 function envStringToObject (envString) {
   const output = {}
-  const split = envString.split(EOL)
+  const split = envString.split(/\r?\n/)
   split
-    .filter((line) => {
+    .filter(line => {
       return line.trim() !== '' && line.indexOf('#') !== 0
     })
-    .forEach((line) => {
+    .forEach(line => {
       const kv = line.split('=')
       output[kv[0]] = kv[1]
     })
@@ -71,16 +50,14 @@ function envStringToObject (envString) {
 function extractEnvVariablesFromText (text) {
   const match = text.match(/\{[a-zA-Z0-9-_]*\}/g)
   if (match) {
-    return match
-      .map((found) => found.replace('{', '').replace('}', ''))
-      .filter((found) => found !== '')
+    return match.map(found => found.replace('{', '').replace('}', '')).filter(found => found !== '')
   }
   return []
 }
 function getPackageConfigurationObject (config, serviceName = '') {
   const output = {
     config: {},
-    env: {}
+    env: {},
   }
   let current = output.config
   for (const param of config) {
@@ -90,14 +67,14 @@ function getPackageConfigurationObject (config, serviceName = '') {
         let value
         let isPath = false
         switch (param.type) {
-          case 'string' :
+          case 'string':
             value = param.value.toString()
             break
           case 'number':
             value = parseInt(param.value)
             break
           case 'boolean':
-            value = (param.value === 'true')
+            value = param.value === 'true'
             break
           case 'path':
             value = `${join(`{${PLT_ROOT}}`, param.value)}`
@@ -167,7 +144,7 @@ async function getLatestNpmVersion (pkg) {
 function flattenObject (ob) {
   const result = {}
   for (const i in ob) {
-    if ((typeof ob[i]) === 'object' && !Array.isArray(ob[i])) {
+    if (typeof ob[i] === 'object' && !Array.isArray(ob[i])) {
       const temp = flattenObject(ob[i])
       for (const j in temp) {
         result[i + '.' + j] = temp[j]
@@ -181,8 +158,13 @@ function flattenObject (ob) {
 
 function getServiceTemplateFromSchemaUrl (schemaUrl) {
   const splitted = schemaUrl.split('/')
-  return `@platformatic/${splitted[splitted.length - 1]}`
+
+  if (schemaUrl.startsWith('https://platformatic.dev/schemas')) {
+    return `@platformatic/${splitted[splitted.length - 1]}`
+  }
+  return `@platformatic/${splitted[splitted.length - 2]}`
 }
+
 module.exports = {
   addPrefixToString,
   convertServiceNameToPrefix,
@@ -192,8 +174,7 @@ module.exports = {
   extractEnvVariablesFromText,
   flattenObject,
   getServiceTemplateFromSchemaUrl,
-  safeMkdir,
-  stripVersion,
+  createDirectory,
   PLT_ROOT,
-  getLatestNpmVersion
+  getLatestNpmVersion,
 }