Fix test suite and CI workflow issues

- Fix shellcheck warnings (use single quotes in trap, remove unused code)
- Format README.md with pandoc for consistency
- Update CI workflow to exclude test fixtures from pre-commit formatting
- Test fixtures must remain unformatted for test suite to work correctly
- All 25 tests now pass successfully

Co-authored-by: Amp <[email protected]>
Amp-Thread-ID: https://ampcode.com/threads/T-a4b3b491-de29-4cf7-a459-f324a9c0c53b

Author: jupblb

.github/workflows/test.yml

@@ -27,9 +27,18 @@ jobs:
     - name: Test with pre-commit
       run: |
         pip install pre-commit
-        pre-commit run --all-files || true
+        # Create a test configuration that excludes test fixtures
+        cat > .pre-commit-test-config.yaml << 'EOF'
+        repos:
+          - repo: .
+            rev: HEAD
+            hooks:
+              - id: pandoc
+                exclude: ^tests/fixtures/
+        EOF
+        pre-commit run --config .pre-commit-test-config.yaml --all-files || true
         # Run again to ensure idempotency
-        pre-commit run --all-files
+        pre-commit run --config .pre-commit-test-config.yaml --all-files
 
   lint:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -4,5 +4,6 @@ repos:
     rev: HEAD
     hooks:
       - id: pandoc
+        exclude: ^tests/fixtures/
         # Optional: customize formatting options
         # args: [--columns=100, --no-reference-links, --from=markdown, --to=markdown]

README.md

@@ -1,6 +1,6 @@
 # pre-commit-pandoc
 
-[![Test](https://github.com/jupblb/pre-commit-pandoc/actions/workflows/test.yml/badge.svg)](https://github.com/jupblb/pre-commit-pandoc/actions/workflows/test.yml)
+[![Test]][1]
 
 A [pre-commit] hook for formatting Markdown files using [pandoc].
 
@@ -16,7 +16,7 @@ This hook formats Markdown files with pandoc using the following settings:
 ## Prerequisites
 
 - [pre-commit] installed
-- [pandoc][1] installed
+- [pandoc][2] installed
 
 ## Installation
 
@@ -82,8 +82,8 @@ repos:
 - `--to <format>` - Set output format (default: gfm)
 
 Common format values include: `gfm` (GitHub Flavored Markdown), `markdown`,
-`markdown_strict`, `commonmark`. See [pandoc documentation][2] for all
-supported formats.
+`markdown_strict`, `commonmark`. See [pandoc documentation] for all supported
+formats.
 
 ## How it Works
 
@@ -102,7 +102,9 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 
 MIT License - see LICENSE file for details.
 
+  [Test]: https://github.com/jupblb/pre-commit-pandoc/actions/workflows/test.yml/badge.svg
+  [1]: https://github.com/jupblb/pre-commit-pandoc/actions/workflows/test.yml
   [pre-commit]: https://pre-commit.com
   [pandoc]: https://pandoc.org/
-  [1]: https://pandoc.org/installing.html
-  [2]: https://pandoc.org/MANUAL.html#general-options
+  [2]: https://pandoc.org/installing.html
+  [pandoc documentation]: https://pandoc.org/MANUAL.html#general-options

flake.nix

@@ -10,7 +10,7 @@
         pkgs = (import nixpkgs) { inherit system; };
       in {
         devShell = pkgs.mkShell {
-          buildInputs = with pkgs; [ pandoc pre-commit ];
+          buildInputs = with pkgs; [ pandoc pre-commit shellcheck ];
         };
       }
     );

tests/test_pandoc_format.sh

@@ -22,7 +22,7 @@ PANDOC_FORMAT="$PROJECT_ROOT/pandoc-format"
 
 # Temporary directory for test files
 TEST_TEMP_DIR=$(mktemp -d)
-trap "rm -rf $TEST_TEMP_DIR" EXIT
+trap 'rm -rf "$TEST_TEMP_DIR"' EXIT
 
 # Helper functions
 print_test_header() {
@@ -55,24 +55,6 @@ assert_exit_code() {
     fi
 }
 
-assert_file_changed() {
-    local file1=$1
-    local file2=$2
-    local test_name=$3
-    
-    TESTS_RUN=$((TESTS_RUN + 1))
-    
-    if ! cmp -s "$file1" "$file2"; then
-        print_success "$test_name: file was changed as expected"
-        TESTS_PASSED=$((TESTS_PASSED + 1))
-        return 0
-    else
-        print_failure "$test_name: file was not changed"
-        TESTS_FAILED=$((TESTS_FAILED + 1))
-        return 1
-    fi
-}
-
 assert_file_unchanged() {
     local file1=$1
     local file2=$2
@@ -141,7 +123,6 @@ test_basic_formatting() {
     print_test_header "Basic formatting with defaults"
 
     cp "$SCRIPT_DIR/fixtures/simple.md" "$TEST_TEMP_DIR/test1.md"
-    local original="$TEST_TEMP_DIR/test1.md"
 
     # Run pandoc-format
     set +e
@@ -156,7 +137,8 @@ test_basic_formatting() {
     assert_contains "$TEST_TEMP_DIR/test1.md" "\[inline link\]:" "Reference links"
 
     # Check line wrapping (approximate check for 80 columns)
-    local long_lines=$(awk 'length > 85' "$TEST_TEMP_DIR/test1.md" | wc -l)
+    local long_lines
+    long_lines=$(awk 'length > 85' "$TEST_TEMP_DIR/test1.md" | wc -l)
     TESTS_RUN=$((TESTS_RUN + 1))
     if [ "$long_lines" -eq 0 ]; then
         print_success "Lines wrapped at ~80 columns"
@@ -182,7 +164,8 @@ test_custom_columns() {
     assert_exit_code 1 $exit_code "Custom columns formatting"
 
     # Check line wrapping (approximate check for 60 columns)
-    local long_lines=$(awk 'length > 65' "$TEST_TEMP_DIR/test2.md" | wc -l)
+    local long_lines
+    long_lines=$(awk 'length > 65' "$TEST_TEMP_DIR/test2.md" | wc -l)
     TESTS_RUN=$((TESTS_RUN + 1))
     if [ "$long_lines" -eq 0 ]; then
         print_success "Lines wrapped at ~60 columns"