Skip to content
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

Documentation updates #769

Merged
merged 1 commit into from
Apr 21, 2024
Merged

Documentation updates #769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 21 additions & 6 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,26 @@ object test extends Tests with TestModule.Munit {
}
```

| Scala Version | JVM | Scala.js (0.6.x) | Scala.js (1.x) | Native (0.4.x) |
| ------------- | :-: | :--------------: | :------------: | :------------: |
| 2.11.x | ✅ | ✅ until 0.7.16 | ✅ | ✅ |
| 2.12.x | ✅ | ✅ until 0.7.16 | ✅ | ✅ |
| 2.13.x | ✅ | ✅ until 0.7.16 | ✅ | ✅ |
| 3.0.x | ✅ | n/a | ✅ | n/a |
**Maven**

```xml
<dependency>
<groupId>org.scalameta</groupId>
<artifactId>munit_3</artifactId>
<version>@STABLE_VERSION@</version>
<scope>test</scope>
</dependency>
```
The complete setup can be seen in a Maven g8 template [scalameta/maven-scala-seed.g8](https://github.com/scalameta/maven-scala-seed.g8)

### Supported Platforms

| Scala Version | JVM | Scala.js (0.6.x) | Scala.js (1.x) | Native (0.4.x) | Native (0.5.x) |
|---------------| :-: | :--------------: | :------------: | :------------: | :------------: |
| 2.11.x | ✅ | ✅ until 0.7.16 | ✅ | ✅ | n/a |
| 2.12.x | ✅ | ✅ until 0.7.16 | ✅ | ✅ | ✅ |
| 2.13.x | ✅ | ✅ until 0.7.16 | ✅ | ✅ | ✅ |
| 3.x | ✅ | n/a | ✅ | n/a | ✅ |

Next, write a test suite.

Expand Down Expand Up @@ -84,6 +98,7 @@ Use `testOnly` to run only a single test suite in the sbt shell.
### Run tests in IntelliJ

MUnit test suites can be executed from in IntelliJ like normal test suites.
Please ensure that the JUnit plugin is enabled.

![Running MUnit from IntelliJ](https://i.imgur.com/oAA2ZeQ.png)

Expand Down
1 change: 1 addition & 0 deletions docs/integrations/external-integrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Feel free to add your project to this list by submitting a pull request
- [discipline-munit](https://github.com/typelevel/discipline-munit): MUnit binding for Typelevel Discipline
- [http4s-munit](https://github.com/alejandrohdezma/http4s-munit): Integration library between MUnit and http4s
- [munit-cats-effect](https://github.com/typelevel/munit-cats-effect): Integration library for MUnit & cats-effect
- [munit-scalacheck](https://github.com/scalameta/munit-scalacheck): Scalacheck integration for MUnit
- [munit-snapshot](https://github.com/lolgab/munit-snapshot): Snapshot testing for MUnit
- [munit-zio](https://github.com/poslegm/munit-zio): MUnit and ZIO integration
- [pact4s](https://github.com/jbwheatley/pact4s): Consumer driven contract testing
Expand Down
2 changes: 1 addition & 1 deletion docs/tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ class CustomTimeoutSuite extends munit.FunSuite {
```

> Note that `munitTimeout` is only respected for async tests in the stable
> version version of MUnit (v0.x series). The setting is ignored by normal
> version of MUnit (v0.x series). The setting is ignored by normal
> non-async tests. However, starting with MUnit v1.0 (latest milestone release:
> @VERSION@), the timeout applies to all tests including non-async tests.

Expand Down