Skip to content

Change installing munit to reflect changes in scala-cli #2811

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 27, 2023
Merged

Change installing munit to reflect changes in scala-cli #2811

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd2fd31
Change installing munit to reflect changes in scala-cli
szymon-rd May 24, 2023
314c1dc
Adjust directives syntax
szymon-rd May 24, 2023
5d8a3dd
script -> source
szymon-rd May 24, 2023
33562cc
Fix wording
szymon-rd May 25, 2023
c622332
Update _includes/_markdown/install-munit.md
adpi2 May 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions _includes/_markdown/install-munit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,17 @@
{% tab 'Scala CLI' %}
You can require the entire toolkit in a single line:
```scala
//> using dep "org.scala-lang::toolkit-test:0.1.7"
//> using toolkit latest
```
**However, MUnit won't be available in your source right away.**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That message sounds scary, I think it would be better to only give a note that the dependency will be available in test files only, which are files within a test directory or that have the .test.scala extension.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something along the way:

MUnit being a testing framework, it is only available in test files: files in a `test` directory or that have the `.test.scala` extension. Refer to the [Scala CLI documentation]() to learn more about the test scope.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I fixed it.

MUnit will be available in the test scope sources only.
To write a source file in the test scope, you can either put it in a `test` directory,
or change its name to end with `.test.scala`. You can also use a dedicated directive to set the scope of your file.
Learn more in the [Scala CLI documentation on tests](https://scala-cli.virtuslab.org/docs/commands/test/).

Alternatively, you can require just a specific version of MUnit:
```scala
//> using dep "org.scalameta::munit:1.0.0-M7"
//> using dep org.scalameta::munit:1.0.0-M7
```
{% endtab %}
{% tab 'sbt' %}
Expand Down
4 changes: 2 additions & 2 deletions _includes/_markdown/install-os-lib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
{% tab 'Scala CLI' %}
You can require the entire toolkit in a single line:
```scala
//> using toolkit "latest"
//> using toolkit latest
```

Alternatively, you can require just a specific version of OS-Lib:
```scala
//> using dep "com.lihaoyi::os-lib:0.9.1"
//> using dep com.lihaoyi::os-lib:0.9.1
```
{% endtab %}
{% tab 'sbt' %}
Expand Down
4 changes: 2 additions & 2 deletions _includes/_markdown/install-sttp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
{% tab 'Scala CLI' %}
You can require the entire toolkit in a single line:
```scala
//> using toolkit "latest"
//> using toolkit latest
```

Alternatively, you can require just a specific version of sttp:
```scala
//> using dep "com.softwaremill.sttp.client4::core:4.0.0-M1"
//> using dep com.softwaremill.sttp.client4::core:4.0.0-M1
```
{% endtab %}
{% tab 'sbt' %}
Expand Down
4 changes: 2 additions & 2 deletions _includes/_markdown/install-upickle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
{% tab 'Scala CLI' %}
Using Scala CLI, you can require the entire toolkit in a single line:
```scala
//> using toolkit "latest"
//> using toolkit latest
```

Alternatively, you can require just a specific version of UPickle:
```scala
//> using dep "com.lihaoyi::upickle:3.1.0
//> using dep com.lihaoyi::upickle:3.1.0
```
{% endtab %}
{% tab 'sbt' %}
Expand Down