stacks 0.41.1 → 0.44.9

package/buddy/src/commands/example.ts

@@ -0,0 +1,65 @@
+import { ExitCode } from '@stacksjs/types'
+import type { CLI, ExamplesOption, ExamplesOptions } from '@stacksjs/types'
+import { italic, log, prompts } from '@stacksjs/cli'
+import { componentExample, invoke as runExample, webComponentExample } from '@stacksjs/actions/examples'
+
+const descriptions = {
+  example: 'Which example do you want to see?',
+  components: 'Test your libraries against your built bundle',
+  vue: 'Test your Vue component library',
+  webComponents: 'Test your web component library',
+  debug: 'Enable debug mode',
+}
+
+async function example(stacks: CLI) {
+  stacks
+    .command('example', descriptions.example)
+    .option('-c, --components', descriptions.components)
+    .option('-v, --vue', descriptions.vue)
+    .option('-w, --web-components', descriptions.webComponents)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: ExamplesOptions) => {
+      const answer: ExamplesOption = await prompts.select({
+        type: 'select',
+        name: 'example',
+        message: 'Which example are you trying to view?',
+        choices: [
+          { title: 'Components', value: 'components' },
+          { title: 'Web Components', value: 'web-components' },
+        ],
+      })
+
+      if (answer !== null) {
+        log.error(`You did not provide an answer. Please try again, ${italic('or report the issue')}`)
+        process.exit()
+      }
+
+      if (answer === 'components')
+        await componentExample(options)
+      else if (answer === 'web-components')
+        await webComponentExample(options)
+      else process.exit(ExitCode.InvalidArgument)
+
+      await runExample(options)
+      process.exit(ExitCode.Success)
+    })
+
+  stacks
+    .command('example:vue', descriptions.vue)
+    .option('-v, --vue', descriptions.debug, { default: true })
+    .option('--debug', descriptions.debug, { default: false })
+    .alias('example:components')
+    .action(async (options: ExamplesOptions) => {
+      await runExample(options)
+    })
+
+  stacks
+    .command('example:web-components', 'Test your Web Component library.')
+    .option('-w, --web-components', descriptions.debug, { default: true })
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: ExamplesOptions) => {
+      await runExample(options)
+    })
+}
+
+export { example }

package/buddy/src/commands/fresh.ts

@@ -0,0 +1,18 @@
+import type { CLI, CommitOptions } from '@stacksjs/types'
+import { invoke } from '@stacksjs/actions/fresh'
+
+const descriptions = {
+  fresh: 'Reinstalls your npm dependencies',
+  debug: 'Enable debug mode',
+}
+
+async function fresh(stacks: CLI) {
+  stacks
+    .command('fresh', descriptions.fresh)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: CommitOptions) => {
+      await invoke(options)
+    })
+}
+
+export { fresh }

package/buddy/src/commands/generate.ts

