Add Cask tutorials #3056

gkepka · 2024-08-12T06:29:19Z

The scala-cli part needs some attention. While code compiles and starts without any problems, the process end immediately after being started. In SBT the same problem can be solved by setting fork := true, but I wasn't able to find any similar solution for scala-cli.

sjrd · 2024-08-13T14:54:36Z

The scala-cli part needs some attention. While code compiles and starts without any problems, the process end immediately after being started. In SBT the same problem can be solved by setting fork := true, but I wasn't able to find any similar solution for scala-cli.

In order to troubleshoot and isolate the problem: have you tried adding a while (true) {} loop at the end of main?

sjrd

Overall the structure and amount of details seem good to me. Here are some localized comments.

_overviews/toolkit/web-server-intro.md

_overviews/toolkit/web-server-static.md

sjrd · 2024-08-13T14:55:06Z

_overviews/toolkit/web-server-static.md

@@ -0,0 +1,146 @@
+---
+title: How to serve a static file?


Suggested change

title: How to serve a static file?

title: A minimal Cask server

See my other comment.

I would like to preserve the "How to [do X]" title convention, used in all the other tutorials. I imagine that's what a person in a need for guidance would search for.

_overviews/toolkit/web-server-static.md

_overviews/toolkit/web-server-input.md

_overviews/toolkit/web-server-websockets.md

_overviews/toolkit/OrderedListOfMdFiles

_overviews/toolkit/web-server-input.md

gkepka · 2024-08-26T08:39:16Z

The problem with scala-cli turned out to be caused by the difference between how files with .sc and .scala extensions are handled. It turns out that while the .scala files are executed as written, the contents of .sc files are wrapped in an auto-generated main function, ignoring all main functions defined in the code. The documentation for scala-cli makes a very good job at hiding that distinction, I managed to find it descibed here.

sjrd

This looks much better now, IMO!

There are a number of English grammar issues that we should fix. Let's discuss offline how you prefer me to report them.

sjrd · 2024-08-27T11:31:06Z

_overviews/toolkit/web-server-dynamic.md

@@ -65,17 +71,17 @@ In the terminal, the following command will start the server:
 {% endtab %}
 {% endtabs %}

