create-platformatic 2.0.0-alpha.2 → 2.0.0-alpha.4

package/create-platformatic.mjs

@@ -19,8 +19,8 @@ if (isMain(import.meta)) {
   const _args = process.argv.slice(2)
   const args = parseArgs(_args, {
     alias: {
-      v: 'version'
-    }
+      v: 'version',
+    },
   })
 
   if (args.version) {

package/eslint.config.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require('neostandard')({})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.4",
   "description": "Create platformatic application interactive tool",
   "repository": {
     "type": "git",
@@ -35,31 +35,31 @@
     "strip-ansi": "^7.1.0",
     "undici": "^6.9.0",
     "which": "^3.0.1",
-    "@platformatic/config": "2.0.0-alpha.2",
-    "@platformatic/utils": "2.0.0-alpha.2",
-    "@platformatic/generators": "2.0.0-alpha.2"
+    "@platformatic/generators": "2.0.0-alpha.4",
+    "@platformatic/config": "2.0.0-alpha.4",
+    "@platformatic/utils": "2.0.0-alpha.4"
   },
   "devDependencies": {
     "ajv": "^8.12.0",
-    "borp": "^0.16.0",
+    "borp": "^0.17.0",
     "c8": "^10.0.0",
     "cross-env": "^7.0.3",
     "dotenv": "^16.4.5",
+    "eslint": "9",
     "esmock": "^2.6.4",
     "fastify": "^4.26.2",
-    "snazzy": "^9.0.0",
-    "standard": "^17.1.0",
-    "typescript": "~5.5.0",
+    "neostandard": "^0.11.1",
+    "typescript": "~5.5.4",
     "yaml": "^2.4.1",
-    "@platformatic/composer": "2.0.0-alpha.2",
-    "@platformatic/db": "2.0.0-alpha.2",
-    "@platformatic/runtime": "2.0.0-alpha.2",
-    "@platformatic/service": "2.0.0-alpha.2"
+    "@platformatic/composer": "2.0.0-alpha.4",
+    "@platformatic/db": "2.0.0-alpha.4",
+    "@platformatic/runtime": "2.0.0-alpha.4",
+    "@platformatic/service": "2.0.0-alpha.4"
   },
   "scripts": {
-    "test:cli": "borp --pattern \"test/cli/*test.mjs\" --timeout 120000 --concurrency=1",
-    "test:unit": "pnpm run lint && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" borp --pattern \"test/unit/*test.mjs\" --timeout 120000 --concurrency=1",
+    "test:cli": "borp --pattern \"test/cli/*test.mjs\" --timeout=180000 --concurrency=1",
+    "test:unit": "pnpm run lint && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" borp --pattern \"test/unit/*test.mjs\" --timeout=180000 --concurrency=1",
     "test": "npm run test:unit && npm run test:cli",
-    "lint": "standard | snazzy"
+    "lint": "eslint"
   }
 }

package/src/index.mjs

@@ -1,21 +1,21 @@
-import { say } from './say.mjs'
-import path, { basename, join } from 'node:path'
-import inquirer from 'inquirer'
-import generateName from 'boring-name-generator'
-import { getUsername, getVersion, minimumSupportedNodeVersions, isCurrentVersionSupported, safeMkdir } from './utils.mjs'
-import { createGitRepository } from './create-git-repository.mjs'
-import { getPkgManager } from '@platformatic/utils'
 import { StackableGenerator } from '@platformatic/generators'
-import pino from 'pino'
-import pretty from 'pino-pretty'
+import { createDirectory, getPkgManager } from '@platformatic/utils'
+import generateName from 'boring-name-generator'
 import { execa } from 'execa'
+import inquirer from 'inquirer'
 import parseArgs from 'minimist'
-import ora from 'ora'
-import { pathToFileURL } from 'node:url'
 import { writeFile } from 'node:fs/promises'
-import { request } from 'undici'
+import path, { basename, join } from 'node:path'
 import { setTimeout } from 'node:timers/promises'
