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

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

@@ -8,5 +8,5 @@ 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

@@ -7,7 +7,7 @@ const {
   extractEnvVariablesFromText,
   getPackageConfigurationObject,
   PLT_ROOT,
-  getLatestNpmVersion
+  getLatestNpmVersion,
 } = require('./utils')
 const { join } = require('node:path')
 const { FileGenerator } = require('./file-generator')
@@ -24,7 +24,7 @@ const fakeLogger = {
   warn: () => {},
   debug: () => {},
   trace: () => {},
-  error: () => {}
+  error: () => {},
 }
 /* c8 ignore start */
 
@@ -60,7 +60,7 @@ class BaseGenerator extends FileGenerator {
       envPrefix: '',
       env: {},
       defaultEnv: {},
-      isUpdating: false
+      isUpdating: false,
     }
   }
 
@@ -137,7 +137,7 @@ class BaseGenerator extends FileGenerator {
     this.config = {
       ...this.getDefaultConfig(),
       ...oldConfig,
-      ...config
+      ...config,
     }
 
     if (this.config.isRuntimeContext) {
@@ -163,7 +163,7 @@ class BaseGenerator extends FileGenerator {
       const newConfig = await this.inquirer.prompt(this.questions)
       this.setConfig({
         ...this.config,
-        ...newConfig
+        ...newConfig,
       })
     }
   }
@@ -190,7 +190,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 +203,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 +215,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 +236,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 +280,15 @@ class BaseGenerator extends FileGenerator {
         noEmitOnError: true,
         incremental: true,
         strict: true,
-        outDir: 'dist'
+        outDir: 'dist',
       },
       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),
     })
   }
 
@@ -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/create-stackable-cli.js

@@ -129,14 +129,14 @@ function generateStackableCli (typescript, stackableName) {
         path: 'cli',
         file: 'start.ts',
         contents: getTsStackableStartCli(),
-        options: { mode: 0o755 }
+        options: { mode: 0o755 },
       },
       {
         path: 'cli',
         file: 'create.ts',
         contents: getTsStackableCreateCli(stackableName),
-        options: { mode: 0o755 }
-      }
+        options: { mode: 0o755 },
+      },
     ]
   }
 
@@ -145,17 +145,17 @@ function generateStackableCli (typescript, stackableName) {
       path: 'cli',
       file: 'start.js',
       contents: getJsStackableStartCli(),
-      options: { mode: 0o755 }
+      options: { mode: 0o755 },
     },
     {
       path: 'cli',
       file: 'create.js',
       contents: getJsStackableCreateCli(stackableName),
-      options: { mode: 0o755 }
-    }
+      options: { mode: 0o755 },
+    },
   ]
 }
 
 module.exports = {
-  generateStackableCli
+  generateStackableCli,
 }

package/lib/create-stackable-files.js

@@ -450,69 +450,69 @@ function generateStackableFiles (typescript, stackableName) {
       {
         path: '',
         file: 'index.ts',
-        contents: getTsStackableIndexFile(stackableName)
+        contents: getTsStackableIndexFile(stackableName),
       },
       {
         path: '',
         file: 'index.d.ts',
-        contents: getStackableIndexTypesFile(stackableName)
+        contents: getStackableIndexTypesFile(stackableName),
       },
       {
         path: '',
         file: 'config.d.ts',
-        contents: getStackableConfigTypesFile(stackableName)
+        contents: getStackableConfigTypesFile(stackableName),
       },
       {
         path: 'lib',
         file: 'generator.ts',
-        contents: getTsStackableGeneratorFile(stackableName)
+        contents: getTsStackableGeneratorFile(stackableName),
       },
       {
         path: 'lib/templates',
         file: 'types.ts',
-        contents: getTsGlobalTypesTemplateFile(stackableName)
+        contents: getTsGlobalTypesTemplateFile(stackableName),
       },
       {
         path: 'lib',
         file: 'schema.ts',
-        contents: getTsStackableSchemaFile(stackableName)
-      }
+        contents: getTsStackableSchemaFile(stackableName),
+      },
     ]
   }
   return [
     {
       path: '',
       file: 'index.js',
-      contents: getJsStackableIndexFile(stackableName)
+      contents: getJsStackableIndexFile(stackableName),
     },
     {
       path: '',
       file: 'index.d.ts',
-      contents: getStackableIndexTypesFile(stackableName)
+      contents: getStackableIndexTypesFile(stackableName),
     },
     {
       path: '',
       file: 'config.d.ts',
-      contents: getStackableConfigTypesFile(stackableName)
+      contents: getStackableConfigTypesFile(stackableName),
     },
     {
       path: 'lib',
       file: 'generator.js',
-      contents: getJsStackableGeneratorFile(stackableName)
+      contents: getJsStackableGeneratorFile(stackableName),
     },
     {
       path: 'lib/templates',
       file: 'types.js',
-      contents: getJsGlobalTypesTemplateFile(stackableName)
+      contents: getJsGlobalTypesTemplateFile(stackableName),
     },
     {
       path: 'lib',
       file: 'schema.js',
-      contents: getJsStackableSchemaFile(stackableName)
-    }
+      contents: getJsStackableSchemaFile(stackableName),
+    },
   ]
 }
 
 module.exports = {
-  generateStackableFiles
+  generateStackableFiles,
 }

