Skip to content

Commit 8bcf0c5

Browse files
authored
docs(vscode): include references to VS Code extension (#858)
1 parent 96b1535 commit 8bcf0c5

File tree

9 files changed

+56
-0
lines changed

9 files changed

+56
-0
lines changed

docs/docs/basics/middleware.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,7 @@ To create new middleware on a Dart Frog project, run the following command:
4545
# Creates routes/hello/_middleware.dart
4646
dart_frog new middleware "/hello"
4747
```
48+
49+
:::tip
50+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create new middleware within your IDE.
51+
:::

docs/docs/basics/resources.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ title: 📚 Additional Resources
77

88
- [Awesome Dart Frog repo][awesome_dart_frog_link]: Highlights awesome Dart Frog resources — articles, videos, open source projects, and more!
99

10+
- [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog): extends VS Code with support for Dart Frog and provides tools for effectively managing Dart Frog projects within VS Code.
11+
1012
:::info
1113
Fun fact: Did you know the [dart2js][dart2js_compiler_link] compiler [used to be called frog][dart2js_frog_pr_link]?
1214
:::

docs/docs/basics/routes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ Managing routes in Dart Frog is essentially as simple as managing the file struc
2828
dart_frog new route "/hello"
2929
```
3030

31+
:::tip
32+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create new routes within your IDE.
33+
:::
34+
3135
## Requests 📥
3236

3337
All route handlers have access to information regarding the inbound request. In this section, we'll take a look at various ways in which we can interact with the inbound request.

docs/docs/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@ dart_frog build
9595

9696
✅ WebSocket Support 🔌
9797

98+
✅ VS Code Extension 💻
99+
98100
🚧 Generated Dart Client Package 📦
99101

100102
🚧 Generated API Documentation 📔

docs/docs/tutorials/counter.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ cd ./counter
7373
dart_frog dev
7474
```
7575

76+
:::tip
77+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create Dart Frog apps within your IDE.
78+
:::
79+
7680
## Running the development server
7781

7882
You should now have a directory called `counter` -- `cd` into it:
@@ -164,6 +168,10 @@ Handler middleware(Handler handler) {
164168
}
165169
```
166170

171+
:::tip
172+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create new middleware within your IDE.
173+
:::
174+
167175
Now that we've defined the middleware, we can create our private `count` and provide the count to all sub routes:
168176

169177
```dart

docs/docs/tutorials/echo.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ cd ./echo
7373
dart_frog dev
7474
```
7575

76+
:::tip
77+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create Dart Frog apps within your IDE.
78+
:::
79+
7680
## Running the development server
7781

7882
You should now have a directory called `echo` -- `cd` into it:
@@ -137,6 +141,10 @@ Response onRequest(RequestContext context, String message) {
137141
Since this route handler corresponds to a dynamic route, we will received the parameter as an argument in `onRequest`.
138142
:::
139143

144+
:::tip
145+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create new dynamic routes within your IDE.
146+
:::
147+
140148
Save the changes and hot reload should kick in ⚡️
141149

142150
```bash

docs/docs/tutorials/hello_world.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ cd ./hello_world
5858
dart_frog dev
5959
```
6060

61+
:::tip
62+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create Dart Frog apps within your IDE.
63+
:::
64+
6165
## Running the development server
6266

6367
You should now have a directory called `hello_world` -- `cd` into it:

docs/docs/tutorials/todos.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ cd ./todos
7676
dart_frog dev
7777
```
7878

79+
:::tip
80+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create Dart Frog apps within your IDE.
81+
:::
82+
7983
## Running the development server
8084

8185
You should now have a directory called `todos` -- `cd` into it:
@@ -489,6 +493,10 @@ We're providing a single instance of the `TodosDataSource` so we have a single s
489493
In addition, we're using the `requestLogger` middleware from `package:dart_frog` to log all requests for debugging.
490494
:::
491495

496+
:::tip
497+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create new middleware within your IDE.
498+
:::
499+
492500
## Creating the `/todos` route
493501

494502
Next, delete the root route handler at `routes/index.dart` and create a route handler for the `/todos` endpoint by creating `routes/todos/index.dart`:
@@ -532,6 +540,10 @@ Future<Response> _post(RequestContext context) async {
532540
}
533541
```
534542

543+
:::tip
544+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create new routes within your IDE.
545+
:::
546+
535547
:::note
536548
We're using `context.read<TodosDataSource>` to access the provided instance of the `TodosDataSource`.
537549
:::

docs/docs/tutorials/web_socket_counter.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@ cd ./web_socket_counter
6363
dart_frog dev
6464
```
6565

66+
:::tip
67+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create Dart Frog apps within your IDE.
68+
:::
69+
6670
## Running the development server
6771

6872
You should now have a directory called `web_socket_counter`. Let's change directories into the newly created project:
@@ -109,6 +113,10 @@ Response onRequest(RequestContext context) {
109113

110114
We can also delete the root endpoint at `routes/index.dart` since we won't be needing it for this example.
111115

116+
:::tip
117+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create new routes within your IDE.
118+
:::
119+
112120
Save the changes and hot reload should kick in ⚡️
113121

114122
```
@@ -307,6 +315,10 @@ Handler middleware(Handler handler) => handler.use(counterProvider);
307315
For more information, refer to the [middleware documentation](/docs/basics/middleware).
308316
:::
309317

318+
:::tip
319+
Install and use the [Dart Frog VS Code extension](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog) to easily create new middleware within your IDE.
320+
:::
321+
310322
## Using the Counter
311323

312324
We can access the `CounterCubit` instance from our WebSocket handler via `context.read<CounterCubit>()`.

0 commit comments

Comments
 (0)