+import { pathToFileURL } from 'node:url'
+import ora from 'ora'
+import pino from 'pino'
+import pretty from 'pino-pretty'
 import resolve from 'resolve'
+import { request } from 'undici'
+import { createGitRepository } from './create-git-repository.mjs'
+import { say } from './say.mjs'
+import { getUsername, getVersion, isCurrentVersionSupported, minimumSupportedNodeVersions } from './utils.mjs'
 
 const MARKETPLACE_HOST = 'https://marketplace.platformatic.dev'
 
@@ -26,10 +26,7 @@ export async function fetchStackables (marketplaceHost) {
   const stackablesRequestTimeout = setTimeout(5000, new Error('Request timed out'))
 
   try {
-    const { statusCode, body } = await Promise.race([
-      stackablesRequest,
-      stackablesRequestTimeout
-    ])
+    const { statusCode, body } = await Promise.race([stackablesRequest, stackablesRequestTimeout])
     if (statusCode === 200) {
       return (await body.json()).map(stackable => stackable.name)
     }
@@ -44,7 +41,7 @@ export async function chooseStackable (stackables) {
     name: 'type',
     message: 'Which kind of project do you want to create?',
     default: stackables.indexOf('@platformatic/service'),
-    choices: stackables
+    choices: stackables,
   })
 
   return options.type
@@ -57,7 +54,7 @@ async function importOrLocal ({ pkgManager, name, projectDir, pkg }) {
     try {
       const fileToImport = resolve.sync(pkg, { basedir: projectDir })
       return await import(pathToFileURL(fileToImport))
-    } catch { }
+    } catch {}
 
     const spinner = ora(`Installing ${pkg}...`).start()
     await execa(pkgManager, ['install', pkg], { cwd: projectDir })
@@ -68,13 +65,13 @@ async function importOrLocal ({ pkgManager, name, projectDir, pkg }) {
   }
 }
 
-export const createPlatformatic = async (argv) => {
+export const createPlatformatic = async argv => {
   const args = parseArgs(argv, {
     default: {
-      install: true
+      install: true,
     },
     boolean: ['install'],
-    string: ['global-config', 'marketplace-host']
+    string: ['global-config', 'marketplace-host'],
   })
 
   const username = await getUsername()
@@ -90,10 +87,12 @@ export const createPlatformatic = async (argv) => {
     await say(`Please use one of the following Node.js versions >= ${supportedVersions}.`)
   }
 
-  const logger = pino(pretty({
-    translateTime: 'SYS:HH:MM:ss',
-    ignore: 'hostname,pid'
-  }))
+  const logger = pino(
+    pretty({
+      translateTime: 'SYS:HH:MM:ss',
+      ignore: 'hostname,pid',
+    })
+  )
 
   const pkgManager = getPkgManager()
 
@@ -104,8 +103,8 @@ export const createPlatformatic = async (argv) => {
     default: 'application',
     choices: [
       { name: 'Application', value: 'application' },
-      { name: 'Stackable', value: 'stackable' }
-    ]
+      { name: 'Stackable', value: 'stackable' },
+    ],
   })
 
   if (projectType === 'application') {
@@ -120,29 +119,29 @@ async function createApplication (args, logger, pkgManager) {
     type: 'input',
     name: 'dir',
     message: 'Where would you like to create your project?',
-    default: 'platformatic'
+    default: 'platformatic',
   })
 
   const projectDir = path.resolve(process.cwd(), optionsDir.dir)
   const projectName = basename(projectDir)
 
-  await safeMkdir(projectDir)
+  await createDirectory(projectDir)
 
   const runtime = await importOrLocal({
     pkgManager,
     name: projectName,
     projectDir,
-    pkg: '@platformatic/runtime'
+    pkg: '@platformatic/runtime',
   })
 
   const generator = new runtime.Generator({
     logger,
     name: projectName,
-    inquirer
+    inquirer,
   })
   generator.setConfig({
     ...generator.config,
-    targetDirectory: projectDir
+    targetDirectory: projectDir,
   })
 
   await generator.populateFromExistingConfig()
