create-platformatic 0.29.0 → 0.30.1

package/create-platformatic.mjs

@@ -36,4 +36,6 @@ export {
   createStaticWorkspaceGHAction,
   createDynamicWorkspaceGHAction
 } from './src/ghaction.mjs'
+
 export { createGitignore, createPackageJson, getDependencyVersion, getVersion } from './src/index.mjs'
+export { default as createService } from './src/service/create-service.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "0.29.0",
+  "version": "0.30.1",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -17,6 +17,7 @@
   "dependencies": {
     "boring-name-generator": "^1.0.3",
     "chalk": "^5.2.0",
+    "columnify": "^1.6.0",
     "commist": "^3.2.0",
     "desm": "^1.3.0",
     "es-main": "^1.2.0",
@@ -33,7 +34,7 @@
     "semver": "^7.5.1",
     "undici": "^5.22.1",
     "which": "^3.0.1",
-    "@platformatic/config": "0.29.0"
+    "@platformatic/config": "0.30.1"
   },
   "devDependencies": {
     "ajv": "^8.12.0",
@@ -45,8 +46,8 @@
     "standard": "^17.1.0",
     "tap": "^16.3.6",
     "yaml": "^2.3.1",
-    "@platformatic/db": "0.29.0",
-    "@platformatic/service": "0.29.0"
+    "@platformatic/db": "0.30.1",
+    "@platformatic/service": "0.30.1"
   },
   "scripts": {
     "test": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 tap --no-coverage test/*test.mjs test/*/*test.mjs",

package/src/get-tsconfig.mjs

@@ -3,10 +3,11 @@ export function getTsConfig (outDir) {
     compilerOptions: {
       module: 'commonjs',
       esModuleInterop: true,
-      target: 'es2019',
+      target: 'es2020',
       sourceMap: true,
       pretty: true,
       noEmitOnError: true,
+      incremental: true,
       outDir
     },
     watchOptions: {

package/src/ghaction.mjs

@@ -2,12 +2,36 @@ import { join } from 'path'
 import inquirer from 'inquirer'
 import { isFileAccessible } from './utils.mjs'
 import { writeFile, mkdir } from 'fs/promises'
+import columnify from 'columnify'
+function envAsString (env) {
+  return Object.keys(env).reduce((acc, key) => {
+    if (key === 'DATABASE_URL') {
+      acc += `          ${key}: \${{ secrets.DATABASE_URL }}\n`
+    } else {
+      acc += `          ${key}: ${env[key]} \n`
+    }
 
-export const dynamicWorkspaceGHTemplate = (env, config, buildTS = false) => {
-  const envAsStr = Object.keys(env).reduce((acc, key) => {
-    acc += `          ${key}: ${env[key]} \n`
     return acc
   }, '')
+}
+
+function formatSecretsToAdd (secrets) {
+  const output = columnify(secrets, {
+    showHeaders: false,
+    columnSplitter: ': ',
+    config: {
+      key: {
+        align: 'right'
+      },
+      value: {
+        align: 'left'
+      }
+    }
+  })
+  return output
+}
+export const dynamicWorkspaceGHTemplate = (env, config, buildTS = false) => {
+  const envString = envAsString(env)
 
   return `name: Deploy Platformatic application to the cloud
 on:
@@ -39,15 +63,12 @@ jobs:
           platformatic_workspace_key: \${{ secrets.PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY }}
           platformatic_config_path: ${config}
         env:
-${envAsStr}
+${envString}
 `
 }
 
 export const staticWorkspaceGHTemplate = (env, config, buildTS = false) => {
-  const envAsStr = Object.keys(env).reduce((acc, key) => {
-    acc += `          ${key}: ${env[key]} \n`
-    return acc
-  }, '')
+  const envString = envAsString(env)
 
   return `name: Deploy Platformatic application to the cloud
 on:
@@ -80,7 +101,7 @@ jobs:
           platformatic_workspace_key: \${{ secrets.PLATFORMATIC_STATIC_WORKSPACE_API_KEY }}
           platformatic_config_path: ${config}
         env:
-${envAsStr}
+${envString}
 `
 }
 
@@ -91,7 +112,13 @@ export const createDynamicWorkspaceGHAction = async (logger, env, config, projec
   if (!isGithubActionExists) {
     await mkdir(join(projectDir, '.github', 'workflows'), { recursive: true })
     await writeFile(ghActionFilePath, dynamicWorkspaceGHTemplate(env, config, buildTS))
-    logger.info('Github action successfully created, please add PLATFORMATIC_DYNAMIC_WORKSPACE_ID and PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY as repository secrets.')
+    logger.info('Github action successfully created, please add the following secrets as repository secrets: ')
+    const secretsString = formatSecretsToAdd({
+      PLATFORMATIC_DYNAMIC_WORKSPACE_ID: 'your workspace id',
+      PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY: 'your workspace API key',
+      DATABASE_URL: env.DATABASE_URL
+    })
+    logger.info(`\n ${secretsString}`)
     const isGitDir = await isFileAccessible('.git', projectDir)
     if (!isGitDir) {
       logger.warn('No git repository found. The Github action won\'t be triggered.')
@@ -126,7 +153,13 @@ export const createStaticWorkspaceGHAction = async (logger, env, config, project
   if (!isGithubActionExists) {
     await mkdir(join(projectDir, '.github', 'workflows'), { recursive: true })
     await writeFile(ghActionFilePath, staticWorkspaceGHTemplate(env, config, buildTS))
-    logger.info('Github action successfully created, please add PLATFORMATIC_STATIC_WORKSPACE_ID and PLATFORMATIC_STATIC_WORKSPACE_API_KEY as repository secret.')
+    logger.info('Github action successfully created, please add the following secrets as repository secrets: ')
+    const secretsString = formatSecretsToAdd({
+      PLATFORMATIC_STATIC_WORKSPACE_ID: 'your workspace id',
+      PLATFORMATIC_STATIC_WORKSPACE_API_KEY: 'your workspace API key',
+      DATABASE_URL: env.DATABASE_URL
+    })
+    logger.info(`\n ${secretsString}`)
     const isGitDir = await isFileAccessible('.git', projectDir)
     if (!isGitDir) {
       logger.warn('No git repository found. The Github action won\'t be triggered.')

package/test/ghaction-dynamic.test.mjs

@@ -29,9 +29,9 @@ const env = {
   PLT_SERVER_LOGGER_LEVEL: 'info'
 }
 
-test('creates gh action', async ({ end, equal }) => {
+test('creates gh action', async ({ equal, match }) => {
   await createDynamicWorkspaceGHAction(fakeLogger, env, 'db', tmpDir, false)
-  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_DYNAMIC_WORKSPACE_ID and PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY as repository secrets.')
+  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
   const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'))
   equal(accessible, true)
   const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'), 'utf8')
@@ -41,16 +41,16 @@ test('creates gh action', async ({ end, equal }) => {
   equal(steps[0].name, 'Checkout application project repository')
   equal(steps[1].name, 'npm install --omit=dev')
   equal(steps[2].name, 'Deploy project')
-  equal(steps[2].env.DATABASE_URL, 'mydbconnectionstring')
+  match(steps[2].env.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
   equal(steps[2].env.PLT_SERVER_LOGGER_LEVEL, 'info')
 
   equal(permissions.contents, 'read')
   equal(permissions['pull-requests'], 'write')
 })
 
-test('creates gh action with TS build step', async ({ end, equal }) => {
+test('creates gh action with TS build step', async ({ equal, match }) => {
   await createDynamicWorkspaceGHAction(fakeLogger, env, 'db', tmpDir, true)
-  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_DYNAMIC_WORKSPACE_ID and PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY as repository secrets.')
+  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
   const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'))
   equal(accessible, true)
   const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'), 'utf8')
@@ -61,7 +61,7 @@ test('creates gh action with TS build step', async ({ end, equal }) => {
   equal(steps[1].name, 'npm install --omit=dev')
   equal(steps[2].name, 'Build project')
   equal(steps[3].name, 'Deploy project')
-  equal(steps[3].env.DATABASE_URL, 'mydbconnectionstring')
+  match(steps[3].env.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
   equal(steps[3].env.PLT_SERVER_LOGGER_LEVEL, 'info')
 
   equal(permissions.contents, 'read')
@@ -78,17 +78,21 @@ test('do not create gitignore file because already present', async ({ end, equal
 
 test('creates gh action with a warn if a .git folder is not present', async ({ end, equal }) => {
   await createDynamicWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
-  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_DYNAMIC_WORKSPACE_ID and PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY as repository secrets.')
+  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
   const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'))
   equal(accessible, true)
-  equal(log[1], 'No git repository found. The Github action won\'t be triggered.')
+  const secretsLogLine = log[1].split('\n')
+  equal(secretsLogLine[1].trim(), 'PLATFORMATIC_DYNAMIC_WORKSPACE_ID: your workspace id')
+  equal(secretsLogLine[2].trim(), 'PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY: your workspace API key')
+  equal(secretsLogLine[3].trim(), 'DATABASE_URL: mydbconnectionstring')
+  equal(log[2], 'No git repository found. The Github action won\'t be triggered.')
 })
 
 test('creates gh action without a warn if a .git folder is present', async ({ end, equal }) => {
   await mkdir(join(tmpDir, '.git'), { recursive: true })
   await createDynamicWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
-  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_DYNAMIC_WORKSPACE_ID and PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY as repository secrets.')
+  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
   const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'))
   equal(accessible, true)
-  equal(log.length, 1)
+  equal(log.length, 2)
 })

package/test/ghaction-static.test.mjs

@@ -29,9 +29,9 @@ const env = {
   PLT_SERVER_LOGGER_LEVEL: 'info'
 }
 
-test('creates gh action', async ({ end, equal }) => {
+test('creates gh action', async ({ equal, match }) => {
   await createStaticWorkspaceGHAction(fakeLogger, env, 'db', tmpDir, false)
-  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_STATIC_WORKSPACE_ID and PLATFORMATIC_STATIC_WORKSPACE_API_KEY as repository secret.')
+  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
   const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'))
   equal(accessible, true)
   const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'), 'utf8')
@@ -41,15 +41,15 @@ test('creates gh action', async ({ end, equal }) => {
   equal(steps[0].name, 'Checkout application project repository')
   equal(steps[1].name, 'npm install --omit=dev')
   equal(steps[2].name, 'Deploy project')
-  equal(steps[2].env.DATABASE_URL, 'mydbconnectionstring')
+  match(steps[2].env.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
   equal(steps[2].env.PLT_SERVER_LOGGER_LEVEL, 'info')
 
   equal(permissions.contents, 'read')
 })
 
-test('creates gh action with TS build step', async ({ end, equal }) => {
+test('creates gh action with TS build step', async ({ equal, match }) => {
   await createStaticWorkspaceGHAction(fakeLogger, env, 'db', tmpDir, true)
-  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_STATIC_WORKSPACE_ID and PLATFORMATIC_STATIC_WORKSPACE_API_KEY as repository secret.')
+  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
   const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'))
   equal(accessible, true)
   const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'), 'utf8')
@@ -60,7 +60,7 @@ test('creates gh action with TS build step', async ({ end, equal }) => {
   equal(steps[1].name, 'npm install --omit=dev')
   equal(steps[2].name, 'Build project')
   equal(steps[3].name, 'Deploy project')
-  equal(steps[3].env.DATABASE_URL, 'mydbconnectionstring')
+  match(steps[3].env.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
   equal(steps[3].env.PLT_SERVER_LOGGER_LEVEL, 'info')
 
   equal(permissions.contents, 'read')
@@ -76,17 +76,21 @@ test('do not create gitignore file because already present', async ({ end, equal
 
 test('creates gh action with a warn if a .git folder is not present', async ({ end, equal }) => {
   await createStaticWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
-  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_STATIC_WORKSPACE_ID and PLATFORMATIC_STATIC_WORKSPACE_API_KEY as repository secret.')
+  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
   const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'))
   equal(accessible, true)
-  equal(log[1], 'No git repository found. The Github action won\'t be triggered.')
+  const secretsLogLine = log[1].split('\n')
+  equal(secretsLogLine[1].trim(), 'PLATFORMATIC_STATIC_WORKSPACE_ID: your workspace id')
+  equal(secretsLogLine[2].trim(), 'PLATFORMATIC_STATIC_WORKSPACE_API_KEY: your workspace API key')
+  equal(secretsLogLine[3].trim(), 'DATABASE_URL: mydbconnectionstring')
+  equal(log[2], 'No git repository found. The Github action won\'t be triggered.')
 })
 
 test('creates gh action without a warn if a .git folder is present', async ({ end, equal }) => {
   await mkdir(join(tmpDir, '.git'), { recursive: true })
   await createStaticWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
-  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_STATIC_WORKSPACE_ID and PLATFORMATIC_STATIC_WORKSPACE_API_KEY as repository secret.')
+  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
   const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'))
   equal(accessible, true)
-  equal(log.length, 1)
+  equal(log.length, 2)
 })