chore: shell option

no wip here in case i need to search for it later again 😂

Author: chrisbbreuer

.stacks/core/actions/src/build/core.ts

@@ -3,4 +3,4 @@ import { runCommands } from '@stacksjs/cli'
 
 await runCommands([
   'pnpm -r --filter "./core/*" --filter "!./core/x-ray" build', // build all packages except x-ray (which is a dev tool/app)
-], { verbose: true, cwd: frameworkPath(), shell: true })
+], { verbose: true, cwd: frameworkPath() })

.stacks/core/actions/src/bump.ts

@@ -3,5 +3,5 @@ import { frameworkPath } from '@stacksjs/path'
 
 await runCommand(
   'bunx bumpp ./package.json ./core/**/package.json ./ide/vscode/package.json --execute "buddy changelog --quiet" --all',
-  { verbose: true, cwd: frameworkPath(), shell: true },
+  { verbose: true, cwd: frameworkPath() },
 )

.stacks/core/actions/src/changelog.ts

@@ -3,5 +3,5 @@ import { projectPath } from '@stacksjs/path'
 
 await runCommand(
   'changelogen --output CHANGELOG.md --from $(git describe --abbrev=0 --tags HEAD^)  --to $(git describe)',
-  { verbose: true, cwd: projectPath(), shell: true },
+  { verbose: true, cwd: projectPath() },
 )

.stacks/core/actions/src/release.ts

@@ -10,6 +10,6 @@ await runActions([
   Action.LintFix, // ensure there are no lint errors
   // Action.Test, // run the tests
   Action.Bump, // bump the versions, create the git tag, generate the changelog, commit & push the changes
-], { verbose: true, cwd: frameworkPath(), shell: true }) // debug mode needs to be enabled to see the output due to the interactive prompts
+], { verbose: true, cwd: frameworkPath() }) // debug mode needs to be enabled to see the output due to the interactive prompts
 
 log.success(`Successfully released ${app.name}`)

.stacks/core/buddy/src/commands/upgrade.ts

@@ -52,7 +52,7 @@ export async function upgrade(buddy: CLI) {
         options = answers.reduce((a: any, v: any) => ({ ...a, [v]: true }), {})
       }
 
-      const result = await runAction(Action.Upgrade, { ...options, shell: true })
+      const result = await runAction(Action.Upgrade, { ...options })
 
       if (result.isErr()) {
         outro('While running the buddy:upgrade command, there was an issue', { startTime: perf, useSeconds: true, isError: true }, result.error as Error)

.stacks/core/cli/src/run.ts

@@ -12,23 +12,37 @@ import { log } from './console'
  * @param options The options to pass to the command.
  * @param errorMsg The name of the error to throw if the command fails.
  * @returns The result of the command.
+ * @example
+ * ```ts
+ * const result = await exec('ls')
+ *
+ * if (result.isErr())
+ *   console.error(result.error)
+ * else
+ *   console.log(result)
+ * ```
+ * @example
+ * ```ts
+ * const result = await exec('ls', { cwd: '/home' })
+ * ```
  */
 export async function exec(command: string | string[], options?: CliOptions): Promise<ResultAsync<Subprocess, StacksError>> {
-  const cmd = Array.isArray(command) ? command : command.split(' ')
+  const cmd: string[] = Array.isArray(command) ? command : command.split(' ')
   const proc = spawn(cmd, {
     ...options,
     stdout: options?.stdout || 'inherit',
     cwd: options?.cwd || import.meta.dir,
     onExit(subprocess, exitCode, signalCode, error) {
-      if (exitCode !== ExitCode.Success && exitCode) {
+      console.log('here')
+      if (exitCode !== 0 && exitCode) {
         log.error(error)
         process.exit(exitCode)
       }
     },
   })
-  const exited = await proc.exited
 
-  if (exited === ExitCode.Success)
+  const exited = await proc.exited
+  if (exited === 0)
     return okAsync(proc)
 
   return errAsync(handleError(new Error(`Failed to execute command: ${cmd.join(' ')}`)))
@@ -39,6 +53,19 @@ export async function exec(command: string | string[], options?: CliOptions): Pr
  *
  * @param command The command to execute.
  * @returns The result of the command.
+ * @example
+ * ```ts
+ * const result = execSync('ls')
+ *
+ * if (result.isErr())
+ *   console.error(result.error)
+ * else
+ *   console.log(result)
+ * ```
+ * @example
+ * ```ts
+ * const result = execSync('ls', { cwd: '/home' })
+ * ```
  */
 export function execSync(command: string | string[], options?: CliOptions): Result<SyncSubprocess, Error> {
   const cmd = Array.isArray(command) ? command : command.split(' ')
@@ -64,9 +91,29 @@ export function execSync(command: string | string[], options?: CliOptions): Resu
  * @param command The command to run.
  * @param options The options to pass to the command.
  * @returns The result of the command.
+ * @example
+ * ```ts
+ * const result = await runCommand('ls')
+ *
+ * if (result.isErr())
+ *   console.error(result.error)
+ * else
+ *   console.log(result)
+ * ```
+ * @example
+ * ```ts
+ * const result = await runCommand('ls', { cwd: '/home' })
+ *
+ * if (result.isErr())
+ *   console.error(result.error)
+ * else
+ *   console.log(result)
+ * ```
  */
-// export async function runCommand(command: string, options?: CliOptions): Promise<ResultAsync<Subprocess, StacksError>> {
-export async function runCommand(command: string, options?: any): Promise<ResultAsync<Subprocess, StacksError>> {
+export async function runCommand(command: string, options?: string | CliOptions): Promise<ResultAsync<Subprocess, StacksError>> {
+  if (typeof options === 'string')
+    return await exec(command, { cwd: options })
+
   return await exec(command, options)
 }
 

.stacks/core/types/build.ts

@@ -1,6 +1,6 @@
 import { log, runCommand } from '@stacksjs/cli'
 
-const result = await runCommand('bun build ./src/index.ts --outdir dist --format esm --target bun', {
+const result = await runCommand('bun build ./src/index.ts --outdir dist --format esm --target node', {
   cwd: import.meta.dir,
 })
 

.stacks/core/types/src/cli.ts

@@ -56,22 +56,6 @@ export interface CliOptions {
 
   env?: Record<string, string>
 
-  /**
-   * **Should the command be run inside a shell?**
-   *
-   * If `true`, runs `command` inside of a shell. Uses `/bin/sh` on UNIX and `cmd.exe`
-   * on Windows. A different shell can be specified as a string. The shell should
-   * understand the `-c` switch on UNIX or `/d /s /c` on Windows.
-   *
-   * We recommend against using this option since it is:
-   *  - not cross-platform, encouraging shell-specific syntax.
-   *  - slower, because of the additional shell interpretation.
-   *  - unsafe, potentially allowing command injection.
-   *
-   * @default false
-   */
-  shell?: boolean
-
   /**
    * **Encoding**
    *