create-platformatic 1.0.0 → 1.1.0

package/create-platformatic.mjs

@@ -24,7 +24,7 @@ if (isMain(import.meta)) {
   })
 
   if (args.version) {
-    console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'))).version)
+    console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'), 'utf8')).version)
     process.exit(0)
   }
   await createPlatformatic(_args)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -16,39 +16,39 @@
   "author": "Marco Piraccini <marco.piraccini@gmail.com>",
   "dependencies": {
     "boring-name-generator": "^1.0.3",
-    "chalk": "^5.2.0",
+    "chalk": "^5.3.0",
     "columnify": "^1.6.0",
     "commist": "^3.2.0",
     "desm": "^1.3.0",
-    "es-main": "^1.2.0",
-    "execa": "^8.0.0",
-    "fastify": "^4.18.0",
+    "es-main": "^1.3.0",
+    "execa": "^8.0.1",
+    "fastify": "^4.23.2",
     "help-me": "^4.2.0",
-    "inquirer": "^9.2.7",
+    "inquirer": "^9.2.11",
     "log-update": "^5.0.1",
     "minimist": "^1.2.8",
     "ora": "^6.3.1",
-    "pino": "^8.14.1",
-    "pino-pretty": "^10.0.0",
+    "pino": "^8.15.3",
+    "pino-pretty": "^10.2.0",
     "pupa": "^3.1.0",
-    "semver": "^7.5.1",
-    "undici": "^5.22.1",
+    "semver": "^7.5.4",
+    "undici": "^5.25.3",
     "which": "^3.0.1",
-    "@platformatic/config": "1.0.0"
+    "@platformatic/config": "1.1.0"
   },
   "devDependencies": {
     "ajv": "^8.12.0",
-    "c8": "^8.0.0",
+    "c8": "^8.0.1",
     "cross-env": "^7.0.3",
-    "dotenv": "^16.1.4",
-    "esmock": "^2.3.1",
+    "dotenv": "^16.3.1",
+    "esmock": "^2.5.1",
     "snazzy": "^9.0.0",
     "standard": "^17.1.0",
-    "tap": "^16.3.6",
-    "typescript": "~5.2.0",
-    "yaml": "^2.3.1",
-    "@platformatic/service": "1.0.0",
-    "@platformatic/db": "1.0.0"
+    "tap": "^16.3.9",
+    "typescript": "~5.2.2",
+    "yaml": "^2.3.2",
+    "@platformatic/service": "1.1.0",
+    "@platformatic/db": "1.1.0"
   },
   "scripts": {
     "test": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 tap --no-coverage test/*test.mjs test/*/*test.mjs",

package/src/ask-dir.mjs

@@ -1,3 +1,5 @@
+'use strict'
+
 import inquirer from 'inquirer'
 import { resolve } from 'path'
 

package/src/cli-options.mjs

@@ -19,16 +19,6 @@ export const getUseTypescript = typescript => {
   }
 }
 
