@stacksjs/buddy 0.58.72 → 0.58.73

package/dist/index.js

@@ -2,6 +2,7 @@
 import {
 build,
 changelog,
+check,
 clean,
 cloud,
 commit,
@@ -22,7 +23,9 @@ list,
 make,
 migrate,
 optimizePkgxDeps,
+ports,
 prepublish,
+projects,
 release,
 seed,
 setup,
@@ -32,9 +35,9 @@ tinker,
 types,
 upgrade,
 version
-} from "./chunk-94f0ae38d2d27d78.js";
+} from "./chunk-1a569f35f66ae151.js";
 import"./chunk-0455e53fab4244b1.js";
-import"./chunk-59a9de11428ba763.js";
+import"./chunk-bf054cfbc9cf2201.js";
 export {
   version,
   upgrade,
@@ -45,7 +48,9 @@ export {
   setup,
   seed,
   release,
+  projects,
   prepublish,
+  ports,
   optimizePkgxDeps,
   migrate,
   make,
@@ -66,6 +71,7 @@ export {
   commit,
   cloud,
   clean,
+  check,
   changelog,
   build
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/buddy",
   "type": "module",
-  "version": "0.58.72",
+  "version": "0.58.73",
   "description": "Meet Buddy. The Stacks runtime.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -66,8 +66,8 @@
   ],
   "scripts": {
     "buddy": "bunx ./src/cli.ts",
-    "build": "bun --bun build.ts",
-    "compile": "bun build ./src/cli.ts --compile --outfile budd",
+    "build": "bun --bun build.ts && bun run compile",
+    "compile": "bun compile.ts",
     "typecheck": "bun --bun tsc --noEmit",
     "prepublishOnly": "bun --bun run build"
   },

package/src/cli.ts

@@ -1,5 +1,5 @@
 import process from 'node:process'
-import { handleError } from '@stacksjs/error-handling'
+import { log } from '@stacksjs/logging'
 import { CAC } from 'cac'
 import { ensureProjectIsInitialized } from '@stacksjs/utils'
 import { path as p } from '@stacksjs/path'
@@ -8,25 +8,17 @@ import * as cmd from './commands'
 
 // setup global error handlers
 process.on('uncaughtException', (error: Error) => {
-  console.error('An error occurred:', error.message)
-  // handleError(error)
+  log.debug('uncaughtException')
+  log.error(error)
   process.exit(1)
 })
 
-process.on('uncaughtException', (error: Error) => {
-  console.error('An error occurred:', error.message)
-  handleError(error)
+process.on('unhandledRejection', (error: Error) => {
+  log.debug('unhandledRejection')
+  log.error(error)
   process.exit(1)
 })
 
-// process.on('unhandledRejection', errorHandler)
-
-// function errorHandler(error: Error) {
-//   console.error('An error occurred:', error.message)
-//   log.error(error.message)
-//   process.exit(1)
-// }
-
 async function main() {
   // const buddy = cli('buddy')
   const buddy = new CAC('buddy')
@@ -40,6 +32,7 @@ async function main() {
 
   cmd.build(buddy)
   cmd.changelog(buddy)
+  cmd.check(buddy)
   cmd.clean(buddy)
   cmd.cloud(buddy)
   // cmd.commit(buddy)
@@ -48,6 +41,8 @@ async function main() {
   cmd.domains(buddy)
   cmd.deploy(buddy)
   cmd.dns(buddy)
+  cmd.ports(buddy)
+  cmd.projects(buddy)
   cmd.fresh(buddy)
   cmd.generate(buddy)
   cmd.http(buddy)
@@ -61,10 +56,20 @@ async function main() {
   cmd.setup(buddy)
   // cmd.example(buddy)
   // cmd.test(buddy)
-  // cmd.version(buddy)
+  cmd.version(buddy)
   // cmd.prepublish(buddy)
   cmd.upgrade(buddy)
 
+  // dynamic imports
+  await dynamicImports(buddy)
+
+  buddy.help()
+  buddy.parse()
+}
+
+await main()
+
+async function dynamicImports(buddy: CAC) {
   // dynamically import and register commands from ./app/Commands/*
   const commandsDir = p.appPath('Commands')
   const commandFiles = fs.readdirSync(commandsDir).filter(file => file.endsWith('.ts'))
@@ -83,9 +88,4 @@ async function main() {
   const listenerImport = await import(p.listenersPath('Console.ts'))
   if (typeof listenerImport.default === 'function')
     listenerImport.default(buddy)
-
-  buddy.help()
-  buddy.parse()
 }
-
-await main()

package/src/commands/check.ts

@@ -0,0 +1,45 @@
+import process from 'node:process'
+import type { CLI, CheckOptions } from '@stacksjs/types'
+import { ExitCode } from '@stacksjs/types'
+import { Action } from '@stacksjs/enums'
+import { runAction } from '@stacksjs/actions'
+import { log } from 'stacks/logging'
+import { intro, outro } from 'stacks/cli'
+
+export function check(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('check [type]', descriptions.command)
+    .option('--ports', descriptions.ports)
+    .option('-p, --project', descriptions.project, { default: false })
+    .option('--verbose', descriptions.verbose, { default: false })
+    .action(async (type: string | undefined, options: CheckOptions) => {
+      log.debug('Running `buddy check [type]` ...', options)
+
+      const perf = await intro('buddy check [type]')
+
+      switch (type) {
+        case 'ports':
+          await runAction(Action.CheckPorts)
+          return
+      }
+
+      if (options.ports)
+        await runAction(Action.CheckPorts, options)
+
+      // await runAction(Action.Prepublish, options)
+      await outro('Exited', { startTime: perf, useSeconds: true })
+      process.exit(ExitCode.Success)
+    })
+
+  buddy.on('check:*', () => {
+    console.error('Invalid command: %s\nSee --help for a list of available commands.', buddy.args.join(' '))
+    process.exit(1)
+  })
+}

package/src/commands/create.ts

@@ -19,12 +19,16 @@ export function create(buddy: CLI) {
     functions: 'Are you developing functions/composables?',
     api: 'Are you building an API?',
     database: 'Do you need a database?',
+    notifications: 'Do you need notifications? e.g. email, SMS, push or chat notifications',
+    cache: 'Do you need caching?',
+    email: 'Do you need email?',
     project: 'Target a specific project',
     verbose: 'Enable verbose output',
   }
 
   buddy
     .command('new <name>', descriptions.command)
+    .alias('create <name>')
     .option('-u, --ui', descriptions.ui, { default: true }) // if no, disregard remainder of questions wrt UI
     .option('-c, --components', descriptions.components, { default: true }) // if no, -v and -w would be false
     .option('-w, --web-components', descriptions.webComponents, { default: true })
@@ -33,6 +37,8 @@ export function create(buddy: CLI) {
     .option('-f, --functions', descriptions.functions, { default: true }) // if no, API would be false
     .option('-a, --api', descriptions.api, { default: true }) // APIs need an HTTP server & assumes functions is true
     .option('-d, --database', descriptions.database, { default: true })
+    .option('-ca, --cache', descriptions.cache, { default: false })
+    .option('-e, --email', descriptions.email, { default: false })
     .option('-p, --project', descriptions.project, { default: false })
     .option('--verbose', descriptions.verbose, { default: false })
     // .option('--auth', 'Scaffold an authentication?', { default: true })

package/src/commands/generate.ts

@@ -1,6 +1,7 @@
 import process from 'node:process'
 import {
   generateComponentMeta,
+  generateCoreSymlink,
   generateIdeHelpers,
   generateLibEntries,
   generateMigrations,
@@ -22,6 +23,7 @@ export function generate(buddy: CLI) {
     customData: 'Generate VS Code custom data (custom-elements.json) for IDEs',
     ideHelpers: 'Generate IDE helpers',
     componentMeta: 'Generate component meta information',
+    coreSymlink: 'Generate symlink of the core framework to the project root',
     pkgx: 'Generate the pkgx configuration file',
     select: 'What are you trying to generate?',
     project: 'Target a specific project',
@@ -38,6 +40,7 @@ export function generate(buddy: CLI) {
     .option('-c, --component-meta', descriptions.componentMeta)
     .option('-p, --pkgx', descriptions.pkgx)
     .option('-p, --project', descriptions.project, { default: false })
+    .option('--core-symlink', descriptions.coreSymlink)
     .option('--verbose', descriptions.verbose, { default: false })
     .action(async (options: GeneratorOptions) => {
       log.debug('Running `buddy generate` ...', options)
@@ -139,6 +142,13 @@ export function generate(buddy: CLI) {
       generateMigrations()
     })
 
+  buddy
+    .command('generate:core-symlink', 'Generate core symlink. A shortcut for core developers.')
+    .action(async (options: GeneratorOptions) => {
+      log.debug('Running `buddy core-symlink` ...', options)
+      await generateCoreSymlink()
+    })
+
   buddy.on('generate:*', () => {
     console.error('Invalid command: %s\nSee --help for a list of available commands.', buddy.args.join(' '))
     process.exit(1)

package/src/commands/index.ts

@@ -1,5 +1,6 @@
 export * from './build'
 export * from './changelog'
+export * from './check'
 export * from './clean'
 export * from './cloud'
 export * from './commit'
@@ -18,7 +19,9 @@ export * from './install'
 export * from './key'
 export * from './make'
 export * from './migrate'
+export * from './ports'
 export * from './prepublish'
+export * from './projects'
 export * from './release'
 export * from './seed'
 export * from './setup'

package/src/commands/ports.ts

@@ -0,0 +1,73 @@
+import process from 'node:process'
+import type { CLI, CheckOptions } from '@stacksjs/types'
+import { ExitCode } from '@stacksjs/types'
+import { ports as projectPorts } from '@stacksjs/config'
+import { log } from '@stacksjs/logging'
+import { $ } from 'bun'
+import { intro, italic, outro } from 'stacks/cli'
+
+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('-p, --project [name]', descriptions.project, { default: '' })
+    .option('-q, --quiet', 'Use minimal output', { default: false })
+    .option('--verbose', descriptions.verbose, { default: false })
+    .action(async (options: CheckOptions) => {
+      log.debug('Running `buddy ports` ...', options)
+
+      let perf
+      if (!options.quiet)
+        perf = await intro('buddy ports')
+
+      if (options.project) {
+        if (!options.quiet)
+          log.info(`Checking ports for project: ${italic(options.project)}`)
+
+        const projectList = await $`./buddy projects:list --quiet`.text()
+        log.debug('projectList', projectList)
+
+        const projects = projectList.split('\n').filter(line => line.startsWith('   - ')).map(line => line.trim().substring(4))
+        log.debug('projects', projects)
+
+        const projectPath = projects.find(project => project.includes(options.project as string)) || ''
+        log.debug('projectPath', projectPath)
+
+        $.cwd(projectPath.startsWith('/') ? projectPath : `/${projectPath}`)
+
+        const res = (await $`./buddy ports --quiet`.text()).trim()
+        log.debug(`./buddy ports --quiet response for ${projectPath}`, res)
+
+        // eslint-disable-next-line no-console
+        console.log('')
+        // eslint-disable-next-line no-console
+        console.log(res)
+        // eslint-disable-next-line no-console
+        console.log('')
+      }
+      else {
+        // eslint-disable-next-line no-console
+        console.log('')
+        // eslint-disable-next-line no-console
+        console.log(projectPorts)
+        // eslint-disable-next-line no-console
+        console.log('')
+      }
+
+      if (!options.quiet)
+        await outro('Exited', { startTime: perf, useSeconds: true })
+
+      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)
+  })
+}

package/src/commands/projects.ts

@@ -0,0 +1,59 @@
+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)
+
+      await intro('buddy projects:list')
+
+      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.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/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
 }