raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

chore: mention the faster code fmt approach (#1022)

Browse source 
* chore: mention the faster code fmt approach

* chore: Add Coursier cli for formatting

* chore: Remove the scalafmt version.

* chore: Add notes about install scalafmt with cs.

* chore: mention binaries built

---------

Co-authored-by: He-Pin(kerr) <hepin1989@gmail.com>
This commit is contained in:
AndyChen 2024-01-23 11:05:52 +08:00 • committed by GitHub
parent d282d5e153
commit 7ffcf5b76d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -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.)