@stacksjs/buddy 0.66.0 → 0.68.0

package/src/commands/ports.ts

@@ -1,188 +0,0 @@
-import type { CLI, Ports, PortsOptions } from '@stacksjs/types'
-import { $ } from 'bun'
-import process from 'node:process'
-import { intro, italic, outro } from '@stacksjs/cli'
-import { ports as projectPorts } from '@stacksjs/config'
-import { log } from '@stacksjs/logging'
-import { findProjectPath, path as p, projectPath } from '@stacksjs/path'
-import { ExitCode } from '@stacksjs/types'
-import { findStacksProjects } from '@stacksjs/utils'
-
-export function ports(buddy: CLI): void {
-  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)
-    console.log('')
-
-  console.log(ports)
-
-  if (!options.quiet)
-    console.log('')
-}

package/src/commands/prepublish.ts

@@ -1,28 +0,0 @@
-import type { CLI, PrepublishOptions } from '@stacksjs/types'
-import process from 'node:process'
-import { runAction } from '@stacksjs/actions'
-import { Action } from '@stacksjs/enums'
-import { log } from '@stacksjs/logging'
-
-export function prepublish(buddy: CLI): void {
-  const descriptions = {
-    command: 'Run your prepublish script',
-    project: 'Target a specific project',
-    verbose: 'Enable verbose output',
-  }
-
-  buddy
-    .command('prepublish', descriptions.command)
-    .option('-p, --project [project]', descriptions.project, { default: false })
-    .option('--verbose', descriptions.verbose, { default: false })
-    .action(async (options: PrepublishOptions) => {
-      log.debug('Running `buddy prepublish` ...', options)
-
-      await runAction(Action.Prepublish, options)
-    })
-
-  buddy.on('prepublish:*', () => {
-    console.error('Invalid command: %s\nSee --help for a list of available commands.', buddy.args.join(' '))
-    process.exit(1)
-  })
-}

package/src/commands/projects.ts

@@ -1,54 +0,0 @@
-import type { CLI, ProjectsOptions } from '@stacksjs/types'
-import process from 'node:process'
-import { intro, log } from '@stacksjs/cli'
-import { ExitCode } from '@stacksjs/types'
-import { findStacksProjects } from '@stacksjs/utils'
-
-export function projects(buddy: CLI): void {
-  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) 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) 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/release.ts

@@ -1,47 +0,0 @@
-import type { CLI, ReleaseOptions } from '@stacksjs/types'
-import process from 'node:process'
-import { runAction } from '@stacksjs/actions'
-import { intro, italic, log, outro } from '@stacksjs/cli'
-import { Action } from '@stacksjs/enums'
-import { ExitCode } from '@stacksjs/types'
-
-const descriptions = {
-  release: 'Release a new version of your libraries/packages',
-  project: 'Target a specific project',
-  dryRun: 'Run the release without actually releasing',
-  verbose: 'Enable verbose output',
-}
-
-export function release(buddy: CLI): void {
-  buddy
-    .command('release', descriptions.release)
-    .option('--dry-run', descriptions.dryRun, { default: false })
-    .option('-p, --project [project]', descriptions.project, { default: false })
-    .option('--verbose', descriptions.verbose, { default: false })
-    .action(async (options: ReleaseOptions) => {
-      log.debug('Running `buddy release` ...', options)
-
-      if (options.dryRun)
-        log.warn('Dry run enabled. No changes will be made or committed.')
-
-      const startTime = await intro('buddy release')
-      const result = await runAction(Action.Release, options)
-
-      if (result.isErr()) {
-        log.error('Failed to release', result.error)
-        process.exit(ExitCode.FatalError)
-      }
-
-      await outro('Triggered CI/CD Release via GitHub Actions', {
-        startTime,
-        useSeconds: true,
-      })
-
-      log.info(`Follow along: ${italic('https://github.com/stacksjs/stacks/actions')}`)
-    })
-
-  buddy.on('release:*', () => {
-    console.error('Invalid command: %s\nSee --help for a list of available commands.', buddy.args.join(' '))
-    process.exit(1)
-  })
-}

package/src/commands/route.ts

@@ -1,39 +0,0 @@
-import type { CLI, MigrateOptions } from '@stacksjs/types'
-import process from 'node:process'
-import { runAction } from '@stacksjs/actions'
-import { intro, outro } from '@stacksjs/cli'
-import { Action } from '@stacksjs/enums'
-import { ExitCode } from '@stacksjs/types'
-
-export function route(buddy: CLI): void {
-  const descriptions = {
-    route: 'Lists your routes',
-    verbose: 'Enable verbose output',
-  }
-
-  buddy
-    .command('route:list', descriptions.route)
-    .option('--verbose', descriptions.verbose, { default: false })
-    .action(async (options: MigrateOptions) => {
-      const perf = await intro('buddy route:list')
-      const result = await runAction(Action.RouteList, options)
-
-      if (result.isErr()) {
-        await outro(
-          'While running the migrate command, there was an issue',
-          { startTime: perf, useSeconds: true },
-          result.error,
-        )
-        process.exit()
-      }
-
-      await outro(`Successfully listed routes`)
-
-      process.exit(ExitCode.Success)
-    })
-
-  buddy.on('route:*', () => {
-    console.error('Invalid command: %s\nSee --help for a list of available commands.', buddy.args.join(' '))
-    process.exit(1)
-  })
-}

package/src/commands/seed.ts

