create-platformatic 0.15.0 → 0.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",

package/src/create-package-json.mjs

@@ -6,10 +6,11 @@ import { join } from 'node:path'
 const packageJsonTemplate = (addTSBuild = false) => (`\
 {
   "scripts": {
-    "start": "platformatic {type} start"${addTSBuild
-? `,
+    ${addTSBuild
+? ` "start": "yarn clean && platformatic {type} start",
+    "clean": "rm -fr ./dist",
     "build": "npx tsc"`
-: ''}
+: '"start": "platformatic {type} start"'}
   },
   "devDependencies": {
     "fastify": "^{fastifyVersion}"

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

@@ -8,7 +8,7 @@ import inquirer from 'inquirer'
 import { readFile, writeFile } from 'fs/promises'
 import pino from 'pino'
 import pretty from 'pino-pretty'
-import { execa, execaNode } from 'execa'
+import { execa } from 'execa'
 import ora from 'ora'
 import createDB from './create-db.mjs'
 import askProjectDir from '../ask-project-dir.mjs'
@@ -95,7 +95,7 @@ const createPlatformaticDB = async (_args) => {
     hostname: args.hostname,
     port: args.port,
     database: args.database,
-    migrations: args.migrations,
+    migrations: wizardOptions.defaultMigrations ? args.migrations : '',
     plugin: generatePlugin,
     types: useTypes,
     typescript: useTypescript
@@ -125,10 +125,10 @@ const createPlatformaticDB = async (_args) => {
   }
 
   if (runPackageManagerInstall) {
-  // We applied package manager install, so we can:
-  // - run the migrations
-  // - generate types
-  // if we don't generate migrations, we don't ask to apply them (the folder might not exist)
+    // We applied package manager install, so we can:
+    // - run the migrations
+    // - generate types
+    // if we don't generate migrations, we don't ask to apply them (the folder might not exist)
     if (wizardOptions.defaultMigrations) {
       const { applyMigrations } = await inquirer.prompt([{
         type: 'list',
@@ -141,7 +141,7 @@ const createPlatformaticDB = async (_args) => {
       if (applyMigrations) {
         const spinner = ora('Applying migrations...').start()
         // We need to apply migrations using the platformatic installed in the project
-        await execaNode('./node_modules/@platformatic/db/db.mjs', ['migrations', 'apply'], { cwd: projectDir })
+        await execa(pkgManager, ['exec', 'platformatic', 'db', 'migrations', 'apply'], { cwd: projectDir })
         spinner.succeed('...done!')
       }
     }
@@ -156,14 +156,14 @@ const createPlatformaticDB = async (_args) => {
 
       if (generateTypes) {
         const spinner = ora('Generating types...').start()
-        await execaNode('./node_modules/@platformatic/db/db.mjs', ['types'], { cwd: projectDir })
+        await execa(pkgManager, ['exec', 'platformatic', 'db', 'types'], { cwd: projectDir })
         spinner.succeed('...done!')
       }
     }
-    await execaNode('./node_modules/@platformatic/db/db.mjs', ['schema', 'config'], { cwd: projectDir })
+    await execa(pkgManager, ['exec', 'platformatic', 'db', 'schema', 'config'], { cwd: projectDir })
     logger.info('Configuration schema successfully created.')
   }
-  await askCreateGHAction(logger, env, 'db', useTypescript)
+  await askCreateGHAction(logger, env, 'db', useTypescript, projectDir)
 
   if (!runPackageManagerInstall) {
     logger.warn(`You must run the following commands in the project folder to complete the setup:

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

@@ -97,7 +97,7 @@ const createPlatformaticService = async (_args) => {
   }
 
   // We don't have the option for TS (yet) so we don't run build on TS
-  await askCreateGHAction(logger, env, 'service', false)
+  await askCreateGHAction(logger, env, 'service', false, projectDir)
 }
 
 export default createPlatformaticService

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

@@ -20,7 +20,7 @@ afterEach(() => {
   rmSync(tmpDir, { recursive: true, force: true })
 })
 
-test('creates package.json file for db project', async ({ end, equal }) => {
+test('creates package.json file for db project', async ({ equal }) => {
   const version = '1.2.3'
   const fastifyVersion = '4.5.6'
   await createPackageJson('db', version, fastifyVersion, fakeLogger, tmpDir, false)
@@ -34,7 +34,7 @@ test('creates package.json file for db project', async ({ end, equal }) => {
   equal(packageJson.devDependencies.fastify, `^${fastifyVersion}`)
 })
 
-test('creates package.json file for service project', async ({ end, equal }) => {
+test('creates package.json file for service project', async ({ equal }) => {
   const version = '1.2.3'
   const fastifyVersion = '4.5.6'
   await createPackageJson('service', version, fastifyVersion, fakeLogger, tmpDir, false)
@@ -47,7 +47,7 @@ test('creates package.json file for service project', async ({ end, equal }) =>
   equal(packageJson.devDependencies.fastify, `^${fastifyVersion}`)
 })
 
-test('do not create package.json file because already present', async ({ end, equal }) => {
+test('do not create package.json file because already present', async ({ equal }) => {
   const version = '1.2.3'
   const fastifyVersion = '4.5.6'
   const packagejson = join(tmpDir, 'package.json')
@@ -56,7 +56,7 @@ test('do not create package.json file because already present', async ({ end, eq
   equal(log, `${tmpDir}/package.json found, skipping creation of package.json file.`)
 })
 
-test('creates package.json file with TD build', async ({ end, equal }) => {
+test('creates package.json file with TS build', async ({ equal }) => {
   const version = '1.2.3'
   const fastifyVersion = '4.5.6'
   await createPackageJson('db', version, fastifyVersion, fakeLogger, tmpDir, true)
@@ -64,7 +64,8 @@ test('creates package.json file with TD build', async ({ end, equal }) => {
   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.start, 'yarn clean && platformatic db start')
+  equal(packageJson.scripts.clean, 'rm -fr ./dist')
   equal(packageJson.scripts.build, 'npx tsc')
   equal(packageJson.dependencies.platformatic, `^${version}`)
   equal(packageJson.devDependencies.fastify, `^${fastifyVersion}`)

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

@@ -36,7 +36,7 @@ const fakeLogger = {
   info: msg => log.push(msg)
 }
 
-test('creates project with no typescript', async ({ end, equal }) => {
+test('creates project with no typescript', async ({ equal }) => {
   const params = {
     hostname: 'myhost',
     port: 6666,
@@ -75,15 +75,15 @@ test('creates project with no typescript', async ({ end, equal }) => {
   equal(core.openapi, true)
   equal(migrations.dir, 'migrations')
 
-  const migrationFileDo = await readFileSync(pathToMigrationFileDo, 'utf8')
+  const migrationFileDo = readFileSync(pathToMigrationFileDo, 'utf8')
   equal(migrationFileDo, moviesMigrationDo)
-  const migrationFileUndo = await readFileSync(pathToMigrationFileUndo, 'utf8')
+  const migrationFileUndo = readFileSync(pathToMigrationFileUndo, 'utf8')
   equal(migrationFileUndo, moviesMigrationUndo)
 
   equal(await isFileAccessible(join(tmpDir, 'plugin.js')), true)
 })
 
-test('creates project with no typescript and no plugin', async ({ end, equal }) => {
+test('creates project with no typescript and no plugin', async ({ equal }) => {
   const params = {
     hostname: 'myhost',
     port: 6666,
@@ -122,15 +122,15 @@ test('creates project with no typescript and no plugin', async ({ end, equal })
   equal(core.openapi, true)
   equal(migrations.dir, 'migrations')
 
-  const migrationFileDo = await readFileSync(pathToMigrationFileDo, 'utf8')
+  const migrationFileDo = readFileSync(pathToMigrationFileDo, 'utf8')
   equal(migrationFileDo, moviesMigrationDo)
-  const migrationFileUndo = await readFileSync(pathToMigrationFileUndo, 'utf8')
+  const migrationFileUndo = readFileSync(pathToMigrationFileUndo, 'utf8')
   equal(migrationFileUndo, moviesMigrationUndo)
 
   equal(await isFileAccessible(join(tmpDir, 'plugin.js')), false)
 })
 
-test('creates project with typescript', async ({ end, equal }) => {
+test('creates project with typescript', async ({ equal }) => {
   const params = {
     hostname: 'myhost',
     port: 6666,
@@ -169,9 +169,9 @@ test('creates project with typescript', async ({ end, equal }) => {
   equal(core.openapi, true)
   equal(migrations.dir, 'migrations')
 
-  const migrationFileDo = await readFileSync(pathToMigrationFileDo, 'utf8')
+  const migrationFileDo = readFileSync(pathToMigrationFileDo, 'utf8')
   equal(migrationFileDo, moviesMigrationDo)
-  const migrationFileUndo = await readFileSync(pathToMigrationFileUndo, 'utf8')
+  const migrationFileUndo = readFileSync(pathToMigrationFileUndo, 'utf8')
   equal(migrationFileUndo, moviesMigrationUndo)
 
   equal(plugin.path, 'plugin.ts')
@@ -180,7 +180,7 @@ test('creates project with typescript', async ({ end, equal }) => {
   equal(await isFileAccessible(join(tmpDir, 'tsconfig.json')), true)
 })
 
-test('creates project with configuration already present', async ({ end, equal, ok }) => {
+test('creates project with configuration already present', async ({ ok }) => {
   const pathToDbConfigFileOld = join(tmpDir, 'platformatic.db.json')
   writeFileSync(pathToDbConfigFileOld, JSON.stringify({ test: 'test' }))
   const params = {
@@ -191,7 +191,7 @@ test('creates project with configuration already present', async ({ end, equal,
   ok(log.includes('Configuration file platformatic.db.json found, skipping creation of configuration file.'))
 })
 
-test('creates project with migration folder already present', async ({ end, equal, ok }) => {
+test('creates project with migration folder already present', async ({ equal }) => {
   const pathToMigrationsOld = join(tmpDir, 'migrations')
   mkdirSync(pathToMigrationsOld)
   const params = {
@@ -202,7 +202,7 @@ test('creates project with migration folder already present', async ({ end, equa
   equal(log.includes('Migrations folder migrations found, skipping creation of migrations folder.'), true)
 })
 
-test('creates project with "do" migration already present', async ({ end, equal, ok }) => {
+test('creates project with "do" migration already present', async ({ ok }) => {
   const pathToMigrationsOld = join(tmpDir, 'migrations')
   mkdirSync(pathToMigrationsOld)
   const pathToMigrationFileDo = join(pathToMigrationsOld, '001.do.sql')
@@ -215,7 +215,7 @@ test('creates project with "do" migration already present', async ({ end, equal,
   ok(log.includes('Migration file 001.do.sql found, skipping creation of migration file.'))
 })
 
-test('creates project with tsconfig already present', async ({ end, equal, ok }) => {
+test('creates project with tsconfig already present', async ({ ok }) => {
   const pathToTsConfig = join(tmpDir, 'tsconfig.json')
   writeFileSync(pathToTsConfig, 'test')
   const params = {
@@ -227,7 +227,7 @@ test('creates project with tsconfig already present', async ({ end, equal, ok })
   ok(log.includes(`Typescript configuration file ${pathToTsConfig} found, skipping creation of typescript configuration file.`))
 })
 
-test('creates project with plugin already present', async ({ end, equal, ok }) => {
+test('creates project with plugin already present', async ({ ok }) => {
   const pathToPlugin = join(tmpDir, 'plugin.js')
   writeFileSync(pathToPlugin, 'test')
   const params = {
@@ -239,3 +239,29 @@ test('creates project with plugin already present', async ({ end, equal, ok }) =
   await createDB(params, fakeLogger, tmpDir)
   ok(log.includes(`Plugin file ${pathToPlugin} found, skipping creation of plugin file.`))
 })
+
+test('creates project with no default migrations', async ({ notOk }) => {
+  const params = {
+    hostname: 'myhost',
+    port: 6666,
+    plugin: false,
+    migrations: ''
+  }
+  await createDB(params, fakeLogger, tmpDir)
+  notOk(log.includes('Migrations folder migrations successfully created.'))
+  notOk(log.includes('Migration file 001.do.sql successfully created.'))
+  notOk(log.includes('Migration file 001.undo.sql successfully created.'))
+})
+
+test('creates project with default migrations', async ({ ok }) => {
+  const params = {
+    hostname: 'myhost',
+    port: 6666,
+    plugin: false,
+    migrations: 'migrations'
+  }
+  await createDB(params, fakeLogger, tmpDir)
+  ok(log.includes('Migrations folder migrations successfully created.'))
+  ok(log.includes('Migration file 001.do.sql successfully created.'))
+  ok(log.includes('Migration file 001.undo.sql successfully created.'))
+})