rusty-pdfgrep 0.2.0

Grep through PDF files — a Rust port of Hans-Peter Deifel's `pdfgrep(1)` with lopdf-backed text extraction, regex + fancy-regex pluggable engines, --password retry for encrypted PDFs, GNU-grep-compatible color output, recursive walking with fnmatch include/exclude, and a typed library API.
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
# rusty-pdfgrep CI workflow.
#
# v0.2.0 (E011 Phase 10) expands the v0.1.0 pipeline with the portfolio-wide
# Cargo Features Convention 5-tier matrix per spec 00011 §Per-Port v0.2.0
# CI Matrix + FR-010..FR-014:
#
#   Tier 1 — test-default                (full DDR-003 cross-compile matrix)
#   Tier 2 — test-no-default             (Linux x86_64 only + dep-tree audit)
#   Tier 3 — test-<bundle>               (per preset, Linux only)
#   Tier 4 — check-leaf-<leaf>           (SKIPPED — zero leaves, see below)
#   Tier 5 — lint-convention             (vendored feature-lint, Linux only)
#
# rusty-pdfgrep is a tightly-coupled-capability port per spec 00011 §Scope
# Edge Cases — minimum-convention surface with zero carved leaves. Tier 4 is
# intentionally empty (no `check-leaf-<leaf>` jobs) because there are no
# leaves to check per docs/feature-layout.md §v0.2.0 Carved Leaves.
#
# v0.2.0 is a PURELY ADDITIVE release. All v0.1.x feature names and
# compositions are preserved verbatim; this CI matrix layers the new tiered
# coverage on top without removing any pre-existing gates.
#
# Pre-existing v0.1.0 gates (rustfmt, clippy, audit, MSRV, full cross-compile
# matrix, library-without-binary, publish-dry-run) are preserved unchanged.

name: CI

on:
  push:
    branches: [main]
    tags: ["v[0-9]+.[0-9]+.[0-9]+"]
  pull_request:
    branches: [main]

env:
  CARGO_TERM_COLOR: always
  RUST_BACKTRACE: 1
  # Pinned locale for byte-equality fixture assertions (see
  # tests/common/mod.rs::assert_pinned_env and fixtures/README.md). MUST
  # be inherited by every job that runs `cargo test`.
  LC_ALL: C.UTF-8

# Minimum permissions for the default GITHUB_TOKEN. `contents: read` is what
# `actions/checkout` needs to fetch the repo; declaring it explicitly avoids
# auth failures under restrictive org/repo workflow-permission defaults.
permissions:
  contents: read

