Skip to content

Commit

Permalink
making arc create output consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
jessehattabaugh authored and ryanblock committed May 7, 2024
1 parent 9825af7 commit bac5d47
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 35 deletions.
11 changes: 5 additions & 6 deletions src/views/docs/en/reference/project-manifest/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,16 +82,15 @@ events:
</div>
</arc-viewer>

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
```
19 changes: 9 additions & 10 deletions src/views/docs/en/reference/project-manifest/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,20 +116,19 @@ http:
</div>
</arc-viewer>

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
```
Expand Down
22 changes: 12 additions & 10 deletions src/views/docs/en/reference/project-manifest/queues.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "<code>@queues</code>"
title: '<code>@queues</code>'
category: app.arc
description: Define SQS topics
---
Expand Down Expand Up @@ -42,8 +42,11 @@ publish-log

```json
{
"app": "myapp",
"queues": ["convert-image", "publish-log"]
"app": "myapp",
"queues": [
"convert-image",
"publish-log"
]
}
```

Expand All @@ -58,8 +61,8 @@ publish-log
---
app: myapp
queues:
- convert-image
- publish-log
- convert-image
- publish-log
```

</div>
Expand All @@ -68,14 +71,13 @@ queues:
</div>
</arc-viewer>

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
```
13 changes: 5 additions & 8 deletions src/views/docs/en/reference/project-manifest/scheduled.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,17 +87,14 @@ scheduled:
</div>
</arc-viewer>


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
```
2 changes: 1 addition & 1 deletion src/views/docs/en/reference/project-manifest/ws.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Running `arc create` generates the following WebSocket handlers, each mapping to

```bash
/
β”œβ”€β”€ src/ws
β”œβ”€β”€ src/ws/
β”‚ β”œβ”€β”€ connect
β”‚ β”œβ”€β”€ default
β”‚ └── disconnect
Expand Down

0 comments on commit bac5d47

Please sign in to comment.