Autoformat README.md

Author: calda

.github/workflows/main.yml

@@ -41,6 +41,18 @@ jobs:
       - name: Run Unit Tests
         run: swift test
 
+  lint-markdown:
+    name: Lint Markdown
+    runs-on: macos-15
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - uses: actions/setup-node@v4
+      - name: Lint README.md
+        run: bundle exec rake lint:markdown
+
   site-build:
     name: Build Site
     runs-on: macos-15

Rakefile

@@ -8,13 +8,52 @@ namespace :lint do
   task :swift do
     sh 'swift package --allow-writing-to-package-directory format --lint'
   end
+
+  desc 'Lints README.md'
+  task :markdown do
+    unless system('which npx > /dev/null 2>&1')
+      puts "Error: npx is not installed. Please run: brew install node"
+      exit 1
+    end
+
+    readme_path = 'README.md'
+    check_result = system('npx --yes prettier --check README.md')
+
+    unless check_result
+      puts ""
+      puts "README.md has unformatted changes."
+      puts "Please run `bundle exec rake format:markdown` and commit the result."
+      exit 1
+    end
+  end
 end
 
 namespace :format do
   desc 'Formats swift files'
   task :swift do
     sh 'swift package --allow-writing-to-package-directory format'
   end
+
+  desc 'Formats README.md'
+  task :markdown do
+    unless system('which npx > /dev/null 2>&1')
+      puts "Error: npx is not installed. Please run: brew install node"
+      exit 1
+    end
+
+    readme_path = 'README.md'
+
+    # Check if there would be changes by running prettier in check mode
+    check_result = system('npx --yes prettier --check README.md > /dev/null 2>&1')
+
+    if check_result
+      puts "No changes"
+    else
+      # Format the file
+      sh 'npx --yes prettier --write README.md'
+      puts "Formatted README.md"
+    end
+  end
 end
 
 namespace :update do