create-platformatic 1.1.0 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -32,9 +32,10 @@
     "pino-pretty": "^10.2.0",
     "pupa": "^3.1.0",
     "semver": "^7.5.4",
-    "undici": "^5.25.3",
+    "strip-ansi": "^7.1.0",
+    "undici": "^5.25.4",
     "which": "^3.0.1",
-    "@platformatic/config": "1.1.0"
+    "@platformatic/config": "1.2.0"
   },
   "devDependencies": {
     "ajv": "^8.12.0",
@@ -47,11 +48,12 @@
     "tap": "^16.3.9",
     "typescript": "~5.2.2",
     "yaml": "^2.3.2",
-    "@platformatic/service": "1.1.0",
-    "@platformatic/db": "1.1.0"
+    "@platformatic/db": "1.2.0",
+    "@platformatic/service": "1.2.0"
   },
   "scripts": {
-    "test": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 tap --no-coverage test/*test.mjs test/*/*test.mjs",
+    "test:cli": "tap --no-coverage test/cli/*test.mjs -t90",
+    "test": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 tap --no-coverage test/*test.mjs test/*[!cli]/*test.mjs && npm run test:cli",
     "lint": "standard | snazzy"
   }
 }

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

@@ -11,7 +11,7 @@ import { execa } from 'execa'
 import ora from 'ora'
 import createComposer from './create-composer.mjs'
 import askDir from '../ask-dir.mjs'
-import { getRunPackageManagerInstall, getPort } from '../cli-options.mjs'
+import { getRunPackageManagerInstall, getPort, getUseTypescript } from '../cli-options.mjs'
 import { createReadme } from '../create-readme.mjs'
 import { stat } from 'node:fs/promises'
 import { join } from 'path'
@@ -61,6 +61,7 @@ const createPlatformaticComposer = async (_args, opts) => {
   const portQuestion = getPort(args.port)
   portQuestion.when = !isRuntimeContext
   toAsk.push(portQuestion)
+  toAsk.push(getUseTypescript(args.typescript))
 
   if (isRuntimeContext) {
     const servicesNames = opts.runtimeContext.servicesNames.filter(
@@ -95,7 +96,8 @@ const createPlatformaticComposer = async (_args, opts) => {
     servicesToCompose,
     port,
     staticWorkspaceGitHubAction,
-    dynamicWorkspaceGitHubAction
+    dynamicWorkspaceGitHubAction,
+    useTypescript
   } = await inquirer.prompt(toAsk)
 
   // Create the project directory
@@ -108,7 +110,8 @@ const createPlatformaticComposer = async (_args, opts) => {
     servicesToCompose,
     staticWorkspaceGitHubAction,
     dynamicWorkspaceGitHubAction,
-    runtimeContext: opts.runtimeContext
+    runtimeContext: opts.runtimeContext,
+    typescript: useTypescript
   }
 
   await createComposer(
@@ -123,7 +126,7 @@ const createPlatformaticComposer = async (_args, opts) => {
   // 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
   if (!opts.skipPackageJson) {
-    await createPackageJson(version, fastifyVersion, logger, projectDir, false)
+    await createPackageJson(version, fastifyVersion, logger, projectDir, useTypescript)
   }
   if (!opts.skipGitignore) {
     await createGitignore(logger, projectDir)

package/src/composer/create-composer.mjs

@@ -4,8 +4,11 @@ import { join } from 'path'
 import * as desm from 'desm'
 import { generatePlugins, generateRouteWithTypesSupport } from '../create-plugins.mjs'
 import { createDynamicWorkspaceGHAction, createStaticWorkspaceGHAction } from '../ghaction.mjs'
+import { getTsConfig } from '../get-tsconfig.mjs'
 
-function generateConfig (isRuntimeContext, version, servicesToCompose, envPrefix) {
+const TS_OUT_DIR = 'dist'
+
+function generateConfig (isRuntimeContext, version, servicesToCompose, typescript, envPrefix) {
   const config = {
     $schema: `https://platformatic.dev/schemas/v${version}/composer`,
     composer: {
@@ -35,9 +38,7 @@ function generateConfig (isRuntimeContext, version, servicesToCompose, envPrefix
         level: '{PLT_SERVER_LOGGER_LEVEL}'
       }
     }
-  }
-
-  if (isRuntimeContext) {
+  } else {
     config.composer.services = servicesToCompose.map((serviceName) => {
       return {
         id: serviceName,
@@ -49,10 +50,14 @@ function generateConfig (isRuntimeContext, version, servicesToCompose, envPrefix
     })
   }
 
+  if (typescript === true && config.plugins) {
+    config.plugins.typescript = `{PLT_${envPrefix}TYPESCRIPT}`
+  }
+
   return config
 }
 
-function generateEnv (isRuntimeContext, hostname, port, envPrefix) {
+function generateEnv (isRuntimeContext, hostname, port, typescript, envPrefix) {
   let env = ''
 
   if (!isRuntimeContext) {
@@ -64,6 +69,13 @@ PLT_SERVER_LOGGER_LEVEL=info`
   env += `
 PLT_${envPrefix}EXAMPLE_ORIGIN=
 `
+  if (typescript === true) {
+    env += `\
+# Set to false to disable automatic typescript compilation.
+# Changing this setting is needed for production
+PLT_${envPrefix}TYPESCRIPT=true
+`
+  }
   return env
 }
 
@@ -71,11 +83,18 @@ async function createComposer (
   params,
   logger,
   currentDir = process.cwd(),
-  version,
-  staticWorkspaceGitHubAction,
-  dynamicWorkspaceGitHubAction
+  version
 ) {
-  const { isRuntimeContext, hostname, port, servicesToCompose = [], runtimeContext } = params
+  const {
+    isRuntimeContext,
+    hostname,
+    port,
+    servicesToCompose = [],
+    runtimeContext,
+    typescript,
+    staticWorkspaceGitHubAction,
+    dynamicWorkspaceGitHubAction
+  } = params
 
   const composerEnv = {
     PLT_SERVER_LOGGER_LEVEL: 'info',
@@ -91,11 +110,11 @@ async function createComposer (
   if (accessibleConfigFilename === undefined) {
     const envPrefix = runtimeContext !== undefined ? `${runtimeContext.envPrefix}_` : ''
 
-    const config = generateConfig(isRuntimeContext, version, servicesToCompose, envPrefix)
+    const config = generateConfig(isRuntimeContext, version, servicesToCompose, typescript, 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, envPrefix)
+    const env = generateEnv(isRuntimeContext, hostname, port, typescript, envPrefix)
     const envFileExists = await isFileAccessible('.env', currentDir)
     await appendFile(join(currentDir, '.env'), env)
     await writeFile(join(currentDir, '.env.sample'), env)
@@ -108,14 +127,24 @@ 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)
+  await generatePlugins(logger, currentDir, typescript, 'composer')
+  await generateRouteWithTypesSupport(logger, currentDir, true)
+
+  if (typescript === true) {
+    const tsConfigFileName = join(currentDir, 'tsconfig.json')
+    const tsConfig = getTsConfig(TS_OUT_DIR)
+    await writeFile(tsConfigFileName, JSON.stringify(tsConfig, null, 2))
+    logger.info(`Typescript configuration file ${tsConfigFileName} successfully created.`)
+
+    // TODO: global.d.ts is needed to compile the project. Still need to populate it
+    await writeFile(join(currentDir, 'global.d.ts'), '')
+  }
 
   if (staticWorkspaceGitHubAction) {
-    await createStaticWorkspaceGHAction(logger, composerEnv, './platformatic.service.json', currentDir, false)
+    await createStaticWorkspaceGHAction(logger, composerEnv, './platformatic.service.json', currentDir, typescript)
   }
   if (dynamicWorkspaceGitHubAction) {
-    await createDynamicWorkspaceGHAction(logger, composerEnv, './platformatic.service.json', currentDir, false)
+    await createDynamicWorkspaceGHAction(logger, composerEnv, './platformatic.service.json', currentDir, typescript)
   }
 
   return composerEnv

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

@@ -170,7 +170,7 @@ const createPlatformaticDB = async (_args, opts) => {
     choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
   })
 
-  // Promtp for questions
+  // Prompt for questions
   const wizardOptions = await inquirer.prompt(toAsk)
 
   await mkdir(projectDir, { recursive: true })

package/src/db/create-db.mjs

@@ -298,7 +298,7 @@ function generateConfig (isRuntimeContext, migrations, plugin, types, typescript
     }
   }
 
-  if (typescript === true) {
+  if (typescript === true && config.plugins) {
     config.plugins.typescript = `{PLT_${envPrefix}TYPESCRIPT}`
   }
 
@@ -418,14 +418,9 @@ export async function createDB (params, logger, currentDir, version) {
 
   if (typescript === true) {
     const tsConfigFileName = join(currentDir, 'tsconfig.json')
-    const isTsConfigExists = await isFileAccessible(tsConfigFileName)
-    if (!isTsConfigExists) {
-      const tsConfig = getTsConfig(TS_OUT_DIR)
-      await writeFile(tsConfigFileName, JSON.stringify(tsConfig, null, 2))
-      logger.info(`Typescript configuration file ${tsConfigFileName} successfully created.`)
-    } else {
-      logger.info(`Typescript configuration file ${tsConfigFileName} found, skipping creation of typescript configuration file.`)
-    }
+    const tsConfig = getTsConfig(TS_OUT_DIR)
+    await writeFile(tsConfigFileName, JSON.stringify(tsConfig, null, 2))
+    logger.info(`Typescript configuration file ${tsConfigFileName} successfully created.`)
   }
 
   if (plugin) {