arri 0.53.1 → 0.54.0

package/README.md

@@ -2,8 +2,27 @@
 
 Command line interface for ARRI-RPC
 
+## Table of Contents
+
+-   [Commands](#commands)
+-   [Usage with @arrirpc/server](#usage-with-arrirpcserver)
+
+## Commands
+
+Run `arri --help` to get a full list of commands
+
+| Cmd                  | Description                                                                                                                                    |
+| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| codegen [input-file] | Run generate clients specified in the `arri.config.ts`. See [here](/README.md#creating-schemas-for-custom-server-implementations) for details. |
+| init [dir]           | Scaffold an arri app/library                                                                                                                   |
+| list                 | List available arri versions                                                                                                                   |
+| use [version]        | Update arri dependencies to a specific version (checks recursively for package.json, pubspec.yaml, cargo.toml, etc)                            |
+| version              | Print current CLI version                                                                                                                      |
+
 ## Usage with @arrirpc/server
 
+@arrirpc/server will automatically rerun code generators on hot-reload during development, and when building for production.
+
 For full details visit the [server docs](https://github.com/modiimedia/arri/blob/master/packages/arri/README.md)
 
 #### 1) Create an `arri.config.ts`
@@ -27,83 +46,3 @@ export default defineConfig({
 arri dev
 arri build
 ```
-
-## Generate Clients Without an Arri Server
-
-#### 1) Create an App Definition
-
-```ts
-// app-definition.ts
-import { createAppDefinition } from "arri";
-import { a } from "@arrirpc/schema";
-
-export default createAppDefinition({
-    procedures: {
-        sayHello: {
-            transport: "http",
-            method: "post",
-            path: "/say-hello",
-            params: a.object({
-                name: a.string(),
-            }),
-            response: a.object({
-                message: a.string(),
-            }),
-        },
-    },
-});
-```
-
-#### 2) Create an `arri.config.ts`
-
-```ts
-// arri.config.ts
-import { defineConfig, generators } from "arri";
-
-export default defineConfig({
-    generators: [
-        generators.typescriptClient({
-            // options
-        }),
-        generators.dartClient({
-            // options
-        }),
-        generators.kotlinClient({
-            // options
-        }),
-    ],
-});
-```
-
-#### 3) Run codegen command
-
-```bash
-arri codegen ./app-definition.ts
-```
-
-#### Now you can use the generated clients in your application code
-
-```ts
-// typescript
-await client.sayHello({
-    name: "John Doe",
-});
-```
-
-```dart
-// dart
-await client.sayHello(
-    SayHelloParams(
-        name: "John Doe",
-    ),
-);
-```
-
-```kt
-// kotlin
-client.sayHello(
-    SayHelloParams(
-        name = "John Doe"
-    )
-)
-```

package/dist/cli.cjs

@@ -34,6 +34,9 @@ const enquirer__default = /*#__PURE__*/_interopDefaultCompat(enquirer);
 const consola__default = /*#__PURE__*/_interopDefaultCompat(consola);
 
 const build = citty.defineCommand({
+  meta: {
+    description: "Build the arri TS server"
+  },
   args: {
     config: {
       type: "string",
@@ -219,6 +222,10 @@ async function createCodegenEntryFile(config) {
 }
 
 const codegen = citty.defineCommand({
+  meta: {
+    name: "Codegen",
+    description: "Run code-generators. (Uses options from your arri config file)"
+  },
   args: {
     schema: {
       type: "positional",
@@ -301,7 +308,7 @@ const codegen = citty.defineCommand({
 const init = citty.defineCommand({
   meta: {
     name: "Init",
-    description: "Scaffold an Arri app"
+    description: "Scaffold an arri app"
   },
   args: {
     dir: {
@@ -672,7 +679,7 @@ const __dirname$1 = path__default.dirname(__filename$1);
 const version = citty.defineCommand({
   meta: {
     name: "Version",
-    description: "Get the current Arri CLI version"
+    description: "Get the current arri CLI version"
   },
   run() {
     const packageJson = JSON.parse(

package/dist/cli.mjs

@@ -21,6 +21,9 @@ import '@joshmossas/listhen';
 import 'h3';
 
 const build = defineCommand({
+  meta: {
+    description: "Build the arri TS server"
+  },
   args: {
     config: {
       type: "string",
@@ -206,6 +209,10 @@ async function createCodegenEntryFile(config) {
 }
 
 const codegen = defineCommand({
+  meta: {
+    name: "Codegen",
+    description: "Run code-generators. (Uses options from your arri config file)"
+  },
   args: {
     schema: {
       type: "positional",
@@ -288,7 +295,7 @@ const codegen = defineCommand({
 const init = defineCommand({
   meta: {
     name: "Init",
-    description: "Scaffold an Arri app"
+    description: "Scaffold an arri app"
   },
   args: {
     dir: {
@@ -659,7 +666,7 @@ const __dirname = path.dirname(__filename);
 const version = defineCommand({
   meta: {
     name: "Version",
-    description: "Get the current Arri CLI version"
+    description: "Get the current arri CLI version"
   },
   run() {
     const packageJson = JSON.parse(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arri",
-  "version": "0.53.1",
+  "version": "0.54.0",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -35,16 +35,16 @@
     "esbuild": "^0.21.5",
     "esbuild-plugin-replace": "^1.4.0",
     "globby": "^14.0.1",
-    "h3": "^1.11.1",
+    "h3": "^1.12.0",
     "ofetch": "^1.3.4",
     "pathe": "^1.1.2",
     "prettier": "^3.3.2",
-    "@arrirpc/codegen-kotlin": "0.53.1",
-    "@arrirpc/codegen-dart": "0.53.1",
-    "@arrirpc/schema": "0.53.1",
-    "@arrirpc/codegen-rust": "0.53.1",
-    "@arrirpc/codegen-ts": "0.53.1",
-    "@arrirpc/codegen-utils": "0.53.1"
+    "@arrirpc/codegen-dart": "0.54.0",
+    "@arrirpc/codegen-kotlin": "0.54.0",
+    "@arrirpc/codegen-rust": "0.54.0",
+    "@arrirpc/codegen-ts": "0.54.0",
+    "@arrirpc/codegen-utils": "0.54.0",
+    "@arrirpc/schema": "0.54.0"
   },
   "devDependencies": {
     "@types/degit": "^2.8.6"