@@ -0,0 +1,110 @@
+import type { CLI, GeneratorOptions } from '@stacksjs/types'
+import { ExitCode } from '@stacksjs/types'
+import { prompts } from '@stacksjs/cli'
+import { componentMeta, ideHelpers, libEntries, invoke as startGenerationProcess, types, vsCodeCustomData, vueCompat, webTypes } from '@stacksjs/actions/generate'
+
+const descriptions = {
+  command: 'Automagically build any of your libraries/packages for production use. Select any of the following packages',
+  types: 'Generate your TypeScript types',
+  entries: 'Generate your function & component library entry points',
+  webTypes: 'Generate web-types.json for IDEs',
+  customData: 'Generate VS Code custom data (custom-elements.json) for IDEs',
+  ideHelpers: 'Generate IDE helpers',
+  vueCompat: 'Generate Vue 2 & 3 compatibility',
+  componentMeta: 'Generate component meta information',
+  debug: 'Enable debug mode',
+}
+
+async function generate(stacks: CLI) {
+  stacks
+    .command('generate', descriptions.command)
+    .option('-t, --types', descriptions.types)
+    .option('-e, --entries', descriptions.entries)
+    .option('-w, --web-types', descriptions.webTypes)
+    .option('-c, --custom-data', descriptions.customData)
+    .option('-i, --ide-helpers', descriptions.ideHelpers)
+    .option('-v, --vue-compatibility', descriptions.vueCompat)
+    .option('-c, --component-meta', descriptions.componentMeta)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: GeneratorOptions) => {
+      if (hasNoOptions(options)) {
+        const answers = await prompts.multiselect({
+          type: 'multiselect',
+          name: 'generate',
+          message: 'What are you trying to generate?',
+          choices: [ // todo: should be a multi-select
+            { title: '1.) TypeScript Types', value: 'types' },
+            { title: '2.) Library Entry Points', value: 'entries' },
+            { title: '3.) Web Types', value: 'web-types' },
+            { title: '4.) VS Code Custom Data', value: 'custom-data' },
+            { title: '5.) IDE Helpers', value: 'ide-helpers' },
+            { title: '6.) Vue 2 & 3 Compatibility', value: 'vue-compatibility' },
+            { title: '7.) Component Meta', value: 'component-meta' },
+          ],
+        })
+
+        // creates an object out of array and sets answers to true
+        options = answers.reduce((a: any, v: any) => ({ ...a, [v]: true }), {})
+      }
+
+      await startGenerationProcess(options)
+
+      process.exit(ExitCode.Success)
+    })
+
+  stacks
+    .command('generate:types', descriptions.types)
+    .option('--debug', descriptions.debug, { default: false })
+    .alias('types:generate')
+    .action(async (options: GeneratorOptions) => {
+      await types(options)
+    })
+
+  stacks
+    .command('generate:entries', descriptions.entries)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: GeneratorOptions) => {
+      await libEntries(options)
+    })
+
+  stacks
+    .command('generate:vue-compatibility', descriptions.vueCompat)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: GeneratorOptions) => {
+      await vueCompat(options)
+    })
+
+  stacks
+    .command('generate:web-types', descriptions.webTypes)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: GeneratorOptions) => {
+      await webTypes(options)
+    })
+
+  stacks
+    .command('generate:vscode-custom-data', descriptions.customData)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: GeneratorOptions) => {
+      await vsCodeCustomData(options)
+    })
+
+  stacks
+    .command('generate:ide-helpers', descriptions.ideHelpers)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: GeneratorOptions) => {
+      await ideHelpers(options)
+    })
+
+  stacks
+    .command('generate:component-meta', descriptions.componentMeta)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: GeneratorOptions) => {
+      await componentMeta(options)
+    })
+}
+
+function hasNoOptions(options: GeneratorOptions) {
+  return !options.types && !options.entries && !options.webTypes && !options.customData && !options.ideHelpers && !options.vueCompatibility && !options.componentMeta
+}
+
+export { generate }

package/buddy/src/commands/index.ts

@@ -0,0 +1,18 @@
+export * from './build'
+export * from './clean'
+export * from './commit'
+export * from './create'
+export * from './dev'
+export * from './example'
+export * from './fresh'
+export * from './generate'
+export * from './lint'
+export * from './key'
+export * from './make'
+export * from './prepublish'
+export * from './preinstall'
+export * from './release'
+export * from './setup'
+export * from './test'
+export * from './types'
+export * from './update'

package/buddy/src/commands/key.ts

@@ -0,0 +1,18 @@
+import type { CLI, KeyOptions } from '@stacksjs/types'
+import { generate as generateAppKey } from '@stacksjs/actions/key'
+
+async function key(stacks: CLI) {
+  const descriptions = {
+    command: 'Generate & set the application key.',
+    debug: 'Enable debug mode',
+  }
+
+  stacks
+    .command('key:generate', descriptions.command)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: KeyOptions) => {
+      await generateAppKey(options)
+    })
+}
+
+export { key }

