Skip to content

Add fatal warnings example to the README #205

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add fatal warnings example to the README #205

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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,17 @@ ScalacOptions.defaultOptionsForVersion(

The following are simple examples of use in sbt and Mill. Note that they are not complete project definitions.

### Modifying options: Fatal warnings example

A common requirement is use a modified version of the default settings. In this example, we are going to enable fatal warnings.

```scala
ScalacOptions.tokensForVersion(
ScalaVersion.V3_1_0,
ScalacOptions.default ++ ScalacOptions.fatalWarningOptions
)
```

### sbt example

Add the following dependency to an `sbt` file within the project directory, for instance `project/plugins`:
Expand Down