pdftract/scripts/analyze_doc_coverage.sh
jedarden 246befd8d1 feat(pdftract-2m3gl): implement PHP SDK with Packagist publishing
- Add jedarden/pdftract Composer package (sdk/php/)
- Implement Client.php with proc_open subprocess execution
- Add PSR-3 LoggerInterface integration (defaults to NullLogger)
- Add 9 contract methods: extract, extractText, extractMarkdown, extractStream, search, getMetadata, hash, classify, verifyReceipt
- Add readonly model classes: Document, Page, Metadata, Fingerprint, Classification, Match, Receipt
- Add exception classes: PdftractException base + 8 subclasses
- Add PHPUnit conformance test suite
- Add phpunit.xml configuration
- Add composer.json with jedarden/pdftract package name
- Add .ci/argo-workflows/pdftract-php-publish.yaml (Packagist auto-discovery from git tags)

Also includes Ruby SDK scaffold from parallel workflow.

Closes pdftract-2m3gl
2026-06-01 10:27:03 -04:00

35 lines
1.4 KiB
Bash
Executable file

#!/bin/bash
# Analyze rustdoc coverage for pdftract-core
echo "Analyzing pdftract-core public API documentation coverage..."
echo "================================================================"
echo ""
# Count public items (functions, structs, enums, traits, type aliases, constants)
# Use rustdoc JSON output or simpler: grep for pub fn/pub struct/pub enum/pub trait/pub type/pub const
cd crates/pdftract-core/src
# Count public items
total_pub_items=$(grep -r "^pub " --include="*.rs" | grep -E "pub (fn|struct|enum|trait|type|const|static|mod)" | wc -l)
echo "Total public items found: $total_pub_items"
# Count items with doc comments (/// or //!)
# This is a rough estimate - we'd need a more sophisticated parser for exact counts
echo ""
echo "Note: This is a basic grep-based count. A precise analysis requires:"
echo "1. Rust AST parsing via rust-analyzer or syn crate"
echo "2. Checking for /// doc comments on each public item"
echo "3. Distinguishing between module-level and item-level docs"
echo ""
echo "Key modules to review:"
find . -name "*.rs" -type f | head -20 | while read f; do
count=$(grep "^pub " "$f" | grep -E "pub (fn|struct|enum|trait|type)" | wc -l)
if [ "$count" -gt 0 ]; then
echo " $f: $count public items"
fi
done
echo ""
echo "To get precise coverage with examples, run:"
echo "cargo doc -p pdftract-core --no-deps --all-features 2>&1 | grep -i 'missing.*doc'"