@@ -1,47 +0,0 @@
-import type { CLI, SeedOptions } from '@stacksjs/types'
-import process from 'node:process'
-import { runAction } from '@stacksjs/actions'
-import { intro, log, outro } from '@stacksjs/cli'
-import { Action } from '@stacksjs/enums'
-import { ExitCode } from '@stacksjs/types'
-
-export function seed(buddy: CLI): void {
-  const descriptions = {
-    seed: 'Seed your database',
-    project: 'Target a specific project',
-    verbose: 'Enable verbose output',
-  }
-
-  buddy
-    .command('seed', descriptions.seed)
-    .option('-p, --project [project]', descriptions.project, { default: false })
-    .option('--verbose', descriptions.verbose, { default: false })
-    .action(async (options: SeedOptions) => {
-      log.debug('Running `buddy seed` ...', options)
-
-      const perf = await intro('buddy seed')
-      const result = await runAction(Action.Seed, options)
-
-      if (result.isErr()) {
-        await outro(
-          'While running the seed command, there was an issue',
-          { startTime: perf, useSeconds: true },
-          result.error,
-        )
-        process.exit(ExitCode.FatalError)
-      }
-
-      const APP_ENV = process.env.APP_ENV || 'local'
-
-      await outro(`Seeded your ${APP_ENV} database.`, {
-        startTime: perf,
-        useSeconds: true,
-      })
-      process.exit(ExitCode.Success)
-    })
-
-  buddy.on('seed:*', () => {
-    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,145 +0,0 @@
-import type { CLI, CliOptions } from '@stacksjs/types'
-import process from 'node:process'
-import { runAction } from '@stacksjs/actions'
-import { log, runCommand } from '@stacksjs/cli'
-import { Action } from '@stacksjs/enums'
-import { handleError } from '@stacksjs/error-handling'
-import { path as p } from '@stacksjs/path'
-import { storage } from '@stacksjs/storage'
-import { ExitCode } from '@stacksjs/types'
-
-export function setup(buddy: CLI): void {
-  const descriptions = {
-    setup: 'This command ensures your project is setup correctly',
-    ohMyZsh: 'Enable Oh My Zsh',
-    aws: 'Ensures AWS is connected to the project',
-    project: 'Target a specific project',
-    verbose: 'Enable verbose output',
-  }
-
-  buddy
-    .command('setup', descriptions.setup)
-    .alias('ensure')
-    .option('-p, --project [project]', descriptions.project, { default: false })
-    .option('--verbose', descriptions.verbose, { default: false })
-    .action(async (options: CliOptions) => {
-      log.debug('Running `buddy setup` ...', options)
-
-      if (!(await isPkgxInstalled()))
-        await installPkgx()
-
-      // ensure the minimal amount of deps are written to ./pkgx.yaml
-      await optimizePkgxDeps()
-
-      // TODO: optimizeConfigDir()
-      // TODO: optimizeAddDir()
-
-      await initializeProject(options)
-    })
-
-  buddy
-    .command('setup:oh-my-zsh', descriptions.ohMyZsh) // if triggered multiple times, it will update the plugin
-    .alias('upgrade:oh-my-zsh')
-    .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)
-
-      if (result.isErr()) {
-        log.error(result.error)
-        process.exit(ExitCode.FatalError)
-      }
-    })
-
-  buddy.on('setup:*', () => {
-    console.error('Invalid command: %s\nSee --help for a list of available commands.', buddy.args.join(' '))
-    process.exit(ExitCode.FatalError)
-  })
-}
-
-async function isPkgxInstalled(): Promise<boolean> {
-  const result = await runCommand('pkgx --version', { silent: true })
-
-  if (result.isOk())
-    return true
-
-  return false
-}
-
-async function installPkgx(): Promise<void> {
-  const result = await runCommand(p.frameworkPath('scripts/pkgx-install'))
-
-  if (result.isOk())
-    return
-
-  handleError(result.error)
-  process.exit(ExitCode.FatalError)
-}
-
-async function initializeProject(options: CliOptions): Promise<void> {
-  log.info('Installing dependencies...')
-
-  const result = await runCommand('bun install', {
-    cwd: options.cwd || p.projectPath(),
-  })
-
-  if (result.isErr()) {
-    handleError(result.error)
-    process.exit(ExitCode.FatalError)
-  }
-
-  log.success('Installed node_modules')
-
-  ensureEnvIsSet(options)
-
-  const keyResult = await runCommand('buddy key:generate', {
-    cwd: options.cwd || p.projectPath(),
-  })
-
-  if (keyResult.isErr()) {
-    handleError(keyResult.error)
-    process.exit(ExitCode.FatalError)
-  }
-
-  log.info('Ensuring AWS is connected...')
-
-  const awsResult = await runCommand('buddy configure:aws', {
-    cwd: options.cwd || p.projectPath(),
-  })
-
-  if (awsResult.isErr()) {
-    handleError(awsResult.error)
-    process.exit(ExitCode.FatalError)
-  }
-
-  log.success('Configured AWS')
-
-  // TODO: ensure the IDE is setup by making sure .vscode etc exists, and if not, copy them over
-
-  log.success('Project is setup')
-  log.info('Happy coding! 💙')
-}
-
-export async function optimizePkgxDeps(): Promise<void> {
-  return new Promise(resolve => setTimeout(resolve, 300))
-}
-
-export async function ensureEnvIsSet(options: CliOptions): Promise<void> {
-  log.info('Ensuring .env exists...')
-
-  if (storage.doesNotExist(p.projectPath('.env'))) {
-    const envResult = await runCommand('cp .env.example .env', {
-      cwd: options.cwd || p.projectPath(),
-    })
-
-    if (envResult.isErr()) {
-      handleError(envResult.error)
-      process.exit(ExitCode.FatalError)
-    }
-
-    log.success('.env created')
-  }
-  else {
-    log.success('.env existed')
-  }
-}