create-platformatic 0.26.1 → 0.28.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "0.26.1",
+  "version": "0.28.1",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -21,9 +21,9 @@
     "desm": "^1.3.0",
     "es-main": "^1.2.0",
     "execa": "^7.1.1",
-    "fastify": "^4.17.0",
+    "fastify": "^4.18.0",
     "help-me": "^4.2.0",
-    "inquirer": "^9.2.6",
+    "inquirer": "^9.2.7",
     "log-update": "^5.0.1",
     "minimist": "^1.2.8",
     "ora": "^6.3.1",
@@ -33,20 +33,20 @@
     "semver": "^7.5.1",
     "undici": "^5.22.1",
     "which": "^3.0.1",
-    "@platformatic/config": "0.26.1"
+    "@platformatic/config": "0.28.1"
   },
   "devDependencies": {
     "ajv": "^8.12.0",
-    "c8": "^7.13.0",
+    "c8": "^8.0.0",
     "cross-env": "^7.0.3",
-    "dotenv": "^16.0.3",
-    "esmock": "^2.2.3",
+    "dotenv": "^16.1.4",
+    "esmock": "^2.3.1",
     "snazzy": "^9.0.0",
-    "standard": "^17.0.0",
-    "tap": "^16.3.4",
-    "yaml": "^2.2.2",
-    "@platformatic/db": "0.26.1",
-    "@platformatic/service": "0.26.1"
+    "standard": "^17.1.0",
+    "tap": "^16.3.6",
+    "yaml": "^2.3.1",
+    "@platformatic/db": "0.28.1",
+    "@platformatic/service": "0.28.1"
   },
   "scripts": {
     "test": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 --100 tap --no-coverage test/*test.mjs test/*/*test.mjs",

package/src/cli-options.mjs

@@ -19,6 +19,16 @@ export const getUseTypescript = typescript => {
   }
 }
 
