@platformatic/generators 1.13.1 → 1.13.3

package/lib/base-generator.d.ts

@@ -3,7 +3,7 @@ import { FileGenerator } from './file-generator'
 import { PackageConfiguration } from './utils'
 export namespace BaseGenerator {
   export type BaseGeneratorOptions = FileGenerator.FileGeneratorOptions & {
-    type?: 'service' | 'db' | 'composer'
+    module: string
     inquirer?: object
   }
   
@@ -109,5 +109,7 @@ export namespace BaseGenerator {
     _getConfigFileContents(): Promise<JSONValue>
     _generateEnv(): Promise<void>
     appendConfigEnv(): Promise<void>
+
+    postInstallActions(): Promise<void>
   }
-}
+}

package/lib/base-generator.js

@@ -5,8 +5,8 @@ const { stripVersion, convertServiceNameToPrefix, addPrefixToEnv, extractEnvVari
 const { join } = require('node:path')
 const { FileGenerator } = require('./file-generator')
 const { generateTests, generatePlugins } = require('./create-plugin')
+const { PrepareError, MissingEnvVariable, ModuleNeeded } = require('./errors')
 const { generateGitignore } = require('./create-gitignore')
-const { NoQuestionsError, PrepareError, MissingEnvVariable } = require('./errors')
 const generateName = require('boring-name-generator')
 /* c8 ignore start */
 const fakeLogger = {
@@ -21,15 +21,18 @@ const fakeLogger = {
 class BaseGenerator extends FileGenerator {
   constructor (opts = {}) {
     super(opts)
-    this.type = opts.type
     this.files = []
     this.logger = opts.logger || fakeLogger
     this.questions = []
     this.pkgData = null
-    this.inquirer = null
+    this.inquirer = opts.inquirer || null
     this.targetDirectory = opts.targetDirectory || null
     this.config = this.getDefaultConfig()
     this.packages = []
+    this.module = opts.module
+    if (!this.module) {
+      throw ModuleNeeded()
+    }
   }
 
   getDefaultConfig () {
@@ -115,11 +118,13 @@ class BaseGenerator extends FileGenerator {
 
   /* c8 ignore start */
   async ask () {
-    if (!this.questions.length) {
-      throw new NoQuestionsError()
-    }
     if (this.inquirer) {
-      this.config = await this.inquirer.prompt(this.questions)
+      await this.prepareQuestions()
+      const newConfig = await this.inquirer.prompt(this.questions)
+      this.setConfig({
+        ...this.config,
+        ...newConfig
+      })
     }
   }
 
@@ -154,8 +159,6 @@ class BaseGenerator extends FileGenerator {
 
       await this.generateConfigFile()
 
-      await this.prepareQuestions()
-
       await this.generateEnv()
 
       if (this.config.typescript) {
@@ -172,12 +175,16 @@ class BaseGenerator extends FileGenerator {
         this.files.push(...generatePlugins(this.config.typescript))
         if (this.config.tests) {
           // create tests
-          this.files.push(...generateTests(this.config.typescript, this.type))
+          this.files.push(...generateTests(this.config.typescript, this.module))
         }
       }
+
       this.files.push(generateGitignore())
+
       await this._afterPrepare()
+
       this.checkEnvVariablesInConfigFile()
+
       return {
         targetDirectory: this.targetDirectory,
         env: this.config.env
@@ -187,12 +194,14 @@ class BaseGenerator extends FileGenerator {
         // throw the same error
         throw err
       }
-      throw new PrepareError(err.message)
+      const _err = new PrepareError(err.message)
+      _err.cause = err
+      throw _err
     }
   }
 
   checkEnvVariablesInConfigFile () {
-    const configFileName = this.getConfigFileName()
+    const configFileName = 'platformatic.json'
     const fileOjbect = this.getFileObject(configFileName)
     const envVars = extractEnvVariablesFromText(fileOjbect.contents)
     const envKeys = Object.keys(this.config.env)
@@ -231,113 +240,36 @@ class BaseGenerator extends FileGenerator {
   }
 
   async prepareQuestions () {
-    // directory
-    this.questions.push({
-      type: 'input',
-      name: 'targetDirectory',
-      message: 'Where would you like to create your project?'
-    })
-
-    // typescript
-    this.questions.push({
-      type: 'list',
-      name: 'typescript',
-      message: 'Do you want to use TypeScript?',
-      default: false,
-      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-    })
-
-    // init git repository
-    this.questions.push({
-      type: 'list',
-      name: 'initGitRepository',
-      message: 'Do you want to init the git repository?',
-      default: 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?'
-    })
-
-    // github actions
-    this.questions.push({
-      type: 'list',
-      name: 'staticWorkspaceGitHubAction',
-      message: 'Do you want to create the github action to deploy this application to Platformatic Cloud?',
-      default: true,
-      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-    },
-    {
-      type: 'list',
-      name: 'dynamicWorkspaceGitHubAction',
-      message: 'Do you want to enable PR Previews in your application?',
-      default: true,
-      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-    })
-  }
-
-  async addQuestion (question, where) {
-    if (where) {
-      if (where.before) {
-        const position = this.questions.reduce((acc, element, idx) => {
-          if (acc === null) {
-            if (element.name === where.before) {
-              acc = idx
-            }
-          }
-          return acc
-        }, null)
-
-        if (position) {
-          this.questions.splice(position, 0, question)
-        }
-      } else if (where.after) {
-        const position = this.questions.reduce((acc, element, idx) => {
-          if (acc === null) {
-            if (element.name === where.after) {
-              acc = idx + 1
-            }
-          }
-          return acc
-        }, null)
-
-        if (position) {
-          this.questions.splice(position, 0, question)
-        }
+    if (!this.config.isRuntimeContext) {
+      if (!this.config.targetDirectory) {
+        // directory
+        this.questions.push({
+          type: 'input',
+          name: 'targetDirectory',
+          message: 'Where would you like to create your project?'
+        })
       }
-    } else {
-      this.questions.push(question)
-    }
-  }
 
-  removeQuestion (variableName) {
-    const position = this.questions.reduce((acc, element, idx) => {
-      if (acc === null) {
-        if (element.name === variableName) {
-          acc = idx
-        }
-      }
-      return acc
-    }, null)
-    if (position) {
-      this.questions.splice(position, 1)
-    }
-  }
+      // typescript
+      this.questions.push({
+        type: 'list',
+        name: 'typescript',
+        message: 'Do you want to use TypeScript?',
+        default: false,
+        choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+      })
 
-  getConfigFileName () {
-    if (!this.type) {
-      return 'platformatic.json'
-    } else {
-      return `platformatic.${this.type}.json`
+      // port
+      this.questions.push({
+        type: 'input',
+        name: 'port',
+        message: 'What port do you want to use?'
+      })
     }
   }
 
   async generateConfigFile () {
-    const configFileName = this.getConfigFileName()
+    const configFileName = 'platformatic.json'
     const contents = await this._getConfigFileContents()
     this.addFile({
       path: '',
@@ -407,6 +339,13 @@ class BaseGenerator extends FileGenerator {
       })
       await this._generateEnv()
       this.appendConfigEnv()
+
+      const { contents } = this.getFileObject('.env')
+      this.addFile({
+        path: '',
+        file: '.env.sample',
+        contents
+      })
     }
   }
 
@@ -421,6 +360,8 @@ class BaseGenerator extends FileGenerator {
   }
 
   // implement in the subclass
+  /* c8 ignore next 1 */
+  async postInstallActions () {}
   async _beforePrepare () {}
   async _afterPrepare () {}
   async _getConfigFileContents () { return {} }

package/lib/create-plugin.js

@@ -115,7 +115,7 @@ function testHelperTS (mod, customizations = { pre: '', post: '', config: '', re
   return `\
 import { join } from 'node:path'
 import { readFile } from 'node:fs/promises'
-import { buildServer } from '@platformatic/${mod}'
+import { buildServer } from '${mod}'
 import { test } from 'node:test'
 ${customizations.requires}
 
@@ -125,7 +125,7 @@ type TestContext = Parameters<Exclude<testfn, undefined>>[0]
 export async function getServer (t: TestContext) {
 ${customizations.pre}
   // We go up two folder because this files executes in the dist folder
-  const config = JSON.parse(await readFile(join(__dirname, '..', '..', 'platformatic.${mod}.json'), 'utf8'))
+  const config = JSON.parse(await readFile(join(__dirname, '..', '..', 'platformatic'), 'utf8'))
   // Add your config customizations here. For example you want to set
   // all things that are set in the config file to read from an env variable
   config.server.logger.level = 'warn'
@@ -199,13 +199,13 @@ function generateRouteWithTypesSupport (typescript) {
   }
 }
 
-function generateTests (typescript, type, customizations) {
+function generateTests (typescript, mod, customizations) {
   const output = []
   if (typescript) {
     output.push({
       path: 'test',
       file: 'helper.ts',
-      contents: testHelperTS(type, customizations)
+      contents: testHelperTS(mod, customizations)
     })
     output.push({
       path: join('test', 'plugins'),
@@ -221,7 +221,7 @@ function generateTests (typescript, type, customizations) {
     output.push({
       path: 'test',
       file: 'helper.js',
-      contents: testHelperJS(type, customizations)
+      contents: testHelperJS(mod, customizations)
     })
     output.push({
       path: join('test', 'plugins'),

package/lib/errors.js

@@ -5,7 +5,7 @@ const createError = require('@fastify/error')
 const ERROR_PREFIX = 'PLT_GEN'
 
 module.exports = {
-  NoQuestionsError: createError(`${ERROR_PREFIX}_NO_QUESTIONS_ERROR`, 'No questions added.'),
+  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\'.')

package/package.json

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

package/test/base-generator.test.js

@@ -20,7 +20,8 @@ afterEach(async () => {
 test('should write file and dirs', async (t) => {
   const dir = await getTempDir()
   const gen = new BaseGenerator({
-    logger: fakeLogger
+    logger: fakeLogger,
+    module: '@platformatic/service'
   })
 
   gen.setConfig({
@@ -43,6 +44,13 @@ test('should write file and dirs', async (t) => {
 
 test('extended class should generate config', async (t) => {
   class ServiceClass extends BaseGenerator {
+    constructor (opts) {
+      super({
+        ...opts,
+        module: '@platformatic/service'
+      })
+    }
+
     async _getConfigFileContents () {
       // Implement when extending this class
       return {
@@ -52,7 +60,6 @@ test('extended class should generate config', async (t) => {
   }
 
   const svc = new ServiceClass({
-    type: 'service',
     logger: fakeLogger
   })
 
@@ -61,14 +68,14 @@ test('extended class should generate config', async (t) => {
   const configFile = svc.files[1]
   assert.deepEqual(configFile, {
     path: '',
-    file: 'platformatic.service.json',
+    file: 'platformatic.json',
     contents: JSON.stringify({ foo: 'bar' }, null, 2)
   })
 })
 
 test('setConfig', async (t) => {
   const bg = new BaseGenerator({
-    type: 'service'
+    module: '@platformatic/service'
   })
 
   // should init the default config
@@ -140,7 +147,7 @@ test('setConfig', async (t) => {
 
 test('should append env values', async (t) => {
   const bg = new BaseGenerator({
-    type: 'service'
+    module: '@platformatic/service'
   })
   // partial config with defaults
   bg.setConfig({
@@ -152,11 +159,85 @@ test('should append env values', async (t) => {
   await bg.prepare()
   const dotEnvFile = bg.getFileObject('.env')
   assert.equal(dotEnvFile.contents, 'FOO=bar\n')
+
+  const dotEnvSampleFile = bg.getFileObject('.env.sample')
+  assert.equal(dotEnvSampleFile.contents, 'FOO=bar\n')
+})
+
+test('should prepare the questions', async (t) => {
+  const bg = new BaseGenerator({
+    module: '@platformatic/service'
+  })
+  // partial config with defaults
+  bg.setConfig({
+    env: {
+      FOO: 'bar'
+    }
+  })
+
+  await bg.prepareQuestions()
+  assert.deepStrictEqual(bg.questions, [{
+    type: 'input',
+    name: 'targetDirectory',
+    message: 'Where would you like to create your project?'
+  }, {
+    type: 'list',
+    name: 'typescript',
+    message: 'Do you want to use TypeScript?',
+    default: false,
+    choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+  }, {
+    type: 'input',
+    name: 'port',
+    message: 'What port do you want to use?'
+  }])
+})
+
+test('should prepare the questions with a targetDirectory', async (t) => {
+  const bg = new BaseGenerator({
+    module: '@platformatic/service'
+  })
+  // partial config with defaults
+  bg.setConfig({
+    targetDirectory: './foo',
+    env: {
+      FOO: 'bar'
+    }
+  })
+
+  await bg.prepareQuestions()
+  assert.deepStrictEqual(bg.questions, [{
+    type: 'list',
+    name: 'typescript',
+    message: 'Do you want to use TypeScript?',
+    default: false,
+    choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+  }, {
+    type: 'input',
+    name: 'port',
+    message: 'What port do you want to use?'
+  }])
+})
+
+test('should prepare the questions in runtime context', async (t) => {
+  const bg = new BaseGenerator({
+    module: '@platformatic/service'
+  })
+  // partial config with defaults
+  bg.setConfig({
+    isRuntimeContext: true,
+    env: {
+      FOO: 'bar'
+    }
+  })
+
+  await bg.prepareQuestions()
+  assert.deepStrictEqual(bg.questions, [])
 })
 
 test('should return service metadata', async (t) => {
   const bg = new BaseGenerator({
-    type: 'service'
+    module: '@platformatic/service'
   })
   // partial config with defaults
   bg.setConfig({
@@ -177,7 +258,7 @@ test('should return service metadata', async (t) => {
 
 test('should generate javascript plugin, routes and tests', async (t) => {
   const bg = new BaseGenerator({
-    type: 'service'
+    module: '@platformatic/service'
   })
   bg.setConfig({
     plugin: true,
@@ -193,7 +274,7 @@ test('should generate javascript plugin, routes and tests', async (t) => {
 
 test('should generate tsConfig file and typescript files', async (t) => {
   const bg = new BaseGenerator({
-    type: 'service'
+    module: '@platformatic/service'
   })
   bg.setConfig({
     typescript: true,
@@ -231,99 +312,11 @@ test('should generate tsConfig file and typescript files', async (t) => {
   assert.ok(bg.getFileObject('example.test.ts', 'test/plugins'))
 })
 
-test('should generate platformatic.json file if no type is generated', async (t) => {
-  const bg = new BaseGenerator()
-  await bg.prepare()
-  const configFileObject = bg.getFileObject('platformatic.json')
-  assert.ok(configFileObject)
-})
-
-test('should add questions in the correct position (before)', async (t) => {
-  const question = {
-    type: 'input',
-    name: 'serviceName',
-    message: 'What is the name of the service?'
-  }
-
-  const bg = new BaseGenerator({
-    type: 'service'
-  })
-
-  await bg.prepare()
-  const originalQuestionsLength = bg.questions.length
-  bg.addQuestion(question, { before: 'typescript' }) // should add as second question
-
-  assert.equal(bg.questions.length, originalQuestionsLength + 1)
-  assert.deepEqual(bg.questions[1], {
-    type: 'input',
-    name: 'serviceName',
-    message: 'What is the name of the service?'
-  })
-})
-
-test('should add questions in the correct position (after)', async (t) => {
-  const question = {
-    type: 'input',
-    name: 'serviceName',
-    message: 'What is the name of the service?'
-  }
-
-  const bg = new BaseGenerator({
-    type: 'service'
-  })
-
-  await bg.prepare()
-  const originalQuestionsLength = bg.questions.length
-  bg.addQuestion(question, { after: 'typescript' }) // should add as third question
-
-  assert.equal(bg.questions.length, originalQuestionsLength + 1)
-  assert.deepEqual(bg.questions[2], {
-    type: 'input',
-    name: 'serviceName',
-    message: 'What is the name of the service?'
-  })
-})
-
-test('should add questions at the end', async (t) => {
-  const question = {
-    type: 'input',
-    name: 'serviceName',
-    message: 'What is the name of the service?'
-  }
-
+test('should throw if preapare fails', async (t) => {
   const bg = new BaseGenerator({
-    type: 'service'
+    module: '@platformatic/service'
   })
 
-  await bg.prepare()
-  const originalQuestionsLength = bg.questions.length
-  bg.addQuestion(question)
-
-  assert.equal(bg.questions.length, originalQuestionsLength + 1)
-  assert.deepEqual(bg.questions[originalQuestionsLength], {
-    type: 'input',
-    name: 'serviceName',
-    message: 'What is the name of the service?'
-  })
-})
-
-test('should remove question', async (t) => {
-  const bg = new BaseGenerator()
-
-  await bg.prepare()
-
-  bg.removeQuestion('typescript')
-
-  bg.questions.forEach((question) => {
-    if (question.name === 'typescript') {
-      assert.fail()
-    }
-  })
-})
-
-test('should throw if preapare fails', async (t) => {
-  const bg = new BaseGenerator()
-
   bg._beforePrepare = async () => {
     throw new Error('beforePrepare error')
   }
@@ -337,7 +330,9 @@ test('should throw if preapare fails', async (t) => {
 })
 
 test('should throw if there is a missing env variable', async () => {
-  const bg = new BaseGenerator()
+  const bg = new BaseGenerator({
+    module: '@platformatic/service'
+  })
 
   bg._getConfigFileContents = async () => {
     return {
@@ -362,7 +357,9 @@ test('should throw if there is a missing env variable', async () => {
 })
 
 test('should add package', async () => {
-  const bg = new BaseGenerator()
+  const bg = new BaseGenerator({
+    module: '@platformatic/service'
+  })
 
   const packageDefinition = {
     name: '@my/package',
@@ -382,7 +379,9 @@ test('should add package', async () => {
 
 describe('runtime context', () => {
   test('should set config.envPrefix correctly', async (t) => {
-    const bg = new BaseGenerator()
+    const bg = new BaseGenerator({
+      module: '@platformatic/service'
+    })
 
     bg.setConfig({
       isRuntimeContext: true,
@@ -409,7 +408,9 @@ describe('runtime context', () => {
   })
 
   test('should generate correct env file from config.env', async (t) => {
-    const bg = new BaseGenerator()
+    const bg = new BaseGenerator({
+      module: '@platformatic/service'
+    })
 
     bg.setConfig({
       isRuntimeContext: true,
@@ -431,7 +432,7 @@ describe('runtime context', () => {
 
   test('should return service metadata', async (t) => {
     const bg = new BaseGenerator({
-      type: 'service'
+      module: '@platformatic/service'
     })
     // partial config with defaults
     bg.setConfig({
@@ -454,7 +455,7 @@ describe('runtime context', () => {
 
   test('should generate service name if not provided', async () => {
     const bg = new BaseGenerator({
-      type: 'service'
+      module: '@platformatic/service'
     })
     bg.setConfig({
       targetDirectory: '/foo/bar',