chore: wip

Author: chrisbbreuer

.gitignore

@@ -23,6 +23,7 @@ custom-cli
 .idea
 .stacks
 .vscode
+.cursor
 .zed
 ./test.ts
 resources/assets/fonts/*.woff

storage/framework/defaults/ide/cursor/rules/code-style.mdc

@@ -0,0 +1,12 @@
+---
+description: Code Style & Structure specifics
+globs: 
+---
+## Code Style & Structure
+
+- Write concise, technical TypeScript code with accurate examples in the docblock
+- If Bun native modules are available, use them
+- Use functional and declarative programming patterns; avoid classes unless needed
+- Prefer iteration and modularization over code duplication
+- Use descriptive variable names with auxiliary verbs (e.g., `isLoading`, `hasError`)
+- Use proper jsdoc comments for functions, types, interfaces, and ensure examples are accurate

storage/framework/defaults/ide/cursor/rules/documentation.mdc

@@ -0,0 +1,9 @@
+---
+description: Documentation specific rules
+globs: docs/**/*.md
+---
+## Documentation
+
+- Write documentation for all functions, types, interfaces, and ensure examples are accurate
+- The `./docs` directory is where the vitepress markdown documentation is stored
+- Make sure to update the docs markdown files

storage/framework/defaults/ide/cursor/rules/error-handling-validation.mdc

@@ -0,0 +1,11 @@
+---
+description: Error Handling and Validation specifics
+globs: 
+---
+## Error Handling and Validation
+
+- Prioritize error handling: handle errors and edge cases early
+- Use early returns and guard clauses
+- Implement proper error logging and user-friendly messages
+- Use error boundaries for unexpected errors
+- Use `@stacksjs/error-handling`, which is similar to neverthrow, to handle errors and responses 

storage/framework/defaults/ide/cursor/rules/key-conventions.mdc

@@ -0,0 +1,11 @@
+---
+description: Key code conventions
+globs: 
+---
+## Key Conventions
+
+- If there are two equally valid implementations, the browser version should be preferred
+- Aim for 100% test coverage
+- Avoid usage of `any`
+- Reuse eslint-ignore comments where present, unless not needed
+- ensure we log everything properly, including for debug reasons

storage/framework/defaults/ide/cursor/rules/project-structure.mdc

@@ -0,0 +1,11 @@
+---
+description: Project structure information
+globs: 
+---
+## Project Structure
+
+- the `./src` directory is the source code
+- the `./test` directory is the test code
+- the `./bin` directory is the command-line code
+  - you can also call the CLI via `./clarity ...`
+- the `./docs` directory is the documentation

storage/framework/defaults/ide/cursor/rules/readme.mdc