package/lib/create-stackable-plugin.js

@@ -34,16 +34,16 @@ function generateStackablePlugins (typescript) {
     return [{
       path: 'plugins',
       file: 'example.ts',
-      contents: getTsStackablePluginFile()
+      contents: getTsStackablePluginFile(),
     }]
   }
   return [{
     path: 'plugins',
     file: 'example.js',
-    contents: getJsStackablePluginFile()
+    contents: getJsStackablePluginFile(),
   }]
 }
 
 module.exports = {
-  generateStackablePlugins
+  generateStackablePlugins,
 }

package/lib/create-stackable-tests.js

@@ -108,7 +108,8 @@ const test = require('node:test')
 const assert = require('node:assert')
 const { tmpdir } = require('node:os')
 const { join } = require('node:path')
-const { readFile, readdir, mkdtemp, rm } = require('node:fs/promises')
+const { readFile, readdir, mkdtemp } = require('node:fs/promises')
+const { safeRemove } = require('@platformatic/utils')
 const { Generator } = require('../index')
 const stackablePackageJson = require('../package.json')
 
@@ -163,7 +164,7 @@ test('should return Generator config fields definitions', async () => {
 
 test('should generate a stackable app', async (t) => {
   const testDir = await mkdtemp(join(tmpdir(), 'stackable-'))
-  t.after(() => rm(testDir, { recursive: true, force: true }))
+  t.after(() => safeRemove(testDir))
 
   const generator = new Generator()
 
@@ -231,9 +232,10 @@ import test from 'node:test'
 import assert from 'node:assert'
 import { tmpdir } from 'node:os'
 import { join } from 'node:path'
-import { readFile, readdir, mkdtemp, rm } from 'node:fs/promises'
+import { readFile, readdir, mkdtemp } from 'node:fs/promises'
 import { readFileSync } from 'node:fs'
 import { Generator } from '../index'
+import { safeRemove } from '@platformatic/utils'
 
 const stackablePackageJsonPath = require.resolve('../../package.json')
 const stackablePackageJson = JSON.parse(readFileSync(stackablePackageJsonPath, 'utf8'))
@@ -289,7 +291,7 @@ test('should return Generator config fields definitions', async () => {
 
 test('should generate a stackable app', async (t) => {
   const testDir = await mkdtemp(join(tmpdir(), 'stackable-'))
-  t.after(() => rm(testDir, { recursive: true, force: true }))
+  t.after(() => safeRemove(testDir))
 
   const generator = new Generator()
 
@@ -357,39 +359,39 @@ function generateStackableTests (typescript, stackableName) {
       {
         path: 'test',
         file: 'index.test.ts',
-        contents: getTsStackableIndexTestFile(stackableName)
+        contents: getTsStackableIndexTestFile(stackableName),
       },
       {
         path: 'test',
         file: 'schema.test.ts',
-        contents: getTsStackableSchemaTestFile(stackableName)
+        contents: getTsStackableSchemaTestFile(stackableName),
       },
       {
         path: 'test',
         file: 'generator.test.ts',
-        contents: getTsStackableGeneratorTestFile()
-      }
+        contents: getTsStackableGeneratorTestFile(),
+      },
     ]
   }
   return [
     {
       path: 'test',
       file: 'index.test.js',
-      contents: getJsStackableIndexTestFile(stackableName)
+      contents: getJsStackableIndexTestFile(stackableName),
     },
     {
       path: 'test',
       file: 'schema.test.js',
-      contents: getJsStackableSchemaTestFile(stackableName)
+      contents: getJsStackableSchemaTestFile(stackableName),
     },
     {
       path: 'test',
       file: 'generator.test.js',
-      contents: getJsStackableGeneratorTestFile()
-    }
+      contents: getJsStackableGeneratorTestFile(),
+    },
   ]
 }
 
 module.exports = {
-  generateStackableTests
+  generateStackableTests,
 }

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\'.'),
 }