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

chore: mention the faster code fmt approach #1022

Merged
merged 5 commits into from
Jan 23, 2024
Merged

chore: mention the faster code fmt approach #1022

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ad60157
chore: mention the faster code fmt approach
Roiocam Jan 22, 2024
7b65215
chore: Add Coursier cli for formatting
He-Pin Jan 22, 2024
28e06a9
chore: Remove the scalafmt version.
He-Pin Jan 22, 2024
fcc3317
chore: Add notes about install scalafmt with cs.
He-Pin Jan 22, 2024
898cab6
chore: mention binaries built
Roiocam Jan 23, 2024
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
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,18 @@ sbt
applyCodeStyle
```

To format Scala code more faster, you could format code with [Scala-CLI](https://scala-cli.virtuslab.org/) or [Coursier CLI](https://scalameta.org/scalafmt/docs/installation.html#cli):

**With Scala-Cli**
```shell
scala-cli fmt
```
**With Coursier CLI**
```Shell
cs install scalafmt // skip it if scalafmt is already installed. If you are a macOS or Linux user, you can simply download the native binaries from the Coursier CLI installation page.
scalafmt
```

#### Do not use `-optimize` Scala compiler flag

Pekko has not been compiled or tested with `-optimize` Scala compiler flag. (In sbt, you can specify compiler options in the `scalacOptions` key.)
Expand Down
Loading