Add Biome formatter support for JavaScript files (#2913)

* Replace Prettier with Biome: update Makefile, CI, config and docs

Remove Prettier reference from AGENTS.md

* build: edit biome config, a few cleanups

---------

Co-authored-by: YashVardhan2496 <23bch048@nith.ac.in>
Co-authored-by: Morten Piibeleht <morten.piibeleht@juliahub.com>

Author: 3 people

.github/workflows/CI.yml

@@ -307,14 +307,16 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-  prettier:
-    name: Prettier (JS code formatting)
+  biome:
+    name: Biome (JS code formatting)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
-      - uses: actionsx/prettier@v3
+      - uses: julia-actions/setup-julia@v2
         with:
-          args: --check .
+          version: '1'
+      - run: make install-biome
+      - run: make format-js
 
   runic:
     name: "Runic (Julia code formatting)"

AGENTS.md

@@ -14,7 +14,6 @@ generic defaults:
 
 * for Julia code, use the Runic-based workflow described there
   (for example `make format-julia`);
-* for JS, HTML, and (S)CSS, follow the Prettier guidance described there;
 * for Markdown, follow the Markdown conventions described there and do not
   introduce hard-wrapping or ad hoc list formatting.
 

Makefile

@@ -1,5 +1,6 @@
 JULIA:=julia
 RUNIC:=@runic
+BIOME:=@biome
 
 default: help
 
@@ -29,6 +30,12 @@ format-julia:
 install-runic:
 	julia --project=$(RUNIC) -e 'using Pkg; Pkg.add("Runic")'
 
+format-js:
+	julia --project=$(BIOME) -e 'using biome_jll; run(`$$(biome_jll.biome()) check --write`)'
+
+install-biome:
+	julia --project=$(BIOME) -e 'using Pkg; Pkg.add(; name="biome_jll", version="2.4.8")'
+
 test:
 	${JULIA} --project -e 'using Pkg; Pkg.test()'
 
@@ -66,9 +73,11 @@ help:
 	@echo " - make docs-instantiate: instantiate the docs/ Julia environment"
 	@echo " - make format-julia: formats the Julia source code with Runic"
 	@echo " - make install-runic: installs Runic.jl into the @runic shared Julia environment (for make format)"
+	@echo " - make format-js: formats the JS source code with Biome"
+	@echo " - make install-biome: installs biome_jll into the @biome shared Julia environment"
 	@echo " - make test: run the tests"
 	@echo " - make search-benchmarks: run search functionality benchmarks"
 	@echo " - make themes: compile Documenter's native CSS themes"
 	@echo " - make clean: remove generated files"
 
-.PHONY: default docs-instantiate themes help changelog docs test format-julia install-runic search-benchmarks
+.PHONY: default docs-instantiate themes help changelog docs test format-julia install-runic format-js install-biome search-benchmarks

biome.jsonc

@@ -0,0 +1,26 @@
+{
+  // The biome JLL runs into:
+  // > The configuration schema version does not match the CLI version 0.0.1
+  // "$schema": "https://biomejs.dev/schemas/2.4.8/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": false,
+    "includes": [
+      "biome.jsonc",
+      "assets/html/**",
+      "!!assets/html/themes",
+      "!!assets/html/scss/highlightjs"
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space"
+  },
+  "linter": {
+    "enabled": false
+  }
+}

docs/src/contributing.md

@@ -51,7 +51,7 @@ If the formatter fails to run because it can not load Runic, you can install it
 
 ### JS, HTML and (S)CSS
 
-We use [Prettier](https://github.com/prettier/prettier) v2 for formatting the HTML/web front end related code.
+We use [Biome](https://biomejs.dev) for formatting the JavaScript source code. You can run it with `make format-js` (install with `make install-biome`).
 
 ### Markdown