@stacksjs/buddy 0.58.72 → 0.59.1

package/src/commands/ports.ts

@@ -0,0 +1,180 @@
+import process from 'node:process'
+import type { CLI, Ports, PortsOptions } from '@stacksjs/types'
+import { ExitCode } from '@stacksjs/types'
+import { ports as projectPorts } from '@stacksjs/config'
+import { log } from '@stacksjs/logging'
+import { findProjectPath, path as p, projectPath } from '@stacksjs/path'
+import { $ } from 'bun'
+import { intro, italic, outro } from '@stacksjs/cli'
+import { findStacksProjects } from '@stacksjs/utils'
+
+export function ports(buddy: CLI) {
+  const descriptions = {
+    command: 'Let buddy check your project for potential issues and misconfigurations',
+    ports: 'Check if the ports are available',
+    project: 'Target a specific project',
+    verbose: 'Enable verbose output',
+  }
+
+  buddy
+    .command('ports', descriptions.command)
+    .option('-l, --list', 'List the used ports', { default: true })
+    .option('-c, --check', 'Check if the ports are available', { default: false })
+    .option('-p, --project [name]', descriptions.project, { default: undefined })
+    .option('-q, --quiet', 'Use minimal output', { default: false })
+    .option('--verbose', descriptions.verbose, { default: false })
+    .action(async (options: PortsOptions) => {
+      log.debug('Running `buddy ports` ...', options)
+
+      let perf
+      if (!options.quiet)
+        perf = await intro('buddy ports')
+
+      if (options.project) {
+        const path = await findProjectPath(options.project)
+        log.debug(`Path: ${path}`)
+
+        const ports = await getPortsForProjectPath(path, options)
+        log.debug(`./buddy ports --quiet response for ${projectPath}`, ports)
+
+        outputPorts(ports, options)
+      }
+
+      // use the user config ports
+      else {
+        outputPorts(projectPorts, options)
+      }
+
+      if (!options.quiet)
+        await outro('Exited', { startTime: perf, useSeconds: false })
+
+      process.exit(ExitCode.Success)
+    })
+
+  buddy
+    .command('ports:list', descriptions.ports)
+    .option('-p, --project [name]', descriptions.project, { default: undefined })
+    .option('-q, --quiet', 'Use minimal output', { default: false })
+    .option('--verbose', descriptions.verbose, { default: false })
+    .action(async (options: PortsOptions) => {
+      log.debug('Running `buddy ports:list` ...', options)
+
+      let perf
+      if (!options.quiet)
+        perf = await intro('buddy ports:list')
+
+      // return the ports for the project
+      if (options.project) {
+        if (!options.quiet)
+          log.info(`Listing ports for project: ${italic(options.project)}`)
+
+        const path = await findProjectPath(options.project)
+
+        log.debug(`Path: ${path}`)
+
+        const ports = await getPortsForProjectPath(path, options)
+
+        outputPorts(ports, options)
+      }
+      // return the used ports for all projects
+      else {
+        outputPorts(projectPorts, options)
+      }
+
+      if (!options.quiet)
+        await outro('Exited', { startTime: perf, useSeconds: false })
+
+      process.exit(ExitCode.Success)
+    })
+
+  buddy
+    .command('ports:check', descriptions.ports)
+    .option('-p, --project [name]', descriptions.project, { default: projectPath() })
+    .option('-q, --quiet', 'Use minimal output', { default: false })
+    .option('--verbose', descriptions.verbose, { default: false })
+    .action(async (options: PortsOptions) => {
+      log.debug('Running `buddy ports:check` ...', options)
+
+      let perf
+      if (!options.quiet)
+        perf = await intro('buddy ports:check')
+
+      const projects = await findStacksProjects(undefined, { quiet: true })
+
+      log.debug('Running `buddy ports`')
+      log.debug(`Found ${projects.length} projects`)
+      log.debug('Projects:', projects)
+
+      // need to loop over the projects and then trigger `buddy ports` for each project (which returns a list of ports)
+      const projectsPorts: { [project: string]: Ports } = {}
+      for (const project of projects)
+        projectsPorts[project] = await getPortsForProjectPath(project, options)
+
+      log.info('ProjectsPorts:', projectsPorts)
+
+      if (!options.quiet)
+        await outro('Exited', { startTime: perf, useSeconds: false })
+
+      process.exit(ExitCode.Success)
+    })
+
+  buddy.on('ports:*', () => {
+    console.error('Invalid command: %s\nSee --help for a list of available commands.', buddy.args.join(' '))
+    process.exit(1)
+  })
+}
+
+async function getPortsForProjectPath(path: string, options: PortsOptions) {
+  if (!options.quiet)
+    log.info(`Checking ports for project: ${italic(path)}`)
+
+  $.cwd(path)
+  // load the .env file for the project
+  $.env(await import(`${path}/.env`))
+
+  const projectList = await $`./buddy projects:list --quiet`.text()
+  log.debug('ProjectListResponse', projectList)
+
+  // get the list of all Stacks project paths (on the system)
+  const projects = projectList.split('\n').filter(line => line.startsWith('   - ')).map(line => line.trim().substring(4))
+  log.debug('Projects:', projects)
+
+  // since we are targeting a specific project, find its path
+  const ppath = options.project ?? p.projectPath()
+  let projectPath = projects.find(project => project.includes(ppath))
+
+  log.debug(`Checking ports for project: ${projectPath}`)
+  if (projectPath === '' || !projectPath) // default to the current project
+    projectPath = p.projectPath()
+
+  log.debug(`$ Running: ./buddy ports:list --quiet via ${projectPath}`)
+  const response = (await $`./buddy ports:list --quiet`.json())
+
+  log.debug(`Response for ./buddy ports:list --quiet via ${projectPath}`, response)
+
+  // Step 1: Add double quotes around keys
+  let validJsonString = response.replace(/(\w+)(?=\s*:)/g, '"$1"')
+
+  // Step 2: Remove potential trailing commas before closing braces
+  validJsonString = validJsonString.replace(/,(\s*})/g, '$1')
+
+  // Now we can parse it into an object
+  const ports = JSON.parse(validJsonString) as Ports
+
+  log.debug(`Ports for ${projectPath}`, ports)
+
+  return ports
+}
+
+function outputPorts(ports: Ports, options: PortsOptions) {
+  if (!options.quiet)
+  // eslint-disable-next-line no-console
+    console.log('')
+
+  // eslint-disable-next-line no-console
+  console.log(ports)
+
+  if (!options.quiet)
+  // eslint-disable-next-line no-console
+    console.log('')
+}

