create-platformatic 1.8.1 → 1.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "1.8.1",
+  "version": "1.10.0",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -35,7 +35,7 @@
     "strip-ansi": "^7.1.0",
     "undici": "^5.25.4",
     "which": "^3.0.1",
-    "@platformatic/config": "1.8.1"
+    "@platformatic/config": "1.10.0"
   },
   "devDependencies": {
     "ajv": "^8.12.0",
@@ -48,8 +48,8 @@
     "tap": "^16.3.9",
     "typescript": "~5.2.2",
     "yaml": "^2.3.2",
-    "@platformatic/service": "1.8.1",
-    "@platformatic/db": "1.8.1"
+    "@platformatic/db": "1.10.0",
+    "@platformatic/service": "1.10.0"
   },
   "scripts": {
     "test:cli": "tap --no-coverage test/cli/*test.mjs -t120",

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

@@ -135,6 +135,11 @@ const createPlatformaticComposer = async (_args, opts) => {
     await execa(pkgManager, ['install'], { cwd: projectDir })
     spinner.succeed()
   }
+
+  // returns metadata that can be used to make some further actions
+  return {
+    typescript: useTypescript
+  }
 }
 
 export default createPlatformaticComposer

package/src/create-package-json.mjs

@@ -47,11 +47,12 @@ const packageJsonTemplate = async (addTSBuild, fastifyVersion, platVersion) => {
  * @param {object} scripts Package.json scripts list
  * @param {object} dependencies Package.json dependencies list
  */
-export const createPackageJson = async (platVersion, fastifyVersion, logger, dir, addTSBuild = false, scripts = {}, dependencies = {}) => {
+export const createPackageJson = async (platVersion, fastifyVersion, logger, dir, addTSBuild = false, scripts = {}, dependencies = {}, devDependencies = {}) => {
   const packageJsonFileName = join(dir, 'package.json')
   const pkg = await packageJsonTemplate(addTSBuild, fastifyVersion, platVersion)
   Object.assign(pkg.scripts, scripts)
   Object.assign(pkg.dependencies, dependencies)
+  Object.assign(pkg.devDependencies, devDependencies)
   await writeFile(packageJsonFileName, JSON.stringify(pkg, null, 2))
   logger.debug(`${packageJsonFileName} successfully created.`)
 }

package/src/create-plugins.mjs

@@ -116,9 +116,13 @@ function testHelperTS (mod, customizations = { pre: '', post: '', config: '', re
 import { join } from 'node:path'
 import { readFile } from 'node:fs/promises'
 import { buildServer } from '@platformatic/${mod}'
+import { test } from 'node:test'
 ${customizations.requires}
 
-export async function getServer (t) {
+type testfn = Parameters<typeof test>[0]
+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'))

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

@@ -256,6 +256,10 @@ const createPlatformaticDB = async (_args, opts) => {
       }
     }
   }
+  // returns metadata that can be used to make some further actions
+  return {
+    typescript: useTypescript
+  }
 }
 
 export default createPlatformaticDB

package/src/get-tsconfig.mjs

@@ -8,6 +8,7 @@ export function getTsConfig (outDir) {
       pretty: true,
       noEmitOnError: true,
       incremental: true,
+      strict: true,
       outDir
     },
     watchOptions: {

package/src/ghaction.mjs

@@ -99,6 +99,13 @@ ${envBlock}
 
 export const staticWorkspaceGHTemplate = (env, config, buildTS = false) => {
   const envString = envAsString(env, 3)
+  let envBlock = ''
+  if (envString.length) {
+    envBlock = `
+    env:
+${envString}
+    `
+  }
 
   return `name: Deploy Platformatic application to the cloud
 on:
@@ -116,8 +123,7 @@ jobs:
     permissions:
       contents: read
     runs-on: ubuntu-latest
-    env:
-${envString}
+${envBlock}
     steps:
       - name: Checkout application project repository
         uses: actions/checkout@v3

package/src/index.mjs

@@ -31,14 +31,11 @@ export async function chooseKind (argv, opts = {}) {
 
   switch (options.type) {
     case 'db':
-      await createPlatformaticDB(argv, opts)
-      break
+      return await createPlatformaticDB(argv, opts)
     case 'service':
-      await createPlatformaticService(argv, opts)
-      break
+      return await createPlatformaticService(argv, opts)
     case 'composer':
-      await createPlatformaticComposer(argv, opts)
-      break
+      return await createPlatformaticComposer(argv, opts)
     case 'runtime':
       await createPlatformaticRuntime(argv, opts)
       break

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

@@ -72,20 +72,15 @@ export async function createPlatformaticRuntime (_args) {
 
   const fastifyVersion = await getDependencyVersion('fastify')
 
-  // Create the package.json, notes that we don't have the option for TS (yet) so we don't generate
-  // the package.json with the TS build
-  await createPackageJson(version, fastifyVersion, logger, projectDir, false)
-  await createGitignore(logger, projectDir)
-  await createReadme(logger, projectDir, 'runtime')
-
   logger.info('Let\'s create a first service!')
 
   const names = []
+  let addTypescriptDevDep = false
   while (true) {
-    if (!await createRuntimeService({ servicesDir, names, logger })) {
-      continue
+    const serviceData = await createRuntimeService({ servicesDir, names, logger })
+    if (!addTypescriptDevDep && serviceData.typescript) {
+      addTypescriptDevDep = true
     }
-
     const { shouldBreak } = await inquirer.prompt([
       {
         type: 'list',
@@ -100,6 +95,18 @@ export async function createPlatformaticRuntime (_args) {
       break
     }
   }
+  const devDependencies = {}
+  if (addTypescriptDevDep) {
+    const typescriptVersion = await getDependencyVersion('typescript')
+    devDependencies.typescript = `^${typescriptVersion}`
+    devDependencies['@types/node'] = 'latest'
+  }
+
+  // Create the package.json, notes that we don't have the option for TS (yet) so we don't generate
+  // the package.json with the TS build
+  await createPackageJson(version, fastifyVersion, logger, projectDir, false, {}, {}, devDependencies)
+  await createGitignore(logger, projectDir)
+  await createReadme(logger, projectDir, 'runtime')
 
   let entrypoint = ''
 
@@ -126,7 +133,8 @@ export async function createPlatformaticRuntime (_args) {
     staticWorkspaceGitHubAction,
     dynamicWorkspaceGitHubAction,
     serviceNames: names,
-    initGitRepository
+    initGitRepository,
+    typescript: addTypescriptDevDep
   }
 
   await createRuntime(params, logger, projectDir, version)
@@ -168,7 +176,7 @@ export async function createRuntimeService ({ servicesDir, names, logger }) {
 
   const serviceDir = join(servicesDir, name)
 
-  await chooseKind([], {
+  const serviceData = await chooseKind([], {
     skip: 'runtime',
     serviceName: name,
     dir: serviceDir,
@@ -185,5 +193,5 @@ export async function createRuntimeService ({ servicesDir, names, logger }) {
     }
   })
 
-  return true
+  return serviceData
 }

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

@@ -122,5 +122,9 @@ const createPlatformaticService = async (_args, opts = {}) => {
     logger.trace({ err })
     spinner.fail('Failed to generate Types. Try again by running "platformatic service types"')
   }
+  // returns metadata that can be used to make some further actions
+  return {
+    typescript: useTypescript
+  }
 }
 export default createPlatformaticService

package/src/utils.mjs

@@ -74,7 +74,17 @@ export const findRuntimeConfigFile = async (directory) => (ConfigManager.findCon
  */
 export const getDependencyVersion = async (dependencyName) => {
   const require = createRequire(import.meta.url)
-  const pathToPackageJson = join(dirname(require.resolve(dependencyName)), 'package.json')
+  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