chore: wip

chore: wip

chore: wip

chore: wip

chore: wip

chore: wip

chore: wip

chore: wip

Author: chrisbbreuer

.gitignore

@@ -10,6 +10,7 @@ updates
 tests/unit/coverage
 dist*
 !.gitkeep
+custom-cli
 
 .fleet
 .idea

app/Actions/SendWelcomeEmail.ts

@@ -3,20 +3,18 @@ import { Action } from '@stacksjs/actions'
 export default new Action({
   name: 'SendWelcomeEmail',
   description: 'Send a welcome email to a new user',
+  // longRunning: false,
+
   async handle() {
-    // Send the email
-    await sendEmail({
+    return sendEmail({
       to: 'some@recipient.com',
       subject: 'Welcome to our app!',
       text: 'We are excited to have you here.',
     })
-
-    // Return a message
-    return `Welcome email sent to ${email}`
   },
 })
 
 function sendEmail({ to, subject, text }: { to: string, subject: string, text: string }) {
   log.info('Sending email', { to, subject, text })
-  return Promise.resolve()
+  return `Welcome email sent to ${email}`
 }

app/Commands/inspire.ts

@@ -1,13 +1,16 @@
-// triggered via `$your-command inspire`
+// triggered via `$your-cli inspire` and `buddy inspire`
 import process from 'node:process'
-import { cli, log } from '@stacksjs/cli'
+import { log } from '@stacksjs/cli'
 import { collect } from '@stacksjs/collections'
+import { ExitCode } from '@stacksjs/types'
+import type { CLI } from '@stacksjs/types'
 
-// for enhanced type safety
+// for enhanced type-safety & autocompletion, you may want to define the options interface
 interface InspireOptions {
   two: boolean
 }
 
+// could be queried from any API or a database
 const quotes = collect([
   'The best way to get started is to quit talking and begin doing.',
   'The pessimist sees difficulty in every opportunity. The optimist sees opportunity in every difficulty.',
@@ -26,16 +29,18 @@ const quotes = collect([
   'Security is mostly a superstition. Life is either a daring adventure or nothing.',
 ])
 
-cli()
-  .command('inspire', 'Inspire yourself with a random quote')
-  .option('--two, -t', 'Show two quotes', { default: false })
-  .alias('insp')
-  .action((options: InspireOptions) => {
-    if (options.two)
-      quotes.random(2).forEach(quote => log.info(quote))
-    else
-      log.info(quotes.random())
+export default function (cli: CLI) {
+  return cli
+    .command('inspire', 'Inspire yourself with a random quote')
+    .option('--two, -t', 'Inspire yourself with two random quotes', { default: false })
+    .alias('insp')
+    .action((options: InspireOptions) => {
+      if (options.two)
+        quotes.random(2).map((quote, index) => log.info(`${index + 1}. ${quote}`))
+      else
+        log.info(quotes.random())
 
-    log.success('Have a great day!')
-    process.exit(ExitCode.Success)
-  })
+      log.success('Have a great day!')
+      process.exit(ExitCode.Success)
+    })
+}

app/Jobs/DummyJob.ts

@@ -1,13 +1,14 @@
 import { Job } from '@stacksjs/queue'
+import { Every } from '@stacksjs/types'
 
 export default new Job({
   name: 'Send Welcome Email', // defaults to the file name
   description: 'A demo cron job that runs every 5th minute', // optional
-  // `run: 'demo-job'` is another option where `demo-job` refers to ./resources/functions/demo-job.ts
   tries: 3, // defaults to 3, in case of failures
   backoff: 3, // defaults to 3-second delays between retries
-  action: 'SendWelcomeEmail',
-  // handle: () => { // or `action: () => {`
-  //   log.info('This cron job runs every 5th minute')
-  // },
+  schedule: Every.FiveSeconds, // '*/5 * * * *' in cron syntax (overwrites the Scheduler's definition)
+  handle: () => { // or `action: () => {`
+    log.info('This cron job will get based ')
+  },
+  // action: 'SendWelcomeEmail', // instead of handle, you may target an action
 })

app/Schedule.ts

@@ -1,15 +1,13 @@
-// import { schedule as run } from '@stacksjs/scheduler'
-// import type { Scheduler } from '@stacksjs/types'
+import { run } from '@stacksjs/scheduler'
+import type { Scheduler } from '@stacksjs/types'
 
-// export default {
-//   schedule() {
-//     run.command('bun /home/some/script.js').everySecond()
-//     run.command('bun /home/some/other/script.ts').everyMinute()
-//     run.action('./actions/SomeAction.ts').everyFiveMinutes() // could use a better dummy example 😅
-//     run.job('./jobs/DummyJob.ts').everyTenMinutes()
-//     run.exec('bun /home/some/script.ts').everyMinute()
-//     run.call(() => {
-//       // ...
-//     }).weekly().mondays().at('13:00').timezone('America/Los_Angeles')
-//   },
-// } satisfies Scheduler
+export default function scheduler() {
+  run().command('bun /home/some/script.js').everySecond()
+  run.command('bun /home/some/other/script.ts').everyMinute()
+  run.action('./actions/SomeAction.ts').everyFiveMinutes() // could use a better dummy example 😅
+  run.job('./jobs/DummyJob.ts').everyTenMinutes()
+  run.exec('bun /home/some/script.ts').everyMinute()
+  run.call(() => {
+    // ...
+  }).weekly().mondays().at('13:00').timezone('America/Los_Angeles')
+}

bun.lockb

@@ -8,7 +8,7 @@ import type { BinaryConfig } from '@stacksjs/types'
  * you have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
 export default {
-  name: 'Buddy CLI',
-  command: 'buddy', // enables `buddy <command> <options>`
+  name: 'My Custom CLI',
+  command: 'custom-cli', // enables `custom-cli <command> <options>`
   description: 'This is an example command to illustrate how to create your own commands. Check out `../app/commands` for more.',
 } satisfies BinaryConfig

config/cli.ts

@@ -1,11 +1,13 @@
 export class Action {
   name: string
   description: string
+  longRunning: boolean
   handle: () => Promise<string>
 
   constructor({ name, description, handle }: { name: string, description: string, handle: () => Promise<string> }) {
     this.name = name
     this.description = description
+    this.longRunning = false // TODO: Implement long running actions
     this.handle = handle
   }
 }

storage/framework/core/actions/src/action.ts

@@ -0,0 +1,24 @@
+import process from 'node:process'
+import { ExitCode } from '@stacksjs/types'
+import { writeTextFile } from '@stacksjs/storage'
+import { projectPath } from '@stacksjs/path'
+import { cli } from '@stacksjs/config'
+
+log.info('Creating Vue Component Library Entry Point...')
+
+if (!cli.command) {
+  log.error('No command defined in the CLI configuration')
+  process.exit(ExitCode.FatalError)
+}
+
+await writeTextFile({
+  path: projectPath(cli.command),
+  data: `#!/usr/bin/env bun
+import('./storage/framework/core/buddy/src/custom-cli')
+`,
+}).catch((err) => {
+  log.error('There was an error generating your custom CLI file.', err)
+  process.exit(ExitCode.FatalError)
+})
+
+log.success('Generated custom CLI file')

storage/framework/core/actions/src/generate/custom-cli-file.ts

@@ -2,6 +2,8 @@ import process from 'node:process'
 import { handleError } from '@stacksjs/error-handling'
 import { cli } from '@stacksjs/cli'
 import { ensureProjectIsInitialized } from '@stacksjs/utils'
+import { path as p } from '@stacksjs/path'
+import { fs } from '@stacksjs/storage'
 import * as cmd from './commands'
 
 // setup global error handlers
@@ -44,6 +46,21 @@ async function main() {
   // cmd.prepublish(buddy)
   cmd.upgrade(buddy)
 
+  // dynamically import and register commands from ./app/Commands/*
+  const commandsDir = p.appPath('Commands')
+  const commandFiles = fs.readdirSync(commandsDir).filter(file => file.endsWith('.ts'))
+
+  for (const file of commandFiles) {
+    const commandPath = `${commandsDir}/${file}`
+    const dynamicImport = await import(commandPath)
+
+    // Correctly use the default export function
+    if (typeof dynamicImport.default === 'function')
+      dynamicImport.default(buddy)
+    else
+      console.error(`Expected a default export function in ${file}, but got:`, dynamicImport.default)
+  }
+
   buddy.parse()
 }
 

storage/framework/core/buddy/src/cli.ts

@@ -0,0 +1,36 @@
+import process from 'node:process'
+import { handleError } from '@stacksjs/error-handling'
+import { config } from '@stacksjs/config'
+import { cli } from '@stacksjs/cli'
+import { path as p } from '@stacksjs/path'
+import { fs } from '@stacksjs/storage'
+
+// setup global error handlers
+process.on('uncaughtException', handleError)
+process.on('unhandledRejection', handleError)
+
+async function main() {
+  const buddy = cli(config.cli.name)
+
+  if (!fs.existsSync(p.projectPath(config.cli.command)))
+    fs.writeFileSync(p.projectPath(config.cli.command), `import('./storage/framework/core/buddy/src/custom-cli')`)
+
+  // dynamically import and register commands from ./app/Commands/*
+  const commandsDir = p.appPath('Commands')
+  const commandFiles = fs.readdirSync(commandsDir).filter(file => file.endsWith('.ts'))
+
+  for (const file of commandFiles) {
+    const commandPath = `${commandsDir}/${file}`
+    const dynamicImport = await import(commandPath)
+
+    // Correctly use the default export function
+    if (typeof dynamicImport.default === 'function')
+      dynamicImport.default(buddy)
+    else
+      console.error(`Expected a default export function in ${file}, but got:`, dynamicImport.default)
+  }
+
+  buddy.parse()
+}
+
+await main()

storage/framework/core/buddy/src/custom-cli.ts

@@ -21,7 +21,7 @@ export function cli(name?: string | CliOptions, options?: CliOptions) {
     name = options.name
   }
 
-  const cli = cac(name)
+  const cli = cac(name || 'buddy') // default to extending buddy
 
   cli.help()
   cli.version(options?.version || version)

storage/framework/core/cli/src/cli.ts

@@ -12,9 +12,9 @@ export const {
   analytics,
   api,
   app,
-  binary,
   cache,
   cloud,
+  cli,
   database,
   dns,
   docs,

storage/framework/core/config/src/config.ts

@@ -59,9 +59,9 @@ export default {
     },
   },
 
-  binary: {
-    name: 'buddy',
-    command: 'buddy',
+  cli: {
+    name: 'My Custom CLI',
+    command: 'my-custom-cli',
     description: 'Stacks is a full-stack framework for TypeScript.',
     source: p.appPath('commands'),
   },

storage/framework/core/config/src/defaults.ts

@@ -2,7 +2,7 @@ import type { StacksConfig } from '@stacksjs/types'
 import ai from '../../../../../config/ai'
 import app from '../../../../../config/app'
 import cache from '../../../../../config/cache'
-import binary from '../../../../../config/cli'
+import cli from '../../../../../config/cli'
 import cloud from '../../../../../config/cloud'
 import database from '../../../../../config/database'
 import dns from '../../../../../config/dns'
@@ -25,8 +25,8 @@ import ui from '../../../../../config/ui'
 export default {
   ai,
   app,
-  binary,
   cache,
+  cli,
   cloud,
   database,
   dns,

storage/framework/core/config/src/overrides.ts

@@ -3,14 +3,16 @@ import type { JobOptions } from '@stacksjs/types'
 export class Job {
   name: JobOptions['name']
   description: JobOptions['description']
-  handle: JobOptions['handle']
+  action?: JobOptions['action']
+  handle?: JobOptions['handle']
   tries: JobOptions['tries']
   backoff: JobOptions['backoff']
 
-  constructor({ name, description, handle, tries, backoff }: JobOptions) {
+  constructor({ name, description, handle, tries, backoff, action }: JobOptions) {
     this.name = name
     this.description = description
     this.handle = handle
+    this.action = action
     this.tries = tries
     this.backoff = backoff
   }

storage/framework/core/queue/src/index.ts

@@ -231,7 +231,7 @@ export interface Scheduler {
 }
 
 // function run(callback: Function): Scheduler {
-function run(callback: ((now: Date | 'manual' | 'init') => void) | string): Scheduler {
+export function run(callback: ((now: Date | 'manual' | 'init') => void) | string): Scheduler {
   return {
     everySecond: () => {
       cron.schedule('* * * * * *', callback)

storage/framework/core/scheduler/src/index.ts

@@ -7,12 +7,13 @@ export interface JobOptions {
    */
   name?: string
 
-  handle: string | Function
+  handle?: string | Function
   action?: string
   description?: string
   timezone?: string
   tries?: number
   backoff?: number | number[]
+  schedule?: string | Every
   enabled?: boolean
 }
 

storage/framework/core/types/src/cron-jobs.ts

@@ -52,22 +52,22 @@ export interface StacksOptions {
   app: AppConfig
 
   /**
-   * **Binary Options**
+   * **Cache Options**
    *
-   * This configuration defines all of your Binary options. Because Stacks is fully-typed, you
+   * This configuration defines all of your Cache options. Because Stacks is fully-typed, you
    * may hover any of the options below and the definitions will be provided. In case you
    * have any questions, feel free to reach out via Discord or GitHub Discussions.
    */
-  binary: BinaryConfig
+  cache: CacheConfig
 
   /**
-   * **Cache Options**
+   * **CLI / Binary Options**
    *
-   * This configuration defines all of your Cache options. Because Stacks is fully-typed, you
+   * This configuration defines all of your Binary options. Because Stacks is fully-typed, you
    * may hover any of the options below and the definitions will be provided. In case you
    * have any questions, feel free to reach out via Discord or GitHub Discussions.
    */
-  cache: CacheConfig
+  cli: BinaryConfig
 
   /**
    * **Cloud Options**