verify-docs-swift

To verify Swift code examples in YAML files, you can generate a dedicated test suite that extracts swift blocks and compiles them using xcodebuild to ensure correctness. This process automates validation by creating a DocsExamplesCompileTest.swift file from your docs-db entries.

The best way to automate testing for Swift code samples in docs-db YAML is running a Python script to extract code blocks and generate a compilable test file. You then build the DemoApp2 target with xcodebuild to validate every example.

Yes, the automated Swift docs compilation test specifically targets the DemoApp2 Swift test build using xcodebuild. It relies on a Python script to handle top-level Task wrappers and BGGeo imports during the extraction process.

To generate a compile test for Swift documentation blocks, run scripts/generate_docs_compile_test_swift.py to extract swift blocks from YAML files. This creates DocsExamplesCompileTest.swift, which you then build to verify all code samples.

A key limitation of validating Swift code blocks with automated test generation is that it specifically handles top-level Task wrappers and BGGeo imports. It applies only to docs-db YAML entries and requires building the DemoApp2 target.