package/buddy/src/commands/lint.ts

@@ -0,0 +1,27 @@
+import type { CLI, LintOptions } from '@stacksjs/types'
+import { invoke, lintFix } from '@stacksjs/actions/lint'
+
+const descriptions = {
+  lint: 'Automagically lints your codebase',
+  lintFix: 'Automagically fixes lint errors',
+  debug: 'Enable debug mode',
+}
+
+async function lint(stacks: CLI) {
+  stacks
+    .command('lint', descriptions.lint)
+    .option('-f, --fix', descriptions.lintFix, { default: false })
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: LintOptions) => {
+      await invoke(options)
+    })
+
+  stacks
+    .command('lint:fix', descriptions.lintFix)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: LintOptions) => {
+      await lintFix(options)
+    })
+}
+
+export { lint }

package/buddy/src/commands/make.ts

@@ -0,0 +1,219 @@
+import { ExitCode } from '@stacksjs/types'
+import type { CLI, MakeOptions } from '@stacksjs/types'
+import { log, prompts } from '@stacksjs/cli'
+import {
+  invoke,
+  component as makeComponent,
+  database as makeDatabase,
+  factory as makeFactory,
+  fx as makeFunction,
+  language as makeLanguage,
+  migration as makeMigration,
+  notification as makeNotification,
+  page as makePage,
+  stack as makeStack,
+} from '@stacksjs/actions/make'
+
+const descriptions = {
+  component: 'Create a new component',
+  page: 'Create a new page',
+  function: 'Create a new function',
+  language: 'Create a new language',
+  database: 'Create a new database',
+  migration: 'Create a new migration',
+  factory: 'Create a new factory',
+  notification: 'Create a new notification',
+  stack: 'Create a new new stack',
+  debug: 'Enable debug mode',
+}
+
+async function make(stacks: CLI) {
+  stacks
+    .command('make', 'The make command')
+    .option('-c, --component', descriptions.component, { default: false })
+    .option('-p, --page', descriptions.page, { default: false })
+    .option('-f, --function', descriptions.function, { default: false })
+    .option('-l, --language', descriptions.language, { default: false })
+    .option('-d, --database', descriptions.database, { default: false })
+    .option('-m, --migration', descriptions.migration, { default: false })
+    .option('-f, --factory', descriptions.factory, { default: false })
+    .option('-n, --notification', descriptions.notification, { default: false })
+    .option('-s, --stack', descriptions.stack, { default: false })
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: MakeOptions) => {
+      const name = stacks.args[0]
+
+      if (!name) {
+        log.error('You need to specify a name. Read more about the documentation here.')
+        process.exit()
+      }
+
+      if (hasNoOptions(options)) {
+        const answers = await prompts.multiselect({
+          type: 'multiselect',
+          name: 'make',
+          message: 'What are you trying to make?',
+          choices: [
+            { title: 'Component', value: 'component' },
+            { title: 'Function', value: 'function' },
+            { title: 'Page', value: 'page' },
+            { title: 'Language', value: 'language' },
+            { title: 'Notification', value: 'notification' },
+            { title: 'Database', value: 'database' },
+            { title: 'Migration', value: 'migration' },
+            { title: 'Factory', value: 'factory' },
+            { title: 'Stack', value: 'stack' },
+          ],
+        })
+
+        // creates an object out of array and sets answers to true
+        options = answers.reduce((a: any, v: any) => ({ ...a, [v]: true }), {})
+      }
+
+      await invoke(options)
+
+      process.exit(ExitCode.Success)
+    })
+
+  stacks
+    .command('make:component', descriptions.component)
+    .option('--n, -name', 'The name of the component')
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: MakeOptions) => {
+      const name = stacks.args[0] || options.name
+      options.name = name
+
+      if (!name) {
+        log.error('You need to specify a name. Read more about the documentation here.')
+        process.exit()
+      }
+
+      await makeComponent(options)
+    })
+
+  stacks
+    .command('make:database', descriptions.database)
+    .option('--n, -name', 'The name of the database')
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: MakeOptions) => {
+      const name = stacks.args[0] || options.name
+      options.name = name
+
+      if (!name) {
+        log.error('You need to specify a name. Read more about the documentation here.')
+        process.exit()
+      }
+
+      await makeDatabase(options)
+    })
+
+  stacks
+    .command('make:migration', descriptions.migration)
+    .option('--n, -name', 'The name of the migration')
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: MakeOptions) => {
+      const name = stacks.args[0] || options.name
+      options.name = name
+
+      if (!name) {
+        log.error('You need to specify a name. Read more about the documentation here.')
+        process.exit()
+      }
+
+      await makeMigration(options)
+    })
+
+  stacks
+    .command('make:factory', descriptions.factory)
+    .option('--n, -name', 'The name of the factory')
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: MakeOptions) => {
+      const name = stacks.args[0] || options.name
+      options.name = name
+
+      if (!name) {
+        log.error('You need to specify a name. Read more about the documentation here.')
+        process.exit()
+      }
+
+      await makeFactory(options)
+    })
+
+  stacks
+    .command('make:page', descriptions.page)
+    .option('--n, -name', 'The name of the page')
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: MakeOptions) => {
+      const name = stacks.args[0] || options.name
+      options.name = name
+
+      if (!name) {
+        log.error('You need to specify a name. Read more about the documentation here.')
+        process.exit()
+      }
+
+      await makePage(options)
+    })
+
+  stacks
+    .command('make:function', descriptions.function)
+    .option('--n, -name', 'The name of the function')
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: MakeOptions) => {
+      await makeFunction(options)
+    })
+
+  stacks
+    .command('make:lang', descriptions.language)
+    .option('--n, -name', 'The name of the language')
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: MakeOptions) => {
+      const name = stacks.args[0] || options.name
+      options.name = name
+
+      if (!name) {
+        log.error('You need to specify a name. Read more about the documentation here.')
+        process.exit()
+      }
+
+      await makeLanguage(options)
+    })
+
+  stacks
+    .command('make:notification', descriptions.notification)
+    .option('--n, -name', 'The name of the notification')
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: MakeOptions) => {
+      const name = stacks.args[0] || options.name
+      options.name = name
+
+      if (!name) {
+        log.error('You need to specify a name. Read more about the documentation here.')
+        process.exit()
+      }
+
+      await makeNotification(options)
+    })
+
+  stacks
+    .command('make:stack', descriptions.stack)
+    .option('--n, -name', 'The name of the stack')
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: MakeOptions) => {
+      const name = stacks.args[0] || options.name
+      options.name = name
+
+      if (!name) {
+        log.error('You need to specify a name. Read more about the documentation here.')
+        process.exit()
+      }
+
+      await makeStack(options)
+    })
+}
+
+function hasNoOptions(options: MakeOptions) {
+  return !options.component && !options.page && !options.function && !options.language && !options.database && !options.migration && !options.factory && !options.notification && !options.stack
+}
+
+export { make }

