wattpm-utils 3.39.0 → 3.41.0

package/bin/cli.js

@@ -1,11 +1,10 @@
 #!/usr/bin/env node
 
-import { checkNodeVersionForApplications, setExecutableId, setExecutableName } from '@platformatic/foundation'
+import { checkNodeVersionForApplications } from '@platformatic/foundation'
+import { createCLIContext } from '@platformatic/foundation/lib/cli.js'
 
 checkNodeVersionForApplications()
-setExecutableId('wattpm-utils')
-setExecutableName('Watt')
 
 // Use await import here so that we can throw a proper error on unsupported Node.js version
 const { main } = await import('../index.js')
-await main()
+await main.call(createCLIContext('wattpm-utils', 'Watt'))

package/index.js

@@ -1,4 +1,4 @@
-import { createCliLogger, getExecutableId, logFatalError, parseArgs, setVerbose } from '@platformatic/foundation'
+import { createCliLogger, logFatalError, parseArgs } from '@platformatic/foundation'
 import { bold } from 'colorette'
 import { createCommand } from './lib/commands/create.js'
 import { installCommand, updateCommand } from './lib/commands/dependencies.js'
@@ -8,7 +8,7 @@ import { patchConfigCommand } from './lib/commands/patch-config.js'
 import { version } from './lib/version.js'
 
 export async function main () {
-  globalThis.platformatic = { executable: getExecutableId() }
+  globalThis.platformatic = { executable: this.executableId }
 
   const options = {
     'no-pretty': {
@@ -31,6 +31,7 @@ export async function main () {
 
   const { values, unparsed } = parseArgs(process.argv.slice(2), options)
   const logger = createCliLogger('info', values['no-pretty'])
+  this.logger = logger
 
   if (values.version || unparsed[0] === 'version') {
     console.log(version)
@@ -38,16 +39,16 @@ export async function main () {
   }
 
   if (values.help) {
-    helpCommand(logger, [])
+    helpCommand.call(this, logger, [])
     return
   } else if (unparsed.includes('-h') || unparsed.includes('--help')) {
-    helpCommand(logger, unparsed)
+    helpCommand.call(this, logger, unparsed)
     return
   }
 
   /* c8 ignore next 3 */
   if (values.verbose) {
-    setVerbose(true)
+    this.verbose = true
   }
 
   let command
@@ -82,11 +83,11 @@ export async function main () {
   if (!command) {
     logFatalError(
       logger,
-      `Unknown command ${bold(requestedCommand)}. Please run ${bold(`"${getExecutableId()} help"`)} to see available commands.`
+      `Unknown command ${bold(requestedCommand)}. Please run ${bold(`"${this.executableId} help"`)} to see available commands.`
     )
 
     return
   }
 
-  await command(logger, unparsed.slice(1))
+  await command.call(this, logger, unparsed.slice(1))
 }

package/lib/commands/create.js

@@ -1,4 +1,4 @@
-import { getExecutableName, getPackageManager, parseArgs } from '@platformatic/foundation'
+import { getPackageManager, parseArgs } from '@platformatic/foundation'
 import { createApplication, getUsername, getVersion, say } from 'create-wattpm'
 import { resolve } from 'node:path'
 import { installDependencies } from './dependencies.js'
@@ -41,7 +41,7 @@ export async function createCommand (logger, args) {
   const version = await getVersion()
 
   /* c8 ignore next 3 - Ignoring else branches */
-  const executableName = getExecutableName()
+  const executableName = this.executableName
   const greeting = username ? `Hello ${username},` : 'Hello,'
   await say(`${greeting} welcome to ${version ? `${executableName} ${version}!` : `${executableName}!`}`)
 
@@ -68,7 +68,7 @@ export async function createCommand (logger, args) {
 
 const createHelp = {
   description () {
-    return `Creates a new ${getExecutableName()} project`
+    return `Creates a new ${this.executableName} project`
   },
   options: [
     {

package/lib/commands/dependencies.js

@@ -207,7 +207,15 @@ export async function installCommand (logger, args) {
   )
 
   const root = getRoot(positionals)
-  const configurationFile = await findRuntimeConfigurationFile(logger, root, config)
+  const configurationFile = await findRuntimeConfigurationFile(
+    logger,
+    root,
+    config,
+    true,
+    true,
+    true,
+    this.executableName
+  )
 
   /* c8 ignore next 3 - Hard to test */
   if (!configurationFile) {
@@ -241,7 +249,15 @@ export async function updateCommand (logger, args) {
   )
 
   const root = getRoot(positionals)
-  const configurationFile = await findRuntimeConfigurationFile(logger, root, config)
+  const configurationFile = await findRuntimeConfigurationFile(
+    logger,
+    root,
+    config,
+    true,
+    true,
+    true,
+    this.executableName
+  )
 
   /* c8 ignore next 3 - Hard to test */
   if (!configurationFile) {

package/lib/commands/external.js

@@ -5,7 +5,6 @@ import {
   ensureLoggableError,
   findConfigurationFile,
   findRuntimeConfigurationFile,
-  getExecutableId,
   getRoot,
   loadConfigurationFile as loadRawConfigurationFile,
   logFatalError,
@@ -94,8 +93,16 @@ export async function appendEnvVariable (envFile, key, value) {
   return writeFile(envFile, contents, 'utf-8')
 }
 
-async function fixConfiguration (logger, root, configOption, skipDependencies, packageManager) {
-  const configurationFile = await findRuntimeConfigurationFile(logger, root, configOption, true, true, false)
+async function fixConfiguration (context, logger, root, configOption, skipDependencies, packageManager) {
+  const configurationFile = await findRuntimeConfigurationFile(
+    logger,
+    root,
+    configOption,
+    true,
+    true,
+    false,
+    context.executableName
+  )
 
   /* c8 ignore next 3 - Hard to test */
   if (!configurationFile) {
@@ -533,7 +540,7 @@ export async function importCommand (logger, args) {
     Two arguments = root and URL
   */
   if (positionals.length === 0) {
-    return fixConfiguration(logger, '', config, skipDependencies, packageManager)
+    return fixConfiguration(this, logger, '', config, skipDependencies, packageManager)
   } else if (positionals.length === 1) {
     root = getRoot()
     rawUrl = positionals[0]
@@ -542,7 +549,15 @@ export async function importCommand (logger, args) {
     rawUrl = positionals[1]
   }
 
-  const configurationFile = await findRuntimeConfigurationFile(logger, root, config)
+  const configurationFile = await findRuntimeConfigurationFile(
+    logger,
+    root,
+    config,
+    true,
+    true,
+    true,
+    this.executableName
+  )
 
   /* c8 ignore next 3 - Hard to test */
   if (!configurationFile) {
@@ -597,7 +612,15 @@ export async function resolveCommand (logger, args) {
   )
 
   const root = getRoot(positionals)
-  const configurationFile = await findRuntimeConfigurationFile(logger, root, config)
+  const configurationFile = await findRuntimeConfigurationFile(
+    logger,
+    root,
+    config,
+    true,
+    true,
+    true,
+    this.executableName
+  )
 
   /* c8 ignore next 3 - Hard to test */
   if (!configurationFile) {
@@ -693,7 +716,7 @@ export const help = {
     ],
     footer () {
       return `
-${getExecutableId()} resolve command resolves runtime applications that have the \`url\` in their configuration.
+${this.executableId} resolve command resolves runtime applications that have the \`url\` in their configuration.
 To change the directory where an application is cloned, you can set the \`path\` property in the application configuration.
 
 After cloning the application, the resolve command will set the relative path to the application in the Platformatic configuration file.

package/lib/commands/help.js

@@ -1,9 +1,9 @@
-import { getExecutableId, getExecutableName, logFatalError, logo } from '@platformatic/foundation'
+import { logFatalError, logo } from '@platformatic/foundation'
 import { loadApplicationsCommands } from '@platformatic/runtime'
 import { bold } from 'colorette'
 
-function sanitizeHelp (raw) {
-  return (typeof raw === 'function' ? raw() : raw).trim()
+function sanitizeHelp (context, raw) {
+  return (typeof raw === 'function' ? raw.call(context) : raw).trim()
 }
 
 async function loadCommands () {
@@ -19,14 +19,14 @@ async function loadCommands () {
   return commands
 }
 
-export async function showGeneralHelp (logger) {
+export async function showGeneralHelp (context, logger) {
   if (typeof logger !== 'function') {
     logger = console.log
   }
 
-  const executableId = getExecutableId()
+  const executableId = context.executableId
   const commands = Object.values(await loadCommands())
-  const applicationsCommands = Object.values((await loadApplicationsCommands()).help)
+  const applicationsCommands = Object.values((await loadApplicationsCommands(context.executableName)).help)
 
   const options = [
     { usage: '-V, --version', description: `Show ${executableId} version` },
@@ -34,7 +34,7 @@ export async function showGeneralHelp (logger) {
     { usage: '--help', description: 'Show this help' }
   ]
 
-  logger(logo())
+  logger(logo.call(context))
   logger(`\nUsage: ${executableId} [options] [command]\n`)
 
   // Compute the maximum length of options or commands
@@ -48,24 +48,26 @@ export async function showGeneralHelp (logger) {
   // Print all options
   logger('Options:\n')
   for (const { usage, description } of options) {
-    logger(`  ${usage.padEnd(maximumLength, ' ')} ${sanitizeHelp(description)}`)
+    logger(`  ${usage.padEnd(maximumLength, ' ')} ${sanitizeHelp(context, description)}`)
   }
   logger('')
 
   // Print all commands
   logger('Commands:\n')
   for (const { usage, description } of commands) {
-    logger(`  ${usage.padEnd(maximumLength, ' ')} ${sanitizeHelp(description)}`)
+    logger(`  ${usage.padEnd(maximumLength, ' ')} ${sanitizeHelp(context, description)}`)
   }
   logger('')
 }
 
-export function showHelp (command, logger) {
+export function showHelp (context, command, logger) {
   if (typeof logger !== 'function') {
     logger = console.log
   }
 
-  logger(`\nUsage: ${getExecutableId()} ${sanitizeHelp(command.usage)}\n\n${sanitizeHelp(command.description)}.\n`)
+  logger(
+    `\nUsage: ${context.executableId} ${sanitizeHelp(context, command.usage)}\n\n${sanitizeHelp(context, command.description)}.\n`
+  )
 
   let { options, args } = command
   options ??= []
@@ -78,7 +80,7 @@ export function showHelp (command, logger) {
   if (options.length) {
     logger('Options:\n')
     for (const { usage, description } of options) {
-      logger(`  ${usage.padEnd(maximumLength, ' ')} ${sanitizeHelp(description)}`)
+      logger(`  ${usage.padEnd(maximumLength, ' ')} ${sanitizeHelp(context, description)}`)
     }
     logger('')
   }
@@ -87,13 +89,13 @@ export function showHelp (command, logger) {
   if (args.length) {
     logger('Arguments:\n')
     for (const { name, description } of args) {
-      logger(`  ${name.padEnd(maximumLength, ' ')} ${sanitizeHelp(description)}`)
+      logger(`  ${name.padEnd(maximumLength, ' ')} ${sanitizeHelp(context, description)}`)
     }
     logger('')
   }
 
   if (command.footer) {
-    logger(sanitizeHelp(command.footer) + '\n')
+    logger(sanitizeHelp(context, command.footer) + '\n')
   }
 }
 
@@ -101,31 +103,31 @@ export async function helpCommand (logger, args) {
   const command = args?.[0]
 
   if (!command) {
-    return showGeneralHelp()
+    return showGeneralHelp(this)
   }
 
   const commands = await loadCommands()
   if (!commands[command]) {
     return logFatalError(
       logger,
-      `Unknown command ${bold(command)}. Please run ${bold(`"${getExecutableId()} help"`)} to see available commands.`
+      `Unknown command ${bold(command)}. Please run ${bold(`"${this.executableId} help"`)} to see available commands.`
     )
   }
 
-  showHelp(commands[command])
+  showHelp(this, commands[command])
 }
 
 export const help = {
   help: {
     usage: 'help [command]',
     description () {
-      return `Show help about ${getExecutableName()} or one of its commands`
+      return `Show help about ${this.executableName} or one of its commands`
     }
   },
   version: {
     usage: 'version',
     description () {
-      return `Show current ${getExecutableName()} version`
+      return `Show current ${this.executableName} version`
     }
   }
 }

package/lib/commands/patch-config.js

@@ -69,7 +69,9 @@ export async function patchConfig (logger, configurationFile, patchPath) {
       applications: {}
     }
 
-    const applications = Object.fromEntries(loaded.runtime.applications.map(application => [application.id, application]))
+    const applications = Object.fromEntries(
+      loaded.runtime.applications.map(application => [application.id, application])
+    )
 
     // Load configuration for all applications
     for (const application of loaded.runtime.applications) {
@@ -165,7 +167,15 @@ export async function patchConfigCommand (logger, args) {
     patch = positionals[1]
   }
 
-  const configurationFile = await findRuntimeConfigurationFile(logger, root, config)
+  const configurationFile = await findRuntimeConfigurationFile(
+    logger,
+    root,
+    config,
+    true,
+    true,
+    true,
+    this.executableName
+  )
 
   /* c8 ignore next 3 */
   if (!configurationFile) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wattpm-utils",
-  "version": "3.39.0",
+  "version": "3.41.0",
   "description": "The Node.js Application Server Utilities Commands",
   "main": "index.js",
   "type": "module",
@@ -29,9 +29,9 @@
     "execa": "^9.4.0",
     "semver": "^7.7.0",
     "tar": "^7.5.7",
-    "@platformatic/foundation": "3.39.0",
-    "@platformatic/runtime": "3.39.0",
-    "create-wattpm": "3.39.0"
+    "@platformatic/foundation": "3.41.0",
+    "create-wattpm": "3.41.0",
+    "@platformatic/runtime": "3.41.0"
   },
   "devDependencies": {
     "cleaner-spec-reporter": "^0.5.0",
@@ -41,7 +41,7 @@
     "neostandard": "^0.12.0",
     "typescript": "^5.5.4",
     "undici": "^7.0.0",
-    "@platformatic/node": "3.39.0"
+    "@platformatic/node": "3.41.0"
   },
   "engines": {
     "node": ">=22.19.0"