From ae0601281b2d81d3d824c5179b553aa4b5e8668e Mon Sep 17 00:00:00 2001 From: Matthew Raymer Date: Wed, 20 Aug 2025 13:00:16 +0000 Subject: [PATCH] feat: add markdown validation and auto-fix scripts - Create validate-markdown.sh for compliance checking - Add fix-markdown.sh for automatic formatting fixes - Exclude node_modules from validation scope - Integrate with npm scripts for easy usage --- scripts/fix-markdown.sh | 19 +++++++++++++++++++ scripts/validate-markdown.sh | 19 +++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100755 scripts/fix-markdown.sh create mode 100755 scripts/validate-markdown.sh diff --git a/scripts/fix-markdown.sh b/scripts/fix-markdown.sh new file mode 100755 index 00000000..b2a21f6d --- /dev/null +++ b/scripts/fix-markdown.sh @@ -0,0 +1,19 @@ +#!/usr/bin/env bash +set -euo pipefail + +echo "🔧 Auto-fixing markdown formatting..." + +# Check if markdownlint is available +if ! command -v npx &> /dev/null; then + echo "❌ npx not found. Please install Node.js and npm first." + exit 1 +fi + +# Run markdownlint with auto-fix on project markdown files (exclude node_modules) +echo "📝 Fixing project markdown files..." +npx markdownlint "*.md" "*.mdc" "scripts/**/*.md" "src/**/*.md" "test-playwright/**/*.md" "resources/**/*.md" --config .markdownlint.json --fix 2>/dev/null || { + echo "⚠️ Some issues could not be auto-fixed. Check manually." +} + +echo "✅ Markdown auto-fix complete!" +echo "💡 Run 'npm run markdown:check' to verify all issues are resolved." diff --git a/scripts/validate-markdown.sh b/scripts/validate-markdown.sh new file mode 100755 index 00000000..f54f9dee --- /dev/null +++ b/scripts/validate-markdown.sh @@ -0,0 +1,19 @@ +#!/usr/bin/env bash +set -euo pipefail + +echo "🔍 Validating markdown formatting..." + +# Check if markdownlint is available +if ! command -v npx &> /dev/null; then + echo "❌ npx not found. Please install Node.js and npm first." + exit 1 +fi + +# Run markdownlint on project markdown files (exclude node_modules) +echo "📝 Checking project markdown files..." +npx markdownlint "*.md" "*.mdc" "scripts/**/*.md" "src/**/*.md" "test-playwright/**/*.md" "resources/**/*.md" --config .markdownlint.json 2>/dev/null || { + echo "❌ Markdown validation failed. Run 'npm run markdown:fix' to auto-fix issues." + exit 1 +} + +echo "✅ All markdown files pass validation!"