package/buddy/src/commands/preinstall.ts

@@ -0,0 +1,18 @@
+import type { CLI, PreinstallOptions } from '@stacksjs/types'
+import { invoke } from '@stacksjs/actions/preinstall'
+
+const descriptions = {
+  command: 'Run your preinstall script',
+  debug: 'Enable debug mode',
+}
+
+async function preinstall(stacks: CLI) {
+  stacks
+    .command('preinstall', descriptions.command)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: PreinstallOptions) => {
+      await invoke(options)
+    })
+}
+
+export { preinstall }

package/buddy/src/commands/prepublish.ts

@@ -0,0 +1,19 @@
+import type { CLI, PrepublishOptions } from '@stacksjs/types'
+import { Action } from '@stacksjs/types'
+import { runAction } from '@stacksjs/actions'
+
+const descriptions = {
+  command: 'Run your prepublish script',
+  debug: 'Enable debug mode',
+}
+
+async function prepublish(stacks: CLI) {
+  stacks
+    .command('prepublish', descriptions.command)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: PrepublishOptions) => {
+      await runAction(Action.Prepublish, options)
+    })
+}
+
+export { prepublish }

package/buddy/src/commands/release.ts

@@ -0,0 +1,28 @@
+import type { CLI, ReleaseOptions } from '@stacksjs/types'
+import { intro, log, outro } from '@stacksjs/cli'
+import { runAction } from '@stacksjs/actions'
+import { Action } from '@stacksjs/types'
+
+const descriptions = {
+  release: 'Release a new version of your libraries/packages',
+  debug: 'Enable debug mode',
+}
+
+async function release(stacks: CLI) {
+  stacks
+    .command('release', descriptions.release)
+    .option('--debug', descriptions.debug, { default: true }) // it's on by default because it requires manual input
+    .action(async (options: ReleaseOptions) => {
+      const perf = intro('buddy release')
+      const result = await runAction(Action.Release, options)
+
+      if (result.isErr()) {
+        log.error('Failed to trigger the CI/CD release workflow.', result.error)
+        process.exit()
+      }
+
+      outro('Triggered CI/CD release workflow', { startTime: perf, useSeconds: true })
+    })
+}
+
+export { release }

