From 9f49554dc59c472fbeaf22559e1bf2ffc405f6dc Mon Sep 17 00:00:00 2001 From: Jesse Hattabaugh Date: Tue, 7 May 2024 15:09:49 -0700 Subject: [PATCH] making `arc create` output consistent --- .../en/reference/project-manifest/events.md | 11 +++++----- .../en/reference/project-manifest/http.md | 19 ++++++++-------- .../en/reference/project-manifest/queues.md | 22 ++++++++++--------- .../reference/project-manifest/scheduled.md | 13 +++++------ .../docs/en/reference/project-manifest/ws.md | 2 +- 5 files changed, 32 insertions(+), 35 deletions(-) diff --git a/src/views/docs/en/reference/project-manifest/events.md b/src/views/docs/en/reference/project-manifest/events.md index ac6aa539..7802e8a1 100644 --- a/src/views/docs/en/reference/project-manifest/events.md +++ b/src/views/docs/en/reference/project-manifest/events.md @@ -82,16 +82,15 @@ events: -Which generates the following scaffolding: +Running `arc create` generates the following handlers: ```bash / -├── custom +├── custom/ │ └── source/ -├── src -│ └── events -│ ├── hit-counter/ -│ └── likes/ +├── src/events/ +│ ├── hit-counter/ +│ └── likes/ ├── app.arc └── package.json ``` diff --git a/src/views/docs/en/reference/project-manifest/http.md b/src/views/docs/en/reference/project-manifest/http.md index e9fc6d4a..711a508b 100644 --- a/src/views/docs/en/reference/project-manifest/http.md +++ b/src/views/docs/en/reference/project-manifest/http.md @@ -116,20 +116,19 @@ http: -Which utilizes the following project directory structure: +Running `arc create` generates the following handlers: ```bash / -├── custom +├── custom/ │ └── source/ -├── src -│ └── http -│ ├── get-index/ -│ ├── get-pages/ -│ ├── get-pages-000dateID/ -│ ├── get-contact/ -│ ├── get-widgets-catchall/ -│ └── post-contact/ +├── src/http/ +│ ├── get-index/ +│ ├── get-pages/ +│ ├── get-pages-000dateID/ +│ ├── get-contact/ +│ ├── get-widgets-catchall/ +│ └── post-contact/ ├── app.arc └── package.json ``` diff --git a/src/views/docs/en/reference/project-manifest/queues.md b/src/views/docs/en/reference/project-manifest/queues.md index 3ac99bf9..8d7a3b86 100644 --- a/src/views/docs/en/reference/project-manifest/queues.md +++ b/src/views/docs/en/reference/project-manifest/queues.md @@ -1,5 +1,5 @@ --- -title: "@queues" +title: '@queues' category: app.arc description: Define SQS topics --- @@ -42,8 +42,11 @@ publish-log ```json { - "app": "myapp", - "queues": ["convert-image", "publish-log"] + "app": "myapp", + "queues": [ + "convert-image", + "publish-log" + ] } ``` @@ -58,8 +61,8 @@ publish-log --- app: myapp queues: - - convert-image - - publish-log +- convert-image +- publish-log ``` @@ -68,14 +71,13 @@ queues: -Which generates the corresponding code: +Running `arc create` generates the following handlers: ```bash / -├── src -│ └── queues -│ ├── convert-image/ -│ └── publish-log/ +├── src/queues/ +│ ├── convert-image/ +│ └── publish-log/ ├── app.arc └── package.json ``` diff --git a/src/views/docs/en/reference/project-manifest/scheduled.md b/src/views/docs/en/reference/project-manifest/scheduled.md index 1cdf8832..ca44556e 100644 --- a/src/views/docs/en/reference/project-manifest/scheduled.md +++ b/src/views/docs/en/reference/project-manifest/scheduled.md @@ -87,17 +87,14 @@ scheduled: - -Which generates the following scaffolding: +Running `arc create` generates the following handlers: ```bash / -├── custom -│ └── source/ -├── src/ -│ └── scheduled/ -│ ├── daily-update-buddy/ -│ └── friyay-only/ +├── custom/source/ +├── src/scheduled/ +│ ├── daily-update-buddy/ +│ └── friyay-only/ ├── app.arc └── package.json ``` diff --git a/src/views/docs/en/reference/project-manifest/ws.md b/src/views/docs/en/reference/project-manifest/ws.md index 7ea47e4e..7dfedeb8 100644 --- a/src/views/docs/en/reference/project-manifest/ws.md +++ b/src/views/docs/en/reference/project-manifest/ws.md @@ -68,7 +68,7 @@ Running `arc create` generates the following WebSocket handlers, each mapping to ```bash / -├── src/ws +├── src/ws/ │ ├── connect │ ├── default │ └── disconnect