create-platformatic 1.1.1 → 1.3.0

package/create-platformatic.mjs

@@ -37,5 +37,5 @@ export {
   createDynamicWorkspaceGHAction
 } from './src/ghaction.mjs'
 
-export { createGitignore, createPackageJson, getDependencyVersion, getVersion } from './src/index.mjs'
+export { createGitignore, createGitRepository, 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": "1.1.1",
+  "version": "1.3.0",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -32,9 +32,10 @@
     "pino-pretty": "^10.2.0",
     "pupa": "^3.1.0",
     "semver": "^7.5.4",
+    "strip-ansi": "^7.1.0",
     "undici": "^5.25.4",
     "which": "^3.0.1",
-    "@platformatic/config": "1.1.1"
+    "@platformatic/config": "1.3.0"
   },
   "devDependencies": {
     "ajv": "^8.12.0",
@@ -47,11 +48,12 @@
     "tap": "^16.3.9",
     "typescript": "~5.2.2",
     "yaml": "^2.3.2",
-    "@platformatic/db": "1.1.1",
-    "@platformatic/service": "1.1.1"
+    "@platformatic/db": "1.3.0",
+    "@platformatic/service": "1.3.0"
   },
   "scripts": {
-    "test": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 tap --no-coverage test/*test.mjs test/*/*test.mjs",
+    "test:cli": "tap --no-coverage test/cli/*test.mjs -t120",
+    "test": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 tap --no-coverage test/*test.mjs test/*[!cli]/*test.mjs && npm run test:cli",
     "lint": "standard | snazzy"
   }
 }

package/src/cli-options.mjs

@@ -19,6 +19,16 @@ export const getUseTypescript = typescript => {
   }
 }
 
+export const getInitGitRepository = () => {
+  return {
+    type: 'list',
+    name: 'initGitRepository',
+    message: 'Do you want to init the git repository?',
+    default: false,
+    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

@@ -11,7 +11,7 @@ import { execa } from 'execa'
 import ora from 'ora'
 import createComposer from './create-composer.mjs'
 import askDir from '../ask-dir.mjs'
-import { getRunPackageManagerInstall, getPort } from '../cli-options.mjs'
+import { getRunPackageManagerInstall, getPort, getUseTypescript, getInitGitRepository } from '../cli-options.mjs'
 import { createReadme } from '../create-readme.mjs'
 import { stat } from 'node:fs/promises'
 import { join } from 'path'
@@ -61,6 +61,7 @@ const createPlatformaticComposer = async (_args, opts) => {
   const portQuestion = getPort(args.port)
   portQuestion.when = !isRuntimeContext
   toAsk.push(portQuestion)
+  toAsk.push(getUseTypescript(args.typescript))
 
   if (isRuntimeContext) {
     const servicesNames = opts.runtimeContext.servicesNames.filter(
@@ -90,12 +91,18 @@ const createPlatformaticComposer = async (_args, opts) => {
       choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
     })
   }
+
+  if (!opts.skipGitRepository) {
+    toAsk.push(getInitGitRepository())
+  }
   const {
     runPackageManagerInstall,
     servicesToCompose,
     port,
     staticWorkspaceGitHubAction,
-    dynamicWorkspaceGitHubAction
+    dynamicWorkspaceGitHubAction,
+    useTypescript,
+    initGitRepository
   } = await inquirer.prompt(toAsk)
 
   // Create the project directory
@@ -108,7 +115,9 @@ const createPlatformaticComposer = async (_args, opts) => {
     servicesToCompose,
     staticWorkspaceGitHubAction,
     dynamicWorkspaceGitHubAction,
-    runtimeContext: opts.runtimeContext
+    runtimeContext: opts.runtimeContext,
+    typescript: useTypescript,
+    initGitRepository
   }
 
   await createComposer(
@@ -123,7 +132,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(version, fastifyVersion, logger, projectDir, false)
+    await createPackageJson(version, fastifyVersion, logger, projectDir, useTypescript)
   }
   if (!opts.skipGitignore) {
     await createGitignore(logger, projectDir)

package/src/composer/create-composer.mjs

@@ -4,8 +4,12 @@ import { join } from 'path'
 import * as desm from 'desm'
 import { generatePlugins, generateRouteWithTypesSupport } from '../create-plugins.mjs'
 import { createDynamicWorkspaceGHAction, createStaticWorkspaceGHAction } from '../ghaction.mjs'
+import { getTsConfig } from '../get-tsconfig.mjs'
+import { createGitRepository } from '../create-git-repository.mjs'
 
-function generateConfig (isRuntimeContext, version, servicesToCompose, envPrefix) {
+const TS_OUT_DIR = 'dist'
+
+function generateConfig (isRuntimeContext, version, servicesToCompose, typescript, envPrefix) {
   const config = {
     $schema: `https://platformatic.dev/schemas/v${version}/composer`,
     composer: {
@@ -35,9 +39,7 @@ function generateConfig (isRuntimeContext, version, servicesToCompose, envPrefix
         level: '{PLT_SERVER_LOGGER_LEVEL}'
       }
     }
-  }
-
-  if (isRuntimeContext) {
+  } else {
     config.composer.services = servicesToCompose.map((serviceName) => {
       return {
         id: serviceName,
@@ -49,10 +51,14 @@ function generateConfig (isRuntimeContext, version, servicesToCompose, envPrefix
     })
   }
 
+  if (typescript === true && config.plugins) {
+    config.plugins.typescript = `{PLT_${envPrefix}TYPESCRIPT}`
+  }
+
   return config
 }
 
-function generateEnv (isRuntimeContext, hostname, port, envPrefix) {
+function generateEnv (isRuntimeContext, hostname, port, typescript, envPrefix) {
   let env = ''
 
   if (!isRuntimeContext) {
@@ -64,6 +70,13 @@ PLT_SERVER_LOGGER_LEVEL=info`
   env += `
 PLT_${envPrefix}EXAMPLE_ORIGIN=
 `
+  if (typescript === true) {
+    env += `\
+# Set to false to disable automatic typescript compilation.
+# Changing this setting is needed for production
+PLT_${envPrefix}TYPESCRIPT=true
+`
+  }
   return env
 }
 
@@ -71,11 +84,19 @@ async function createComposer (
   params,
   logger,
   currentDir = process.cwd(),
-  version,
-  staticWorkspaceGitHubAction,
-  dynamicWorkspaceGitHubAction
+  version
 ) {
-  const { isRuntimeContext, hostname, port, servicesToCompose = [], runtimeContext } = params
+  const {
+    isRuntimeContext,
+    hostname,
+    port,
+    servicesToCompose = [],
+    runtimeContext,
+    typescript,
+    staticWorkspaceGitHubAction,
+    dynamicWorkspaceGitHubAction,
+    initGitRepository
+  } = params
 
   const composerEnv = {
     PLT_SERVER_LOGGER_LEVEL: 'info',
@@ -91,11 +112,11 @@ async function createComposer (
   if (accessibleConfigFilename === undefined) {
     const envPrefix = runtimeContext !== undefined ? `${runtimeContext.envPrefix}_` : ''
 
-    const config = generateConfig(isRuntimeContext, version, servicesToCompose, envPrefix)
+    const config = generateConfig(isRuntimeContext, version, servicesToCompose, typescript, envPrefix)
     await writeFile(join(currentDir, 'platformatic.composer.json'), JSON.stringify(config, null, 2))
     logger.info('Configuration file platformatic.composer.json successfully created.')
 
-    const env = generateEnv(isRuntimeContext, hostname, port, envPrefix)
+    const env = generateEnv(isRuntimeContext, hostname, port, typescript, envPrefix)
     const envFileExists = await isFileAccessible('.env', currentDir)
     await appendFile(join(currentDir, '.env'), env)
     await writeFile(join(currentDir, '.env.sample'), env)
@@ -108,14 +129,28 @@ async function createComposer (
   } else {
     logger.info(`Configuration file ${accessibleConfigFilename} found, skipping creation of configuration file.`)
   }
-  await generatePlugins(logger, currentDir, false, 'composer')
-  await generateRouteWithTypesSupport(logger, currentDir, false)
+  await generatePlugins(logger, currentDir, typescript, 'composer')
+  await generateRouteWithTypesSupport(logger, currentDir, true)
+
+  if (typescript === true) {
+    const tsConfigFileName = join(currentDir, 'tsconfig.json')
+    const tsConfig = getTsConfig(TS_OUT_DIR)
+    await writeFile(tsConfigFileName, JSON.stringify(tsConfig, null, 2))
+    logger.info(`Typescript configuration file ${tsConfigFileName} successfully created.`)
+
+    // TODO: global.d.ts is needed to compile the project. Still need to populate it
+    await writeFile(join(currentDir, 'global.d.ts'), '')
+  }
 
   if (staticWorkspaceGitHubAction) {
-    await createStaticWorkspaceGHAction(logger, composerEnv, './platformatic.service.json', currentDir, false)
+    await createStaticWorkspaceGHAction(logger, composerEnv, './platformatic.service.json', currentDir, typescript)
   }
   if (dynamicWorkspaceGitHubAction) {
-    await createDynamicWorkspaceGHAction(logger, composerEnv, './platformatic.service.json', currentDir, false)
+    await createDynamicWorkspaceGHAction(logger, composerEnv, './platformatic.service.json', currentDir, typescript)
+  }
+
+  if (initGitRepository) {
+    await createGitRepository(logger, currentDir)
   }
 
   return composerEnv

package/src/create-git-repository.mjs

@@ -0,0 +1,105 @@
+import { execa } from 'execa'
+
+export const GIT_FIRST_COMMIT_MESSAGE = 'Platformatic project started! 🚀'
+export const GIT_MAIN_BRANCH = 'main'
+
+/**
+ * Creates a Git repository and performs the initial commit if it doesn't already exist.
+ *
+ * This function checks if Git is installed, initializes a Git repository in the specified
+ * directory if it's not already a Git repository, and performs the initial commit.
+ *
+ * @param {import('pino.').BaseLogger} logger - The logger interface for logging messages.
+ * @param {string} [dir='.'] - The target directory where the Git repository should be created.
+ */
+export async function createGitRepository (logger, dir = '.') {
+  if (!await isGitInstalled()) {
+    logger.error('Git is not installed')
+    return
+  }
+
+  if (!await gitInit(logger, dir)) {
+    return
+  }
+
+  if (!await gitCommit(logger, dir)) {
+    return
+  }
+
+  logger.info('Git repository initialized.')
+}
+
+/**
+ * Checks if Git is installed on the system.
+ *
+ * @async
+ * @returns {Promise<boolean>} A Promise that resolves to true if Git is installed, false otherwise.
+ */
+async function isGitInstalled () {
+  try {
+    await execa('git', ['--version'])
+    return true
+  } catch (err) {
+    return false
+  }
+}
+
+/**
+ * Checks if a Git repository exists in the specified directory.
+ *
+ * @async
+ * @param {string} dir - The directory to check for a Git repository.
+ * @returns {Promise<boolean>} A Promise that resolves to true if a Git repository exists in the directory, false otherwise.
+ */
+async function doesGitRepositoryExist (dir) {
+  try {
+    await execa('git', ['rev-parse', '--is-inside-work-tree'], { cwd: dir })
+    return true
+  } catch (e) {
+    return false
+  }
+}
+
+/**
+ * Initializes a Git repository in the specified directory if it doesn't already exist.
+ *
+ * @async
+ * @param {import('pino.').BaseLogger} - The logger object for logging messages.
+ * @param {string} dir - The directory where the Git repository should be initialized.
+ * @returns {Promise<boolean>} A Promise that resolves to true if the Git repository is successfully initialized, false otherwise.
+ */
+async function gitInit (logger, dir) {
+  try {
+    if (await doesGitRepositoryExist(dir)) {
+      logger.info('Git repository already exists.')
+      return false
+    }
+
+    await execa('git', ['init', '-b', GIT_MAIN_BRANCH], { cwd: dir })
+    logger.debug('Git repository initialized.')
+    return true
+  } catch (err) {
+    logger.error('Git repository init failed.', err)
+    return false
+  }
+}
+
+/**
+ * Commits changes in a Git repository located in the specified directory.
+ *
+ * @async
+ * @param {import('pino.').BaseLogger} - The logger object for logging messages.
+ * @param {string} dir - The directory of the Git repository where changes should be committed.
+ * @returns {Promise<boolean>} A Promise that resolves to true if the Git commit is successful, false otherwise.
+ */
+async function gitCommit (logger, dir) {
+  try {
+    await execa('git', ['add', '-A'], { cwd: dir })
+    await execa('git', ['commit', '-m', GIT_FIRST_COMMIT_MESSAGE], { cwd: dir })
+    logger.debug('Git commit done.')
+    return true
+  } catch (err) {
+    logger.error('Git commit failed.', err)
+    return false
+  }
+}

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

@@ -12,7 +12,7 @@ import { execa } from 'execa'
 import ora from 'ora'
 import { getConnectionString, createDB } from './create-db.mjs'
 import askDir from '../ask-dir.mjs'
-import { getRunPackageManagerInstall, getUseTypescript, getPort } from '../cli-options.mjs'
+import { getRunPackageManagerInstall, getUseTypescript, getPort, getInitGitRepository } from '../cli-options.mjs'
 import { createReadme } from '../create-readme.mjs'
 import { join } from 'node:path'
 
@@ -169,8 +169,10 @@ const createPlatformaticDB = async (_args, opts) => {
     when: !opts.skipGitHubActions,
     choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
   })
