Merge pull request #1872 from o1-labs/dw/sed-macos-gnu

Makefile: enforce GNU sed on macOS

Author: dannywillems

.github/workflows/whitespace-check.yaml

@@ -16,3 +16,37 @@ jobs:
 
       - name: Check for trailing whitespaces
         run: make check-trailing-whitespace
+
+  test-fix-whitespace:
+    timeout-minutes: 5
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Install GNU sed (macOS)
+        if: runner.os == 'macOS'
+        run: ./website/docs/developers/scripts/setup/install-gnu-sed-macos.sh
+
+      - name: Create test file with trailing whitespace
+        run: printf 'line with trailing spaces   \nclean line\n' > test-whitespace.md
+
+      - name: Run fix-trailing-whitespace
+        run: make fix-trailing-whitespace
+
+      - name: Verify trailing whitespace was removed
+        run: |
+          if grep -q '[[:space:]]$' test-whitespace.md; then
+            echo "ERROR: Trailing whitespace was not removed"
+            cat -vet test-whitespace.md
+            exit 1
+          else
+            echo "Trailing whitespace successfully removed"
+            cat -vet test-whitespace.md
+          fi
+
+      - name: Clean up test file
+        run: rm -f test-whitespace.md

CHANGELOG.md

@@ -25,6 +25,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - **Dependencies**: vendor redux-rs into `vendor/redux` to centralize all code
   in the monorepo ([#1814](https://github.com/o1-labs/mina-rust/pull/1814))
+- **Build System**: enforce GNU sed on macOS, require `brew install gnu-sed`
+  for `make fix-trailing-whitespace`, add CI test for cross-platform support,
+  fix [#1864](https://github.com/o1-labs/mina-rust/issues/1864)
+  ([#1872](https://github.com/o1-labs/mina-rust/pull/1872))
 - **Dependency**: use tag instead of references of o1-labs/proof-systems, fix
   [[#1674](https://github.com/o1-labs/mina-rust/issues/1674)]
   ([#1673](https://github.com/o1-labs/mina-rust/pull/1673))

CLAUDE.md

@@ -424,10 +424,5 @@ When modifying CI workflows, especially for performance improvements:
 - **MANDATORY**: Run `make fix-trailing-whitespace` before every commit
 - **MANDATORY**: Run `make check-trailing-whitespace` to verify no trailing
   whitespaces remain
-- **macOS only**: After running `make fix-trailing-whitespace` or
-  `make format-md`, run these commands to clean up backup files created by sed:
-  ```bash
-  git clean -f -- '*-e' && git clean -f -- '**/*-e'
-  ```
 - This applies to ALL file modifications, regardless of file type
 - Trailing whitespaces are strictly prohibited in the codebase

Makefile

@@ -42,6 +42,17 @@ CIRCUITS_REPO ?= https://github.com/o1-labs/circuit-blobs.git
 CIRCUITS_REV ?= main
 CIRCUITS_NETWORKS ?= 3.0.0mainnet berkeley-devnet
 
+# Detect GNU sed (macOS requires gsed from Homebrew gnu-sed)
+UNAME_S := $(shell uname -s)
+ifeq ($(UNAME_S),Darwin)
+    SED := $(shell command -v gsed 2>/dev/null)
+    ifeq ($(SED),)
+        $(error GNU sed (gsed) not found on macOS. Install with: brew install gnu-sed)
+    endif
+else
+    SED := sed
+endif
+
 # Documentation server port
 DOCS_PORT ?= 3000
 
@@ -179,14 +190,16 @@ fix-trailing-whitespace: ## Remove trailing whitespaces from all files
 		-o -name "*.js" -o -name "*.jsx" -o -name "*.sh" \) \
 		-not -path "./target/*" \
 		-not -path "./node_modules/*" \
+		-not -path "./frontend/.angular/*" \
 		-not -path "./frontend/node_modules/*" \
 		-not -path "./frontend/dist/*" \
+		-not -path "./pkg/*" \
 		-not -path "./website/node_modules/*" \
 		-not -path "./website/build/*" \
 		-not -path "./website/static/api-docs/*" \
 		-not -path "./website/.docusaurus/*" \
 		-not -path "./.git/*" \
-		-exec sh -c 'echo "Processing: $$1"; sed -i'\'''\'' -e "s/[[:space:]]*$$//" "$$1"' _ {} \; && \
+		-exec sh -c 'echo "Processing: $$1"; $(SED) -i -e "s/[[:space:]]*$$//" "$$1"' _ {} \; && \
 		echo "Trailing whitespaces removed."
 
 .PHONY: check-trailing-whitespace
@@ -198,8 +211,10 @@ check-trailing-whitespace: ## Check for trailing whitespaces in source files
 		-o -name "*.js" -o -name "*.jsx" -o -name "*.sh" \) \
 		-not -path "./target/*" \
 		-not -path "./node_modules/*" \
+		-not -path "./frontend/.angular/*" \
 		-not -path "./frontend/node_modules/*" \
 		-not -path "./frontend/dist/*" \
+		-not -path "./pkg/*" \
 		-not -path "./website/node_modules/*" \
 		-not -path "./website/build/*" \
 		-not -path "./website/static/api-docs/*" \

website/docs/developers/getting-started.mdx

@@ -10,6 +10,7 @@ import TabItem from "@theme/TabItem";
 import InstallRustSh from "!!raw-loader!./scripts/setup/install-rust.sh";
 import InstallSystemDepsSh from "!!raw-loader!./scripts/setup/install-system-deps.sh";
 import InstallSystemDepsMacOSSh from "!!raw-loader!./scripts/setup/install-system-deps-macos.sh";
+import InstallGnuSedMacOSSh from "!!raw-loader!./scripts/setup/install-gnu-sed-macos.sh";
 
 import InstallDockerSh from "!!raw-loader!./scripts/setup/install-docker.sh";
 import InstallDockerMacOSSh from "!!raw-loader!./scripts/setup/install-docker-macos.sh";
@@ -142,6 +143,21 @@ The Mina Rust Node maintains strict code quality standards:
 
 <CodeBlock language="bash">{FormatAndLintSh}</CodeBlock>
 
+<!-- prettier-ignore-start -->
+
+:::note macOS users
+
+The `make fix-trailing-whitespace` command requires GNU sed. Install it with
+Homebrew:
+
+<CodeBlock language="bash">{InstallGnuSedMacOSSh}</CodeBlock>
+
+The Makefile will automatically use `gsed` on macOS when available.
+
+:::
+
+<!-- prettier-ignore-stop -->
+
 ### Working with Makefiles
 
 The project's Makefile provides many helpful commands. View all available

website/docs/developers/scripts/setup/install-gnu-sed-macos.sh

@@ -0,0 +1 @@
+brew install gnu-sed