@stacksjs/skills 0.70.44 → 0.70.53

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE.md +21 -0
  2. package/README.md +394 -0
  3. package/package.json +4 -4
package/LICENSE.md ADDED
@@ -0,0 +1,21 @@
1
+ # MIT License
2
+
3
+ Copyright (c) 2023 Open Web Foundation
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,394 @@
1
+ ![Social Card of Stacks](./public/images/social.png)
2
+
3
+ # Rapid App & Library Development
4
+
5
+ [![npm version](https://img.shields.io/npm/v/stacks?style=flat-square)](https://npmjs.com/package/stacks)
6
+ [![GitHub Actions](https://img.shields.io/github/actions/workflow/status/stacksjs/stacks/ci.yml?style=flat-square&branch=main)](https://github.com/stacksjs/stacks/actions?query=workflow%3Aci)
7
+ [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
8
+ [![npm downloads](https://img.shields.io/npm/dm/stacks?style=flat-square)](https://npmjs.com/package/stacks)
9
+ <!-- [![Codecov][codecov-src]][codecov-href] -->
10
+
11
+ > [!NOTE]
12
+ > Stacks is in active development and usable today — every section below
13
+ > is real, runnable functionality. Expect occasional breaking changes
14
+ > while we cut the official 1.0. Feedback and issue reports are welcome.
15
+
16
+ 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._
17
+
18
+ - Web & Desktop Applications _(including system tray apps)_
19
+ - Serverless & Traditional APIs
20
+ - Cloud Infrastructure Creation & Maintenance
21
+ - Interactive CLIs
22
+ - Framework-agnostic Component & Function Libraries
23
+ - Deployment & Release Manager _(CI & CD)_
24
+
25
+ ## Convention Over Configuration
26
+
27
+ 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.
28
+
29
+ > “It is the framework’s responsibility to remove patterns that lead to boilerplate code. And Stacks is really good at that.” _- Chris_
30
+
31
+ <!-- ![Atomic UI & FX Design](./docs/assets/diagram.png) -->
32
+
33
+ ## Prerequisites
34
+
35
+ Stacks runs on [Bun](https://bun.sh). You'll need:
36
+
37
+ - **Bun ≥ 1.3.11** — install with `curl -fsSL https://bun.sh/install | bash`, or upgrade an existing install with `bun upgrade`.
38
+ - **macOS, Linux, or WSL** — Windows-native is on the roadmap; today the toolchain assumes a POSIX shell.
39
+ - **Node.js is NOT required.** Bun handles the JS/TS runtime, package management, and bundling.
40
+
41
+ That's it for the framework itself. Individual features (Postgres, Redis, AWS deploys, etc.) bring their own prereqs — each is called out where it matters in the docs.
42
+
43
+ ## Get Started
44
+
45
+ The fastest path, assuming Bun is installed:
46
+
47
+ ```bash
48
+ bunx buddy new my-project
49
+ ```
50
+
51
+ A one-line installer (`curl -Ssf stacksjs.com/install | sh`) is also planned and will appear here once it lands; for now the `bunx` form above is the supported install path.
52
+
53
+ ## Usage
54
+
55
+ Stacks ships with `buddy`, a single CLI for everything you'll do day to day. The handful below covers the common workflows; the full reference is collapsed underneath.
56
+
57
+ ```bash
58
+ buddy dev # start the dev server (frontend, API, dashboard, …)
59
+ buddy build # build for production (CLI prompts for what to build)
60
+ buddy test # run tests
61
+ buddy migrate # run database migrations
62
+ buddy make:action UpdateUser # scaffold a new Action (also: model, view, job, …)
63
+ buddy --help # show every available command
64
+ ```
65
+
66
+ For the full command reference, see the collapsible section below or the [Buddy CLI documentation](https://stacksjs.org/docs/cli).
67
+
68
+ <details>
69
+ <summary>View the complete Buddy Toolkit</summary>
70
+
71
+ ```bash
72
+ buddy --version # get the Stacks version
73
+ buddy --help # view help menu
74
+ # please note: you may suffix any command with the
75
+ # `command --help` flag to review the help menu
76
+
77
+ buddy install # installs dependencies
78
+ buddy add # adds a stack or dependency
79
+ buddy fresh # fresh reinstall of all deps
80
+ buddy clean # removes all deps
81
+ buddy setup # sets up the project initially
82
+ buddy setup:oh-my-zsh # optional: sets up Oh My Zsh with auto-completions & "aliases"
83
+
84
+ buddy upgrade # upgrades all dependencies
85
+ buddy upgrade -i # prompts you to select which updates to apply (wip)
86
+ buddy upgrade:dependencies # auto-upgrades package.json deps
87
+ buddy upgrade:framework # auto-upgrades deps & the Stacks framework
88
+ buddy upgrade:search-engine # auto-upgrades configured search engine
89
+ buddy upgrade:shell # upgrades the shell integration
90
+ buddy upgrade:binary # upgrades the `stacks` binary
91
+ buddy upgrade:bun # upgrades to latest project-defined Bun version
92
+ buddy upgrade:all # auto-upgrades all of the above
93
+
94
+ # if you need any more info on any command listed here, you may suffix
95
+ # any of them via the "help option", i.e. `buddy ... --help`
96
+
97
+ buddy dev # starts the frontend dev server
98
+ buddy dev -i # prompts any of the dev servers (components, functions, views, docs, or api)
99
+ buddy dev:api # starts the API dev server
100
+ buddy dev:dashboard # starts the Admin/Dashboard dev server
101
+ buddy dev:desktop # starts the Desktop dev server
102
+ buddy dev:views # starts frontend dev server
103
+ buddy dev:components # starts component dev server
104
+ buddy dev:functions # stubs functions
105
+ buddy dev:docs # starts local docs dev server
106
+ buddy dev docs # also starts the local docs dev server (colon is optional for all commands)
107
+ buddy development # `buddy dev` alias
108
+
109
+ buddy share # creates a sharable link to your local project
110
+
111
+ # for Laravel folks, `serve` may ring more familiar than the `dev` name. Hence, we aliased it
112
+ buddy serve
113
+ buddy serve:components
114
+ buddy serve:desktop
115
+ buddy serve:views
116
+ buddy serve:functions
117
+ buddy serve:docs
118
+
119
+ # building for production (e.g. AWS, Google Cloud, npm, Vercel, Netlify, et al.)
120
+ buddy build # select a specific build (follow CLI prompts)
121
+ buddy build:views # builds SSG views
122
+ buddy build:desktop # builds Desktop application
123
+ buddy build:library # builds any or all libraries
124
+ buddy build:functions # builds function library
125
+ buddy build:components # builds Vue component library & Web Component library
126
+ buddy build:web-components # builds framework agnostic Web Component library (i.e. Custom Elements)
127
+ buddy build:all # builds all your code
128
+
129
+ # `buddy build` aliases
130
+ buddy prod
131
+ buddy prod:components
132
+ buddy prod:desktop
133
+ buddy prod:library
134
+ buddy prod:views
135
+ buddy prod:functions
136
+ buddy prod:web-components
137
+ buddy prod:all
138
+ buddy production # `buddy prod` alias
139
+
140
+ # sets your application key
141
+ buddy key:generate
142
+
143
+ buddy make:component HelloWorld # bootstraps a HelloWorld component
144
+ buddy make:function hello-world # bootstraps a hello-world function
145
+ buddy make:view hello-world # bootstraps a hello-word page
146
+ buddy make:model Car # bootstraps a Car model
147
+ buddy make:database cars # creates a cars database
148
+ buddy make:migration create_cars_table # creates a cars migration file
149
+ buddy make:factory cars # creates a Car factory file
150
+ buddy make:table cars # bootstraps a cars data table
151
+ buddy make:notification welcome-email # bootstraps a welcome-email notification
152
+ buddy make:lang de # bootstraps a lang/de.yml language file
153
+ buddy make:stack my-project # shares logic with `bunx --bun stacks new my-project`
154
+
155
+ buddy migrate # runs database migrations
156
+ buddy migrate:dns # sets the ./config/dns.ts file
157
+
158
+ buddy dns example.com # list all DNS records for example.com
159
+ buddy dns example.com --type MX # list MX records for example.com
160
+
161
+ buddy https example.com/api/hello
162
+ # http [flags] [METHOD] URL [ITEM [ITEM]]
163
+ buddy http --help
164
+ buddy http PUT example.com/api/put X-API-Token:123 name=John # Custom HTTP method, HTTP headers and JSON data
165
+ buddy http -v example.com/api/get # See the request that is being sent using one of the output options
166
+ buddy http POST example.com/api/post hello=World # submitting forms
167
+ buddy http -a USERNAME POST https://api.github.com/repos/user/repo/issues/83/comments body='Great feature! :heart:'
168
+ buddy http localhost:8000 Host:example.com
169
+
170
+ buddy lint # runs linter
171
+ buddy lint:fix # runs linter and fixes issues
172
+
173
+ buddy commit # follow CLI prompts for committing staged changes
174
+ buddy release # creates the releases for the stack & triggers the Release Action (workflow)
175
+ buddy changelog # generates CHANGELOG.md
176
+
177
+ # when deploying your app/s to a remote server or cloud provider
178
+ buddy deploy # select a specific deployment (follow CLI prompts)
179
+ # buddy deploy:docs # deploys docs to AWS (or other configured provider)
180
+ # buddy deploy:functions # deploys functions to AWS (or other configured provider)
181
+ # buddy deploy:views # deploys views to AWS (or other configured provider)
182
+ # buddy deploy:all # deploys all your code
183
+ buddy undeploy # be careful: "undeploys" removes/deletes your deployed resources
184
+
185
+ buddy cloud:remove # removes cloud setup
186
+ buddy cloud:cleanup # removes cloud setup & cleans up all potentially leftover resources
187
+ buddy cloud:add --jump-box # adds a jump box to your cloud setup
188
+
189
+ # select the example to run (follow CLI prompts)
190
+ buddy example # prompts you to select which example to run
191
+ buddy example:vue # runs the Vue example
192
+ buddy example:web-components # runs the Web Component example
193
+
194
+ # you likely won’t need to run these commands as they are auto-triggered, but they are available
195
+ buddy generate # prompts you to select which generator to run
196
+ buddy generate:types # generates types for your components, functions, & views
197
+ buddy generate:entries # generates entry files for components, functions, & views
198
+ buddy generate:web-types # generates Web Component types
199
+ buddy generate:vscode-custom-data # generates VSCode custom data
200
+ buddy generate:ide-helpers # generates IDE helpers
201
+ buddy generate:component-meta # generates component meta
202
+ buddy generate:all # runs all generators
203
+
204
+ # generates your application key
205
+ buddy key:generate # generates your application key
206
+
207
+ # manage your environment variables
208
+ buddy env:get # get an environment variable
209
+ buddy env:set # set an environment variable
210
+ buddy env:encrypt # encrypt an environment variable
211
+ buddy env:decrypt # decrypt an environment variable
212
+ buddy env:keypair # generate a keypair
213
+ buddy env:rotate # rotate a keypair
214
+
215
+ # generate your TypeScript declarations
216
+ buddy types:generate # generates types for your components, functions, & views
217
+ buddy types:fix # auto-fixes types for your components, functions, & views
218
+
219
+ buddy domains # alias for `buddy domains:list`
220
+ buddy domains:add stacksjs.com # adds a domain
221
+ buddy domains:remove stacksjs.com # removes a domain
222
+ buddy domains:list # lists all domains
223
+ buddy domains:update # apply ./config/dns.ts updates
224
+ buddy domains:purchase stacksjs.com # purchase a new domain
225
+
226
+ # test your stack
227
+ buddy test # runs test suite (unit & e2e)
228
+ buddy test:coverage # runs test coverage
229
+ buddy test:types # runs typecheck
230
+
231
+ # the CLI may be triggered in any
232
+ # of the following syntax
233
+ stx fresh
234
+ buddy fresh
235
+ bud fresh
236
+ ```
237
+
238
+ </details>
239
+
240
+ Read more about the Buddy CLI in the [official docs](https://stacksjs.org/docs/cli) — every command, every flag, every prompt explained.
241
+
242
+ ## Features
243
+
244
+ 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:
245
+
246
+ ### Frontend Development
247
+
248
+ _Develop dynamic UIs with helpers for atomic design, and much more._
249
+
250
+ - 🧩 **Components** _primitive to develop user interfaces_
251
+ - 🤖 **Functions** _primitive to develop business logic (and grant your UI superpowers)_
252
+ - 🎨 **UI Kit** _modern & deeply-integrated components_
253
+ - 🌐 **Web** _“a routing & templating engine that makes sense”_
254
+ - 🖥️ **Desktop** _transforms your web app into a desktop app, plus more_
255
+ - 📝 **Documentation** _markdown-based documentation, auto-generated_
256
+ - 📚 **Library** _auto-builds & manages component & function libraries_
257
+ - ⚡️ Powered by Bun, Craft, Headwind
258
+
259
+ ### Backend Development
260
+
261
+ _Develop serverless (or server) functions with countless helpers to build scalable & fast APIs._
262
+
263
+ - 🪄 **AI** _deep AI integrations to simplify building agentic workflow_
264
+ - 🤖 **APIs** _scalability & maintainability built-in_
265
+ - 🏎️ **Cache** _unified caching for DynamoDB, Redis and more_
266
+ - ⚙️ **CLIs** _create beautiful CLIs for Linux, Windows, and Mac (dependency-free binaries)_
267
+ - 🛍️ **Commerce** _own & grow your own online business with ease (SaaS-optimized)_
268
+ - 📀 **Database** _DynamoDB, SQLite, MySQL, Postgres, and more_
269
+ - 👾 **Errors** _native type-safe error handling_
270
+ - 🗓️ **Events** _functional event (front & backend) communication_
271
+ - 📢 **Notifications** _emails, SMSs, direct, and push notifications & webhooks_
272
+ - 🗺️ **ORM** _automated schemas for scale & a pretty API_
273
+ - 💳 **Payments** _unified API for one-off & subscription billing methods for Stripe_
274
+ - ⚙️ **Queues** _run any heavy workload in the background_
275
+ - 🛠️ **Query Builder** _powerful, type-safe SQL query builder_
276
+ - 💬 **Realtime** _“everything you need to build dynamic real-time apps”_
277
+ - 🧭 **Router** _smart routing, file-based or Laravel-like_
278
+ - 🔎 **Search Engine** _smart searching, advanced filtering & sorting, pagination, headless UI_
279
+ - 💾 **Storage** _a secure-by-default File API that feels right_
280
+ - 🧪 **Tinker** _a powerful TypeScript REPL_
281
+ - 🌪️ **Validation** _e2e type-safety (true frontend & backend harmony)_
282
+ - 🎯 **X-Ray** _all you need to debug, log & analyze_
283
+
284
+ ### Cloud Development
285
+
286
+ _Develop & maintain cloud infrastructure with ease. “Imagine Vercel, Vapor and Forge having been unified.”_
287
+
288
+ - ☁️ **Server** _local development server & production-ready servers out-of-the-box_
289
+ - ⛅️ **Serverless** _on-demand, auto-scaling, zero maintenance_
290
+ - ⏰ **Alarms** _built-in cloud infrastructure monitoring to avoid surprises_
291
+ - 🚏 **CDN** _zero-config, low-latency, request life-cycle hooks, optimized request compressions (Brotli & gzip)_
292
+ - 🔀 **Domain** _version-controlled & zero-config domain management (e.g. DNS management)_
293
+ - 🤖 **AI** _fine-tune a foundational model using your application data_
294
+ - 📧 **Email** _secure & zero-setup <easy-peasy@custom-domains.com> mailboxes_
295
+ - 🔐 **Firewall** _native web application firewall support_
296
+ - 📦 **Storage** _unlimited cloud storage & automatic backups_
297
+ - 🚜 **Maintenance** _maintain your cloud infrastructure with ease using Buddy & Stacks_
298
+ - 🚦 **Infrastructure as Code** _version-controlled cloud infrastructure (AWS, Google next?)_
299
+
300
+ ### CI/CD
301
+
302
+ _Focus on coding, not publishing._
303
+
304
+ - 🚀 **Deployment Manager** _takes the sweat out of production deployments—zero-setup push-to-deploy_
305
+ - 0️⃣ **Zero Downtime** _deploy with confidence using a zero-downtime deployment strategy_
306
+ - 📫 **Release Manager** _libraries (component & function) auto-published to npm, git helpers, and more_
307
+
308
+ ### Developer Experience (DX)
309
+
310
+ Convention over configuration, while staying wholly configurable. _No more boilerplate._
311
+
312
+ - 💎 **Automated Upgrades** _no need to worry about upgrading to the latest versions, Stacks upgrades you_
313
+ - 🦋 **Pretty Dev URLs** _your-project.localhost instead of localhost:3000_
314
+ - 💡 **IDE Integration** _auto-completions, inline docs & a powerful IDE setup_
315
+ - 🪄 **Zero-Config** _yet highly configurable—convention over configuration_
316
+ - 💅 **Linter & Formatter** _auto-configured & built into your IDE_
317
+ - 💪🏼 **Type Strong** _built-in e2e type-safety_
318
+ - ✨ **Git Workflows** _committing with ease_
319
+ - 🚗 **Auto Imports** _your components & functions, including date, string, array, & object helpers_
320
+ - ⏩ **Code Snippets** _goodbye to the boilerplate code—thank you Sarah Drasner_
321
+ - 🔤 **Spell Checker** _be notified once there are typos_
322
+ - 🛠️ **Essential Utilities** _powers at your fingertips. Collections, VueUse, and more_
323
+ - 👥 **Team Management** _manage your team & their permissions_
324
+ - 🧪 **Streamlined Testing** _unit & e2e tests powered by Bun, Vitest & Playwright_
325
+
326
+ 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.
327
+
328
+ 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 ✌🏼_
329
+
330
+ > _An actual rapid application development framework for all Full Stack needs. Next-level simplicity & DX._
331
+
332
+ ## Testing
333
+
334
+ ```bash
335
+ ./buddy test
336
+ ```
337
+
338
+ ## Changelog
339
+
340
+ Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
341
+
342
+ ## Contributing
343
+
344
+ Please see the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
345
+
346
+ ## Community
347
+
348
+ For help, discussion about best practices, or any other conversation that would benefit from being searchable:
349
+
350
+ [Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
351
+
352
+ For casual chit-chat with others using this package:
353
+
354
+ [Join the Stacks Discord Server](https://discord.gg/stacksjs)
355
+
356
+ ## Postcardware
357
+
358
+ “Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where Stacks is being used! We showcase them on our website too.
359
+
360
+ Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎
361
+
362
+ ## Sponsors
363
+
364
+ We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
365
+
366
+ - [JetBrains](https://www.jetbrains.com/)
367
+ - [The Solana Foundation](https://solana.com/)
368
+
369
+ ## Credits
370
+
371
+ - [Laravel](https://laravel.com) _many thanks to their community_
372
+ - [Chris Breuer](https://github.com/chrisbbreuer)
373
+ - [All Contributors](../../contributors)
374
+
375
+ And a special thanks to [Dan Scanlon](https://twitter.com/danscan) for donating the `stacks` name on npm ✨
376
+
377
+ ## License
378
+
379
+ The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.
380
+
381
+ Made with 💙
382
+
383
+ <!-- Badges -->
384
+ [npm-version-src]: https://img.shields.io/npm/v/stacks?style=flat-square
385
+ [npm-version-href]: https://npmjs.com/package/stacks
386
+
387
+ [npm-downloads-src]: https://img.shields.io/npm/dm/stacks?style=flat-square
388
+ [npm-downloads-href]: https://npmjs.com/package/stacks
389
+
390
+ [github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/stacks/ci.yml?style=flat-square&branch=main
391
+ [github-actions-href]: https://github.com/stacksjs/stacks/actions?query=workflow%3Aci
392
+
393
+ <!-- [codecov-src]: https://img.shields.io/codecov/c/gh/stacksjs/stacks/main?style=flat-square
394
+ [codecov-href]: https://codecov.io/gh/stacksjs/buddy -->
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@stacksjs/skills",
3
3
  "type": "module",
4
- "version": "0.70.44",
4
+ "version": "0.70.53",
5
5
  "description": "Agent skills for the Stacks framework, following the agentskills.io standard.",
6
6
  "author": "Chris Breuer",
7
7
  "contributors": [
@@ -49,11 +49,11 @@
49
49
  "prepublishOnly": "bun run build"
50
50
  },
51
51
  "dependencies": {
52
- "@stacksjs/path": "^0.70.44",
53
- "@stacksjs/storage": "^0.70.44"
52
+ "@stacksjs/path": "0.70.53",
53
+ "@stacksjs/storage": "0.70.53"
54
54
  },
55
55
  "devDependencies": {
56
56
  "better-dx": "^0.2.12",
57
- "@stacksjs/types": "^0.70.44"
57
+ "@stacksjs/types": "0.70.53"
58
58
  }
59
59
  }