-Access the endpoint at [http://localhost:8080/time](http://localhost:8080/time). You should see a result similar to the
-one below.
+Access [the endpoint](http://localhost:8080/time). You should see a result similar to the one below.


IMO the previous text, with the link appearing in the text, was better here. We should actively show the user that we're sending them to a localhost URL.

sjrd

Final English grammar and style comments.

sjrd · 2024-09-17T12:14:26Z

_includes/_markdown/install-cask.md

+{% tabs cask-install class=tabs-build-tool %}
+
+{% tab 'Scala CLI' %}
+You can declare dependency on Cask with `using` directive:


Suggested change

You can declare dependency on Cask with `using` directive:

You can declare a dependency on Cask with the following `using` directive:

sjrd · 2024-09-17T12:16:04Z

_overviews/toolkit/web-server-cookies-and-decorators.md

+In this example, we are building a rudimentary authentication service. The `getLogin` method provides a form where
+username and password can be inputted. The `postLogin` reads the credentials and, if they match the expected ones, a session
+identifier is generated, saved in the application state, and sends back a cookie with the identifier.


Suggested change

In this example, we are building a rudimentary authentication service. The `getLogin` method provides a form where

username and password can be inputted. The `postLogin` reads the credentials and, if they match the expected ones, a session

identifier is generated, saved in the application state, and sends back a cookie with the identifier.

In this example, we are building a rudimentary authentication service. The `getLogin` method provides a form where

the user can enter their username and password. The `postLogin` method reads the credentials. If they match the expected ones, it generates a session

identifier, saves it in the application state, and sends back a cookie with the identifier.

sjrd · 2024-09-17T12:16:34Z

_overviews/toolkit/web-server-cookies-and-decorators.md

+username and password can be inputted. The `postLogin` reads the credentials and, if they match the expected ones, a session
+identifier is generated, saved in the application state, and sends back a cookie with the identifier.
+
+Cookies can be read either with a method parameter of `cask.Cookie` type or by accessing `cask.Request` directly.


Suggested change

Cookies can be read either with a method parameter of `cask.Cookie` type or by accessing `cask.Request` directly.

Cookies can be read either with a method parameter of `cask.Cookie` type or by accessing the `cask.Request` directly.

sjrd · 2024-09-17T12:17:57Z

_overviews/toolkit/web-server-cookies-and-decorators.md

+## Using decorators
+
+Decorators can be used for extending endpoints functionality with validation or new parameters. They are defined by extending
+`cask.RawDecorator` class and then used as annotations.


Suggested change

`cask.RawDecorator` class and then used as annotations.

the `cask.RawDecorator` class. They are then used as annotations.

sjrd · 2024-09-17T12:18:47Z

_overviews/toolkit/web-server-dynamic.md

+
+## Serving dynamically generated content
+
+You can create an endpoint returning dynamically generated content with `@cask.get` annotation.


Suggested change

You can create an endpoint returning dynamically generated content with `@cask.get` annotation.

You can create an endpoint returning dynamically generated content with the `@cask.get` annotation.

sjrd · 2024-09-17T13:00:48Z

_overviews/toolkit/web-server-static.md

+`src/main/resources` directory. Cask will match any subpath coming after `/static` and append it to the directory path.
+If you access the `/static/hello.html` file, it will serve the file available at `src/main/resources/hello.html`.
+The directory path can be any path available to the server, relative or not. If the requested file cannot be found in the
+specified location, a 404 response with an error message will be returned instead.


Suggested change

specified location, a 404 response with an error message will be returned instead.

specified location, the server will return a 404 response with an error message.

sjrd · 2024-09-17T13:01:11Z

_overviews/toolkit/web-server-static.md

+The directory path can be any path available to the server, relative or not. If the requested file cannot be found in the
+specified location, a 404 response with an error message will be returned instead.
+
+The `Example` object inherits from the `cask.MainRoutes` class, providing the main function that starts the server. The `initialize()`


Suggested change

The `Example` object inherits from the `cask.MainRoutes` class, providing the main function that starts the server. The `initialize()`

The `Example` object inherits from the `cask.MainRoutes` class. It provides the main function that starts the server. The `initialize()`

sjrd · 2024-09-17T13:02:23Z

_overviews/toolkit/web-server-static.md

+{% endtabs %}
+
+In the endpoint method, the location is set to `"."`, telling the server that the files are available directly in the
+resources directory. In general, you can use any nested location within the resources directory, for instance you could opt


Suggested change

resources directory. In general, you can use any nested location within the resources directory, for instance you could opt

resources directory. In general, you can use any nested location within the resources directory. For instance, you could opt

sjrd · 2024-09-17T13:04:33Z

_overviews/toolkit/web-server-websockets.md

+You can create a WebSocket endpoint by using the `@cask.websocket` annotation. The endpoint method can return either a
+`cask.WsHandler` instance defining how the communication should take place, or a `cask.Response`, which rejects the 
+attempt at forming a WebSocket connection.


Suggested change

You can create a WebSocket endpoint by using the `@cask.websocket` annotation. The endpoint method can return either a

`cask.WsHandler` instance defining how the communication should take place, or a `cask.Response`, which rejects the

attempt at forming a WebSocket connection.

You can create a WebSocket endpoint with the `@cask.websocket` annotation. The endpoint method should return a

`cask.WsHandler` instance defining how the communication should take place. It can also return a `cask.Response`, which rejects the

attempt at forming a WebSocket connection.

sjrd · 2024-09-17T13:06:18Z

_overviews/toolkit/web-server-websockets.md

+In the `cask.WsHandler` we define a `cask.WsActor` which reacts to events (of `cask.util.Ws.Event` type) and uses
+WebSocket channel to send messages. In this example, we receive the name of a city and return the current time there. If server
+receives an empty message, the connection is closed.


Suggested change

In the `cask.WsHandler` we define a `cask.WsActor` which reacts to events (of `cask.util.Ws.Event` type) and uses

WebSocket channel to send messages. In this example, we receive the name of a city and return the current time there. If server

receives an empty message, the connection is closed.

In the `cask.WsHandler` we define a `cask.WsActor`. It reacts to events (of type `cask.util.Ws.Event`) and uses the

WebSocket channel to send messages. In this example, we receive the name of a city and return the current time there. If the server

receives an empty message, the connection is closed.

Add Cask tutorials

9760f28

sjrd requested changes Aug 13, 2024

View reviewed changes

Update

a837327

Fixes

7d388d5

sjrd reviewed Aug 27, 2024

View reviewed changes

gkepka added 2 commits August 29, 2024 11:04

Grammar corrections

48431b6

Fixes

569d5df

gkepka marked this pull request as ready for review September 9, 2024 09:17

sjrd requested changes Sep 17, 2024

View reviewed changes

Grammar fixes

4d4264f

sjrd approved these changes Oct 1, 2024

View reviewed changes

sjrd merged commit 02c00cc into scala:main Oct 1, 2024
1 check passed

fResult pushed a commit to fResult/docs.scala-lang that referenced this pull request Oct 27, 2024

Add Cask tutorials (scala#3056)

48366e7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Cask tutorials #3056

Add Cask tutorials #3056

gkepka commented Aug 12, 2024 •

edited

Loading

sjrd commented Aug 13, 2024

sjrd left a comment

sjrd Aug 13, 2024

gkepka Aug 26, 2024

gkepka commented Aug 26, 2024

sjrd left a comment

sjrd Aug 27, 2024

sjrd left a comment

sjrd Sep 17, 2024

sjrd Sep 17, 2024

sjrd Sep 17, 2024

sjrd Sep 17, 2024

sjrd Sep 17, 2024

sjrd Sep 17, 2024

sjrd Sep 17, 2024

sjrd Sep 17, 2024

sjrd Sep 17, 2024

sjrd Sep 17, 2024

	title: How to serve a static file?
	title: A minimal Cask server

	You can declare dependency on Cask with `using` directive:
	You can declare a dependency on Cask with the following `using` directive:

	Cookies can be read either with a method parameter of `cask.Cookie` type or by accessing `cask.Request` directly.
	Cookies can be read either with a method parameter of `cask.Cookie` type or by accessing the `cask.Request` directly.

	`cask.RawDecorator` class and then used as annotations.
	the `cask.RawDecorator` class. They are then used as annotations.


		## Serving dynamically generated content

		You can create an endpoint returning dynamically generated content with `@cask.get` annotation.

	specified location, a 404 response with an error message will be returned instead.
	specified location, the server will return a 404 response with an error message.

	The `Example` object inherits from the `cask.MainRoutes` class, providing the main function that starts the server. The `initialize()`
	The `Example` object inherits from the `cask.MainRoutes` class. It provides the main function that starts the server. The `initialize()`

	resources directory. In general, you can use any nested location within the resources directory, for instance you could opt
	resources directory. In general, you can use any nested location within the resources directory. For instance, you could opt

Add Cask tutorials #3056

Add Cask tutorials #3056

Conversation

gkepka commented Aug 12, 2024 • edited Loading

sjrd commented Aug 13, 2024

sjrd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gkepka commented Aug 26, 2024

sjrd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sjrd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gkepka commented Aug 12, 2024 •

edited

Loading