create-platformatic 0.33.1 → 0.34.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "0.33.1",
+  "version": "0.34.0",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -34,7 +34,7 @@
     "semver": "^7.5.1",
     "undici": "^5.22.1",
     "which": "^3.0.1",
-    "@platformatic/config": "0.33.1"
+    "@platformatic/config": "0.34.0"
   },
   "devDependencies": {
     "ajv": "^8.12.0",
@@ -47,8 +47,8 @@
     "tap": "^16.3.6",
     "typescript": "~5.1.6",
     "yaml": "^2.3.1",
-    "@platformatic/db": "0.33.1",
-    "@platformatic/service": "0.33.1"
+    "@platformatic/db": "0.34.0",
+    "@platformatic/service": "0.34.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/create-package-json.mjs

@@ -3,8 +3,15 @@ import { writeFile, readFile } from 'fs/promises'
 import { join } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
+/**
+ * Creates a package.json template file
+ * @param {boolean} addTSBuild Whether to add TS Build or not
+ * @param {string} fastifyVersion Fastify Version
+ * @param {string} platVersion Platformatic Version
+ */
 const packageJsonTemplate = async (addTSBuild, fastifyVersion, platVersion) => {
   const __dirname = fileURLToPath(new URL('.', import.meta.url))
+
   const pkg = {
     scripts: {
       start: 'platformatic start'
@@ -38,13 +45,15 @@ const packageJsonTemplate = async (addTSBuild, fastifyVersion, platVersion) => {
  * @param {string} dir Target directory where to create the file
  * @param {boolean} addTSBuild Whether to add TS Build or not
  * @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 = {}) => {
+export const createPackageJson = async (platVersion, fastifyVersion, logger, dir, addTSBuild = false, scripts = {}, dependencies = {}) => {
   const packageJsonFileName = join(dir, 'package.json')
   const isPackageJsonExists = await isFileAccessible(packageJsonFileName)
   if (!isPackageJsonExists) {
     const pkg = await packageJsonTemplate(addTSBuild, fastifyVersion, platVersion)
     Object.assign(pkg.scripts, scripts)
+    Object.assign(pkg.dependencies, dependencies)
     await writeFile(packageJsonFileName, JSON.stringify(pkg, null, 2))
     logger.debug(`${packageJsonFileName} successfully created.`)
   } else {

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

@@ -169,8 +169,12 @@ const createPlatformaticDB = async (_args, opts) => {
     migrate: 'platformatic db migrations apply'
   }
 
+  const dependencies = {
+    '@platformatic/db': `^${version}`
+  }
+
   // Create the package.json, .gitignore, readme
-  await createPackageJson(version, fastifyVersion, logger, projectDir, useTypescript, scripts)
+  await createPackageJson(version, fastifyVersion, logger, projectDir, useTypescript, scripts, dependencies)
   await createGitignore(logger, projectDir)
   await createReadme(logger, projectDir)
 

package/src/db/create-db.mjs

@@ -203,12 +203,17 @@ export async function createDB ({ hostname, database = 'sqlite', port, migration
     await generatePluginWithTypesSupport(logger, currentDir, typescript)
   }
 
-  return {
+  const output = {
     DATABASE_URL: connectionString,
     PLT_SERVER_LOGGER_LEVEL: 'info',
     PORT: port,
     PLT_SERVER_HOSTNAME: hostname
   }
+
+  if (typescript) {
+    output.PLT_TYPESCRIPT = true
+  }
+  return output
 }
 
 export default createDB

package/src/ghaction.mjs

@@ -3,12 +3,13 @@ import inquirer from 'inquirer'
 import { isFileAccessible } from './utils.mjs'
 import { writeFile, mkdir } from 'fs/promises'
 import columnify from 'columnify'
-function envAsString (env) {
+function envAsString (env, indent) {
+  const spaces = Array(indent * 2).join(' ')
   return Object.keys(env).reduce((acc, key) => {
     if (key === 'DATABASE_URL') {
-      acc += `          ${key}: \${{ secrets.DATABASE_URL }}\n`
+      acc += `${spaces}${key}: \${{ secrets.DATABASE_URL }}\n`
     } else {
-      acc += `          ${key}: ${env[key]} \n`
+      acc += `${spaces}${key}: ${env[key]} \n`
     }
 
     return acc
@@ -31,7 +32,7 @@ function formatSecretsToAdd (secrets) {
   return output
 }
 export const dynamicWorkspaceGHTemplate = (env, config, buildTS = false) => {
-  const envString = envAsString(env)
+  const envString = envAsString(env, 3)
 
   return `name: Deploy Platformatic application to the cloud
 on:
@@ -46,6 +47,8 @@ jobs:
       contents: read
       pull-requests: write
     runs-on: ubuntu-latest
+    env:
+${envString}
     steps:
       - name: Checkout application project repository
         uses: actions/checkout@v3
@@ -62,13 +65,11 @@ jobs:
           platformatic_workspace_id: \${{ secrets.PLATFORMATIC_DYNAMIC_WORKSPACE_ID }}
           platformatic_workspace_key: \${{ secrets.PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY }}
           platformatic_config_path: ${config}
-        env:
-${envString}
 `
 }
 
 export const staticWorkspaceGHTemplate = (env, config, buildTS = false) => {
-  const envString = envAsString(env)
+  const envString = envAsString(env, 3)
 
   return `name: Deploy Platformatic application to the cloud
 on:
@@ -84,6 +85,8 @@ jobs:
     permissions:
       contents: read
     runs-on: ubuntu-latest
+    env:
+${envString}
     steps:
       - name: Checkout application project repository
         uses: actions/checkout@v3
@@ -100,8 +103,6 @@ jobs:
           platformatic_workspace_id: \${{ secrets.PLATFORMATIC_STATIC_WORKSPACE_ID }}
           platformatic_workspace_key: \${{ secrets.PLATFORMATIC_STATIC_WORKSPACE_API_KEY }}
           platformatic_config_path: ${config}
-        env:
-${envString}
 `
 }
 

package/src/service/create-service.mjs

@@ -180,12 +180,15 @@ async function createService ({ hostname, port, typescript = false }, logger, cu
   } else {
     logger.info('Routes folder "routes" found, skipping creation of routes folder.')
   }
-
-  return {
+  const output = {
     PLT_SERVER_LOGGER_LEVEL: 'info',
     PORT: port,
     PLT_SERVER_HOSTNAME: hostname
   }
+  if (typescript) {
+    output.PLT_TYPESCRIPT = true
+  }
+  return output
 }
 
 export default createService

package/test/create-package-json.test.mjs

@@ -23,7 +23,12 @@ afterEach(() => {
 test('creates package.json file for db project', async ({ equal }) => {
   const version = '1.2.3'
   const fastifyVersion = '4.5.6'
-  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, false)
+  const addTSBuild = false
+  const scripts = {}
+  const dependencies = {
+    '@platformatic/db': `^${version}`
+  }
+  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, addTSBuild, scripts, dependencies)
   equal(log, `${join(tmpDir, 'package.json')} successfully created.`)
   const accessible = await isFileAccessible(join(tmpDir, 'package.json'))
   equal(accessible, true)
@@ -31,13 +36,15 @@ test('creates package.json file for db project', async ({ equal }) => {
   equal(packageJson.scripts.start, 'platformatic start')
   equal(packageJson.scripts.build, undefined)
   equal(packageJson.dependencies.platformatic, `^${version}`)
+  equal(packageJson.dependencies['@platformatic/db'], `^${version}`)
   equal(packageJson.devDependencies.fastify, `^${fastifyVersion}`)
 })
 
 test('creates package.json file for service project', async ({ equal }) => {
   const version = '1.2.3'
   const fastifyVersion = '4.5.6'
-  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, false)
+  const addTSBuild = false
+  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, addTSBuild)
   equal(log, `${join(tmpDir, 'package.json')} successfully created.`)
   const accessible = await isFileAccessible(join(tmpDir, 'package.json'))
   equal(accessible, true)
@@ -50,16 +57,18 @@ test('creates package.json file for service project', async ({ equal }) => {
 test('do not create package.json file because already present', async ({ equal }) => {
   const version = '1.2.3'
   const fastifyVersion = '4.5.6'
+  const addTSBuild = false
   const packagejson = join(tmpDir, 'package.json')
   writeFileSync(packagejson, 'TEST')
-  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, false)
+  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, addTSBuild)
   equal(log, `${join(tmpDir, 'package.json')} found, skipping creation of package.json file.`)
 })
 
 test('creates package.json file with TS build', async ({ equal }) => {
   const version = '1.2.3'
   const fastifyVersion = '4.5.6'
-  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, true)
+  const addTSBuild = true
+  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, addTSBuild)
   equal(log, `${join(tmpDir, 'package.json')} successfully created.`)
   const accessible = await isFileAccessible(join(tmpDir, 'package.json'))
   equal(accessible, true)

package/test/db/create-db.test.mjs

@@ -181,6 +181,7 @@ test('creates project with typescript', async ({ equal, same }) => {
   equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
   equal(process.env.PORT, '6666')
   equal(process.env.DATABASE_URL, 'sqlite://./db.sqlite')
+  equal(process.env.PLT_TYPESCRIPT, 'true')
   process.env = {}
 
   const pathToDbEnvSampleFile = join(tmpDir, '.env.sample')

package/test/ghaction-dynamic.test.mjs

@@ -36,13 +36,13 @@ test('creates gh action', async ({ equal, match }) => {
   equal(accessible, true)
   const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'), 'utf8')
   const ghAction = parse(ghFile)
-  const { steps, permissions } = ghAction.jobs.build_and_deploy
+  const { steps, permissions, env: jobEnv } = ghAction.jobs.build_and_deploy
   equal(steps.length, 3)
   equal(steps[0].name, 'Checkout application project repository')
   equal(steps[1].name, 'npm install --omit=dev')
   equal(steps[2].name, 'Deploy project')
-  match(steps[2].env.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
-  equal(steps[2].env.PLT_SERVER_LOGGER_LEVEL, 'info')
+  match(jobEnv.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
+  equal(jobEnv.PLT_SERVER_LOGGER_LEVEL, 'info')
 
   equal(permissions.contents, 'read')
   equal(permissions['pull-requests'], 'write')
@@ -55,14 +55,14 @@ test('creates gh action with TS build step', async ({ equal, match }) => {
   equal(accessible, true)
   const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'), 'utf8')
   const ghAction = parse(ghFile)
-  const { steps, permissions } = ghAction.jobs.build_and_deploy
+  const { steps, permissions, env: jobEnv } = ghAction.jobs.build_and_deploy
   equal(steps.length, 4)
   equal(steps[0].name, 'Checkout application project repository')
   equal(steps[1].name, 'npm install --omit=dev')
   equal(steps[2].name, 'Build project')
   equal(steps[3].name, 'Deploy project')
-  match(steps[3].env.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
-  equal(steps[3].env.PLT_SERVER_LOGGER_LEVEL, 'info')
+  match(jobEnv.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
+  equal(jobEnv.PLT_SERVER_LOGGER_LEVEL, 'info')
 
   equal(permissions.contents, 'read')
   equal(permissions['pull-requests'], 'write')

package/test/ghaction-static.test.mjs

@@ -36,13 +36,14 @@ test('creates gh action', async ({ equal, match }) => {
   equal(accessible, true)
   const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'), 'utf8')
   const ghAction = parse(ghFile)
-  const { steps, permissions } = ghAction.jobs.build_and_deploy
+  const { steps, permissions, env: jobEnv } = ghAction.jobs.build_and_deploy
+
   equal(steps.length, 3)
   equal(steps[0].name, 'Checkout application project repository')
   equal(steps[1].name, 'npm install --omit=dev')
   equal(steps[2].name, 'Deploy project')
-  match(steps[2].env.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
-  equal(steps[2].env.PLT_SERVER_LOGGER_LEVEL, 'info')
+  match(jobEnv.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
+  equal(jobEnv.PLT_SERVER_LOGGER_LEVEL, 'info')
 
   equal(permissions.contents, 'read')
 })
@@ -54,14 +55,14 @@ test('creates gh action with TS build step', async ({ equal, match }) => {
   equal(accessible, true)
   const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'), 'utf8')
   const ghAction = parse(ghFile)
-  const { steps, permissions } = ghAction.jobs.build_and_deploy
+  const { steps, permissions, env: jobEnv } = ghAction.jobs.build_and_deploy
   equal(steps.length, 4)
   equal(steps[0].name, 'Checkout application project repository')
   equal(steps[1].name, 'npm install --omit=dev')
   equal(steps[2].name, 'Build project')
   equal(steps[3].name, 'Deploy project')
-  match(steps[3].env.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
-  equal(steps[3].env.PLT_SERVER_LOGGER_LEVEL, 'info')
+  match(jobEnv.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
+  equal(jobEnv.PLT_SERVER_LOGGER_LEVEL, 'info')
 
   equal(permissions.contents, 'read')
 })

package/test/service/create-service.test.mjs

@@ -52,12 +52,15 @@ test('creates service with typescript', async ({ equal, same, ok }) => {
   dotenv.config({ path: pathToDbEnvFile })
   equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
   equal(process.env.PORT, '6666')
+  equal(process.env.PLT_TYPESCRIPT, 'true')
+
   process.env = {}
 
   const pathToDbEnvSampleFile = join(tmpDir, '.env.sample')
   dotenv.config({ path: pathToDbEnvSampleFile })
   equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
   equal(process.env.PORT, '6666')
+  equal(process.env.PLT_TYPESCRIPT, 'true')
 
   same(plugins.paths, [{ path: './plugins', encapsulate: false }, './routes'])
   equal(plugins.typescript, '{PLT_TYPESCRIPT}')