stacks 0.1.0 → 0.37.3

package/.gitignore

@@ -0,0 +1,10 @@
+.nitro
+.output
+core/vue-components/.vite-inspect
+core/build/entries/*.ts
+**/dist/*.cjs
+**/dist/*.mjs
+**/dist/**/*.mjs
+**/dist/*.css
+**/dist/*.d.ts
+**/dist/**/*.d.ts

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2022 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,118 +1,79 @@
-stacks
-======
-
- Simple, reliable request/reply-based parallel computing over TCP.
- 
-[![Build Status](https://travis-ci.org/dscanlonpa/stacks.png?branch=master)](https://travis-ci.org/dscanlonpa/stacks)
- 
-What is stacks?
----------------
- Stacks provides a simple request/reply interface to parallel computing.  It's simply a queue of requests that clients 
- (seperate worker machines) reply to.  It's designed to be reliable and easy-to-use in situations involving long, compute-heavy requests.
- 
-Features
---------
-+ JSON, BSON, binary support – msgpack protocol
-+ Automatic round-robin scheduling
-+ Automatic rescheduling of failed requests
-+ Typed requests. `client.on(type, function(body, reply) { ...` interface
-+ Configurable per-request-type worker concurrency limits
-+ Supports zero or more client workers
-+ Automatically saves requests received when no worker is available, and schedules them when the next worker connects
-+ Automatically reschedules requests that were pending on clients that disconnect
-
-Installation
-------------
- To begin using stacks, you must have at least node v0.10 or higher installed.
- 
- Install from npm
- ```
- $ (sudo) npm install --save stacks
- ```
- 
- And add it to your project
- ```javascript
- var stacks = require('stacks');
- ...
- ```
-
-* * *
-
-making requests
-===============
-The master node makes requests to stacks.  The requests are automatically handled by clients.
-```javascript
-var stacks = require('stacks');
-// Listen for clients on port 3000
-stacks.listen(3000);
-
-stacks.request('string reverse', 'hello', { maxRetries: 5 }, function (error, reversedString) {
-  if (error) {
-    console.error('Failed to reverse string after 5 retries. Error:', error);
-  } else {
-    console.log('Reversed string:', reversedString); // Reversed string: olleh
-  }
-});
+# Stacks.js Framework
+
+This framework contains the "core" Stacks logic, its runtime & helpers, excluding the IDE setup.
+
+## ☘️ Features
+
+The ultimate goal of this framework, Stacks, is to _help you_ create a component and/or function library. Stacks is a toolkit of composables, methods, and other goodies required to build optimized libraries. A highly optimized build process that automatically generates `.mjs` & `.cjs` library distributions for you, including its TypeScript types.
+
+Other included core features are:
+
+- ⚡️ Vite plugins to build the component library
+- 🏎 Blazing fast, empowered by a beautiful DX
+- 👣 Tiny foot-print in production builds
+- 💬 Fully-typed TypeScript definitions
+- 🌳 Treeshaking for Vue & Web Components
+- 🎨 Optimized UnoCSS build for Vue & Web Components _(defaults to Tailwind CSS utility classes)_
+- 🧙🏼‍♀️ Unified way to access hundreds of [icon sets](https://icon-sets.iconify.design)
+ — [Icons in Pure CSS](https://antfu.me/posts/icons-in-pure-css)
+
+And all of this in a zero-config, yet configurable, way.
+
+## 🤖 Usage
+
+If you want to use Stacks outside of this framework, install it as a dev dependency:
+
+```bash
+pnpm i -D stacksjs
 ```
 
-handling requests
-=================
-```javascript
-var stacks = require('stacks');
-// connect to stacks server
-stacks.connect(3000, function(client) {
-
-  client.on('string reverse', function(string, reply) {
-    var reversedString = string.split("").reverse().join("");
-    var error = null;
-    reply(error, reversedString);
-  }, 15); // handle only 15 concurrent string reverse requests at a time
-  
-});
+Now, you can use it in your project:
+
+```js
+import {
+  Stacks,
+  atomicCssEngine,
+  autoImports,
+  components,
+  createApp,
+  defineConfig,
+  defineTestConfig,
+  inspect,
+  resolve,
+  uiEngine
+} from 'stacksjs'
+
+// you are now free to use any of the imported methods
 ```
 
-* * *
+Learn more in the docs.
+
+## 🧪 Testing
+
+```bash
+pnpm test
+```
+
+## 📈 Changelog
+
+Please see our [releases](https://github.com/stacksjs/vue-components-library-starter/releases) page for more information on what has changed recently.
 
-Server API
-==========
+## 💪🏼 Contributing
 
-## listen(port, [callback])
-Listen for client (worker) connections
-+ _Number_ `port`: Port to listen for client connections on
-+ _Function_ `callback`: Callback function invoked when stacks has begun listening. Takes no arguments
+Please see [CONTRIBUTING](../../.github/CONTRIBUTING.md) for details.
 
-## request(type, body, [options], callback)
-Make a request on stacks
-+ _String_ `type`: Type of request. Used in client interface to process/reply i.e., `client.on(type, function(body, reply) {...`
-+ _Mixed_ `body`: The request body that will be received by the client request worker. `WARNING: `Arrays will be parsed as arguments and cannot be sent as the top-level object in a request.
-+ _Object_ `options`: Request options. 
-+ _Function_ `callback`: Callback function invoked when request completes (or fails after options.maxRetries). Takes arguments `error`, `response`.
+## 🏝 Community
 
-### request options
-+ _Number_ `maxRetries` (3): The maximum amount of retries to attempt before invoking request callback with `error`.  (These retries are rescheduled by stacks (round-robin if multiple clients are connected)).
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
 
-Client API
-==========
+[Discussions on GitHub](https://github.com/stacksjs/web-components-library-starter/discussions)
 
-## connect(server, callback)
-Connect to stacks server
-+ _Mixed_ `server`: If _Number_, server is interpreted as port. If _Object_, server must have the signature `{ host: '[host-ip-address]', port: 3000 }`
-+ _Function_ `callback`: Invoked after client is connected to stacks server. Takes argument `client`.
+For casual chit-chat with others using this package:
 
-## disconnect()
-Disconnect from stacks server
+[Join the Open Web Discord Server](https://discord.ow3.org)
 
-## Client
-Instance methods of the client object passed to the #connect() callback.
+## 📄 License
 
-#### on(type, worker, [concurrency])
-Handle and reply to requests of type `type`
-+ _String_ `type`: Type of request to handle with `concurrency` concurrent `worker` functions
-+ _Function_ `worker`: Function that processes and replies to a request.  Takes arguments `body`– the request body –and `reply`– the reply function.
-+ _Number_ `concurrency` (1): Limit of concurrent `worker` functions to use for requests of type `type`.
- 
-License
-=======
- 
- MIT
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
 
+Made with ❤️