@@ -162,7 +161,7 @@ async function createApplication (args, logger, pkgManager) {
       pkgManager,
       name: projectName,
       projectDir,
-      pkg: stackableName
+      pkg: stackableName,
     })
 
     const { serviceName } = await inquirer.prompt({
@@ -170,7 +169,7 @@ async function createApplication (args, logger, pkgManager) {
       name: 'serviceName',
       message: 'What is the name of the service?',
       default: generateName().dashed,
-      validate: (value) => {
+      validate: value => {
         if (value.length === 0) {
           return 'Please enter a name'
         }
@@ -184,19 +183,19 @@ async function createApplication (args, logger, pkgManager) {
         }
 
         return true
-      }
+      },
     })
 
     names.push(serviceName)
 
     const stackableGenerator = new stackable.Generator({
       logger,
-      inquirer
+      inquirer,
     })
 
     stackableGenerator.setConfig({
       ...stackableGenerator.config,
-      serviceName
+      serviceName,
     })
 
     generator.addService(stackableGenerator, serviceName)
@@ -209,8 +208,11 @@ async function createApplication (args, logger, pkgManager) {
         name: 'shouldBreak',
         message: 'Do you want to create another service?',
         default: false,
-        choices: [{ name: 'yes', value: false }, { name: 'no', value: true }]
-      }
+        choices: [
+          { name: 'yes', value: false },
+          { name: 'no', value: true },
+        ],
+      },
     ])
 
     if (shouldBreak) {
@@ -226,8 +228,8 @@ async function createApplication (args, logger, pkgManager) {
         type: 'list',
         name: 'entrypoint',
         message: 'Which service should be exposed?',
-        choices: names.map(name => ({ name, value: name }))
-      }
+        choices: names.map(name => ({ name, value: name })),
+      },
     ])
     entrypoint = results.entrypoint
   } else {
@@ -247,7 +249,10 @@ async function createApplication (args, logger, pkgManager) {
     name: 'initGitRepository',
     message: 'Do you want to init the git repository?',
     default: false,
-    choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+    choices: [
+      { name: 'yes', value: true },
+      { name: 'no', value: false },
+    ],
   })
 
   if (initGitRepository) {
@@ -259,7 +264,7 @@ async function createApplication (args, logger, pkgManager) {
     const content = `packages:
 # all packages in direct subdirs of packages/
 - 'services/*'`
-    await (writeFile(join(projectDir, 'pnpm-workspace.yaml'), content))
+    await writeFile(join(projectDir, 'pnpm-workspace.yaml'), content)
   }
 
   if (args.install) {
@@ -288,7 +293,10 @@ async function createStackable (args, logger, pkgManager) {
     name: 'initGitRepository',
     message: 'Do you want to init the git repository?',
     default: false,
-    choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+    choices: [
+      { name: 'yes', value: true },
+      { name: 'no', value: false },
+    ],
   })
 
   if (initGitRepository) {

package/src/utils.mjs

@@ -1,14 +1,14 @@
+import * as desm from 'desm'
 import { execa } from 'execa'
-import { access, constants, mkdir, readFile } from 'fs/promises'
-import { resolve, join, dirname } from 'path'
+import { access, constants, readFile } from 'fs/promises'
 import { createRequire } from 'module'
+import { dirname, join, resolve } from 'path'
 import semver from 'semver'
-import * as desm from 'desm'
 import * as url from 'url'
 
 import ConfigManager from '@platformatic/config'
 
-export const sleep = ms => new Promise((resolve) => setTimeout(resolve, ms))
+export const sleep = ms => new Promise(resolve => setTimeout(resolve, ms))
 export const randomBetween = (min, max) => Math.floor(Math.random() * (max - min + 1) + min)
 const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
@@ -32,7 +32,7 @@ export const getUsername = async () => {
       return stdout.trim()
     }
   } catch (err) {
-  // ignore: git failed
+    // ignore: git failed
   }
   try {
     const { stdout } = await execa('whoami')
@@ -40,7 +40,7 @@ export const getUsername = async () => {
       return stdout.trim()
     }
   } catch (err) {
-  // ignore: whoami failed
+    // ignore: whoami failed
   }
 
   return null
@@ -64,18 +64,18 @@ export async function isDirectoryWriteable (directory) {
   }
 }
 