jobs:
  fmt:
    name: rustfmt
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt
      - run: cargo fmt --all -- --check

  clippy:
    name: clippy (deny warnings)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          components: clippy
      - uses: Swatinem/rust-cache@v2
      - run: cargo clippy --all-targets --all-features -- -D warnings

  audit:
    name: cargo audit
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # Install a stable toolchain so any rustup-aware tool that runs outside
      # the workspace gets a workable Rust. We do NOT cd into the repo before
      # invoking cargo-audit so the repo's `rust-toolchain.toml` (1.85 pin)
      # doesn't engage during the install step.
      - uses: dtolnay/rust-toolchain@stable
      # Prebuilt cargo-audit binary — avoids compiling from source, which
      # would fail under 1.85 due to icu_*/home/time crates bumping MSRV
      # to 1.86+.
      - uses: taiki-e/install-action@v2
        with:
          tool: cargo-audit
      # cargo audit reads `.cargo/audit.toml` automatically; documented
      # ignores there (e.g., RUSTSEC-2026-0009 — transitive time-via-lopdf
      # blocked by 1.85 MSRV) carry through to this step. The explicit
      # `--ignore` flags belt-and-suspender that contract for runners that
      # might not pick up the config file.
      - run: cargo audit --ignore RUSTSEC-2026-0009
        env:
          # Force stable for this step in case `cargo` is wrapped by rustup
          # and detects the workspace's rust-toolchain.toml.
          RUSTUP_TOOLCHAIN: stable

  msrv:
    name: MSRV (1.85)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@1.85
      - uses: Swatinem/rust-cache@v2
      - run: cargo build --all-features
      - run: cargo test --all-features

  # -----------------------------------------------------------------------------
  # Tier 1 — test-default: full DDR-003 cross-compile matrix on `default`
  # features. `default = ["full"]` post-v0.2.0; for rusty-pdfgrep
  # (tightly-coupled-cap port) `full` resolves to `cli` alone, so the
  # kitchen-sink test covers the full documented surface and matches v0.1.x
  # default coverage byte-for-byte.
  # -----------------------------------------------------------------------------
  test-default:
    name: test-default ${{ matrix.target }}
    needs: [fmt, clippy]
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - { os: ubuntu-latest, target: x86_64-unknown-linux-gnu }
          - { os: ubuntu-latest, target: aarch64-unknown-linux-gnu, cross: true }
          - { os: macos-latest, target: x86_64-apple-darwin }
          - { os: macos-latest, target: aarch64-apple-darwin }
          - { os: windows-latest, target: x86_64-pc-windows-msvc }
    env:
      LC_ALL: C.UTF-8
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          targets: ${{ matrix.target }}
      # The workspace pins to 1.85 via rust-toolchain.toml. dtolnay added the
      # target to the stable channel, but cargo will switch to 1.85 when run
      # from the workspace — and 1.85 doesn't have the cross-compile target
      # installed. Add it explicitly here.
      - name: Add cross-compile target to 1.85 toolchain
        if: '!matrix.cross'
        run: rustup target add ${{ matrix.target }} --toolchain 1.85
        shell: bash
      - uses: Swatinem/rust-cache@v2
        with:
          key: ${{ matrix.target }}
      - name: Install cross
        if: matrix.cross
        run: cargo install cross --locked
      - name: Build
        run: |
          if [ "${{ matrix.cross }}" = "true" ]; then
            cross build --release --target ${{ matrix.target }} --all-features
          else
            cargo build --release --target ${{ matrix.target }} --all-features
          fi
        shell: bash
      - name: Test
        if: matrix.cross != true
        run: cargo test --release --target ${{ matrix.target }} --all-features
      - name: Library-without-binary build
        if: matrix.target == 'x86_64-unknown-linux-gnu'
        run: cargo build --no-default-features
      # SC-002 default-install smoke (Linux x86_64 only — the binary is the
      # same on every target). Runs the binary with documented kitchen-sink
      # flags and asserts no "feature not enabled" or "unknown option" errors.
      - name: Default install + capability smoke (SC-002)
        if: matrix.target == 'x86_64-unknown-linux-gnu' && matrix.cross != true
        run: |
          cargo install --path . --no-track --force --locked
          # Verify --help renders (covers clap wiring + binary).
          out=$(rusty-pdfgrep --help 2>&1 || true)
          if [ -z "$out" ]; then
            echo "::error::SC-002 smoke failed — empty --help output"
            exit 1
          fi
          # Verify --version reports a v0.2.x string.
          out=$(rusty-pdfgrep --version 2>&1 || true)
          if ! echo "$out" | grep -q "rusty-pdfgrep 0\."; then
            echo "::error::SC-002 smoke failed — --version did not report rusty-pdfgrep version"
            exit 1
          fi
          # Completions subcommand smoke.
          out=$(rusty-pdfgrep completions bash 2>&1 | head -5)
          if [ -z "$out" ]; then
            echo "::error::SC-002 smoke failed — empty completions output"
            exit 1
          fi
          echo "SC-002 default-install smoke: PASS"
        shell: bash

  # -----------------------------------------------------------------------------
  # Tier 2 — test-no-default: bare library on Linux x86_64. Verifies CLI-only
  # deps are absent from the library build (SC-001 evidence).
  # -----------------------------------------------------------------------------
  test-no-default:
    name: test-no-default (linux-x86_64)
    needs: [fmt, clippy]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
      - run: cargo build --no-default-features
      - run: cargo test --no-default-features --lib
      - name: Dep-tree audit (SC-001)
        run: |
          # Assert no CLI-only deps leak into the bare-library build.
          if cargo tree --no-default-features --prefix none --edges normal --no-dedupe \
              | grep -E '^(clap|clap_complete|anyhow|termcolor|anstyle|walkdir|globset)\b'; then
            echo "::error::CLI-only dep leaked into --no-default-features build"
            exit 1
          fi
          echo "SC-001 dep-tree audit: PASS"

  # -----------------------------------------------------------------------------
  # Tier 3 — test-<bundle>: one job per preset bundle. Linux x86_64 only.
  # rusty-pdfgrep declares 2 preset bundles per FR-007 (tightly-coupled-cap
  # minimum).
  # -----------------------------------------------------------------------------
  test-pdfgrep-classic:
    name: test-pdfgrep-classic (linux-x86_64)
    needs: [fmt, clippy]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
      - run: cargo build --no-default-features --features pdfgrep-classic
      - run: cargo test --no-default-features --features pdfgrep-classic --lib
      # SC-003 per-preset install + size check.
      - name: Per-preset install + size check (SC-003)
        run: |
          cargo install --path . --no-track --force --locked \
            --no-default-features --features pdfgrep-classic
          bundle_size=$(stat -c%s "$(which rusty-pdfgrep)")
          echo "pdfgrep-classic binary size: $bundle_size bytes"
          echo "$bundle_size" > /tmp/pdfgrep-classic-size.txt
          # Baseline sanity: assert the binary is not zero-sized.
          if [ "$bundle_size" -le "0" ]; then
            echo "::error::SC-003 preset install produced empty binary"
            exit 1
          fi
          echo "SC-003 pdfgrep-classic install: PASS"
        shell: bash

  test-pdfgrep-minimal:
    name: test-pdfgrep-minimal (linux-x86_64)
    needs: [fmt, clippy]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
      - run: cargo build --no-default-features --features pdfgrep-minimal
      - run: cargo test --no-default-features --features pdfgrep-minimal --lib
      # SC-003 per-preset install + size check.
      - name: Per-preset install + size check (SC-003)
        run: |
          cargo install --path . --no-track --force --locked \
            --no-default-features --features pdfgrep-minimal
          bundle_size=$(stat -c%s "$(which rusty-pdfgrep)")
          echo "pdfgrep-minimal binary size: $bundle_size bytes"
          if [ "$bundle_size" -le "0" ]; then
            echo "::error::SC-003 preset install produced empty binary"
            exit 1
          fi
          echo "SC-003 pdfgrep-minimal install: PASS"
        shell: bash

  # -----------------------------------------------------------------------------
  # Tier 4 — check-leaf-<leaf>: rusty-pdfgrep carves ZERO new leaves at v0.2.0
  # per docs/feature-layout.md §v0.2.0 Carved Leaves (tightly-coupled-capability
  # port per spec 00011 §Scope Edge Cases). This tier is intentionally empty —
  # no `check-leaf-<leaf>` jobs because there are no leaves to check.
  # The feature-lint script (Tier 5) verifies this absence is intentional
  # via FR-052 sub-rule 2 (the only declared `[features]` keys are the
  # four required umbrellas + the one preset bundle that is not also an
  # umbrella, none of which are leaves).
  # -----------------------------------------------------------------------------

  # -----------------------------------------------------------------------------
  # SC-004 — keep-list workaround smoke. Tightly-coupled-capability port has a
  # trivial keep-list (just `cli`), but the job exists to validate the
  # documented invocation path.
  # -----------------------------------------------------------------------------
  test-keeplist:
    name: test-keeplist (linux-x86_64)
    needs: [fmt, clippy]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
      - name: Install with explicit keep-list
        run: |
          cargo install --path . --no-track --force --locked \
            --no-default-features --features cli
          # Smoke the keep-list install: --help should render the full CLI.
          out=$(rusty-pdfgrep --help 2>&1 || true)
          if [ -z "$out" ]; then
            echo "::error::SC-004 keep-list install: --help produced no output"
            exit 1
          fi
          echo "SC-004 keep-list (--features cli) install: PASS"
        shell: bash

  # -----------------------------------------------------------------------------
  # Tier 5 — lint-convention: feature-lint script is vendored into the port
  # (tools/feature-lint/) so the CI does not depend on cross-repo checkout
  # of the (private) umbrella. Each port keeps its own copy in sync with
  # the umbrella source of truth.
  # -----------------------------------------------------------------------------
  lint-convention:
    name: lint-convention (linux-x86_64)
    needs: [fmt, clippy]
    runs-on: ubuntu-latest
    steps:
      - name: Checkout port
        uses: actions/checkout@v4

      - name: Run feature-lint
        env:
          UMBRELLA_PATH: ${{ github.workspace }}
          PORT_PATH: ${{ github.workspace }}
        run: bash tools/feature-lint/run.sh

  # -----------------------------------------------------------------------------
  # Convention-violation self-test (SC-007 evidence). Manually triggered;
  # creates a temp Cargo.toml without `pdfgrep-classic` and asserts the lint
  # script catches the violation. Spec 00011 T116.
  # -----------------------------------------------------------------------------
  convention-lint-self-test:
    name: convention-lint-self-test
    if: github.event_name == 'workflow_dispatch'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout port
        uses: actions/checkout@v4

      - name: Remove pdfgrep-classic umbrella from Cargo.toml
        run: |
          sed -i '/^pdfgrep-classic\s*=/d' Cargo.toml
          # Verify removal
          if grep -E '^pdfgrep-classic\s*=' Cargo.toml; then
            echo "::error::pdfgrep-classic removal failed"
            exit 1
          fi

      - name: Invoke feature-lint and expect non-zero exit
        env:
          UMBRELLA_PATH: ${{ github.workspace }}
          PORT_PATH: ${{ github.workspace }}
        run: |
          set +e
          bash tools/feature-lint/run.sh 2>stderr.log
          rc=$?
          set -e
          cat stderr.log
          if [ "$rc" = "0" ]; then
            echo "::error::feature-lint should have failed with exit 2 but returned 0"
            exit 1
          fi
          if ! grep -q "required umbrella 'pdfgrep-classic' missing" stderr.log; then
            echo "::error::expected diagnostic 'required umbrella pdfgrep-classic missing' not found"
            exit 1
          fi
          echo "convention-lint-self-test: PASS"

  # -----------------------------------------------------------------------------
  # Library-without-binary build (v0.1.x parity gate). Retained verbatim;
  # the Tier 2 test-no-default job covers a superset of this check, but
  # this job runs in parallel + isolation for the publish-dry-run gate.
  # -----------------------------------------------------------------------------
  library-no-default-features:
    name: library-without-binary
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
      - run: cargo build --no-default-features
      - run: cargo test --no-default-features --lib

  # -----------------------------------------------------------------------------
  # Publish-dry-run + final gate. Runs after every tier above.
  # -----------------------------------------------------------------------------
  publish-dry-run:
    name: cargo publish --dry-run
    needs:
      - fmt
      - clippy
      - audit
      - msrv
      - test-default
      - test-no-default
      - test-pdfgrep-classic
      - test-pdfgrep-minimal
      - test-keeplist
      - lint-convention
      - library-no-default-features
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - run: cargo publish --dry-run --all-features