-
-  // Promtp for questions
+  if (!opts.skipGitRepository) {
+    toAsk.push(getInitGitRepository())
+  }
+  // Prompt for questions
   const wizardOptions = await inquirer.prompt(toAsk)
 
   await mkdir(projectDir, { recursive: true })
@@ -191,7 +193,8 @@ const createPlatformaticDB = async (_args, opts) => {
     typescript: useTypescript,
     staticWorkspaceGitHubAction: wizardOptions.staticWorkspaceGitHubAction,
     dynamicWorkspaceGitHubAction: wizardOptions.dynamicWorkspaceGitHubAction,
-    runtimeContext: opts.runtimeContext
+    runtimeContext: opts.runtimeContext,
+    initGitRepository: wizardOptions.initGitRepository
   }
 
   await createDB(params, logger, projectDir, version)

package/src/db/create-db.mjs

@@ -4,6 +4,7 @@ import { addPrefixToEnv, findDBConfigFile, isFileAccessible } from '../utils.mjs
 import { getTsConfig } from '../get-tsconfig.mjs'
 import { generatePlugins } from '../create-plugins.mjs'
 import { createDynamicWorkspaceGHAction, createStaticWorkspaceGHAction } from '../ghaction.mjs'
+import { createGitRepository } from '../create-git-repository.mjs'
 
 const connectionStrings = {
   postgres: 'postgres://postgres:postgres@127.0.0.1:5432/postgres',
@@ -298,7 +299,7 @@ function generateConfig (isRuntimeContext, migrations, plugin, types, typescript
     }
   }
 
