create-platformatic 0.28.1 → 0.29.0

package/create-platformatic.mjs

@@ -36,3 +36,4 @@ export {
   createStaticWorkspaceGHAction,
   createDynamicWorkspaceGHAction
 } from './src/ghaction.mjs'
+export { createGitignore, createPackageJson, getDependencyVersion, getVersion } from './src/index.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "0.28.1",
+  "version": "0.29.0",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -33,7 +33,7 @@
     "semver": "^7.5.1",
     "undici": "^5.22.1",
     "which": "^3.0.1",
-    "@platformatic/config": "0.28.1"
+    "@platformatic/config": "0.29.0"
   },
   "devDependencies": {
     "ajv": "^8.12.0",
@@ -45,11 +45,11 @@
     "standard": "^17.1.0",
     "tap": "^16.3.6",
     "yaml": "^2.3.1",
-    "@platformatic/db": "0.28.1",
-    "@platformatic/service": "0.28.1"
+    "@platformatic/db": "0.29.0",
+    "@platformatic/service": "0.29.0"
   },
   "scripts": {
-    "test": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 --100 tap --no-coverage test/*test.mjs test/*/*test.mjs",
+    "test": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 tap --no-coverage test/*test.mjs test/*/*test.mjs",
     "lint": "standard | snazzy"
   }
 }

package/src/create-gitignore.mjs

@@ -31,7 +31,11 @@ tags
 # clinicjs
 .clinic/
 `
-
+/**
+ * Creates a standard Platformatic app .gitignore file
+ * @param {import('pino').BaseLogger} logger Logger Interface
+ * @param {string} dir Target directory
+ */
 export const createGitignore = async (logger, dir = '.') => {
   const gitignoreFileName = join(dir, '.gitignore')
   const isGitignoreExists = await isFileAccessible(gitignoreFileName)

package/src/create-package-json.mjs

@@ -23,6 +23,15 @@ const packageJsonTemplate = (addTSBuild = false) => (`\
   }
 }`)
 
+/**
+ * Creates a Platformatic app package.json file
+ * @param {string} platVersion Platformatic Version
+ * @param {string} fastifyVersion Fastify Version
+ * @param {import('pino').BaseLogger} logger Logger Interface
+ * @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
+ */
 export const createPackageJson = async (platVersion, fastifyVersion, logger, dir, addTSBuild = false, scripts = {}) => {
   const packageJsonFileName = join(dir, 'package.json')
   const isPackageJsonExists = await isFileAccessible(packageJsonFileName)

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

@@ -11,11 +11,25 @@ import pino from 'pino'
 import pretty from 'pino-pretty'
 import { execa } from 'execa'
 import ora from 'ora'
-import createDB from './create-db.mjs'
+import { getConnectionString, createDB } from './create-db.mjs'
 import askDir from '../ask-dir.mjs'
 import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
 import { getRunPackageManagerInstall, getUseTypescript, getPort, getOverwriteReadme } from '../cli-options.mjs'
 
+const databases = [{
+  value: 'sqlite',
+  name: 'SQLite'
+}, {
+  value: 'postgres',
+  name: 'PostgreSQL'
+}, {
+  value: 'mysql',
+  name: 'MySQL'
+}, {
+  value: 'mariadb',
+  name: 'MariaDB'
+}]
+
 export const createReadme = async (logger, dir = '.') => {
   const readmeFileName = join(dir, 'README.md')
   let isReadmeExists = await isFileAccessible(readmeFileName)
@@ -70,6 +84,48 @@ const createPlatformaticDB = async (_args, opts) => {
   const pkgManager = getPkgManager()
   const projectDir = opts.dir || await askDir(logger, '.')
 
+  const { database } = await inquirer.prompt({
+    type: 'list',
+    name: 'database',
+    message: 'What database do you want to use?',
+    default: args.database,
+    choices: databases
+  })
+
+  let connectionString = getConnectionString(database)
+
+  while (true) {
+    const pickConnectionString = await inquirer.prompt({
+      type: 'expand',
+      name: 'edit',
+      message: `Do you want to use the connection string "${connectionString}"?`,
+      choices: [
+        {
+          key: 'y',
+          name: 'Confirm',
+          value: false
+        },
+        {
+          key: 'e',
+          name: 'Edit',
+          value: true
+        }
+      ]
+    })
+
+    if (pickConnectionString.edit) {
+      const answers = await inquirer.prompt({
+        type: 'editor',
+        name: 'connectionString',
+        message: 'Edit the connection string',
+        default: connectionString
+      })
+      connectionString = answers.connectionString.trim()
+    } else {
+      break
+    }
+  }
+
   const wizardOptions = await inquirer.prompt([{
     type: 'list',
     name: 'defaultMigrations',
@@ -97,7 +153,8 @@ const createPlatformaticDB = async (_args, opts) => {
   const params = {
     hostname: args.hostname,
     port: wizardOptions.port,
-    database: args.database,
+    database,
+    connectionString,
     migrations: wizardOptions.defaultMigrations ? args.migrations : '',
     plugin: generatePlugin,
     types: useTypes,
@@ -162,8 +219,13 @@ const createPlatformaticDB = async (_args, opts) => {
       if (applyMigrations) {
         const spinner = ora('Applying migrations...').start()
         // We need to apply migrations using the platformatic installed in the project
-        await execa(pkgManager, ['exec', 'platformatic', 'db', 'migrations', 'apply'], { cwd: projectDir })
-        spinner.succeed('...done!')
+        try {
+          await execa(pkgManager, ['exec', 'platformatic', 'db', 'migrations', 'apply'], { cwd: projectDir })
+          spinner.succeed('...done!')
+        } catch (err) {
+          logger.trace({ err })
+          spinner.fail('...failed! Try again by running "platformatic db migrations apply"')
+        }
       }
     }
     if (generatePlugin) {
@@ -177,8 +239,13 @@ const createPlatformaticDB = async (_args, opts) => {
 
       if (generateTypes) {
         const spinner = ora('Generating types...').start()
-        await execa(pkgManager, ['exec', 'platformatic', 'db', 'types'], { cwd: projectDir })
-        spinner.succeed('...done!')
+        try {
+          await execa(pkgManager, ['exec', 'platformatic', 'db', 'types'], { cwd: projectDir })
+          spinner.succeed('...done!')
+        } catch (err) {
+          logger.trace({ err })
+          spinner.fail('...failed! Try again by running "platformatic db types"')
+        }
       }
     }
   }

package/src/db/create-db.mjs

@@ -1,49 +1,37 @@
 import { writeFile, mkdir, appendFile } from 'fs/promises'
 import { join, relative, resolve } from 'path'
 import { findDBConfigFile, isFileAccessible } from '../utils.mjs'
+import { getTsConfig } from '../get-tsconfig.mjs'
 
 const connectionStrings = {
-  postgres: 'postgres://postgres:postgres@localhost:5432/postgres',
+  postgres: 'postgres://postgres:postgres@127.0.0.1:5432/postgres',
   sqlite: 'sqlite://./db.sqlite',
-  mysql: 'mysql://root@localhost:3306/graph',
-  mysql8: 'mysql://root@localhost:3308/graph',
-  mariadb: 'mysql://root@localhost:3307/graph'
+  mysql: 'mysql://root@127.0.0.1:3306/platformatic',
+  mariadb: 'mysql://root@127.0.0.1:3306/platformatic'
 }
 
-const moviesMigrationDo = `
+const moviesMigrationDo = (database) => {
+  const key = {
+    postgres: 'SERIAL',
+    sqlite: 'INTEGER',
+    mysql: 'INTEGER UNSIGNED AUTO_INCREMENT',
+    mariadb: 'INTEGER UNSIGNED AUTO_INCREMENT'
+  }
+
+  return `
 -- Add SQL in this file to create the database tables for your API
 CREATE TABLE IF NOT EXISTS movies (
-  id INTEGER PRIMARY KEY,
+  id ${key[database]} PRIMARY KEY,
   title TEXT NOT NULL
 );
 `
+}
 
 const moviesMigrationUndo = `
 -- Add SQL in this file to drop the database tables 
 DROP TABLE movies;
 `
 