-export const findConfigFile = async (directory) => (ConfigManager.findConfigFile(directory))
-export const findDBConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'db'))
-export const findServiceConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'service'))
-export const findComposerConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'composer'))
-export const findRuntimeConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'runtime'))
+export const findConfigFile = async directory => ConfigManager.findConfigFile(directory)
+export const findDBConfigFile = async directory => ConfigManager.findConfigFile(directory, 'db')
+export const findServiceConfigFile = async directory => ConfigManager.findConfigFile(directory, 'service')
+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) => {
+export const getDependencyVersion = async dependencyName => {
   const rootPackageJson = join(__dirname, '..', 'package.json')
   const packageJsonContents = JSON.parse(await readFile(rootPackageJson, 'utf8'))
   const dependencies = packageJsonContents.dependencies
@@ -103,7 +103,7 @@ export const getDependencyVersion = async (dependencyName) => {
     // some deps are resolved not at their root level
     // for instance 'typescript' will be risolved in its own ./lib directory
     // next loop is to find the nearest parent directory that contains a package.json file
-    while (!await isFileAccessible(join(dependencyPath, 'package.json'))) {
+    while (!(await isFileAccessible(join(dependencyPath, 'package.json')))) {
       dependencyPath = join(dependencyPath, '..')
       if (dependencyPath === '/') {
         throw new Error(`Cannot find package.json for ${dependencyName}`)
@@ -118,7 +118,7 @@ export const getDependencyVersion = async (dependencyName) => {
 
 export const minimumSupportedNodeVersions = ['18.8.0', '20.6.0']
 
-export const isCurrentVersionSupported = (currentVersion) => {
+export const isCurrentVersionSupported = currentVersion => {
   // TODO: add try/catch if some unsupported node version is passed
   for (const version of minimumSupportedNodeVersions) {
     if (semver.major(currentVersion) === semver.major(version) && semver.gte(currentVersion, version)) {
@@ -138,11 +138,3 @@ export function addPrefixToEnv (env, prefix) {
   })
   return output
 }
-
-export async function safeMkdir (dir) {
-  try {
-    await mkdir(dir, { recursive: true })
-  } catch (err) {
-    // do nothing
-  }
-}

package/test/cli/composer.test.mjs

@@ -1,17 +1,12 @@
-import { test } from 'node:test'
+import { safeRemove } from '@platformatic/utils'
+import { mkdtemp } from 'fs/promises'
 import { equal } from 'node:assert'
-import { timeout } from './timeout.mjs'
-import { isFileAccessible } from '../../src/utils.mjs'
 import { join } from 'node:path'
+import { test } from 'node:test'
 import { tmpdir } from 'os'
-import { mkdtemp, rm } from 'fs/promises'
-import {
-  executeCreatePlatformatic,
-  startMarketplace,
-  keys,
-  walk,
-  getServices
-} from './helper.mjs'
+import { isFileAccessible } from '../../src/utils.mjs'
+import { executeCreatePlatformatic, getServices, keys, startMarketplace, walk } from './helper.mjs'
+import { timeout } from './timeout.mjs'
 
 let tmpDir
 test.beforeEach(async () => {
@@ -20,43 +15,52 @@ test.beforeEach(async () => {
 
 test.afterEach(async () => {
   try {
-    await rm(tmpDir, { recursive: true, force: true })
+    await safeRemove(tmpDir)
   } catch (e) {
     // on purpose, in win the resource might be still "busy"
   }
 })
 
-test('Creates a Platformatic Composer', { timeout }, async (t) => {
+test('Creates a Platformatic Composer', { timeout }, async t => {
   const marketplaceHost = await startMarketplace(t)
   // The actions must match IN ORDER
-  const actions = [{
-    match: 'What kind of project do you want to create?',
-    do: [keys.ENTER] // Application
-  }, {
-    match: 'Where would you like to create your project?',
-    do: [keys.ENTER],
-    waitAfter: 8000
-  }, {
-    match: 'Which kind of project do you want to create?',
-    do: [keys.UP, keys.UP, keys.ENTER] // Composer
-  }, {
-    match: 'What is the name of the service?',
-    do: [keys.ENTER]
-  }, {
-    match: 'Do you want to create another service?',
-    do: [keys.DOWN, keys.ENTER] // no
-  }, {
-    // NOTE THAT HERE THE DEFAULT OPTION FOR SERVICE IS "YES"
-    match: 'Do you want to use TypeScript',
-    do: [keys.ENTER], // no
-    waitAfter: 8000
-  }, {
-    match: 'What port do you want to use?',
-    do: [keys.ENTER]
-  }, {
-    match: 'Do you want to init the git repository',
-    do: [keys.DOWN, keys.ENTER] // yes
-  }]
+  const actions = [
+    {
+      match: 'What kind of project do you want to create?',
+      do: [keys.ENTER], // Application
+    },
+    {
+      match: 'Where would you like to create your project?',
+      do: [keys.ENTER],
+      waitAfter: 8000,
+    },
+    {
+      match: 'Which kind of project do you want to create?',
+      do: [keys.UP, keys.UP, keys.ENTER], // Composer
+    },
+    {
+      match: 'What is the name of the service?',
+      do: [keys.ENTER],
+    },
+    {
+      match: 'Do you want to create another service?',
+      do: [keys.DOWN, keys.ENTER], // no
+    },
+    {
+      // NOTE THAT HERE THE DEFAULT OPTION FOR SERVICE IS "YES"
+      match: 'Do you want to use TypeScript',
+      do: [keys.ENTER], // no
+      waitAfter: 8000,
+    },
+    {
+      match: 'What port do you want to use?',
+      do: [keys.ENTER],
+    },
+    {
+      match: 'Do you want to init the git repository',
+      do: [keys.DOWN, keys.ENTER], // yes
+    },
+  ]
   await executeCreatePlatformatic(tmpDir, actions, { marketplaceHost })
 
   const baseProjectDir = join(tmpDir, 'platformatic')

package/test/cli/db.test.mjs

@@ -1,17 +1,12 @@
-import { test } from 'node:test'
+import { safeRemove } from '@platformatic/utils'
+import { mkdtemp } from 'fs/promises'
 import { equal } from 'node:assert'
-import { timeout } from './timeout.mjs'
-import { isFileAccessible } from '../../src/utils.mjs'
 import { join } from 'node:path'
+import { test } from 'node:test'
 import { tmpdir } from 'os'
-import { mkdtemp, rm } from 'fs/promises'
-import {
-  executeCreatePlatformatic,
-  startMarketplace,
-  keys,
-  walk,
-  getServices
-} from './helper.mjs'
+import { isFileAccessible } from '../../src/utils.mjs'
+import { executeCreatePlatformatic, getServices, keys, startMarketplace, walk } from './helper.mjs'
+import { timeout } from './timeout.mjs'
 
 let tmpDir
 test.beforeEach(async () => {
@@ -20,48 +15,59 @@ test.beforeEach(async () => {
 
 test.afterEach(async () => {
   try {
-    await rm(tmpDir, { recursive: true, force: true })
+    await safeRemove(tmpDir)
   } catch (e) {
     // on purpose, in win the resource might be still "busy"
   }
 })
 
-test('Creates a Platformatic DB service with no migrations', { timeout }, async (t) => {
+test('Creates a Platformatic DB service with no migrations', { timeout }, async t => {
   const marketplaceHost = await startMarketplace(t)
   // The actions must match IN ORDER
-  const actions = [{
-    match: 'What kind of project do you want to create?',
-    do: [keys.ENTER] // Application
-  }, {
-    match: 'Where would you like to create your project?',
-    do: [keys.ENTER],
-    waitAfter: 8000
-  }, {
-    match: 'Which kind of project do you want to create?',
-    do: [keys.UP, keys.ENTER] // DB
-  }, {
-    match: 'What is the name of the service?',
-    do: [keys.ENTER]
-  }, {
-    match: 'What is the connection string?',
-    do: [keys.ENTER]
-  }, {
-    match: 'Do you want to create default migrations',
-    do: [keys.DOWN, keys.ENTER] // no
-  }, {
-    match: 'Do you want to create another service?',
-    do: [keys.DOWN, keys.ENTER] // no
-  }, {
-    // NOTE THAT HERE THE DEFAULT OPTION FOR SERVICE IS "YES"
-    match: 'Do you want to use TypeScript',
-    do: [keys.ENTER] // no
-  }, {
-    match: 'What port do you want to use?',
-    do: [keys.ENTER]
-  }, {
-    match: 'Do you want to init the git repository',
-    do: [keys.DOWN, keys.ENTER] // yes
-  }]
+  const actions = [
+    {
+      match: 'What kind of project do you want to create?',
+      do: [keys.ENTER], // Application
+    },
+    {
+      match: 'Where would you like to create your project?',
+      do: [keys.ENTER],
+      waitAfter: 8000,
+    },
+    {
+      match: 'Which kind of project do you want to create?',
+      do: [keys.UP, keys.ENTER], // DB
+    },
+    {
+      match: 'What is the name of the service?',
+      do: [keys.ENTER],
+    },
+    {
+      match: 'What is the connection string?',
+      do: [keys.ENTER],
+    },
+    {
+      match: 'Do you want to create default migrations',
+      do: [keys.DOWN, keys.ENTER], // no
+    },
+    {
+      match: 'Do you want to create another service?',
+      do: [keys.DOWN, keys.ENTER], // no
+    },
+    {
+      // NOTE THAT HERE THE DEFAULT OPTION FOR SERVICE IS "YES"
+      match: 'Do you want to use TypeScript',
+      do: [keys.ENTER], // no
+    },
+    {
+      match: 'What port do you want to use?',
+      do: [keys.ENTER],
+    },
+    {
+      match: 'Do you want to init the git repository',
+      do: [keys.DOWN, keys.ENTER], // yes
+    },
+  ]
   await executeCreatePlatformatic(tmpDir, actions, { marketplaceHost })
 
   const baseProjectDir = join(tmpDir, 'platformatic')

package/test/cli/helper.mjs

@@ -13,7 +13,7 @@ export const keys = {
   DOWN: '\x1B\x5B\x42',
   UP: '\x1B\x5B\x41',
   ENTER: '\x0D',
-  SPACE: '\x20'
+  SPACE: '\x20',
 }
 
 export const createPath = join(import.meta.url, '..', '..', 'create-platformatic.mjs')
@@ -60,19 +60,19 @@ export async function executeCreatePlatformatic (dir, actions = [], options = {}
     const questions = [...actions]
     try {
       const execaOptions = {
-        cwd: dir
+        cwd: dir,
       }
 
       if (pkgManager === 'pnpm') {
         execaOptions.env = {
-          npm_config_user_agent: 'pnpm/6.14.1 npm/? node/v16.4.2 darwin x64'
+          npm_config_user_agent: 'pnpm/6.14.1 npm/? node/v16.4.2 darwin x64',
         }
       }
 
       const child = execa('node', [
         createPath,
         `--install=${pkgMgrInstall.toString()}`,
-        `--marketplace-host=${marketplaceHost}`
+        `--marketplace-host=${marketplaceHost}`,
       ], execaOptions)
 
       // We just need the "lastPrompt" printed before the process stopped to wait for an answer
@@ -147,7 +147,7 @@ export async function startMarketplace (t, opts = {}) {
     return [
       { name: '@platformatic/composer' },
       { name: '@platformatic/db' },
-      { name: '@platformatic/service' }
+      { name: '@platformatic/service' },
     ]
   })