@@ -0,0 +1,328 @@
+---
+description: General information based on the latest ./README.md content
+globs: 
+---
+# Rapid App & Library Development
+
+Stacks is a rapid development framework, where the goal is to _help you_ create & maintain frontends, backends, and clouds—without having to worry about the boilerplate. _An all-in-one toolkit that meets all your full stack needs._
+
+- Web & Desktop Applications _(including system tray apps)_
+- Serverless & Traditional APIs
+- Cloud Infrastructure Creation & Maintenance
+- Interactive CLIs
+- Framework-agnostic Component & Function Libraries
+- Deployment & Release Manager _(CI & CD)_
+
+## Convention Over Configuration
+
+As a developer, Stacks helps you every step along the way—in beginner & expert-friendly ways, allowing you to focus on the _what & why_ of your project, all while enabling you to stay in control & ownership of your _(& your users’)_ data.
+
+> “It is the framework’s responsibility to remove patterns that lead to boilerplate code. And Stacks is really good at that.” _- Chris_
+
+<!-- ![Atomic UI & FX Design](./docs/assets/diagram.png) -->
+
+## Get Started
+
+It’s incredibly easy to get started with this framework. Simply run the following command in your terminal:
+
+```bash
+curl -Ssf stacksjs.org/install | sh # wip
+
+# alternatively, if Bun >= v1.2.0 is installed already,
+# you may also get started via:
+bunx buddy new my-project
+```
+
+## 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 (frontend, API, components, docs, desktop, etc.)
+buddy share # creates a sharable link of your local project
+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 all deps & the Stacks framework
+
+buddy make:component HelloWorld # scaffolds a Component
+buddy make:function HelloWorld # scaffolds a Function
+buddy make:model Car # scaffolds a Model
+buddy make:action UpdateCar # scaffolds an Action
+buddy make:migration create_cars_table # scaffolds a Migration
+buddy make:view Car # scaffolds a Page (https://my-project.test/car)
+buddy make:command Inspire # scaffolds a Command
+buddy make:job SendEmail # scaffolds a Job
+buddy make:middleware Logger # scaffolds a new Middleware
+buddy make:notification WelcomeEmail # scaffolds a Notification
+buddy make:lang de # scaffolds a language file
+
+buddy list # lists all available commands
+buddy --help
+```
+
+<details>
+<summary>View the complete Buddy Toolkit</summary>
+
+```bash
+buddy --version # get the Stacks version
+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 dependencies
+buddy add # adds a stack or dependency
+buddy fresh # fresh reinstall of all deps
+buddy clean # removes all deps
+buddy setup # sets up the project initially
+buddy setup:oh-my-zsh # optional: sets up Oh My Zsh with auto-completions & "aliases"
+
+buddy upgrade # upgrades all dependencies
+buddy upgrade -i # prompts you to select which updates to apply (wip)
+buddy upgrade:dependencies # auto-upgrades package.json deps
+buddy upgrade:framework # auto-upgrades deps & the Stacks framework
+buddy upgrade:search-engine # auto-upgrades configured search engine
+buddy upgrade:shell # upgrades the shell integration
+buddy upgrade:binary # upgrades the `stacks` binary
+buddy upgrade:bun # upgrades to latest project-defined Bun version
+buddy upgrade:all # auto-upgrades all of the above
+
+# 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 # starts the frontend dev server
+buddy dev -i # prompts any of the dev servers (components, functions, views, docs, or api)
+buddy dev:api # starts the API dev server
+buddy dev:dashboard # starts the Admin/Dashboard dev server
+buddy dev:desktop # starts the Desktop dev server
+buddy dev:views # starts frontend dev server
+buddy dev:components # starts component dev server
+buddy dev:functions # stubs functions
+buddy dev:docs # starts local docs dev server
+buddy dev docs # also starts the local docs dev server (colon is optional for all commands)
+buddy development # `buddy dev` alias
+
+buddy share # creates a sharable link to your local project
+
+# for Laravel folks, `serve` may ring more familiar than the `dev` name. Hence, we aliased it:
+buddy serve
+buddy serve:components
+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: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:all
+buddy production # `buddy prod` alias
+
+# sets your application key
+buddy key:generate
+
+buddy make:component HelloWorld # bootstraps a HelloWorld component
+buddy make:function hello-world # bootstraps a hello-world function
+buddy make:view 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:table cars # bootstraps 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 `bunx --bun stacks new my-project`
+
+buddy migrate # runs database migrations
+buddy migrate:dns # sets the ./config/dns.ts file
+
+buddy dns example.com # list all DNS records for example.com
+buddy dns example.com --type MX # list MX records for example.com (proxies dog)
+
+buddy https httpie.io/hello
+# http [flags] [METHOD] URL [ITEM [ITEM]]
+buddy http --help
+buddy http PUT pie.dev/put X-API-Token:123 name=John # Custom HTTP method, HTTP headers and JSON data
+buddy http -v pie.dev/get # See the request that is being sent using one of the output options
+buddy http -f POST pie.dev/post hello=World # submitting forms
+buddy http --offline pie.dev/post hello=offline
+buddy http -a USERNAME POST https://api.github.com/repos/httpie/cli/issues/83/comments body='HTTPie is awesome! :heart:'
+buddy http pie.dev/post < files/data.json
+buddy http pie.dev/image/png > image.png
+buddy http --download pie.dev/image/png
+buddy http --session=logged-in -a username:password pie.dev/get API-Key:123
+buddy http --session=logged-in pie.dev/headers
+buddy http localhost:8000 Host:example.com
+
+buddy lint # runs linter
+buddy lint:fix # runs linter and fixes issues
+
+buddy commit # follow CLI prompts for committing staged changes
+buddy release # creates the releases for the stack & triggers the Release Action (workflow)
+buddy changelog # generates CHANGELOG.md
+
+# when deploying your app/s to a remote server or cloud provider
+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
+buddy undeploy # be careful: "undeploys" removes/deletes your deployed resources
+
+buddy cloud:remove # removes cloud setup
+buddy cloud:cleanup # removes cloud setup & cleans up all potentially leftover resources
+buddy cloud:add --jump-box # adds a jump box to your cloud setup
+
+# select the example to run (follow CLI prompts)
+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  # prompts you to select which generator to run
+buddy generate:types # generates types for your components, functions, & views
+buddy generate:entries # generates entry files for components, functions, & views
+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 # generates your application key
+
+# generate your TypeScript declarations
+buddy types:generate # generates types for your components, functions, & views
+buddy types:fix # auto-fixes types for your components, functions, & views
+
+buddy domains # alias for `buddy domains:list`
+buddy domains:add stacksjs.org # adds a domain
+buddy domains:remove stacksjs.org # removes a domain
+buddy domains:list # lists all domains
+buddy domains:update # apply ./config/dns.ts updates
+buddy domains:purchase stacksjs.org # purchase a new domain
+
+# test your stack
+buddy test # runs test suite (unit & e2e)
+buddy test:coverage # runs test coverage
+buddy test:types # runs typecheck
+
+# the CLI may be triggered in any
+# of the following syntax:
+stx fresh
+buddy fresh
+bud fresh
+```
+
+</details>
+
+Read more here about the Stacks CLI in the documentation.
+
+## Features
+
+The Stacks framework is a harmony of several “engines” to build any web and/or desktop application, in highly scalable & privacy-friendly ways. It consists of the following engines:
+
+### Frontend Development
+
+_Develop dynamic UIs with helpers for atomic design, and much more._
+
+- 🧩 **Components** _primitive to develop user interfaces_
+- 🤖 **Functions** _primitive to develop business logic (and grant your UI superpowers)_
+- 🎨 **UI Kit** _modern & deeply-integrated components_
+- 🌐 **Web** _“a routing & templating engine that makes sense”_
+- 🖥️ **Desktop** _transforms your web app into a desktop app, plus more_
+- 📝 **Documentation** _markdown-based documentation, auto-generated_
+- 📚 **Library** _auto-builds & manages component & function libraries_
+- ⚡️ Powered by Bun, Tauri, UnoCSS, Vite, VitePress and Vue
+
+### Backend Development
+
+_Develop serverless (or server) functions with countless helpers to build scalable & fast APIs._
+
+- 🪄 **AI** _deep AI integrations & foundational model access_
+- 🤖 **APIs** _scalability & maintainability built-in_
+- 🏎️ **Cache** _unified caching for DynamoDB, Redis and more_
+- ⚙️ **CLIs** _create beautiful CLIs for Linux, Windows, and Mac (dependency-free binaries)_
+- 📀 **Database** _DynamoDB, SQLite, MySQL, Postgres, and more_
+- 👾 **Errors** _native type-safe error handling_
+- 🗓️ **Events** _functional event (front & backend) communication_
+- 📢 **Notifications** _emails, SMSs, direct, and push notifications & webhooks_
+- 🗺️ **ORM** _automated schemas for scale & a pretty API_
+- 💳 **Payments** _unified API for one-off & subscription billing methods for Stripe_
+- ⚙️ **Queues** _run any heavy workload in the background_
+- 🛠️ **Query Builder** _powerful, type-safe SQL query builder_
+- 💬 **Realtime** _“everything you need to build dynamic real-time apps”_
+- 🧭 **Router** _smart routing, file-based or Laravel-like_
+- 🔎 **Search Engine** _smart searching, advanced filtering & sorting, pagination, headless UI_
+- 💾 **Storage** _a secure-by-default File API that feels right_
+- 🧪 **Tinker** _a powerful TypeScript REPL_
+- 🌪️ **Validation** _e2e type-safety (true frontend & backend harmony)_
+- 🎯 **X-Ray** _all you need to debug, log & analyze_
+
+### Cloud Development
+
+_Develop & maintain cloud infrastructure with ease. “Imagine Vercel, Vapor and Forge having been unified.”_
+
+- ☁️ **Server** _local development server & production-ready servers out-of-the-box_
+- ⛅️ **Serverless** _on-demand, auto-scaling, zero maintenance_
+- ⏰ **Alarms** _built-in cloud infrastructure monitoring to avoid surprises_
+- 🚏 **CDN** _zero-config, low-latency, request life-cycle hooks, optimized request compressions (Brotli & gzip)_
+- 🔀 **Domain** _version-controlled & zero-config domain management (e.g. DNS management)_
+- 🤖 **AI** _fine-tune a foundational model using your application data_
+- 📧 **Email** _secure & zero-setup <easy-peasy@custom-domains.com> mailboxes_
+- 🔐 **Firewall** _native web application firewall support_
+- 📦 **Storage** _unlimited cloud storage & automatic backups_
+- 🚜 **Maintenance** _maintain your cloud infrastructure with ease using Buddy & Stacks_
+- 🚦 **Infrastructure as Code** _version-controlled cloud infrastructure (AWS, Google next?)_
+
+### CI/CD
+
+_Focus on coding, not publishing._
+
+- 🚀 **Deployment Manager** _takes the sweat out of production deployments—zero-setup push-to-deploy_
+- 0️⃣ **Zero Downtime** _deploy with confidence using a zero-downtime deployment strategy_
+- 📫 **Release Manager** _libraries (component & function) auto-published to npm, git helpers, and more_
+
+### Developer Experience (DX)
+
+Convention over configuration, while staying wholly configurable. _No more boilerplate._
+
+- 💎 **Automated Upgrades** _no need to worry about upgrading to the latest versions, Stacks upgrades you_
+- 🦋 **Pretty Dev URLs** _your-project.localhost instead of localhost:3000_
+- 💡 **IDE Integration** _auto-completions, inline docs & a powerful VS Code setup_
+- 🪄 **Zero-Config** _yet highly configurable—convention over configuration_
+- 💅 **Linter & Formatter** _auto-configured & built into your IDE_
+- 💪🏼 **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** _goodbye to the boilerplate code—thank you Sarah Drasner_
+- 🔤 **Spell Checker** _be notified once there are typos_
+- 🛠️ **Essential Utilities** _powers at your fingertips. Collections, VueUse, and more_
+- 👥 **Team Management** _manage your team & their permissions_
+- 🧪 **Streamlined Testing** _unit & e2e tests powered by Bun, Vitest & Playwright_
+
+No matter whether you are a beginner or an expert, the approachable Stacks design allows you to learn at your own pace, using our thorough documentation covering every aspect of the framework. Stacks is extremely beginner & expert-friendly.
+
+Develop beautiful, reactive, composable UIs without learning a new set of languages. HTML, CSS, and minimal JavaScript—that’s all you need to dive in now! _Or TypeScript ✌🏼_
+
+> _An actual rapid application development framework for all Full Stack needs. Next-level simplicity & DX._