package/src/commands/prepublish.ts

@@ -2,7 +2,7 @@ import process from 'node:process'
 import type { CLI, PrepublishOptions } from '@stacksjs/types'
 import { Action } from '@stacksjs/enums'
 import { runAction } from '@stacksjs/actions'
-import { log } from 'stacks/logging'
+import { log } from '@stacksjs/logging'
 
 export function prepublish(buddy: CLI) {
   const descriptions = {

package/src/commands/projects.ts

@@ -0,0 +1,58 @@
+import process from 'node:process'
+import { ExitCode } from '@stacksjs/types'
+import type { CLI, ProjectsOptions } from '@stacksjs/types'
+import { intro, log } from '@stacksjs/cli'
+import { findStacksProjects } from '@stacksjs/utils'
+
+export function projects(buddy: CLI) {
+  const descriptions = {
+    projects: 'Find all Stacks projects on your system',
+    verbose: 'Enable verbose output',
+  }
+
+  buddy
+    .command('projects', descriptions.projects)
+    .option('-q, --quiet', 'Use minimal output', { default: false })
+    .option('-l, --list', 'List all local Stacks projects', { default: false })
+    .option('--verbose', descriptions.verbose, { default: false })
+    .action(async (options: ProjectsOptions) => {
+      log.debug('Running `buddy projects` ...', options)
+
+      if (!options.quiet)
+        await intro('buddy projects')
+
+      const projects = await findStacksProjects(undefined, options)
+
+      for (const project of projects)
+        // eslint-disable-next-line no-console
+        console.log('   - ', project)
+
+      process.exit(ExitCode.Success)
+    })
+
+  buddy
+    .command('projects:list', descriptions.projects)
+    .option('-q, --quiet', 'Use minimal output', { default: false })
+    .option('-l, --list', 'List all local Stacks projects', { default: true })
+    .option('--verbose', descriptions.verbose, { default: false })
+    .action(async (options: ProjectsOptions) => {
+      log.debug('Running `buddy projects` ...', options)
+
+      if (!options.quiet)
+        await intro('buddy projects:list')
+
+      // uses os.homedir() as the default path
+      const projects = await findStacksProjects(undefined, options)
+
+      for (const project of projects)
+        // eslint-disable-next-line no-console
+        console.log('   - ', project)
+
+      process.exit(ExitCode.Success)
+    })
+
+  buddy.on('projects:*', () => {
+    console.error('Invalid command: %s\nSee --help for a list of available commands.', buddy.args.join(' '))
+    process.exit(1)
+  })
+}

package/src/commands/setup.ts

@@ -1,11 +1,10 @@
 import process from 'node:process'
 import { path as p } from '@stacksjs/path'
+import { Action } from '@stacksjs/enums'
 import { handleError } from '@stacksjs/error-handling'
-import { writeFile } from '@stacksjs/storage'
 import { log, runCommand } from '@stacksjs/cli'
 import { ExitCode } from '@stacksjs/types'
 import type { CLI, CliOptions } from '@stacksjs/types'
-import { $ } from 'bun'
 
 export function setup(buddy: CLI) {
   const descriptions = {
@@ -30,6 +29,9 @@ export function setup(buddy: CLI) {
       // ensure the minimal amount of deps are written to ./pkgx.yaml
       await optimizePkgxDeps()
 
+      // TODO: optimizeConfigDir()
+      // TODO: optimizeAddDir()
+
       await initializeProject(options)
     })
 
@@ -39,60 +41,12 @@ export function setup(buddy: CLI) {
     .option('--verbose', descriptions.verbose, { default: false })
     .action(async (_options?: CliOptions) => {
       log.debug('Running `buddy setup:oh-my-zsh` ...', _options)
+      const result = await runAction(Action.UpgradeShell)
 
-      const homePath = (await $`echo $HOME`.text()).trim()
-      const zshrcPath = p.join(homePath, '.zshrc')
-      const pluginPath = p.frameworkPath('core/zsh-buddy/buddy.plugin.zsh')
-      const customPath = p.join(homePath, '.oh-my-zsh/custom/plugins/buddy/')
-
-      log.info(`Setting up Oh My Zsh via ${zshrcPath}...`)
-      $.cwd(p.dirname(zshrcPath))
-      let data = await $`cat ${p.basename(zshrcPath)}`.text()
-
-      // Manipulate the data
-      const pluginLineRegex = /^(?!#).*plugins=\(([^)]+)\)/m // ensure it's not a comment
-      const match = data.match(pluginLineRegex)
-
-      if (match) {
-        // 1. Find the plugins line
-        const plugins = match[1]?.split(' ')
-        if (!plugins) {
-          log.error('Maybe the plugins line in your .zshrc file could not be found? If this continues being an issue, please reach out to us on Discord.')
-          process.exit(ExitCode.FatalError)
-        }
-
-        // 2. Add buddy to the list of plugins if it's not already there
-        if (!plugins.includes('buddy')) {
-          plugins.push('buddy')
-          const newPluginLine = `plugins=(${plugins.join(' ')})`
-          // 3. Replace the old plugin line with the new one
-          data = data.replace(pluginLineRegex, newPluginLine)
-          // 4. Write the data back to the file
-          await writeFile(zshrcPath, data)
-
-          // need to copy plugin to ~/.oh-my-zsh/custom/plugins
-          log.info(`Copying buddy zsh plugin ${pluginPath} to ${customPath}...`)
-
-          // create customPath if it doesn't exist
-          await runCommand(`mkdir -p ${customPath}`)
-          await runCommand(`cp -rf ${pluginPath} ${customPath}`)
-          // await runCommand(`source ${customPath}/buddy.plugin.zsh`)
-
-          log.success('Copied buddy zsh plugin')
-        }
-        else {
-          log.info('Buddy is already integrated in your shell, ensuring it is updated...')
-          await runCommand(`cp -rf ${pluginPath} ${customPath}`)
-          // await runCommand(`source ${customPath}/buddy.plugin.zsh`)
-          log.success('Updated buddy zsh plugin to latest version')
-        }
+      if (result.isErr()) {
+        log.error(result.error)
+        process.exit(ExitCode.FatalError)
       }
-
-      log.success('Oh My Zsh Setup Complete')
-      log.info('To see changes reflect, you may need to open a new terminal window')
-      // if using the vscode terminal, show the message
-      if (process.env.TERM_PROGRAM === 'vscode')
-        log.info('⌘⇧P terminal.create.new.terminal')
     })
 
   buddy.on('setup:*', () => {

package/src/commands/types.ts

@@ -1,7 +1,7 @@
 import process from 'node:process'
 import type { CLI, CliOptions } from '@stacksjs/types'
 import { generateTypes } from '@stacksjs/actions'
-import { log } from 'stacks/logging'
+import { log } from '@stacksjs/logging'
 
 export function types(buddy: CLI) {
   const descriptions = {

package/src/commands/upgrade.ts

@@ -11,6 +11,8 @@ export function upgrade(buddy: CLI) {
     framework: 'Upgrade the Stacks framework',
     dependencies: 'Upgrade your dependencies (pkgx.yaml & package.json)',
     bun: 'Upgrade Bun to the latest version',
+    shell: 'Upgrade the to the latest shell integration (currently only supports Oh My Zsh)',
+    binary: 'Upgrade the `stacks` binary to the latest version. Please note, the binary is moved to the `~/.stacks/bin` directory',
     all: 'Upgrade Node, package manager, project dependencies, and framework',
     force: 'Overwrite possible local updates with remote framework updates',
     select: 'What are you trying to upgrade?',
@@ -20,12 +22,15 @@ export function upgrade(buddy: CLI) {
 
   buddy
     .command('upgrade', descriptions.command)
-    .option('-c, --framework', descriptions.framework, { default: false })
     .option('-d, --dependencies', descriptions.dependencies, { default: false })
     .option('-b, --bun', descriptions.bun, { default: false })
     .option('-a, --all', descriptions.all, { default: false })
     .option('-f, --force', descriptions.force, { default: false })
+    .option('--framework', descriptions.framework, { default: false })
     .option('-p, --project', descriptions.project, { default: false })
+    .option('-s, --shell', descriptions.shell, { default: false })
+    .option('-b, --binary', descriptions.binary, { default: false })
+    // .option('--canary', descriptions.canary, { default: false })
     .option('--verbose', descriptions.verbose, { default: false })
     .alias('update')
     .example('buddy upgrade -a --verbose')
@@ -40,8 +45,9 @@ export function upgrade(buddy: CLI) {
             options: [
               { value: 'dependencies', label: 'Dependencies' },
               { value: 'framework', label: 'Framework' },
-              { value: 'node', label: 'Node.js' },
-              { value: 'package-manager', label: 'Package Manager' },
+              { value: 'bun', label: 'Bun' },
+              { value: 'shell', label: 'Shell' },
+              { value: 'binary', label: 'Binary' },
             ],
           })
 
@@ -115,6 +121,47 @@ export function upgrade(buddy: CLI) {
       await runAction(Action.Upgrade, options)
     })
 
+  buddy
+    .command('upgrade:shell', descriptions.shell)
+    .option('--verbose', descriptions.verbose, { default: false })
+    .example('buddy upgrade:shell')
+    .action(async (options: UpgradeOptions) => {
+      log.debug('Running `buddy upgrade:shell` ...', options)
+
+      const perf = await intro('buddy upgrade:shell')
+      const result = await runAction(Action.UpgradeShell, options)
+
+      if (result.isErr()) {
+        await outro('While running the buddy upgrade:shell command, there was an issue', { startTime: perf, useSeconds: true }, result.error) // FIXME: should not have to cast
+        process.exit()
+      }
+
+      process.exit(ExitCode.Success)
+    })
+
+  buddy
+    .command('upgrade:binary', descriptions.binary)
+    .option('--verbose', descriptions.verbose, { default: false })
+    .example('buddy upgrade:binary')
+    .action(async (options: UpgradeOptions) => {
+      if (process.getuid && process.getuid() !== 0) {
+        log.warn('To upgrade the binary, you need to run this command with sudo, or as root.')
+        process.exit(0) // Exit with an error code
+      }
+
+      log.debug('Running `buddy upgrade:binary` ...', options)
+
+      const perf = await intro('buddy upgrade:binary')
+      const result = await runAction(Action.UpgradeBinary, options)
+
+      if (result.isErr()) {
+        await outro('While running the buddy upgrade:binary command, there was an issue', { startTime: perf, useSeconds: true }, result.error) // FIXME: should not have to cast
+        process.exit()
+      }
+
+      process.exit(ExitCode.Success)
+    })
+
   buddy.on('upgrade:*', () => {
     console.error('Invalid command: %s\nSee --help for a list of available commands.', buddy.args.join(' '))
     process.exit(1)
@@ -122,5 +169,5 @@ export function upgrade(buddy: CLI) {
 }
 
 function hasNoOptions(options: UpgradeOptions) {
-  return !options.framework && !options.dependencies && !options.packageManager && !options.node && !options.all
+  return !options.framework && !options.dependencies && !options.bun && !options.shell && !options.binary && !options.all
 }