@stacksjs/buddy 0.53.1 → 0.56.3

package/README.md

@@ -8,7 +8,7 @@
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 <!-- [![Codecov][codecov-src]][codecov-href] -->
 
-_Pre-release until public beta released. Coming May/June._
+_Beta coming soon._
 
 The goal of the framework is to _help you_ create & maintain frontends, backends, and clouds—without having to worry about the boilerplate. Stacks is a rapid application development framework, meeting all your full stack needs.
 
@@ -72,7 +72,7 @@ _Create your personal or professional Vercel-like cloud, based on MIT-licensed O
 - ⛅️ **Serverless** _on-demand, auto-scaling, zero maintenance_
 - 🚏 **CDN** _zero-config low-latency CDN, including request life-cycle hooks & optimized request compressions (Brotli & gzip)_
 - 🔀 **Domain** _version-controlled & zero-config domain management (e.g. DNS)_
-- 📧 **Email** _secure & simplistic <easy-peasy@custom-domains.com> mail_
+- 📧 **Email** _secure & simplistic easy-peasy@custom-domains.com mail_
 - 🔐 **Firewall** _native web application firewall support_
 - 🚜 **Maintenance** _handles your cloud infrastructure via the Stacks & Serverless framework_
 - 🤖 **Infrastructure as Code** _create & maintain your cloud infrastructure with ease_
@@ -94,7 +94,7 @@ _Enhanced productivity for developers. No more creating boilerplate._
 - 💪🏼 **Type Strong** _built-in e2e type-safety_
 - ✨ **Git Workflows** _committing with ease_
 - 🚗 **Auto Imports** _your components & functions, including date, string, array, & object helpers_