+export const getOverwriteReadme = () => {
+  return {
+    type: 'list',
+    name: 'shouldReplace',
+    message: 'Do you want to overwrite the existing README.md?',
+    default: true,
+    choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+  }
+}
+
 let port = 3042
 export const getPort = (nextPort) => {
   if (nextPort === undefined) {

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

@@ -13,20 +13,14 @@ import ora from 'ora'
 import createComposer from './create-composer.mjs'
 import askDir from '../ask-dir.mjs'
 import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
-import { getRunPackageManagerInstall, getPort } from '../cli-options.mjs'
+import { getRunPackageManagerInstall, getPort, getOverwriteReadme } from '../cli-options.mjs'
 
 export const createReadme = async (logger, dir = '.') => {
   const readmeFileName = join(dir, 'README.md')
   let isReadmeExists = await isFileAccessible(readmeFileName)
   if (isReadmeExists) {
     logger.debug(`${readmeFileName} found, asking to overwrite it.`)
-    const { shouldReplace } = await inquirer.prompt([{
-      type: 'list',
-      name: 'shouldReplace',
-      message: 'Do you want to overwrite the existing README.md?',
-      default: true,
-      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-    }])
+    const { shouldReplace } = await inquirer.prompt([getOverwriteReadme()])
     isReadmeExists = !shouldReplace
   }
 
@@ -85,7 +79,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('composer', version, fastifyVersion, logger, projectDir, false)
+    await createPackageJson(version, fastifyVersion, logger, projectDir, false)
   }
   if (!opts.skipGitignore) {
     await createGitignore(logger, projectDir)

package/src/create-package-json.mjs

@@ -7,10 +7,10 @@ const packageJsonTemplate = (addTSBuild = false) => (`\
 {
   "scripts": {
     ${addTSBuild
-? `"start": "npm run clean && platformatic {type} start",
+? `"start": "npm run clean && platformatic start",
     "clean": "rm -fr ./dist",
     "build": "npx tsc"`
-: '"start": "platformatic {type} start"'}
+: '"start": "platformatic start"'}
   },
   "devDependencies": {
     "fastify": "^{fastifyVersion}"
@@ -23,12 +23,14 @@ const packageJsonTemplate = (addTSBuild = false) => (`\
   }
 }`)
 
-export const createPackageJson = async (type, platVersion, fastifyVersion, logger, dir, addTSBuild = false) => {
+export const createPackageJson = async (platVersion, fastifyVersion, logger, dir, addTSBuild = false, scripts = {}) => {
   const packageJsonFileName = join(dir, 'package.json')
   const isPackageJsonExists = await isFileAccessible(packageJsonFileName)
   if (!isPackageJsonExists) {
-    const packageJson = pupa(packageJsonTemplate(addTSBuild), { platVersion, fastifyVersion, type })
-    await writeFile(packageJsonFileName, packageJson)
+    const packageJson = pupa(packageJsonTemplate(addTSBuild), { platVersion, fastifyVersion })
+    const parsed = JSON.parse(packageJson)
+    Object.assign(parsed.scripts, scripts)
+    await writeFile(packageJsonFileName, JSON.stringify(parsed, null, 2))
     logger.debug(`${packageJsonFileName} successfully created.`)
   } else {
     logger.debug(`${packageJsonFileName} found, skipping creation of package.json file.`)

package/src/db/README.md

@@ -18,7 +18,7 @@ npm install
 2. Apply migrations:
 
 ```bash
-npx platformatic db migrations apply
+npm run migrate
 ```
 
 

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

@@ -14,20 +14,14 @@ import ora from 'ora'
 import createDB from './create-db.mjs'
 import askDir from '../ask-dir.mjs'
 import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
-import { getRunPackageManagerInstall, getUseTypescript, getPort } from '../cli-options.mjs'
+import { getRunPackageManagerInstall, getUseTypescript, getPort, getOverwriteReadme } from '../cli-options.mjs'
 
 export const createReadme = async (logger, dir = '.') => {
   const readmeFileName = join(dir, 'README.md')
   let isReadmeExists = await isFileAccessible(readmeFileName)
   if (isReadmeExists) {
     logger.debug(`${readmeFileName} found, asking to overwrite it.`)
-    const { shouldReplace } = await inquirer.prompt([{
-      type: 'list',
-      name: 'shouldReplace',
-      message: 'Do you want to overwrite the existing README.md?',
-      default: true,
-      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-    }])
+    const { shouldReplace } = await inquirer.prompt([getOverwriteReadme()])
     isReadmeExists = !shouldReplace
   }
 
@@ -114,8 +108,12 @@ const createPlatformaticDB = async (_args, opts) => {
 
   const fastifyVersion = await getDependencyVersion('fastify')
 
+  const scripts = {
+    migrate: 'platformatic db migrations apply'
+  }
+
   // Create the package.json, .gitignore, readme
-  await createPackageJson('db', version, fastifyVersion, logger, projectDir, useTypescript)
+  await createPackageJson(version, fastifyVersion, logger, projectDir, useTypescript, scripts)
   await createGitignore(logger, projectDir)
   await createReadme(logger, projectDir)
 

package/src/db/create-db.mjs

@@ -61,6 +61,9 @@ function generateConfig (migrations, plugin, types, typescript, version) {
       connectionString: '{DATABASE_URL}',
       graphql: true,
       openapi: true
+    },
+    watch: {
+      ignore: ['*.sqlite', '*.sqlite-journal']
     }
   }
 

package/src/get-pkg-manager.mjs

@@ -1,4 +1,3 @@
-
 export const getPkgManager = () => {
   const userAgent = process.env.npm_config_user_agent
   if (!userAgent) {

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

@@ -2,7 +2,7 @@ import { getVersion, getDependencyVersion, isFileAccessible } from '../utils.mjs
 import { createPackageJson } from '../create-package-json.mjs'
 import { createGitignore } from '../create-gitignore.mjs'
 import { getPkgManager } from '../get-pkg-manager.mjs'
-import { join } from 'path'
+import { join, relative } from 'path'
 import inquirer from 'inquirer'
 import { readFile, writeFile, mkdir } from 'fs/promises'
 import pino from 'pino'
@@ -12,7 +12,7 @@ import ora from 'ora'
 import createRuntime from './create-runtime.mjs'
 import askDir from '../ask-dir.mjs'
 import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
-import { getRunPackageManagerInstall } from '../cli-options.mjs'
+import { getOverwriteReadme, getRunPackageManagerInstall } from '../cli-options.mjs'
 import generateName from 'boring-name-generator'
 import { chooseKind } from '../index.mjs'
 
@@ -21,13 +21,7 @@ export const createReadme = async (logger, dir = '.') => {
   let isReadmeExists = await isFileAccessible(readmeFileName)
   if (isReadmeExists) {
     logger.debug(`${readmeFileName} found, asking to overwrite it.`)
-    const { shouldReplace } = await inquirer.prompt([{
-      type: 'list',
-      name: 'shouldReplace',
-      message: 'Do you want to overwrite the existing README.md?',
-      default: true,
-      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-    }])
+    const { shouldReplace } = await inquirer.prompt([getOverwriteReadme()])
     isReadmeExists = !shouldReplace
   }
 
@@ -52,21 +46,24 @@ export async function createPlatformaticRuntime (_args) {
   const pkgManager = getPkgManager()
 
   const projectDir = await askDir(logger, '.')
-  const servicesDir = await askDir(logger, 'services', 'Where would you like to load your services from?')
+
+  // Create the project directory
+  await mkdir(projectDir, { recursive: true })
+
+  const baseServicesDir = join(relative(process.cwd(), projectDir), 'services')
+  const servicesDir = await askDir(logger, baseServicesDir, 'Where would you like to load your services from?')
 
   const { runPackageManagerInstall } = await inquirer.prompt([
     getRunPackageManagerInstall(pkgManager)
   ])
 
-  // Create the project directory
-  await mkdir(projectDir, { recursive: true })
   await mkdir(servicesDir, { recursive: true })
 
   const fastifyVersion = await getDependencyVersion('fastify')
 
   // 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('runtime', version, fastifyVersion, logger, projectDir, false)
+  await createPackageJson(version, fastifyVersion, logger, projectDir, false)
   await createGitignore(logger, projectDir)
   await createReadme(logger, projectDir)
 
@@ -130,13 +127,24 @@ export async function createRuntimeService ({ servicesDir, names, logger }) {
     type: 'input',
     name: 'name',
     message: 'What is the name of the service?',
-    default: generateName().dashed
+    default: generateName().dashed,
+    validate: (value) => {
+      if (value.length === 0) {
+        return 'Please enter a name'
+      }
+
+      if (value.includes(' ')) {
+        return 'Please enter a name without spaces'
+      }
+
+      if (names.includes(value)) {
+        return 'This name is already used, please choose another one.'
+      }
+
+      return true
+    }
   })
 
-  if (names.includes(name)) {
-    logger.warn('This name is already used, please choose another one.')
-    return false
-  }
   names.push(name)
 
   const serviceDir = join(servicesDir, name)

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

@@ -13,20 +13,14 @@ import ora from 'ora'
 import createService from './create-service.mjs'
 import askDir from '../ask-dir.mjs'
 import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
-import { getRunPackageManagerInstall, getUseTypescript, getPort } from '../cli-options.mjs'
+import { getRunPackageManagerInstall, getUseTypescript, getPort, getOverwriteReadme } from '../cli-options.mjs'
 
 export const createReadme = async (logger, dir = '.') => {
   const readmeFileName = join(dir, 'README.md')
   let isReadmeExists = await isFileAccessible(readmeFileName)
   if (isReadmeExists) {
     logger.debug(`${readmeFileName} found, asking to overwrite it.`)
-    const { shouldReplace } = await inquirer.prompt([{
-      type: 'list',
-      name: 'shouldReplace',
-      message: 'Do you want to overwrite the existing README.md?',
-      default: true,
-      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-    }])
+    const { shouldReplace } = await inquirer.prompt([getOverwriteReadme()])
     isReadmeExists = !shouldReplace
   }
 
@@ -86,7 +80,7 @@ const createPlatformaticService = async (_args, opts = {}) => {
   if (!opts.skipPackageJson) {
     // 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 createPackageJson(version, fastifyVersion, logger, projectDir, false)
   }
   if (!opts.skipGitignore) {
     await createGitignore(logger, projectDir)

package/src/service/create-service.mjs

@@ -8,7 +8,7 @@ const TS_OUT_DIR = 'dist'
 function generateConfig (version, typescript) {
   const plugins = {
     paths: [
-      './plugins',
+      { path: './plugins', encapsulate: false },
       './routes'
     ]
   }
@@ -45,15 +45,16 @@ PLT_SERVER_LOGGER_LEVEL=info
 }
 
 const JS_PLUGIN_WITH_TYPES_SUPPORT = `\
+/// <reference types="@platformatic/service" />
 'use strict'
 /** @param {import('fastify').FastifyInstance} fastify */
 module.exports = async function (fastify, opts) {
   fastify.decorate('example', 'foobar')
 }
-module.exports[Symbol.for('skip-override')] = true
 `
 
 const TS_PLUGIN_WITH_TYPES_SUPPORT = `\
+/// <reference types="@platformatic/service" />
 import { FastifyInstance, FastifyPluginOptions } from 'fastify'
 
 export default async function (fastify: FastifyInstance, opts: FastifyPluginOptions) {
@@ -62,6 +63,7 @@ export default async function (fastify: FastifyInstance, opts: FastifyPluginOpti
 `
 
 const JS_ROUTES_WITH_TYPES_SUPPORT = `\
+/// <reference types="@platformatic/service" />
 'use strict'
 /** @param {import('fastify').FastifyInstance} fastify */
 module.exports = async function (fastify, opts) {
@@ -72,6 +74,7 @@ module.exports = async function (fastify, opts) {
 `
 
 const TS_ROUTES_WITH_TYPES_SUPPORT = `\
+/// <reference types="@platformatic/service" />
 import { FastifyInstance, FastifyPluginOptions } from 'fastify'
 
 declare module 'fastify' {

package/test/cli-options.test.mjs

@@ -1,5 +1,5 @@
 import { test } from 'tap'
-import { getRunPackageManagerInstall, getUseTypescript, getPort } from '../src/cli-options.mjs'
+import { getRunPackageManagerInstall, getUseTypescript, getPort, getOverwriteReadme } from '../src/cli-options.mjs'
 
 test('getRunPackageManagerInstall', async ({ same }) => {
   same(
@@ -28,6 +28,19 @@ test('getUseTypescript', async ({ same }) => {
   )
 })
 
+test('getOverwriteReadme', async ({ same }) => {
+  same(
+    getOverwriteReadme(),
+    {
+      type: 'list',
+      name: 'shouldReplace',
+      message: 'Do you want to overwrite the existing README.md?',
+      default: true,
+      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+    }
+  )
+})
+
 test('getPort', async ({ same }) => {
   same(
     getPort(undefined),

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

@@ -23,12 +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('db', version, fastifyVersion, fakeLogger, tmpDir, false)
+  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, false)
   equal(log, `${join(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.start, 'platformatic start')
   equal(packageJson.scripts.build, undefined)
   equal(packageJson.dependencies.platformatic, `^${version}`)
   equal(packageJson.devDependencies.fastify, `^${fastifyVersion}`)
@@ -37,12 +37,12 @@ test('creates package.json file for db project', async ({ 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)
+  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, false)
   equal(log, `${join(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 service start')
+  equal(packageJson.scripts.start, 'platformatic start')
   equal(packageJson.dependencies.platformatic, `^${version}`)
   equal(packageJson.devDependencies.fastify, `^${fastifyVersion}`)
 })
@@ -52,19 +52,19 @@ test('do not create package.json file because already present', async ({ equal }
   const fastifyVersion = '4.5.6'
   const packagejson = join(tmpDir, 'package.json')
   writeFileSync(packagejson, 'TEST')
-  await createPackageJson('db', version, fastifyVersion, fakeLogger, tmpDir, false)
+  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, false)
   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('db', version, fastifyVersion, fakeLogger, tmpDir, true)
+  await createPackageJson(version, fastifyVersion, fakeLogger, tmpDir, true)
   equal(log, `${join(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, 'npm run clean && platformatic db start')
+  equal(packageJson.scripts.start, 'npm run clean && platformatic start')
   equal(packageJson.scripts.clean, 'rm -fr ./dist')
   equal(packageJson.scripts.build, 'npx tsc')
   equal(packageJson.dependencies.platformatic, `^${version}`)

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

@@ -59,7 +59,7 @@ test('creates service with typescript', async ({ equal, same, ok }) => {
   equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
   equal(process.env.PORT, '6666')
 
-  same(plugins.paths, ['./plugins', './routes'])
+  same(plugins.paths, [{ path: './plugins', encapsulate: false }, './routes'])
   equal(plugins.typescript, true)
 
   ok(await isFileAccessible(join(tmpDir, 'tsconfig.json')))
@@ -95,7 +95,7 @@ test('creates service with javascript', async ({ equal, same, ok }) => {
   equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
   equal(process.env.PORT, '6666')
 
-  same(plugins, { paths: ['./plugins', './routes'] })
+  same(plugins, { paths: [{ path: './plugins', encapsulate: false }, './routes'] })
   ok(await isFileAccessible(join(tmpDir, 'plugins', 'example.js')))
   ok(await isFileAccessible(join(tmpDir, 'routes', 'root.js')))
 })