document and better automate code formatting

Author: fhackett

README.md

@@ -5,9 +5,9 @@ Follow these steps to setup and test the project:
 1. **Clone the Repository**  
    Clone this repository to your local machine:
 
-```bash
-git clone <https://github.com/DistCompiler/forja.git>
-```
+   ```bash
+   git clone <https://github.com/DistCompiler/forja.git>
+   ```
 
 2. **Install Scala CLI:**
    Install Scala CLI using the using this [link](https://scala-cli.virtuslab.org/install/)
@@ -17,19 +17,33 @@ git clone <https://github.com/DistCompiler/forja.git>
 4. **Verify Installation:**
    After installation, close and reopen your terminal, then verify Scala CLI is installed by running:
 
-```bash
-scala-cli version
-```
+   ```bash
+   scala-cli version
+   ```
 
 5. **Run Tests:**
    After veryifying installation, build and run the tests using:
 
-```bash
-scala-cli test .
-```
+   ```bash
+   scala-cli test .
+   ```
 
-6. **Debugging:**
-   Use the debug adapter for troubleshooting and debugging. Refer to the documentation for setup and usage instructions.
+6. **Source formatting:**
+   When contributing, make sure you've formatted your code.
+   This is checked by CI.
+
+   I recommend committing your work, then running the formatters to see the formatting diff.
+   You can then commit with `--amend` to replace your commit if you're happy with what the formatters did.
+
+   Run all the formatting scripts with:
+   ```bash
+   scala-cli run . --main-class scripts.rewrite_src_sc
+   ```
+
+   As a convenience, you can also use `./rewrite_src.sh`, which is a one line shell script that launches the above command.
+
+7. **Debugging:**
+   You can try to use the debug adapter for troubleshooting and debugging. Refer to the documentation for setup and usage instructions.
 
 # Forja Compiler Toolkit
 

project.scala

@@ -9,8 +9,8 @@
 //> using dependency com.lihaoyi::sourcecode:0.4.2
 //> using dependency com.lihaoyi::ujson::4.2.1
 //> using dependency dev.zio::izumi-reflect:3.0.2
-//> using dependency edu.berkeley.cs.jqf:jqf-fuzz:2.0
-//> using dependency edu.berkeley.cs.jqf:jqf-instrument:2.0
+//> using dependency edu.berkeley.cs.jqf:jqf-fuzz:2.1
+//> using dependency edu.berkeley.cs.jqf:jqf-instrument:2.1
 //> using dependency io.github.java-diff-utils:java-diff-utils:4.15
 //> using dependency org.typelevel::cats-core:2.13.0
 

rewrite_src.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+scala-cli run . --main-class scripts.rewrite_src_sc

scripts/rewrite_src.scala

@@ -0,0 +1,33 @@
+// Copyright 2024-2025 Forja Team
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package scripts
+
+@main
+def rewrite_src_sc(): Unit =
+  def cmd(parts: os.Shellable*): Unit =
+    println(s"$$ ${parts.flatten(using _._1).mkString(" ")}")
+    os.proc(parts*).call(cwd = os.pwd, stdout = os.Inherit, stderr = os.Inherit)
+
+  cmd(
+    "scala-cli",
+    "run",
+    ".",
+    "--main-class",
+    "scripts.update_license_sc",
+    "--",
+    "rewrite",
+  )
+  cmd("scala-cli", "fix", "--power", ".")
+  cmd("scala-cli", "format", ".")