-  if (typescript === true) {
+  if (typescript === true && config.plugins) {
     config.plugins.typescript = `{PLT_${envPrefix}TYPESCRIPT}`
   }
 
@@ -349,7 +350,8 @@ export async function createDB (params, logger, currentDir, version) {
     connectionString,
     staticWorkspaceGitHubAction,
     dynamicWorkspaceGitHubAction,
-    runtimeContext
+    runtimeContext,
+    initGitRepository
   } = params
 
   const dbEnv = {
@@ -418,14 +420,9 @@ export async function createDB (params, logger, currentDir, version) {
 
   if (typescript === true) {
     const tsConfigFileName = join(currentDir, 'tsconfig.json')
-    const isTsConfigExists = await isFileAccessible(tsConfigFileName)
-    if (!isTsConfigExists) {
-      const tsConfig = getTsConfig(TS_OUT_DIR)
-      await writeFile(tsConfigFileName, JSON.stringify(tsConfig, null, 2))
-      logger.info(`Typescript configuration file ${tsConfigFileName} successfully created.`)
-    } else {
-      logger.info(`Typescript configuration file ${tsConfigFileName} found, skipping creation of typescript configuration file.`)
-    }
+    const tsConfig = getTsConfig(TS_OUT_DIR)
+    await writeFile(tsConfigFileName, JSON.stringify(tsConfig, null, 2))
+    logger.info(`Typescript configuration file ${tsConfigFileName} successfully created.`)
   }
 
   if (plugin) {
@@ -462,9 +459,14 @@ export async function createDB (params, logger, currentDir, version) {
     await createDynamicWorkspaceGHAction(logger, dbEnv, './platformatic.db.json', currentDir, typescript)
   }
 
+  if (initGitRepository) {
+    await createGitRepository(logger, currentDir)
+  }
+
   if (isRuntimeContext) {
     return addPrefixToEnv(isRuntimeContext)
   }
+
   return dbEnv
 }
 

package/src/index.mjs

@@ -11,6 +11,7 @@ import commist from 'commist'
 import { getUsername, getVersion, minimumSupportedNodeVersions, isCurrentVersionSupported, findRuntimeConfigFile, getDependencyVersion } from './utils.mjs'
 import { createPackageJson } from './create-package-json.mjs'
 import { createGitignore } from './create-gitignore.mjs'
+import { createGitRepository } from './create-git-repository.mjs'
 
 export async function chooseKind (argv, opts = {}) {
   const skip = opts.skip
@@ -107,6 +108,7 @@ export default createPlatformatic
 export {
   createPackageJson,
   createGitignore,
+  createGitRepository,
   getVersion,
   getDependencyVersion
 }

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

@@ -11,7 +11,7 @@ import { execa } from 'execa'
 import ora from 'ora'
 import createRuntime from './create-runtime.mjs'
 import askDir from '../ask-dir.mjs'
-import { getPort, getRunPackageManagerInstall } from '../cli-options.mjs'
+import { getInitGitRepository, getPort, getRunPackageManagerInstall } from '../cli-options.mjs'
 import generateName from 'boring-name-generator'
 import { chooseKind } from '../index.mjs'
 import { createReadme } from '../create-readme.mjs'
@@ -67,10 +67,12 @@ export async function createPlatformaticRuntime (_args) {
     choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
   })
 
+  toAsk.push(getInitGitRepository())
   const {
     runPackageManagerInstall,
     staticWorkspaceGitHubAction,
-    dynamicWorkspaceGitHubAction
+    dynamicWorkspaceGitHubAction,
+    initGitRepository
   } = await inquirer.prompt(toAsk)
 
   await mkdir(servicesDir, { recursive: true })
@@ -130,7 +132,8 @@ export async function createPlatformaticRuntime (_args) {
     entrypointPort,
     staticWorkspaceGitHubAction,
     dynamicWorkspaceGitHubAction,
-    serviceNames: names
+    serviceNames: names,
+    initGitRepository
   }
 
   await createRuntime(params, logger, projectDir, version)
@@ -180,6 +183,7 @@ export async function createRuntimeService ({ servicesDir, names, logger }) {
     skipGitHubActions: true,
     skipPackageJson: true,
     skipGitignore: true,
+    skipGitRepository: true,
     port: '0',
     isRuntimeContext: true,
     runtimeContext: {

package/src/runtime/create-runtime.mjs

@@ -3,6 +3,7 @@ import { findRuntimeConfigFile } from '../utils.mjs'
 import { join, relative, isAbsolute } from 'path'
 import * as desm from 'desm'
 import { createDynamicWorkspaceGHAction, createStaticWorkspaceGHAction } from '../ghaction.mjs'
+import { createGitRepository } from '../create-git-repository.mjs'
 
 function generateConfig (version, path, entrypoint) {
   const config = {
@@ -25,9 +26,10 @@ async function createRuntime (params, logger, currentDir = process.cwd(), versio
     entrypoint,
     entrypointPort,
     staticWorkspaceGitHubAction,
-    dynamicWorkspaceGitHubAction
+    dynamicWorkspaceGitHubAction,
+    initGitRepository
   } = params
-
+  console.log('@@@@@@@@@@@@@@@@', params)
   if (!version) {
     const pkg = await readFile(desm.join(import.meta.url, '..', '..', 'package.json'))
     version = JSON.parse(pkg).version
@@ -59,6 +61,9 @@ async function createRuntime (params, logger, currentDir = process.cwd(), versio
     await createDynamicWorkspaceGHAction(logger, runtimeEnv, './platformatic.runtime.json', currentDir, false)
   }
 
+  if (initGitRepository) {
+    await createGitRepository(logger, currentDir)
+  }
   return {}
 }
 /**

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

@@ -12,7 +12,7 @@ import { execa } from 'execa'
 import ora from 'ora'
 import createService from './create-service.mjs'
 import askDir from '../ask-dir.mjs'
-import { getRunPackageManagerInstall, getUseTypescript, getPort } from '../cli-options.mjs'
+import { getRunPackageManagerInstall, getUseTypescript, getPort, getInitGitRepository } from '../cli-options.mjs'
 import { createReadme } from '../create-readme.mjs'
 
 const createPlatformaticService = async (_args, opts = {}) => {
@@ -71,12 +71,16 @@ const createPlatformaticService = async (_args, opts = {}) => {
       choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
     })
   }
+  if (!opts.skipGitRepository) {
+    toAsk.push(getInitGitRepository())
+  }
   const {
     runPackageManagerInstall,
     useTypescript,
     port,
     staticWorkspaceGitHubAction,
-    dynamicWorkspaceGitHubAction
+    dynamicWorkspaceGitHubAction,
+    initGitRepository
   } = await inquirer.prompt(toAsk)
 
   // Create the project directory
@@ -89,7 +93,8 @@ const createPlatformaticService = async (_args, opts = {}) => {
     typescript: useTypescript,
     staticWorkspaceGitHubAction,
     dynamicWorkspaceGitHubAction,
-    runtimeContext: opts.runtimeContext
+    runtimeContext: opts.runtimeContext,
+    initGitRepository
   }
 
   await createService(params, logger, projectDir, version)

package/src/service/create-service.mjs

@@ -5,6 +5,7 @@ import { addPrefixToEnv, findServiceConfigFile, isFileAccessible } from '../util
 import { getTsConfig } from '../get-tsconfig.mjs'
 import { generatePlugins } from '../create-plugins.mjs'
 import { createDynamicWorkspaceGHAction, createStaticWorkspaceGHAction } from '../ghaction.mjs'
+import { createGitRepository } from '../create-git-repository.mjs'
 
 const TS_OUT_DIR = 'dist'
 
@@ -72,7 +73,8 @@ async function createService (params, logger, currentDir = process.cwd(), versio
     typescript = false,
     staticWorkspaceGitHubAction,
     dynamicWorkspaceGitHubAction,
-    runtimeContext
+    runtimeContext,
+    initGitRepository
   } = params
 
   const serviceEnv = {
@@ -139,7 +141,9 @@ async function createService (params, logger, currentDir = process.cwd(), versio
   if (isRuntimeContext) {
     return addPrefixToEnv(serviceEnv, runtimeContext.envPrefix)
   }
-
+  if (initGitRepository) {
+    await createGitRepository(logger, currentDir)
+  }
   return serviceEnv
 }