create-platformatic 1.10.0 → 1.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "1.10.0",
+  "version": "1.12.0",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -15,6 +15,7 @@
   "license": "Apache-2.0",
   "author": "Marco Piraccini <marco.piraccini@gmail.com>",
   "dependencies": {
+    "@types/node": "^20.8.10",
     "boring-name-generator": "^1.0.3",
     "chalk": "^5.3.0",
     "columnify": "^1.6.0",
@@ -35,7 +36,7 @@
     "strip-ansi": "^7.1.0",
     "undici": "^5.25.4",
     "which": "^3.0.1",
-    "@platformatic/config": "1.10.0"
+    "@platformatic/config": "1.12.0"
   },
   "devDependencies": {
     "ajv": "^8.12.0",
@@ -45,15 +46,14 @@
     "esmock": "^2.5.1",
     "snazzy": "^9.0.0",
     "standard": "^17.1.0",
-    "tap": "^16.3.9",
-    "typescript": "~5.2.2",
+    "typescript": "~5.3.0",
     "yaml": "^2.3.2",
-    "@platformatic/db": "1.10.0",
-    "@platformatic/service": "1.10.0"
+    "@platformatic/service": "1.12.0",
+    "@platformatic/db": "1.12.0"
   },
   "scripts": {
-    "test:cli": "tap --no-coverage test/cli/*test.mjs -t120",
-    "test:unit": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 tap --no-coverage test/*test.mjs test/*[!cli]/*test.mjs",
+    "test:cli": "node --test ./test/cli",
+    "test:unit": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 node --test ./test/unit",
     "test": "npm run test:unit && npm run test:cli",
     "lint": "standard | snazzy"
   }

package/src/cli-options.mjs

@@ -1,13 +1,3 @@
-export const getRunPackageManagerInstall = pkgManager => {
-  return {
-    type: 'list',
-    name: 'runPackageManagerInstall',
-    message: `Do you want to run ${pkgManager} install?`,
-    default: true,
-    choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-  }
-}
-
 export const getUseTypescript = typescript => {
   return {
     type: 'list',

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

@@ -10,7 +10,7 @@ import { execa } from 'execa'
 import ora from 'ora'
 import createComposer from './create-composer.mjs'
 import askDir from '../ask-dir.mjs'
-import { getRunPackageManagerInstall, getPort, getUseTypescript, getInitGitRepository } from '../cli-options.mjs'
+import { getPort, getUseTypescript, getInitGitRepository } from '../cli-options.mjs'
 import { createReadme } from '../create-readme.mjs'
 import { join } from 'path'
 
@@ -32,12 +32,14 @@ const createPlatformaticComposer = async (_args, opts) => {
 
   const args = parseArgs(_args, {
     default: {
-      hostname: '127.0.0.1'
+      hostname: '127.0.0.1',
+      install: true
     },
     alias: {
       h: 'hostname',
       p: 'port'
-    }
+    },
+    boolean: ['install']
   })
 
   const version = await getVersion()
@@ -63,9 +65,6 @@ const createPlatformaticComposer = async (_args, opts) => {
     }
   }
 
-  if (!opts.skipPackageJson) {
-    toAsk.push(getRunPackageManagerInstall(pkgManager))
-  }
   if (!opts.skipGitHubActions) {
     toAsk.push({
       type: 'list',
@@ -87,7 +86,6 @@ const createPlatformaticComposer = async (_args, opts) => {
     toAsk.push(getInitGitRepository())
   }
   const {
-    runPackageManagerInstall,
     servicesToCompose,
     port,
     staticWorkspaceGitHubAction,
@@ -130,7 +128,7 @@ const createPlatformaticComposer = async (_args, opts) => {
   }
   await createReadme(logger, projectDir, 'composer')
 
-  if (runPackageManagerInstall) {
+  if (args.install && !opts.skipPackageJson) {
     const spinner = ora('Installing dependencies...').start()
     await execa(pkgManager, ['install'], { cwd: projectDir })
     spinner.succeed()

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

@@ -11,7 +11,7 @@ import { execa } from 'execa'
 import ora from 'ora'
 import { getConnectionString, createDB } from './create-db.mjs'
 import askDir from '../ask-dir.mjs'
-import { getRunPackageManagerInstall, getUseTypescript, getPort, getInitGitRepository } from '../cli-options.mjs'
+import { getUseTypescript, getPort, getInitGitRepository } from '../cli-options.mjs'
 import { createReadme } from '../create-readme.mjs'
 import { join } from 'node:path'
 
@@ -34,7 +34,8 @@ export function parseDBArgs (_args) {
     default: {
       hostname: '127.0.0.1',
       database: 'sqlite',
-      migrations: 'migrations'
+      migrations: 'migrations',
+      install: true
     },
     alias: {
       h: 'hostname',
@@ -45,7 +46,7 @@ export function parseDBArgs (_args) {
       t: 'types',
       ts: 'typescript'
     },
-    boolean: ['plugin', 'types', 'typescript']
+    boolean: ['plugin', 'types', 'typescript', 'install']
   })
 }
 
@@ -68,11 +69,6 @@ const createPlatformaticDB = async (_args, opts) => {
   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',
     name: 'database',
@@ -208,7 +204,7 @@ const createPlatformaticDB = async (_args, opts) => {
   await createReadme(logger, projectDir, 'db')
 
   let hasPlatformaticInstalled = false
-  if (wizardOptions.runPackageManagerInstall) {
+  if (args.install && !opts.skipPackageJson) {
     const spinner = ora('Installing dependencies...').start()
     await execa(pkgManager, ['install'], { cwd: projectDir })
     spinner.succeed()
@@ -234,18 +230,20 @@ 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)
+    let migrationApplied = false
     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()
+        migrationApplied = true
       } catch (err) {
         logger.trace({ err })
         spinner.fail('Failed applying migrations! Try again by running "platformatic db migrations apply"')
       }
     }
-    if (generatePlugin) {
+    if (generatePlugin && migrationApplied) {
       const spinner = ora('Generating types...').start()
       try {
         await execa(pkgManager, ['exec', 'platformatic', 'db', 'types'], { cwd: projectDir })

package/src/db/create-db.mjs

@@ -376,7 +376,6 @@ export async function createDB (params, logger, currentDir, version) {
   const envSample = generateEnv(isRuntimeContext, hostname, port, getConnectionString(database), typescript, envPrefix)
   await appendFile(join(currentDir, '.env'), env)
   await writeFile(join(currentDir, '.env.sample'), envSample)
-  logger.info('Environment file .env found, appending new environment variables to existing .env file.')
 
   const migrationsFolderName = migrations
   if (createMigrations) {

package/src/index.mjs

@@ -97,6 +97,7 @@ const createPlatformatic = async (argv) => {
     }
 
     await say('\nAll done! Please open the project directory and check the README.')
+    await say('\nTo start your application run \'npm start\'.')
   }
 }
 

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

@@ -8,9 +8,10 @@ import pino from 'pino'
 import pretty from 'pino-pretty'
 import { execa } from 'execa'
 import ora from 'ora'
+import parseArgs from 'minimist'
 import createRuntime from './create-runtime.mjs'
 import askDir from '../ask-dir.mjs'
-import { getInitGitRepository, getPort, getRunPackageManagerInstall } from '../cli-options.mjs'
+import { getInitGitRepository, getPort } from '../cli-options.mjs'
 import generateName from 'boring-name-generator'
 import { chooseKind } from '../index.mjs'
 import { createReadme } from '../create-readme.mjs'
@@ -21,6 +22,13 @@ export async function createPlatformaticRuntime (_args) {
     ignore: 'hostname,pid'
   }))
 
+  const args = parseArgs(_args, {
+    default: {
+      install: true
+    },
+    boolean: ['install']
+  })
+
   const version = await getVersion()
   const pkgManager = getPkgManager()
 
@@ -40,11 +48,6 @@ export async function createPlatformaticRuntime (_args) {
     process.exit(1)
   }
 
-  toAsk.push(getRunPackageManagerInstall(pkgManager))
-  // const { runPackageManagerInstall } = await inquirer.prompt([
-  //   getRunPackageManagerInstall(pkgManager)
-  // ])
-
   toAsk.push({
     type: 'list',
     name: 'staticWorkspaceGitHubAction',
@@ -62,7 +65,6 @@ export async function createPlatformaticRuntime (_args) {
 
   toAsk.push(getInitGitRepository())
   const {
-    runPackageManagerInstall,
     staticWorkspaceGitHubAction,
     dynamicWorkspaceGitHubAction,
     initGitRepository
@@ -99,7 +101,7 @@ export async function createPlatformaticRuntime (_args) {
   if (addTypescriptDevDep) {
     const typescriptVersion = await getDependencyVersion('typescript')
     devDependencies.typescript = `^${typescriptVersion}`
-    devDependencies['@types/node'] = 'latest'
+    devDependencies['@types/node'] = await getDependencyVersion('@types/node')
   }
 
   // Create the package.json, notes that we don't have the option for TS (yet) so we don't generate
@@ -138,7 +140,7 @@ export async function createPlatformaticRuntime (_args) {
   }
 
   await createRuntime(params, logger, projectDir, version)
-  if (runPackageManagerInstall) {
+  if (args.install) {
     const spinner = ora('Installing dependencies...').start()
     await execa(pkgManager, ['install'], { cwd: projectDir })
     spinner.succeed()

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

@@ -11,7 +11,7 @@ import { execa } from 'execa'
 import ora from 'ora'
 import createService from './create-service.mjs'
 import askDir from '../ask-dir.mjs'
-import { getRunPackageManagerInstall, getUseTypescript, getPort, getInitGitRepository } from '../cli-options.mjs'
+import { getUseTypescript, getPort, getInitGitRepository } from '../cli-options.mjs'
 import { createReadme } from '../create-readme.mjs'
 
 const createPlatformaticService = async (_args, opts = {}) => {
@@ -22,12 +22,14 @@ const createPlatformaticService = async (_args, opts = {}) => {
 
   const args = parseArgs(_args, {
     default: {
-      hostname: '127.0.0.1'
+      hostname: '127.0.0.1',
+      install: true
     },
     alias: {
       h: 'hostname',
       p: 'port'
-    }
+    },
+    boolean: ['install']
   })
 
   const version = await getVersion()
@@ -43,10 +45,6 @@ const createPlatformaticService = async (_args, opts = {}) => {
     toAsk.push(getPort(args.port))
   }
 
-  if (!opts.skipPackageJson) {
-    toAsk.unshift(getRunPackageManagerInstall(pkgManager))
-  }
-
   if (!opts.skipGitHubActions) {
     toAsk.push({
       type: 'list',
@@ -67,7 +65,6 @@ const createPlatformaticService = async (_args, opts = {}) => {
     toAsk.push(getInitGitRepository())
   }
   const {
-    runPackageManagerInstall,
     useTypescript,
     port,
     staticWorkspaceGitHubAction,
@@ -106,7 +103,7 @@ const createPlatformaticService = async (_args, opts = {}) => {
   }
   await createReadme(logger, projectDir, 'service')
 
-  if (runPackageManagerInstall) {
+  if (args.install && !opts.skipPackageJson) {
     const spinner = ora('Installing dependencies...').start()
     await execa(pkgManager, ['install'], { cwd: projectDir })
     spinner.succeed()

package/src/service/create-service.mjs

@@ -99,7 +99,6 @@ async function createService (params, logger, currentDir = process.cwd(), versio
   const env = generateEnv(isRuntimeContext, hostname, port, typescript, envPrefix)
   await appendFile(join(currentDir, '.env'), env)
   await writeFile(join(currentDir, '.env.sample'), env)
-  logger.info('Environment file .env found, appending new environment variables to existing .env file.')
 
   if (typescript === true) {
     const tsConfigFileName = join(currentDir, 'tsconfig.json')

package/src/utils.mjs

@@ -4,10 +4,13 @@ import { resolve, join, dirname } from 'path'
 import { createRequire } from 'module'
 import semver from 'semver'
 import * as desm from 'desm'
+import * as url from 'url'
+
 import ConfigManager from '@platformatic/config'
 
 export const sleep = ms => new Promise((resolve) => setTimeout(resolve, ms))
 export const randomBetween = (min, max) => Math.floor(Math.random() * (max - min + 1) + min)
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 export async function isFileAccessible (filename, directory) {
   try {
@@ -73,21 +76,44 @@ export const findRuntimeConfigFile = async (directory) => (ConfigManager.findCon
  * @returns string
  */
 export const getDependencyVersion = async (dependencyName) => {
-  const require = createRequire(import.meta.url)
-  let dependencyPath = dirname(require.resolve(dependencyName))
-  // some deps are resolved not at their root level
-  // for instance 'typescript' will be risolved in its own ./lib directory
-  // next loop is to find the nearest parent directory that contains a package.json file
-  while (!await isFileAccessible(join(dependencyPath, 'package.json'))) {
-    dependencyPath = join(dependencyPath, '..')
-    if (dependencyPath === '/') {
-      throw new Error(`Cannot find package.json for ${dependencyName}`)
+  const rootPackageJson = join(__dirname, '..', 'package.json')
+  const packageJsonContents = JSON.parse(await readFile(rootPackageJson, 'utf8'))
+  const dependencies = packageJsonContents.dependencies
+  const devDependencies = packageJsonContents.devDependencies
+  const regexp = /(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)/
+  if (dependencies[dependencyName]) {
+    const match = dependencies[dependencyName].match(regexp)
+    if (!match) {
+      return await resolveWorkspaceDependency(dependencyName)
+    }
+    return match[0]
+  }
+
+  if (devDependencies[dependencyName]) {
+    const match = devDependencies[dependencyName].match(regexp)
+    if (!match) {
+      return await resolveWorkspaceDependency(dependencyName)
+    }
+    return match[0]
+  }
+
+  async function resolveWorkspaceDependency (dependencyName) {
+    const require = createRequire(import.meta.url)
+    let dependencyPath = dirname(require.resolve(dependencyName))
+    // some deps are resolved not at their root level
+    // for instance 'typescript' will be risolved in its own ./lib directory
+    // next loop is to find the nearest parent directory that contains a package.json file
+    while (!await isFileAccessible(join(dependencyPath, 'package.json'))) {
+      dependencyPath = join(dependencyPath, '..')
+      if (dependencyPath === '/') {
+        throw new Error(`Cannot find package.json for ${dependencyName}`)
+      }
     }
+    const pathToPackageJson = join(dependencyPath, 'package.json')
+    const packageJsonFile = await readFile(pathToPackageJson, 'utf-8')
+    const packageJson = JSON.parse(packageJsonFile)
+    return packageJson.version
   }
-  const pathToPackageJson = join(dependencyPath, 'package.json')
-  const packageJsonFile = await readFile(pathToPackageJson, 'utf-8')
-  const packageJson = JSON.parse(packageJsonFile)
-  return packageJson.version
 }
 
 export const minimumSupportedNodeVersions = ['18.8.0', '20.6.0']

package/.taprc

@@ -1 +0,0 @@
-jobs: 1