create-platformatic 0.11.0 → 0.12.1

package/README.md

@@ -1,11 +1,11 @@
-# @platformatic/create-platformatic-db
+# create-platformatic
 
 Platformatic Creator
 
 ## Usage
 
 ```sh
-npm create platformatic-db
+npm create platformatic
 ```
 
 ## License

package/create-platformatic.mjs

@@ -29,3 +29,6 @@ if (isMain(import.meta)) {
   }
   await createPlatformatic(_args)
 }
+
+export { default as createDB } from './src/db/create-db.mjs'
+export { parseDBArgs } from './src/db/create-db-cli.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "0.11.0",
+  "version": "0.12.1",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -14,32 +14,32 @@
   },
   "author": "Marco Piraccini <marco.piraccini@gmail.com>",
   "dependencies": {
-    "chalk": "^5.1.2",
-    "commist": "^3.1.2",
-    "desm": "^1.2.0",
+    "chalk": "^5.2.0",
+    "commist": "^3.2.0",
+    "desm": "^1.3.0",
     "es-main": "^1.2.0",
     "execa": "^6.1.0",
-    "fastify": "^4.6.0",
-    "help-me": "^4.1.0",
+    "fastify": "^4.10.2",
+    "help-me": "^4.2.0",
     "inquirer": "^9.1.4",
     "log-update": "^5.0.1",
     "minimist": "^1.2.7",
     "mkdirp": "^1.0.4",
     "ora": "^6.1.2",
-    "pino": "^8.4.1",
-    "pino-pretty": "^9.0.0",
+    "pino": "^8.8.0",
+    "pino-pretty": "^9.1.1",
     "pupa": "^3.1.0",
-    "undici": "^5.13.0"
+    "undici": "^5.14.0"
   },
   "devDependencies": {
     "c8": "^7.12.0",
-    "dotenv": "^16.0.1",
+    "dotenv": "^16.0.3",
     "esmock": "^2.1.0",
     "semver": "^7.3.8",
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
-    "tap": "^16.0.0",
-    "yaml": "^2.1.1"
+    "tap": "^16.3.2",
+    "yaml": "^2.1.3"
   },
   "scripts": {
     "test": "standard | snazzy && NODE_OPTIONS=--loader=esmock c8 --100 tap --no-coverage test/*test.mjs test/*/*test.mjs"

package/src/create-package-json.mjs

@@ -3,10 +3,13 @@ import { isFileAccessible } from './utils.mjs'
 import { writeFile } from 'fs/promises'
 import { join } from 'node:path'
 
-const packageJsonTemplate = `\
+const packageJsonTemplate = (addTSBuild = false) => (`\
 {
   "scripts": {
-    "start": "platformatic {type} start"
+    "start": "platformatic {type} start"${addTSBuild
+? `,
+    "build": "npx tsc"`
+: ''}
   },
   "devDependencies": {
     "fastify": "^{fastifyVersion}"
@@ -17,13 +20,13 @@ const packageJsonTemplate = `\
   "engines": {
     "node": "^16.17.0 || ^18.8.0 || >=19"
   }
-}`
+}`)
 
-export const createPackageJson = async (type, platVersion, fastifyVersion, logger, dir = '.') => {
+export const createPackageJson = async (type, platVersion, fastifyVersion, logger, dir, addTSBuild = false) => {
   const packageJsonFileName = join(dir, 'package.json')
   const isPackageJsonExists = await isFileAccessible(packageJsonFileName)
   if (!isPackageJsonExists) {
-    const packageJson = pupa(packageJsonTemplate, { platVersion, fastifyVersion, type })
+    const packageJson = pupa(packageJsonTemplate(addTSBuild), { platVersion, fastifyVersion, type })
     await writeFile(packageJsonFileName, packageJson)
     logger.debug(`${packageJsonFileName} successfully created.`)
   } else {

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

@@ -28,13 +28,8 @@ export const createReadme = async (logger, dir = '.') => {
   }
 }
 
-const createPlatformaticDB = async (_args) => {
-  const logger = pino(pretty({
-    translateTime: 'SYS:HH:MM:ss',
-    ignore: 'hostname,pid'
-  }))
-
-  const args = parseArgs(_args, {
+export const parseDBArgs = (_args) => {
+  return parseArgs(_args, {
     default: {
       hostname: '127.0.0.1',
       port: 3042,
@@ -55,10 +50,17 @@ const createPlatformaticDB = async (_args) => {
     },
     boolean: ['plugin', 'types', 'typescript']
   })
+}
 
+const createPlatformaticDB = async (_args) => {
+  const logger = pino(pretty({
+    translateTime: 'SYS:HH:MM:ss',
+    ignore: 'hostname,pid'
+  }))
+
+  const args = parseDBArgs(_args)
   const version = await getVersion()
   const pkgManager = getPkgManager()
-
   const projectDir = await askProjectDir(logger, '.')
 
   const wizardOptions = await inquirer.prompt([{
@@ -104,7 +106,7 @@ const createPlatformaticDB = async (_args) => {
   const fastifyVersion = await getDependencyVersion('fastify')
 
   // Create the package.json, .gitignore, readme
-  await createPackageJson('db', version, fastifyVersion, logger, projectDir)
+  await createPackageJson('db', version, fastifyVersion, logger, projectDir, useTypescript)
   await createGitignore(logger, projectDir)
   await createReadme(logger, projectDir)
 
@@ -161,12 +163,12 @@ const createPlatformaticDB = async (_args) => {
     await execaNode('./node_modules/@platformatic/db/db.mjs', ['schema', 'config'], { cwd: projectDir })
     logger.info('Configuration schema successfully created.')
   }
-  await askCreateGHAction(logger, env, 'db')
+  await askCreateGHAction(logger, env, 'db', useTypescript)
 
   if (!runPackageManagerInstall) {
     logger.warn(`You must run the following commands in the project folder to complete the setup:
     - ${pkgManager} install
-    - npx platformatic db schema config > ./platformatic.config.schema.json
+    - npx platformatic db schema config
 `)
   }
 }

package/src/ghaction.mjs

@@ -4,7 +4,7 @@ import inquirer from 'inquirer'
 import { isFileAccessible } from './utils.mjs'
 import { writeFile } from 'fs/promises'
 
-export const ghTemplate = (env, type) => {
+export const ghTemplate = (env, type, buildTS = false) => {
   const envAsStr = Object.keys(env).reduce((acc, key) => {
     acc += `          ${key}: ${env[key]} \n`
     return acc
@@ -24,7 +24,11 @@ jobs:
       - name: Checkout application project repository
         uses: actions/checkout@v3
       - name: npm install --omit=dev
-        run: npm install --omit=dev
+        run: npm install --omit=dev${buildTS
+? `
+      - name: Build project        
+        run: npm run build`
+: ''}
       - name: Deploy project
         uses: platformatic/onestep@latest
         with:
@@ -36,13 +40,13 @@ ${envAsStr}
 `
 }
 
-export const createGHAction = async (logger, env, type, projectDir) => {
+export const createGHAction = async (logger, env, type, projectDir, buildTS) => {
   const ghActionFileName = 'platformatic-deploy.yml'
   const ghActionFilePath = join(projectDir, '.github', 'workflows', ghActionFileName)
   const isGithubActionExists = await isFileAccessible(ghActionFilePath)
   if (!isGithubActionExists) {
     await mkdirp(join(projectDir, '.github', 'workflows'))
-    await writeFile(ghActionFilePath, ghTemplate(env, type))
+    await writeFile(ghActionFilePath, ghTemplate(env, type, buildTS))
     logger.info('Github action successfully created, please add PLATFORMATIC_API_KEY as repository secret.')
     const isGitDir = await isFileAccessible('.git', projectDir)
     if (!isGitDir) {
@@ -54,7 +58,7 @@ export const createGHAction = async (logger, env, type, projectDir) => {
 }
 
 /* c8 ignore next 12 */
-export const askCreateGHAction = async (logger, env, type, projectDir = process.cwd()) => {
+export const askCreateGHAction = async (logger, env, type, buildTS, projectDir = process.cwd()) => {
   const { githubAction } = await inquirer.prompt([{
     type: 'list',
     name: 'githubAction',
@@ -63,6 +67,6 @@ export const askCreateGHAction = async (logger, env, type, projectDir = process.
     choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
   }])
   if (githubAction) {
-    await createGHAction(logger, env, type, projectDir)
+    await createGHAction(logger, env, type, projectDir, buildTS)
   }
 }

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

@@ -9,7 +9,7 @@ import inquirer from 'inquirer'
 import { readFile, writeFile } from 'fs/promises'
 import pino from 'pino'
 import pretty from 'pino-pretty'
-import { execa } from 'execa'
+import { execa, execaNode } from 'execa'
 import ora from 'ora'
 import createService from './create-service.mjs'
 import askProjectDir from '../ask-project-dir.mjs'
@@ -63,8 +63,9 @@ const createPlatformaticService = async (_args) => {
 
   const fastifyVersion = await getDependencyVersion('fastify')
 
-  // Create the package.json, .gitignore, readme
-  await createPackageJson('service', version, fastifyVersion, logger, projectDir)
+  // 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('service', version, fastifyVersion, logger, projectDir, false)
   await createGitignore(logger, projectDir)
   await createReadme(logger, projectDir)
 
@@ -80,9 +81,23 @@ const createPlatformaticService = async (_args) => {
     const spinner = ora('Installing dependencies...').start()
     await execa(pkgManager, ['install'], { cwd: projectDir })
     spinner.succeed('...done!')
+    try {
+      await execaNode('./node_modules/@platformatic/service/service.mjs', [], { cwd: projectDir })
+    } catch (err) {
+      console.log(err)
+    }
+    logger.info('Configuration schema successfully created.')
+  }
+
+  if (!runPackageManagerInstall) {
+    logger.warn(`You must run the following commands in the project folder to complete the setup:
+    - ${pkgManager} install
+    - npx platformatic service schema config
+`)
   }
 
-  await askCreateGHAction(logger, env, 'service')
+  // We don't have the option for TS (yet) so we don't run build on TS
+  await askCreateGHAction(logger, env, 'service', false)
 }
 
 export default createPlatformaticService

package/src/service/create-service.mjs

@@ -9,6 +9,7 @@ function generateConfig () {
   ]
 
   const config = {
+    $schema: './platformatic.service.schema.json',
     server: {
       hostname: '{PLT_SERVER_HOSTNAME}',
       port: '{PORT}',

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

@@ -23,12 +23,13 @@ afterEach(() => {
 test('creates package.json file for db project', async ({ end, equal }) => {
   const version = '1.2.3'
   const fastifyVersion = '4.5.6'
-  await createPackageJson('db', version, fastifyVersion, fakeLogger, tmpDir)
+  await createPackageJson('db', version, fastifyVersion, fakeLogger, tmpDir, false)
   equal(log, `${tmpDir}/package.json successfully created.`)
   const accessible = await isFileAccessible(join(tmpDir, 'package.json'))
   equal(accessible, true)
   const packageJson = JSON.parse(readFileSync(join(tmpDir, 'package.json')))
   equal(packageJson.scripts.start, 'platformatic db start')
+  equal(packageJson.scripts.build, undefined)
   equal(packageJson.dependencies.platformatic, `^${version}`)
   equal(packageJson.devDependencies.fastify, `^${fastifyVersion}`)
 })
@@ -36,7 +37,7 @@ test('creates package.json file for db project', async ({ end, equal }) => {
 test('creates package.json file for service project', async ({ end, equal }) => {
   const version = '1.2.3'
   const fastifyVersion = '4.5.6'
-  await createPackageJson('service', version, fastifyVersion, fakeLogger, tmpDir)
+  await createPackageJson('service', version, fastifyVersion, fakeLogger, tmpDir, false)
   equal(log, `${tmpDir}/package.json successfully created.`)
   const accessible = await isFileAccessible(join(tmpDir, 'package.json'))
   equal(accessible, true)
@@ -51,6 +52,20 @@ test('do not create package.json file because already present', async ({ end, eq
   const fastifyVersion = '4.5.6'
   const packagejson = join(tmpDir, 'package.json')
   writeFileSync(packagejson, 'TEST')
-  await createPackageJson('db', version, fastifyVersion, fakeLogger, tmpDir)
+  await createPackageJson('db', version, fastifyVersion, fakeLogger, tmpDir, false)
   equal(log, `${tmpDir}/package.json found, skipping creation of package.json file.`)
 })
+
+test('creates package.json file with TD build', async ({ end, equal }) => {
+  const version = '1.2.3'
+  const fastifyVersion = '4.5.6'
+  await createPackageJson('db', version, fastifyVersion, fakeLogger, tmpDir, true)
+  equal(log, `${tmpDir}/package.json successfully created.`)
+  const accessible = await isFileAccessible(join(tmpDir, 'package.json'))
+  equal(accessible, true)
+  const packageJson = JSON.parse(readFileSync(join(tmpDir, 'package.json')))
+  equal(packageJson.scripts.start, 'platformatic db start')
+  equal(packageJson.scripts.build, 'npx tsc')
+  equal(packageJson.dependencies.platformatic, `^${version}`)
+  equal(packageJson.devDependencies.fastify, `^${fastifyVersion}`)
+})

package/test/ghaction.test.mjs

@@ -1,12 +1,13 @@
 'use strict'
 
 import { test, beforeEach, afterEach } from 'tap'
-import { mkdtemp, rmdir, writeFile } from 'fs/promises'
+import { mkdtemp, rmdir, writeFile, readFile } from 'fs/promises'
 import mkdirp from 'mkdirp'
 import { join } from 'path'
 import { tmpdir } from 'os'
 import { isFileAccessible } from '../src/utils.mjs'
 import { createGHAction } from '../src/ghaction.mjs'
+import { parse } from 'yaml'
 
 let log = []
 let tmpDir
@@ -25,15 +26,41 @@ afterEach(async () => {
 })
 
 const env = {
-  DATABASE_URL: 'mydbconnetionstring',
+  DATABASE_URL: 'mydbconnectionstring',
   PLT_SERVER_LOGGER_LEVEL: 'info'
 }
 
 test('creates gh action', async ({ end, equal }) => {
-  await createGHAction(fakeLogger, env, 'db', tmpDir)
+  await createGHAction(fakeLogger, env, 'db', tmpDir, false)
+  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_API_KEY as repository secret.')
+  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-deploy.yml'))
+  equal(accessible, true)
+  const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-deploy.yml'), 'utf8')
+  const ghAction = parse(ghFile)
+  const steps = ghAction.jobs.build_and_deploy.steps
+  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')
+  equal(steps[2].env.DATABASE_URL, 'mydbconnectionstring')
+  equal(steps[2].env.PLT_SERVER_LOGGER_LEVEL, 'info')
+})
+
+test('creates gh action with TS build step', async ({ end, equal }) => {
+  await createGHAction(fakeLogger, env, 'db', tmpDir, true)
   equal(log[0], 'Github action successfully created, please add PLATFORMATIC_API_KEY as repository secret.')
   const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-deploy.yml'))
   equal(accessible, true)
+  const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-deploy.yml'), 'utf8')
+  const ghAction = parse(ghFile)
+  const steps = ghAction.jobs.build_and_deploy.steps
+  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')
+  equal(steps[3].env.DATABASE_URL, 'mydbconnectionstring')
+  equal(steps[3].env.PLT_SERVER_LOGGER_LEVEL, 'info')
 })
 
 test('do not create gitignore file because already present', async ({ end, equal }) => {