-function getTsConfig (outDir) {
-  return {
-    compilerOptions: {
-      module: 'commonjs',
-      esModuleInterop: true,
-      target: 'es6',
-      sourceMap: true,
-      pretty: true,
-      noEmitOnError: true,
-      outDir
-    },
-    watchOptions: {
-      watchFile: 'fixedPollingInterval',
-      watchDirectory: 'fixedPollingInterval',
-      fallbackPolling: 'dynamicPriority',
-      synchronousWatchDirectory: true,
-      excludeDirectories: ['**/node_modules', outDir]
-    }
-  }
-}
-
 const getPluginName = (isTypescript) => isTypescript === true ? 'plugin.ts' : 'plugin.js'
 const TS_OUT_DIR = 'dist'
 
@@ -86,20 +74,29 @@ function generateConfig (migrations, plugin, types, typescript, version) {
   }
 
   if (typescript === true) {
-    config.plugins.typescript = true
+    config.plugins.typescript = '{PLT_TYPESCRIPT}'
   }
 
   return config
 }
 
-function generateEnv (hostname, port, database) {
-  const connectionString = connectionStrings[database]
-  const env = `\
+function generateEnv (hostname, port, connectionString, typescript) {
+  let env = `\
 PLT_SERVER_HOSTNAME=${hostname}
 PORT=${port}
 PLT_SERVER_LOGGER_LEVEL=info
 DATABASE_URL=${connectionString}
 `
+
+  if (typescript === true) {
+    env += `\
+
+# Set to false to disable automatic typescript compilation.
+# Changing this setting is needed for production
+PLT_TYPESCRIPT=true
+`
+  }
+
   return env
 }
 
@@ -135,7 +132,12 @@ async function generatePluginWithTypesSupport (logger, currentDir, isTypescript)
   logger.info(`Plugin file created at ${relative(currentDir, pluginPath)}`)
 }
 
-async function createDB ({ hostname, database = 'sqlite', port, migrations = 'migrations', plugin = true, types = true, typescript = false }, logger, currentDir, version) {
+export function getConnectionString (database) {
+  return connectionStrings[database]
+}
+
+export async function createDB ({ hostname, database = 'sqlite', port, migrations = 'migrations', plugin = true, types = true, typescript = false, connectionString }, logger, currentDir, version) {
+  connectionString = connectionString || getConnectionString(database)
   const createMigrations = !!migrations // If we don't define a migrations folder, we don't create it
   const accessibleConfigFilename = await findDBConfigFile(currentDir)
   if (accessibleConfigFilename === undefined) {
@@ -143,7 +145,7 @@ async function createDB ({ hostname, database = 'sqlite', port, migrations = 'mi
     await writeFile(join(currentDir, 'platformatic.db.json'), JSON.stringify(config, null, 2))
     logger.info('Configuration file platformatic.db.json successfully created.')
 
-    const env = generateEnv(hostname, port, database)
+    const env = generateEnv(hostname, port, connectionString, typescript)
     const envFileExists = await isFileAccessible('.env', currentDir)
     await appendFile(join(currentDir, '.env'), env)
     await writeFile(join(currentDir, '.env.sample'), env)
@@ -175,7 +177,7 @@ async function createDB ({ hostname, database = 'sqlite', port, migrations = 'mi
   const isMigrationFileDoExists = await isFileAccessible(migrationFilePathDo)
   const isMigrationFileUndoExists = await isFileAccessible(migrationFilePathUndo)
   if (!isMigrationFileDoExists && createMigrations) {
-    await writeFile(migrationFilePathDo, moviesMigrationDo)
+    await writeFile(migrationFilePathDo, moviesMigrationDo(database))
     logger.info(`Migration file ${migrationFileNameDo} successfully created.`)
     if (!isMigrationFileUndoExists) {
       await writeFile(migrationFilePathUndo, moviesMigrationUndo)
@@ -202,7 +204,7 @@ async function createDB ({ hostname, database = 'sqlite', port, migrations = 'mi
   }
 
   return {
-    DATABASE_URL: connectionStrings[database],
+    DATABASE_URL: connectionString,
     PLT_SERVER_LOGGER_LEVEL: 'info',
     PORT: port,
     PLT_SERVER_HOSTNAME: hostname

package/src/get-tsconfig.mjs

@@ -0,0 +1,20 @@
+export function getTsConfig (outDir) {
+  return {
+    compilerOptions: {
+      module: 'commonjs',
+      esModuleInterop: true,
+      target: 'es2019',
+      sourceMap: true,
+      pretty: true,
+      noEmitOnError: true,
+      outDir
+    },
+    watchOptions: {
+      watchFile: 'fixedPollingInterval',
+      watchDirectory: 'fixedPollingInterval',
+      fallbackPolling: 'dynamicPriority',
+      synchronousWatchDirectory: true,
+      excludeDirectories: ['**/node_modules', outDir]
+    }
+  }
+}

package/src/index.mjs

@@ -8,7 +8,9 @@ import createPlatformaticService from './service/create-service-cli.mjs'
 import createPlatformaticComposer from './composer/create-composer-cli.mjs'
 import { createPlatformaticRuntime, createRuntimeService } from './runtime/create-runtime-cli.mjs'
 import commist from 'commist'
-import { getUsername, getVersion, minimumSupportedNodeVersions, isCurrentVersionSupported, findRuntimeConfigFile } from './utils.mjs'
+import { getUsername, getVersion, minimumSupportedNodeVersions, isCurrentVersionSupported, findRuntimeConfigFile, getDependencyVersion } from './utils.mjs'
+import { createPackageJson } from './create-package-json.mjs'
+import { createGitignore } from './create-gitignore.mjs'
 
 export async function chooseKind (argv, opts = {}) {
   const skip = opts.skip
@@ -101,3 +103,10 @@ const createPlatformatic = async (argv) => {
 }
 
 export default createPlatformatic
+
+export {
+  createPackageJson,
+  createGitignore,
+  getVersion,
+  getDependencyVersion
+}

package/src/service/create-service.mjs

@@ -2,6 +2,7 @@ import { writeFile, mkdir, readFile, appendFile } from 'fs/promises'
 import { join } from 'path'
 import * as desm from 'desm'
 import { findServiceConfigFile, isFileAccessible } from '../utils.mjs'
+import { getTsConfig } from '../get-tsconfig.mjs'
 
 const TS_OUT_DIR = 'dist'
 
@@ -29,18 +30,28 @@ function generateConfig (version, typescript) {
   }
 
   if (typescript === true) {
-    config.plugins.typescript = true
+    config.plugins.typescript = '{PLT_TYPESCRIPT}'
   }
 
   return config
 }
 
-function generateEnv (hostname, port) {
-  const env = `\
+function generateEnv (hostname, port, typescript) {
+  let env = `\
 PLT_SERVER_HOSTNAME=${hostname}
 PORT=${port}
 PLT_SERVER_LOGGER_LEVEL=info
 `
+
+  if (typescript === true) {
+    env += `\
+
+# Set to false to disable automatic typescript compilation.
+# Changing this setting is needed for production
+PLT_TYPESCRIPT=true
+`
+  }
+
   return env
 }
 
@@ -90,27 +101,6 @@ export default async function (fastify: FastifyInstance, opts: FastifyPluginOpti
 }
 `
 
-function getTsConfig (outDir) {
-  return {
-    compilerOptions: {
-      module: 'commonjs',
-      esModuleInterop: true,
-      target: 'es6',
-      sourceMap: true,
-      pretty: true,
-      noEmitOnError: true,
-      outDir
-    },
-    watchOptions: {
-      watchFile: 'fixedPollingInterval',
-      watchDirectory: 'fixedPollingInterval',
-      fallbackPolling: 'dynamicPriority',
-      synchronousWatchDirectory: true,
-      excludeDirectories: ['**/node_modules', outDir]
-    }
-  }
-}
-
 async function generatePluginWithTypesSupport (logger, currentDir, isTypescript) {
   await mkdir(join(currentDir, 'plugins'))
   const pluginTemplate = isTypescript
@@ -147,7 +137,7 @@ async function createService ({ hostname, port, typescript = false }, logger, cu
     await writeFile(join(currentDir, 'platformatic.service.json'), JSON.stringify(config, null, 2))
     logger.info('Configuration file platformatic.service.json successfully created.')
 
-    const env = generateEnv(hostname, port)
+    const env = generateEnv(hostname, port, typescript)
     const envFileExists = await isFileAccessible('.env', currentDir)
     await appendFile(join(currentDir, '.env'), env)
     await writeFile(join(currentDir, '.env.sample'), env)

package/src/utils.mjs

@@ -18,7 +18,10 @@ export async function isFileAccessible (filename, directory) {
     return false
   }
 }
-
+/**
+ * Gets the username from git config or `whoami` command
+ * @returns string | null
+ */
 export const getUsername = async () => {
   try {
     const { stdout } = await execa('git', ['config', 'user.name'])
@@ -39,7 +42,10 @@ export const getUsername = async () => {
 
   return null
 }
-
+/**
+ * Get the platformatic package version from package.json
+ * @returns string
+ */
 /* c8 ignore next 4 */
 export const getVersion = async () => {
   const data = await readFile(desm.join(import.meta.url, '..', 'package.json'), 'utf8')
@@ -73,6 +79,11 @@ export const findServiceConfigFile = async (directory) => (ConfigManager.findCon
 export const findComposerConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'composer'))
 export const findRuntimeConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'runtime'))
 
+/**
+ * Gets the version of the specified dependency package from package.json
+ * @param {string} dependencyName
+ * @returns string
+ */
 export const getDependencyVersion = async (dependencyName) => {
   const require = createRequire(import.meta.url)
   const pathToPackageJson = join(dirname(require.resolve(dependencyName)), 'package.json')

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

@@ -188,6 +188,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')
 
   equal(db.graphql, true)
   equal(db.openapi, true)
@@ -199,7 +200,7 @@ test('creates project with typescript', async ({ equal, same }) => {
   equal(migrationFileUndo, moviesMigrationUndo)
 
   same(plugins.paths, ['plugin.ts'])
-  equal(plugins.typescript, true)
+  equal(plugins.typescript, '{PLT_TYPESCRIPT}')
   equal(await isFileAccessible(join(tmpDir, 'plugin.ts')), true)
   equal(await isFileAccessible(join(tmpDir, 'tsconfig.json')), true)
 })

package/test/exports.test.mjs

@@ -0,0 +1,8 @@
+import { test } from 'tap'
+import * as funcs from '../create-platformatic.mjs'
+test('Should export functions', async ({ ok }) => {
+  ok(funcs.createPackageJson)
+  ok(funcs.createGitignore)
+  ok(funcs.getDependencyVersion)
+  ok(funcs.getVersion)
+})

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

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