undoc 0.3.0

High-performance Microsoft Office document extraction to Markdown
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

name: CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

env:
  CARGO_TERM_COLOR: always
  # Run JavaScript actions on Node.js 24. Opt-in flag documented in
  # https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
  # Forced default on 2026-06-02; remove this line after that date.
  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true

jobs:
  version-check:
    name: Version Consistency
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Verify all package versions match
        shell: bash
        run: |
          # Extract version strings from the four canonical files listed in
          # CLAUDE.md's "Version Bump Checklist". CI fails fast when any are
          # out of sync — a full release can't ship mismatched versions.
          root=$(grep -m1 '^version = ' Cargo.toml | sed 's/.*"\(.*\)".*/\1/')
          cli=$(grep -m1 '^version = ' cli/Cargo.toml | sed 's/.*"\(.*\)".*/\1/')
          py=$(grep -m1 '^version = ' bindings/python/pyproject.toml | sed 's/.*"\(.*\)".*/\1/')
          cs=$(grep -oE '<Version>[^<]+</Version>' bindings/csharp/Undoc/Undoc.csproj | head -1 | sed 's/<[^>]*>//g')

          # Also verify cli/Cargo.toml's undoc dep points at the same version
          # so consumers of the published crate aren't broken.
          dep=$(grep -m1 'undoc = { version =' cli/Cargo.toml | sed 's/.*version = "\([^"]*\)".*/\1/')

          echo "Root Cargo.toml:                    $root"
          echo "cli/Cargo.toml:                     $cli"
          echo "bindings/python/pyproject.toml:     $py"
          echo "bindings/csharp/Undoc/Undoc.csproj: $cs"
          echo "cli -> undoc dep version:            $dep"

          fail=0
          for v in "$cli" "$py" "$cs" "$dep"; do
            if [ "$v" != "$root" ]; then
              fail=1
            fi
          done

          if [ $fail -eq 1 ]; then
            echo "::error::Version mismatch — update all four canonical files AND cli's undoc dep together per CLAUDE.md Version Bump Checklist."
            exit 1
          fi
          echo "All versions match: $root"

  test:
    name: Test
    needs: version-check
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
        rust: [stable]

    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: ${{ matrix.rust }}

      - name: Cache cargo
        uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            target/
          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cargo-

      - name: Build
        run: cargo build --release

      - name: Run tests
        run: cargo test

      - name: Build with FFI
        run: cargo build --release --features ffi

  lint:
    name: Lint
    needs: version-check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: stable
          components: rustfmt, clippy

      - name: Check formatting
        run: cargo fmt --all -- --check

      - name: Clippy
        run: cargo clippy -- -D warnings