From 7ffcf5b76d09e7e35ae29c2ae8e3ef0378a04dce Mon Sep 17 00:00:00 2001 From: AndyChen Date: Tue, 23 Jan 2024 11:05:52 +0800 Subject: [PATCH] chore: mention the faster code fmt approach (#1022) * 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) --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0e2e4a422f9..dbf52b8075b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.)