-export const getOverwriteReadme = () => {
-  return {
-    type: 'list',
-    name: 'shouldReplace',
-    message: 'Do you want to overwrite the existing README.md?',
-    default: true,
-    choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-  }
-}
-
 let port = 3042
 export const getPort = (nextPort) => {
   if (nextPort === undefined) {

package/src/composer/create-composer-cli.mjs

@@ -1,39 +1,20 @@
-import { getVersion, getDependencyVersion, isFileAccessible } from '../utils.mjs'
+import { getVersion, getDependencyVersion } from '../utils.mjs'
 import { createPackageJson } from '../create-package-json.mjs'
 import { createGitignore } from '../create-gitignore.mjs'
 import { getPkgManager } from '../get-pkg-manager.mjs'
 import parseArgs from 'minimist'
-import { join } from 'path'
 import inquirer from 'inquirer'
-import { readFile, writeFile, mkdir } from 'fs/promises'
+import { mkdir } from 'fs/promises'
 import pino from 'pino'
 import pretty from 'pino-pretty'
 import { execa } from 'execa'
 import ora from 'ora'
 import createComposer from './create-composer.mjs'
 import askDir from '../ask-dir.mjs'
-import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
-import { getRunPackageManagerInstall, getPort, getOverwriteReadme } from '../cli-options.mjs'
-
-export const createReadme = async (logger, dir = '.') => {
-  const readmeFileName = join(dir, 'README.md')
-  let isReadmeExists = await isFileAccessible(readmeFileName)
-  if (isReadmeExists) {
-    logger.debug(`${readmeFileName} found, asking to overwrite it.`)
-    const { shouldReplace } = await inquirer.prompt([getOverwriteReadme()])
-    isReadmeExists = !shouldReplace
-  }
-
-  if (isReadmeExists) {
-    logger.debug(`${readmeFileName} found, skipping creation of README.md file.`)
-    return
-  }
-
-  const readmeFile = new URL('README.md', import.meta.url)
-  const readme = await readFile(readmeFile, 'utf-8')
-  await writeFile(readmeFileName, readme)
-  logger.debug(`${readmeFileName} successfully created.`)
-}
+import { getRunPackageManagerInstall, getPort } from '../cli-options.mjs'
+import { createReadme } from '../create-readme.mjs'
+import { stat } from 'node:fs/promises'
+import { join } from 'path'
 
 export const getServicesToCompose = (servicesNames) => {
   return {
@@ -64,14 +45,22 @@ const createPlatformaticComposer = async (_args, opts) => {
   const version = await getVersion()
   const pkgManager = getPkgManager()
 
-  const projectDir = opts.dir || await askDir(logger, '.')
+  const projectDir = opts.dir || await askDir(logger, join('.', 'platformatic-composer'))
+  // checks directory
+  try {
+    await stat(projectDir)
+    logger.error(`Directory ${projectDir} already exists. Please choose another path.`)
+    process.exit(1)
+  } catch (err) {}
+
   const isRuntimeContext = opts.isRuntimeContext || false
 
   const toAsk = []
 
-  if (!isRuntimeContext) {
-    toAsk.push(getPort(args.port))
-  }
+  // Ask for port if not in runtime context
+  const portQuestion = getPort(args.port)
+  portQuestion.when = !isRuntimeContext
+  toAsk.push(portQuestion)
 
   if (isRuntimeContext) {
     const servicesNames = opts.runtimeContext.servicesNames.filter(
@@ -85,11 +74,28 @@ const createPlatformaticComposer = async (_args, opts) => {
   if (!opts.skipPackageJson) {
     toAsk.push(getRunPackageManagerInstall(pkgManager))
   }
-
+  if (!opts.skipGitHubActions) {
+    toAsk.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 }]
+    })
+  }
   const {
     runPackageManagerInstall,
     servicesToCompose,
-    port
+    port,
+    staticWorkspaceGitHubAction,
+    dynamicWorkspaceGitHubAction
   } = await inquirer.prompt(toAsk)
 
   // Create the project directory
@@ -99,10 +105,13 @@ const createPlatformaticComposer = async (_args, opts) => {
     isRuntimeContext,
     hostname: args.hostname,
     port,
-    servicesToCompose
+    servicesToCompose,
+    staticWorkspaceGitHubAction,
+    dynamicWorkspaceGitHubAction,
+    runtimeContext: opts.runtimeContext
   }
 
-  const env = await createComposer(
+  await createComposer(
     params,
     logger,
     projectDir,
@@ -119,17 +128,12 @@ const createPlatformaticComposer = async (_args, opts) => {
   if (!opts.skipGitignore) {
     await createGitignore(logger, projectDir)
   }
-  await createReadme(logger, projectDir)
+  await createReadme(logger, projectDir, 'composer')
 
   if (runPackageManagerInstall) {
     const spinner = ora('Installing dependencies...').start()
     await execa(pkgManager, ['install'], { cwd: projectDir })
-    spinner.succeed('...done!')
-  }
-
-  if (!opts.skipGitHubActions) {
-    await askStaticWorkspaceGHAction(logger, env, 'composer', false, projectDir)
-    await askDynamicWorkspaceCreateGHAction(logger, env, 'composer', false, projectDir)
+    spinner.succeed()
   }
 }
 

package/src/composer/create-composer.mjs

@@ -2,21 +2,29 @@ import { readFile, writeFile, appendFile } from 'fs/promises'
 import { findComposerConfigFile, isFileAccessible } from '../utils.mjs'
 import { join } from 'path'
 import * as desm from 'desm'
+import { generatePlugins, generateRouteWithTypesSupport } from '../create-plugins.mjs'
+import { createDynamicWorkspaceGHAction, createStaticWorkspaceGHAction } from '../ghaction.mjs'
 
-function generateConfig (isRuntimeContext, version, servicesToCompose) {
+function generateConfig (isRuntimeContext, version, servicesToCompose, envPrefix) {
   const config = {
     $schema: `https://platformatic.dev/schemas/v${version}/composer`,
     composer: {
       services: [{
         id: 'example',
-        origin: '{PLT_EXAMPLE_ORIGIN}',
+        origin: `{PLT_${envPrefix}EXAMPLE_ORIGIN}`,
         openapi: {
           url: '/documentation/json'
         }
       }],
       refreshTimeout: 1000
     },
-    watch: true
+    watch: true,
+    plugins: {
+      paths: [
+        { path: './plugins', encapsulate: false },
+        './routes'
+      ]
+    }
   }
 
   if (!isRuntimeContext) {
@@ -44,18 +52,18 @@ function generateConfig (isRuntimeContext, version, servicesToCompose) {
   return config
 }
 
-function generateEnv (isRuntimeContext, hostname, port) {
+function generateEnv (isRuntimeContext, hostname, port, envPrefix) {
   let env = ''
 
   if (!isRuntimeContext) {
     env += `\
 PLT_SERVER_HOSTNAME=${hostname}
 PORT=${port}
-PLT_SERVER_LOGGER_LEVEL=info
-PLT_EXAMPLE_ORIGIN=
-`
+PLT_SERVER_LOGGER_LEVEL=info`
   }
-
+  env += `
+PLT_${envPrefix}EXAMPLE_ORIGIN=
+`
   return env
 }
 
@@ -63,10 +71,17 @@ async function createComposer (
   params,
   logger,
   currentDir = process.cwd(),
-  version
+  version,
+  staticWorkspaceGitHubAction,
+  dynamicWorkspaceGitHubAction
 ) {
-  const { isRuntimeContext, hostname, port, servicesToCompose = [] } = params
+  const { isRuntimeContext, hostname, port, servicesToCompose = [], runtimeContext } = params
 
+  const composerEnv = {
+    PLT_SERVER_LOGGER_LEVEL: 'info',
+    PORT: port,
+    PLT_SERVER_HOSTNAME: hostname
+  }
   if (!version) {
     const pkg = await readFile(desm.join(import.meta.url, '..', '..', 'package.json'))
     version = JSON.parse(pkg).version
@@ -74,11 +89,13 @@ async function createComposer (
   const accessibleConfigFilename = await findComposerConfigFile(currentDir)
 
   if (accessibleConfigFilename === undefined) {
-    const config = generateConfig(isRuntimeContext, version, servicesToCompose)
+    const envPrefix = runtimeContext !== undefined ? `${runtimeContext.envPrefix}_` : ''
+
+    const config = generateConfig(isRuntimeContext, version, servicesToCompose, envPrefix)
     await writeFile(join(currentDir, 'platformatic.composer.json'), JSON.stringify(config, null, 2))
     logger.info('Configuration file platformatic.composer.json successfully created.')
 
-    const env = generateEnv(isRuntimeContext, hostname, port)
+    const env = generateEnv(isRuntimeContext, hostname, port, envPrefix)
     const envFileExists = await isFileAccessible('.env', currentDir)
     await appendFile(join(currentDir, '.env'), env)
     await writeFile(join(currentDir, '.env.sample'), env)
@@ -91,12 +108,17 @@ async function createComposer (
   } else {
     logger.info(`Configuration file ${accessibleConfigFilename} found, skipping creation of configuration file.`)
   }
+  await generatePlugins(logger, currentDir, false, 'composer')
+  await generateRouteWithTypesSupport(logger, currentDir, false)
 
-  return {
-    PLT_SERVER_LOGGER_LEVEL: 'info',
-    PORT: port,
-    PLT_SERVER_HOSTNAME: hostname
+  if (staticWorkspaceGitHubAction) {
+    await createStaticWorkspaceGHAction(logger, composerEnv, './platformatic.service.json', currentDir, false)
+  }
+  if (dynamicWorkspaceGitHubAction) {
+    await createDynamicWorkspaceGHAction(logger, composerEnv, './platformatic.service.json', currentDir, false)
   }
+
+  return composerEnv
 }
 
 export default createComposer

package/src/create-package-json.mjs

@@ -14,7 +14,8 @@ const packageJsonTemplate = async (addTSBuild, fastifyVersion, platVersion) => {
 
   const pkg = {
     scripts: {
-      start: 'platformatic start'
+      start: 'platformatic start',
+      test: 'node --test test/**'
     },
     devDependencies: {
       fastify: `^${fastifyVersion}`

package/src/create-readme.mjs

@@ -0,0 +1,12 @@
+'use strict'
+import { readFile, writeFile } from 'fs/promises'
+import { join as desmJoin } from 'desm'
+import { join } from 'path'
+
+export const createReadme = async (logger, dir = '.', type) => {
+  const readmeFileTarget = join(dir, 'README.md')
+  const readmeFileSource = desmJoin(import.meta.url, type, 'README.md')
+  const readme = await readFile(readmeFileSource, 'utf-8')
+  await writeFile(readmeFileTarget, readme)
+  logger.debug(`${readmeFileTarget} successfully created.`)
+}

package/src/db/create-db-cli.mjs

@@ -1,20 +1,20 @@
-import { getVersion, getDependencyVersion, isFileAccessible } from '../utils.mjs'
+import { getVersion, getDependencyVersion } from '../utils.mjs'
 import { createPackageJson } from '../create-package-json.mjs'
 import { createGitignore } from '../create-gitignore.mjs'
 import { getPkgManager } from '../get-pkg-manager.mjs'
 import parseArgs from 'minimist'
-import { join } from 'path'
 import inquirer from 'inquirer'
 import which from 'which'
-import { readFile, writeFile, mkdir } from 'fs/promises'
+import { mkdir, stat } from 'fs/promises'
 import pino from 'pino'
 import pretty from 'pino-pretty'
 import { execa } from 'execa'
 import ora from 'ora'
 import { getConnectionString, createDB } from './create-db.mjs'
 import askDir from '../ask-dir.mjs'
-import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
-import { getRunPackageManagerInstall, getUseTypescript, getPort, getOverwriteReadme } from '../cli-options.mjs'
+import { getRunPackageManagerInstall, getUseTypescript, getPort } from '../cli-options.mjs'
+import { createReadme } from '../create-readme.mjs'
+import { join } from 'node:path'
 
 const databases = [{
   value: 'sqlite',
@@ -30,26 +30,6 @@ const databases = [{
   name: 'MariaDB'
 }]
 
-export const createReadme = async (logger, dir = '.') => {
-  const readmeFileName = join(dir, 'README.md')
-  let isReadmeExists = await isFileAccessible(readmeFileName)
-  if (isReadmeExists) {
-    logger.debug(`${readmeFileName} found, asking to overwrite it.`)
-    const { shouldReplace } = await inquirer.prompt([getOverwriteReadme()])
-    isReadmeExists = !shouldReplace
-  }
-
-  if (isReadmeExists) {
-    logger.debug(`${readmeFileName} found, skipping creation of README.md file.`)
-    return
-  }
-
-  const readmeFile = new URL('README.md', import.meta.url)
-  const readme = await readFile(readmeFile, 'utf-8')
-  await writeFile(readmeFileName, readme)
-  logger.debug(`${readmeFileName} successfully created.`)
-}
-
 export function parseDBArgs (_args) {
   return parseArgs(_args, {
     default: {
@@ -79,8 +59,27 @@ const createPlatformaticDB = async (_args, opts) => {
   const args = parseDBArgs(_args)
   const version = await getVersion()
   const pkgManager = getPkgManager()
-  const projectDir = opts.dir || await askDir(logger, '.')
+  const projectDir = opts.dir || await askDir(logger, join('.', 'platformatic-db'))
+
+  // Create the project directory
+  try {
+    await stat(projectDir)
+    logger.error(`Directory ${projectDir} already exists. Please choose another path.`)
+    process.exit(1)
+  } catch (err) {}
+
   const isRuntimeContext = opts.isRuntimeContext || false
+  const toAsk = []
+
+  // Ask for port if not in runtime context
+  const portQuestion = getPort(args.port)
+  portQuestion.when = !isRuntimeContext
+  toAsk.push(portQuestion)
+
+  // Ask to install deps
+  const installDepsQuestion = getRunPackageManagerInstall(pkgManager)
+  installDepsQuestion.when = !opts.skipPackageJson
+  toAsk.push(installDepsQuestion)
 
   const { database } = await inquirer.prompt({
     type: 'list',
@@ -123,16 +122,27 @@ const createPlatformaticDB = async (_args, opts) => {
       break
     }
   }
-  const wizardPrompts = [{
+
+  toAsk.push({
     type: 'list',
     name: 'defaultMigrations',
     message: 'Do you want to create default migrations?',
     default: true,
     choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-  }]
+  })
+  toAsk.push({
+    type: 'list',
+    name: 'applyMigrations',
+    message: 'Do you want to apply migrations?',
+    default: true,
+    choices: [{ name: 'yes', value: true }, { name: 'no', value: false }],
+    when: (answers) => {
+      return answers.defaultMigrations
+    }
+  })
 
   if (args.plugin === false) {
-    wizardPrompts.push({
+    toAsk.push({
       type: 'list',
       name: 'generatePlugin',
       message: 'Do you want to create a plugin?',
@@ -140,13 +150,29 @@ const createPlatformaticDB = async (_args, opts) => {
       choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
     })
   }
-  const wizardOptions = await inquirer.prompt(wizardPrompts, getUseTypescript(args.typescript))
-  if (!isRuntimeContext) {
-    const { port } = await inquirer.prompt([getPort(args.port)])
-    wizardOptions.port = port
-  }
 
-  // Create the project directory
+  toAsk.push(getUseTypescript(args.typescript))
+
+  toAsk.push({
+    type: 'list',
+    name: 'staticWorkspaceGitHubAction',
+    message: 'Do you want to create the github action to deploy this application to Platformatic Cloud?',
+    default: true,
+    when: !opts.skipGitHubActions,
+    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,
+    when: !opts.skipGitHubActions,
+    choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+  })
+
+  // Promtp for questions
+  const wizardOptions = await inquirer.prompt(toAsk)
+
   await mkdir(projectDir, { recursive: true })
 
   const generatePlugin = args.plugin || wizardOptions.generatePlugin
@@ -162,10 +188,13 @@ const createPlatformaticDB = async (_args, opts) => {
     migrations: wizardOptions.defaultMigrations ? args.migrations : '',
     plugin: generatePlugin,
     types: useTypes,
-    typescript: useTypescript
+    typescript: useTypescript,
+    staticWorkspaceGitHubAction: wizardOptions.staticWorkspaceGitHubAction,
+    dynamicWorkspaceGitHubAction: wizardOptions.dynamicWorkspaceGitHubAction,
+    runtimeContext: opts.runtimeContext
   }
 
-  const env = await createDB(params, logger, projectDir, version)
+  await createDB(params, logger, projectDir, version)
 
   const fastifyVersion = await getDependencyVersion('fastify')
 
@@ -181,25 +210,19 @@ const createPlatformaticDB = async (_args, opts) => {
   // Create the package.json, .gitignore, readme
   await createPackageJson(version, fastifyVersion, logger, projectDir, useTypescript, scripts, dependencies)
   await createGitignore(logger, projectDir)
-  await createReadme(logger, projectDir)
+  await createReadme(logger, projectDir, 'db')
 
   let hasPlatformaticInstalled = false
-  if (!opts.skipPackageJson) {
-    const { runPackageManagerInstall } = await inquirer.prompt([
-      getRunPackageManagerInstall(pkgManager)
-    ])
-
-    if (runPackageManagerInstall) {
-      const spinner = ora('Installing dependencies...').start()
-      await execa(pkgManager, ['install'], { cwd: projectDir })
-      spinner.succeed('...done!')
-      hasPlatformaticInstalled = true
-    }
+  if (wizardOptions.runPackageManagerInstall) {
+    const spinner = ora('Installing dependencies...').start()
+    await execa(pkgManager, ['install'], { cwd: projectDir })
+    spinner.succeed()
+    hasPlatformaticInstalled = true
   }
 
   if (!hasPlatformaticInstalled) {
     try {
-      const npmLs = JSON.parse(await execa('npm', ['ls', '--json']))
+      const npmLs = JSON.parse(await execa('npm', ['ls', '--json']).toString())
       hasPlatformaticInstalled = !!npmLs.dependencies.platformatic
     } catch {
       // Ignore all errors, this can fail
@@ -216,43 +239,28 @@ const createPlatformaticDB = async (_args, opts) => {
     // - run the migrations
     // - generate types
     // if we don't generate migrations, we don't ask to apply them (the folder might not exist)
-    if (wizardOptions.defaultMigrations) {
-      const { applyMigrations } = await inquirer.prompt([{
-        type: 'list',
-        name: 'applyMigrations',
-        message: 'Do you want to apply migrations?',
-        default: true,
-        choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-      }])
-
-      if (applyMigrations) {
-        const spinner = ora('Applying migrations...').start()
-        // We need to apply migrations using the platformatic installed in the project
-        try {
-          await execa(pkgManager, ['exec', 'platformatic', 'db', 'migrations', 'apply'], { cwd: projectDir })
-          spinner.succeed('...done!')
-        } catch (err) {
-          logger.trace({ err })
-          spinner.fail('...failed! Try again by running "platformatic db migrations apply"')
-        }
+    if (wizardOptions.defaultMigrations && wizardOptions.applyMigrations) {
+      const spinner = ora('Applying migrations...').start()
+      // We need to apply migrations using the platformatic installed in the project
+      try {
+        await execa(pkgManager, ['exec', 'platformatic', 'db', 'migrations', 'apply'], { cwd: projectDir })
+        spinner.succeed()
+      } catch (err) {
+        logger.trace({ err })
+        spinner.fail('Failed applying migrations! Try again by running "platformatic db migrations apply"')
       }
     }
     if (generatePlugin) {
       const spinner = ora('Generating types...').start()
       try {
         await execa(pkgManager, ['exec', 'platformatic', 'db', 'types'], { cwd: projectDir })
-        spinner.succeed('...done!')
+        spinner.succeed()
       } catch (err) {
         logger.trace({ err })
-        spinner.fail('...failed! Try again by running "platformatic db types"')
+        spinner.fail('Failed to generate Types. Try again by running "platformatic service types"')
       }
     }
   }
-
-  if (!opts.skipGitHubActions) {
-    await askStaticWorkspaceGHAction(logger, env, 'db', useTypescript, projectDir)
-    await askDynamicWorkspaceCreateGHAction(logger, env, 'db', useTypescript, projectDir)
-  }
 }
 
 export default createPlatformaticDB