package/buddy/src/commands/setup.ts

@@ -0,0 +1,26 @@
+import { runCommand } from '@stacksjs/cli'
+import type { CLI, CliOptions } from '@stacksjs/types'
+
+const descriptions = {
+  ensure: 'This command checks whether Node is installed. pnpm is checked via `only-allow` preinstall hook',
+  setup: 'This command installs Node & pnpm',
+  debug: 'Enable debug mode',
+}
+
+async function setup(stacks: CLI) {
+  stacks
+    .command('ensure', descriptions.ensure)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: CliOptions) => {
+      await runCommand('pnpm install', options)
+    })
+
+  stacks
+    .command('setup', descriptions.setup)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: CliOptions) => {
+      await runCommand('pnpm env use', options)
+    })
+}
+
+export { setup }

package/buddy/src/commands/test.ts

@@ -0,0 +1,41 @@
+import type { CLI, TestOptions } from '@stacksjs/types'
+import { invoke, testCoverageReport, testUi, typecheck } from '@stacksjs/actions/test'
+
+const descriptions = {
+  command: 'Runs your test suite',
+  types: 'Typechecks your codebase',
+  coverage: 'Generates a test coverage report',
+  debug: 'Enable debug mode',
+}
+
+async function test(stacks: CLI) {
+  stacks
+    .command('test', descriptions.command)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: TestOptions) => {
+      await invoke(options)
+    })
+
+  stacks
+    .command('test:ui', descriptions.command)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: TestOptions) => {
+      await testUi(options)
+    })
+
+  stacks
+    .command('test:types', descriptions.types)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: TestOptions) => {
+      await typecheck(options)
+    })
+
+  stacks
+    .command('test:coverage', descriptions.coverage)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async (options: TestOptions) => {
+      await testCoverageReport(options)
+    })
+}
+
+export { test }

package/buddy/src/commands/types.ts

@@ -0,0 +1,26 @@
+import type { CLI } from '@stacksjs/types'
+import { types as generateTypes } from '@stacksjs/actions/generate'
+
+const descriptions = {
+  generate: 'Generate the types of & for your library/libraries',
+  fix: 'wip',
+  debug: 'Enable debug mode',
+}
+
+async function types(stacks: CLI) {
+  stacks
+    .command('types:generate', descriptions.generate)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async () => {
+      await generateTypes()
+    })
+
+  stacks
+    .command('types:fix', descriptions.fix)
+    .option('--debug', descriptions.debug, { default: false })
+    .action(async () => {
+      // await fixTypes()
+    })
+}
+
+export { types }