-- ⏩ **Code Snippets** _say goodbye to the boilerplate—thank you [Sarah Drasner](https://github.com/sdras/vue-vscode-snippets)_
+- ⏩ **Code Snippets** _say goodbye to the boilerplate—thank you Sarah Drasner_
 - 🔤 **Spell Checker** _be notified once there are typos_
 - 🛠️ **Utilities** _Collections, VueUse, and more_
 - 🧪 **Testing** _unit & e2e tests powered by Vitest & Playwright_
@@ -110,27 +110,24 @@ Develop beautiful, reactive, composable UIs without learning a new set of langua
 It's incredibly easy to get started with this framework. Simply run the following command in your terminal:
 
 ```bash
-sh <(curl stacksjs.dev)
+sh <(curl stacksjs.dev) my-project
 
-# alternatively, if Node.js >= v18.12 is installed already,
+# alternatively, if Node.js >= v18.16 is installed already,
 # you may also get started via:
 npx stacks new my-project
 ```
 
-> **Note**
-> pnpm 8 required. _Run the setup script & 🐶 Buddy will set you up. He barks otherwise._
-
 ## 🤖 Usage
 
 The following list includes some of the most common ways to interact with the Stacks API. Meet the toolkit, Buddy:
 
 ```bash
 buddy install # installs all dependencies
-buddy dev # starts one of the dev servers (components, functions, pages, or docs)
+buddy dev # starts one of the dev servers (components, functions, views, or docs)
 buddy build # follow CLI prompts to select which library (or server) to build
 buddy commit # follow CLI prompts for committing changes
 buddy release # creates the releases for the stack & consequently, publishes them to npm
-buddy upgrade # auto-update deps & the Stacks framework
+buddy upgrade # auto-update all deps & the Stacks framework
 
 buddy make:component HelloWorld # scaffolds a component
 buddy make:function HelloWorld # scaffolds a function
@@ -148,69 +145,76 @@ buddy --help # view help menu
 # please note: you may suffix any command with the
 # `command --help` flag to review the help menu
 
-buddy install # installs your dependencies
+buddy install # installs dependencies
+buddy add # adds a stack or dependency
 buddy fresh # fresh reinstall of all deps
-buddy clean # removes all your deps
+buddy clean # removes all deps
 
-buddy update # auto-update deps & the Stacks framework
-buddy update:dependencies # auto-update deps & the Stacks framework
-buddy update:framework # auto-update deps & the Stacks framework
-buddy update:package-manager # auto-update deps & the Stacks framework
-buddy update:search-engine # auto-updates Meilisearch
-buddy update:node # update to latest project-defined node version
-buddy update:all # update Node, package manager, framework, dependencies
+buddy upgrade # auto-upgrades deps, framework, node.js, and/or pnpm
+buddy upgrade:dependencies # auto-upgrades deps & the Stacks framework
+buddy upgrade:framework # auto-upgrades deps & the Stacks framework
+buddy upgrade:package-manager # auto-upgrades deps & the Stacks framework
+buddy upgrade:search-engine # auto-upgrades configured search engine
+buddy upgrade:node # upgrades to latest project-defined node version
+buddy upgrade:all # upgrades Node, package manager, framework, dependencies
 
 # if you need any more info on any command listed here, you may suffix
 # any of them via the "help option", i.e. `buddy ... --help`
 
-buddy dev # start one of the dev servers (components, functions, pages, or docs)
-buddy dev:components # start local playground dev server
+buddy dev # starts one of the dev servers (components, functions, views, or docs)
+buddy dev:components # starts local playground dev server
 buddy dev:desktop # starts the Desktop playground
-buddy dev:pages # start local playground pages dev server
-buddy dev:functions # stub local the functions
-buddy dev:docs # start local docs dev server
+buddy dev:views # starts local playground views dev server
+buddy dev:functions # stubs local the functions
+buddy dev:docs # starts local docs dev server
 buddy development # `buddy dev` alias
 
 # for Laravel folks, `serve` may ring more familiar than the `dev` name. Hence, we aliased it:
 buddy serve
 buddy serve:components
-buddy serve:pages
+buddy serve:desktop
+buddy serve:views
 buddy serve:functions
 buddy serve:docs
 
 # building for production (e.g. AWS, Google Cloud, npm, Vercel, Netlify, et al.)
 buddy build # select a specific build (follow CLI prompts)
-buddy build:components # build Vue component library & Web Component library
-buddy build:vue-components # build Vue 2 & 3-ready Component library
-buddy build:web-components # build framework agnostic Web Component library (i.e. Custom Elements)
-buddy build:functions # build function library
-buddy build:pages # build SSG pages
-buddy build:all # build all your code
+buddy build:views # builds SSG views
+buddy build:desktop # builds Desktop application
+buddy build:library # builds any or all libraries
+buddy build:functions # builds function library
+buddy build:components # builds Vue component library & Web Component library
+buddy build:web-components # builds framework agnostic Web Component library (i.e. Custom Elements)
+buddy build:vue-components # builds Vue 2 & 3-ready Component library
+buddy build:all # builds all your code
 
 # `buddy build` aliases
 buddy prod
 buddy prod:components
+buddy prod:desktop
+buddy prod:library
+buddy prod:views
+buddy prod:functions
 buddy prod:vue-components
 buddy prod:web-components
-buddy prod:functions
-buddy prod:pages
 buddy prod:all
 buddy production # `buddy prod` alias
 
 # sets your application key
 buddy key:generate
 
-buddy make:stack project
-buddy make:component HelloWorld
-buddy make:function hello-world
-buddy make:page hello-world
-buddy make:lang de
-buddy make:notification welcome-email
-buddy make:database cars
-buddy make:table brands
-buddy make:migration create_cars_table
-buddy make:factory cars
-buddy make:seed cars
+buddy make:component HelloWorld # bootstraps a HelloWorld component
+buddy make:function hello-world # bootstraps a hello-world function
+buddy make:page hello-world # bootstraps a hello-word page
+buddy make:model Car # bootstraps a Car model
+buddy make:database cars # creates a cars database
+buddy make:migration create_cars_table # creates a cars migration file
+buddy make:factory cars # creates a Car factory file
+buddy make:seed cars # creates a Car seed file
+buddy make:table cars # boostraps a cars data table
+buddy make:notification welcome-email # bootstraps a welcome-email notification
+buddy make:lang de # bootstraps a lang/de.yml language file
+buddy make:stack my-project # shares logic with `npx stacks new my-project`
 
 buddy lint # runs linter
 buddy lint:fix # runs linter and fixes issues
@@ -220,33 +224,33 @@ buddy release # creates the releases for the stack & triggers the Release Action
 buddy changelog # generates CHANGELOG.md
 
 # when deploying your app/s to a remote server or cloud provider
-buddy deploy
-buddy deploy:docs
-buddy deploy:functions
-buddy deploy:pages
-buddy deploy:all
+buddy deploy # select a specific deployment (follow CLI prompts)
+buddy deploy:docs # deploys docs to AWS (or other configured provider)
+buddy deploy:functions # deploys functions to AWS (or other configured provider)
+buddy deploy:views # deploys views to AWS (or other configured provider)
+buddy deploy:all # deploys all your code
 
 # select the example to run (follow CLI prompts)
-buddy example
-buddy example:vue
-buddy example:web-components
+buddy example # prompts you to select which example to run
+buddy example:vue # runs the Vue example
+buddy example:web-components # runs the Web Component example
 
 # you likely won't need to run these commands as they are auto-triggered, but they are available
-buddy generate
-buddy generate:entries
-buddy generate:vue-compat
-buddy generate:web-types
-buddy generate:vscode-custom-data
-buddy generate:ide-helpers
-buddy generate:component-meta
-buddy generate:all
+buddy generate  # prompts you to select which generator to run
+buddy generate:entries # generates entry files for components, functions, & views
+buddy generate:vue-compat # generates Vue 2 compatibility layer
+buddy generate:web-types # generates Web Component types
+buddy generate:vscode-custom-data # generates VSCode custom data
+buddy generate:ide-helpers # generates IDE helpers
+buddy generate:component-meta # generates component meta
+buddy generate:all # runs all generators
 
 # generates your application key
-buddy key:generate
+buddy key:generate # generates your application key
 
 # generate your TypeScript declarations
-buddy types:generate
-buddy types:fix
+buddy types:generate # generates types for your components, functions, & views
+buddy types:fix # auto-fixes types for your components, functions, & views
 
 # test your stack
 buddy test # runs test suite (unit & e2e)
@@ -259,12 +263,6 @@ stx fresh
 buddy fresh
 bud fresh
 buddy fresh
-pnpm stx fresh
-pnpm buddy fresh
-pnpm buddy fresh
-pnpm fresh
-pnpm run fresh
-pnpm run buddy fresh
 ```
 
 </details>
@@ -275,7 +273,7 @@ Read more here about the Stacks CLI in the documentation.
 
 Because Stacks optimizes the development of easily reusable & composable component & function libraries, the primary intention is to always _keep it simple, yet configurable._
 
-By default, Stacks realizes whether your Stack includes components, functions, and/or pages. Based on that determination, Stacks builds your outputs.
+By default, Stacks realizes whether your Stack includes components, functions, and/or views. Based on that determination, Stacks builds your outputs.
 
 The UI libraries that automatically get built are: a Web Component (Custom Elements) & Vue Component library.
 
@@ -347,7 +345,7 @@ You may view this framework as an incredibly “useful set of frames” to assis
 
 Part of the Stacks ecosystem are the following first-party supported stacks:
 
-- [Table](https://github.com/stacksjs/table) (Data tables with ease)
+- [Table](https://github.com/stacksjs/stacks/tree/main/.stacks/stacks/tables) (Data tables with ease)
 - [Calendar](https://github.com/stacksjs/calendar) (Add to Calendar utilities—iCal, Google, and more)
 - [Command Palette](https://github.com/stacksjs/command-palette) (`⌘ + k` for the web)
 - [Date Picker](https://github.com/stacksjs/date-picker) (Beautiful, modern date picker)
@@ -355,11 +353,10 @@ Part of the Stacks ecosystem are the following first-party supported stacks:
 - [Image](https://github.com/stacksjs/image) (Modern image experience)
 - [Video](https://github.com/stacksjs/video) (Modern video experience)
 - [Audio](https://github.com/stacksjs/audio) (Modern audio experience)
-- [Web3](https://github.com/stacksjs/web3) (Solana support, cross-chain core. _Ethereum & Cardano drivers coming._)
-  - [Wallets](https://github.com/stacksjs/wallets) (Wallet Authentication)
-  - [NFT](https://github.com/stacksjs/nft) (NFTs, Candy Machine mechanisms, and more.)
-  - [DeFi](https://github.com/stacksjs/defi) (Cross-chain DeFi engine, including staking support)
-  - [DAO](https://github.com/stacksjs/dao) (Powerful toolkit for DAO governance, including a Reddit-type of voting system)
+- [Identity](https://github.com/stacksjs/identity) (Identity providers & wallet integrations)
+- [Digital Ownership](https://github.com/stacksjs/ownership) (Public ownership protocol integrations)
+- [Payments](https://github.com/stacksjs/payments) (Unified payment APIs)
+- [Governance](https://github.com/stacksjs/governance) (Powerful toolkit for democratic governance)
 
 View our detailed roadmap/s [here](https://github.com/stacksjs/stacks/projects?query=is%3Aopen), for more information. Additionally, you may find interesting stacks, information & examples over at [Awesome Stacks](https://github.com/stacksjs/awesome-stacks).
 

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+
+export { }

package/dist/cli.mjs

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+import { runAction } from '@stacksjs/actions';
+import { handleError } from '@stacksjs/error-handling';
+import { command, log } from '@stacksjs/cli';
+import { env } from '@stacksjs/validation';
+import { installIfVersionMismatch, isProjectCreated, frameworkVersion } from '@stacksjs/utils';
+import { projectPath } from '@stacksjs/path';
+import { Action } from '@stacksjs/types';
+import { o as setup, k as key, e as create, n as preinstall, p as prepublish, u as upgrade, i as generate, f as dev, b as build, c as changelog, a as clean, d as commit, h as fresh, l as lint, r as release, m as make, j as migrate, s as seed, g as example, t as test, v as version } from './shared/buddy.4ed611cb.mjs';
+import '@stacksjs/actions/generate';
+import '@stacksjs/actions/commit';
+import '@stacksjs/storage';
+import '@stacksjs/actions/dev';
+import '@stacksjs/actions/examples';
+import '@stacksjs/actions/make';
+import '@stacksjs/actions/preinstall';
+import '@stacksjs/logging';
+
+const cli = command("buddy");
+process.on("uncaughtException", handleError);
+process.on("unhandledRejection", handleError);
+async function main() {
+  await installIfVersionMismatch();
+  await setup(cli);
+  await key(cli);
+  if (!await isProjectCreated()) {
+    if (env.APP_ENV !== "production")
+      log.info("Project not yet initialized, generating application key...");
+    else
+      handleError(new Error("Please run `buddy key:generate` to generate an application key"));
+    const result = await runAction(Action.KeyGenerate, { cwd: projectPath() });
+    if (result.isErr())
+      handleError(result.error);
+    log.info("Application key generated.");
+    await create(cli);
+  }
+  await preinstall(cli);
+  await prepublish(cli);
+  await upgrade(cli);
+  await generate(cli);
+  await dev(cli);
+  await build(cli);
+  await changelog(cli);
+  await clean(cli);
+  await commit(cli);
+  await fresh(cli);
+  await lint(cli);
+  await release(cli);
+  await make(cli);
+  await migrate(cli);
+  await seed(cli);
+  await example(cli);
+  await test(cli);
+  await version(cli);
+  cli.help();
+  cli.version(await frameworkVersion());
+  cli.parse();
+}
+main();

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import { CLI } from '@stacksjs/types';
+
+declare function build(buddy: CLI): Promise<void>;
+
+declare function changelog(buddy: CLI): Promise<void>;
+
+declare function clean(buddy: CLI): Promise<void>;
+
+declare function commit(buddy: CLI): Promise<void>;
+
+declare function create(buddy: CLI): Promise<void>;
+
+declare function deploy(buddy: CLI): Promise<void>;
+
+declare function dev(buddy: CLI): Promise<void>;
+
+declare function example(buddy: CLI): Promise<void>;
+
+declare function fresh(buddy: CLI): Promise<void>;
+
+declare function generate(buddy: CLI): Promise<void>;
+
+declare function lint(buddy: CLI): Promise<void>;
+
+declare function inspire(buddy: CLI): Promise<void>;
+
+declare function key(buddy: CLI): Promise<void>;
+
+declare function make(buddy: CLI): Promise<void>;
+
+declare function migrate(buddy: CLI): Promise<void>;
+
+declare function onboarding(buddy: CLI): Promise<void>;
+
+declare function prepublish(buddy: CLI): Promise<void>;
+
+declare function preinstall(buddy: CLI): Promise<void>;
+
+declare function release(buddy: CLI): Promise<void>;
+
+declare function seed(buddy: CLI): Promise<void>;
+
+declare function setting(buddy: CLI): Promise<void>;
+
+declare function setup(buddy: CLI): Promise<void>;
+
+declare function test(buddy: CLI): Promise<void>;
+
+declare function tinker(buddy: CLI): Promise<void>;
+
+declare function types(buddy: CLI): Promise<void>;
+
+declare function upgrade(buddy: CLI): Promise<void>;
+
+declare function version(buddy: CLI): Promise<void>;
+
+export { build, changelog, clean, commit, create, deploy, dev, example, fresh, generate, inspire, key, lint, make, migrate, onboarding, preinstall, prepublish, release, seed, setting, setup, test, tinker, types, upgrade, version };

package/dist/index.mjs

@@ -0,0 +1,96 @@
+export { b as build, c as changelog, a as clean, d as commit, e as create, f as dev, g as example, h as fresh, i as generate, k as key, l as lint, m as make, j as migrate, n as preinstall, p as prepublish, r as release, s as seed, o as setup, t as test, u as upgrade, v as version } from './shared/buddy.4ed611cb.mjs';
+import { runAction } from '@stacksjs/actions';
+import { intro, outro } from '@stacksjs/cli';
+import { Action, ExitCode } from '@stacksjs/types';
+import { types as types$1 } from '@stacksjs/actions/generate';
+import '@stacksjs/actions/commit';
+import '@stacksjs/utils';
+import '@stacksjs/storage';
+import '@stacksjs/path';
+import '@stacksjs/actions/dev';
+import '@stacksjs/actions/examples';
+import '@stacksjs/actions/make';
+import '@stacksjs/actions/preinstall';
+import '@stacksjs/logging';
+
+async function deploy(buddy) {
+  const descriptions = {
+    deploy: "Reinstalls your npm dependencies",
+    verbose: "Enable verbose output"
+  };
+  buddy.command("deploy", descriptions.deploy).option("--verbose", descriptions.verbose, { default: false }).action(async (options) => {
+    const perf = await intro("buddy deploy");
+    const result = await runAction(Action.Deploy, options);
+    if (result.isErr()) {
+      outro("While running the `buddy deploy`, there was an issue", { startTime: perf, useSeconds: true, isError: true }, result.error);
+      process.exit();
+    }
+    outro("Deployment succeeded.", { startTime: perf, useSeconds: true });
+    process.exit(ExitCode.Success);
+  });
+}
+
+async function inspire(buddy) {
+  buddy.command("inspire", "Inspire yourself with a random quote").option("--two", "Show two quotes", { default: false }).action(async () => {
+    const perf = await intro("buddy inspire");
+    const result = await runAction(Action.Inspire);
+    if (result.isErr()) {
+      outro("While running the inspire command, there was an issue", { startTime: perf, useSeconds: true, isError: true }, result.error);
+      process.exit();
+    }
+    outro("Your quote is: ...", { startTime: perf, useSeconds: true });
+    process.exit(ExitCode.Success);
+  });
+}
+
+async function onboarding(buddy) {
+  const descriptions = {
+    command: "Generate Onboarding Pages",
+    verbose: "Enable verbose output"
+  };
+  buddy.command("page:onboarding", descriptions.command).option("--verbose", descriptions.verbose, { default: false }).action(async () => {
+    console.log("onboarding");
+  });
+}
+
+async function setting(buddy) {
+  const descriptions = {
+    command: "Generate Setting Pages",
+    verbose: "Enable verbose output"
+  };
+  buddy.command("page:setting", descriptions.command).option("--verbose", descriptions.verbose, { default: false }).action(async () => {
+    console.log("Generating setting views...");
+  });
+}
+
+async function tinker(buddy) {
+  const descriptions = {
+    tinker: "Tinker with your code",
+    verbose: "Enable verbose output"
+  };
+  buddy.command("tinker", descriptions.tinker).option("--verbose", descriptions.verbose, { default: false }).action(async (options) => {
+    const perf = await intro("buddy tinker");
+    const result = await runAction(Action.Tinker, options);
+    if (result.isErr()) {
+      outro("While running the tinker command, there was an issue", { startTime: perf, useSeconds: true, isError: true }, result.error || void 0);
+      process.exit();
+    }
+    outro("Tinker mode exited.", { startTime: perf, useSeconds: true });
+    process.exit(ExitCode.Success);
+  });
+}
+
+async function types(buddy) {
+  const descriptions = {
+    generate: "Generate the types of & for your library/libraries",
+    fix: "wip",
+    verbose: "Enable verbose output"
+  };
+  buddy.command("types:generate", descriptions.generate).option("--verbose", descriptions.verbose, { default: false }).action(async () => {
+    await types$1();
+  });
+  buddy.command("types:fix", descriptions.fix).option("--verbose", descriptions.verbose, { default: false }).action(async () => {
+  });
+}
+
+export { deploy, inspire, onboarding, setting, tinker, types };