Apply scalafmt

.github/workflows/test.yml

@@ -43,6 +43,9 @@ jobs:
           java-version: ${{ matrix.jvm }}
       - name: Cache Scala
         uses: coursier/cache-action@v5
+      - name: Check Formatting (Scala 2.12 only)
+        if: startsWith(matrix.scala, '2.12')
+        run: sbt ++${{ matrix.scala }} scalafmtCheckAll
       - name: Documentation (Scala 2.12 only)
         if: startsWith(matrix.scala, '2.12')
         run: sbt ++${{ matrix.scala }} docs/mdoc unidoc

.scalafmt.conf

@@ -0,0 +1,26 @@
+version = 2.6.4
+
+maxColumn = 120
+align = most
+continuationIndent.defnSite = 2
+assumeStandardLibraryStripMargin = true
+docstrings = ScalaDoc
+lineEndings = preserve
+includeCurlyBraceInSelectChains = false
+danglingParentheses = true
+
+align.tokens.add = [
+  {
+    code = ":"
+  }
+]
+
+newlines.alwaysBeforeCurlyBraceLambdaParams = false
+newlines.alwaysBeforeMultilineDef = false
+newlines.implicitParamListModifierForce = [before]
+
+verticalMultiline.atDefnSite = true
+
+optIn.annotationNewlines = true
+
+rewrite.rules = [SortImports, PreferCurlyFors, AvoidInfix]

build.sc

@@ -1,6 +1,7 @@
 import mill._
 import mill.scalalib._
 import mill.scalalib.publish._
+import mill.scalalib.scalafmt._
 import coursier.maven.MavenRepository
 import $ivy.`com.lihaoyi::mill-contrib-buildinfo:$MILL_VERSION`
 import mill.contrib.buildinfo.BuildInfo
@@ -29,7 +30,7 @@ def getTestVersion(dep: String, org: String = "edu.berkeley.cs") = {
 }
 
 // Since chisel contains submodule core and macros, a CommonModule is needed
-trait CommonModule extends CrossSbtModule with PublishModule {
+trait CommonModule extends CrossSbtModule with PublishModule with ScalafmtModule {
   def firrtlModule: Option[PublishModule] = None
 
   def firrtlIvyDeps = if (firrtlModule.isEmpty) Agg(

core/src/main/scala/chisel3/Annotation.scala

@@ -15,6 +15,7 @@ import firrtl.transforms.{DontTouchAnnotation, NoDedupAnnotation}
   * Defines a conversion to a corresponding FIRRTL Annotation
   */
 trait ChiselAnnotation {
+
   /** Conversion to FIRRTL Annotation */
   def toFirrtl: Annotation
 }
@@ -54,7 +55,7 @@ object annotate {
   *    m.io.out
   *  }
   *
-  *class AdderTester extends Module
+  * class AdderTester extends Module
   *  with ConstantPropagationTest {
   *  val io = IO(new Bundle {
   *    val a = Input(UInt(32.W))
@@ -73,12 +74,13 @@ object annotate {
   */
 
 object doNotDedup {
+
   /** Marks a module to be ignored in Dedup Transform in Firrtl
     *
     * @param module The module to be marked
     * @return Unmodified signal `module`
     */
-   def apply[T <: RawModule](module: T)(implicit compileOptions: CompileOptions): Unit = {
+  def apply[T <: RawModule](module: T)(implicit compileOptions: CompileOptions): Unit = {
     annotate(new ChiselAnnotation { def toFirrtl = NoDedupAnnotation(module.toNamed) })
   }
 }

core/src/main/scala/chisel3/Attach.scala

@@ -43,4 +43,3 @@ object attach {
     }
   }
 }
-