Skip to content

Sync unified docs with in-process swift-syntax-rs parsing (post-#22290) - #22294

Open
jketema with Copilot wants to merge 2 commits into
mainfrom
copilot/update-md-files-for-unified-extractor
Open

Sync unified docs with in-process swift-syntax-rs parsing (post-#22290)#22294
jketema with Copilot wants to merge 2 commits into
mainfrom
copilot/update-md-files-for-unified-extractor

Conversation

Copilot AI commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

PR #22290 dropped the separate swift-syntax-parse binary in favor of calling swift_syntax_rs::parse_to_json in-process, but explicitly left the .md docs unupdated. unified/AGENTS.md and unified/swift-syntax-rs/README.md still described the old out-of-process binary workflow.

unified/AGENTS.md

  • "Swift Parser" section now describes in-process parsing via swift_syntax_rs::parse_to_json, no separate binary or grammar to edit.
  • Testing bullet drops the CODEQL_EXTRACTOR_UNIFIED_SWIFT_SYNTAX_PARSE env var and corpus-test-skip guidance; now notes cargo test needs a working Swift toolchain (since swift-syntax-rs builds in-process), and that tests are also runnable via bazel test //unified/extractor:all_tests.

unified/swift-syntax-rs/README.md

  • Prerequisites: removed the SWIFT env var mention — build.rs no longer reads SWIFT/SWIFTC, just requires swift/swiftc on PATH.
  • Building & testing: removed the SWIFT=… SWIFTC=… cargo build fallback block.
  • Building with Bazel: clarified swift-syntax-parse is a debugging aid, not shipped in the extractor pack.
  • Converting to a yeast AST: corrected to say the extractor links swift-syntax-rs directly and consumes JSON produced in-process, replacing the stale "out-of-process ... binary" framing.

Documentation-only change; no code, build, or CI behavior affected.

Copilot AI changed the title [WIP] Update documentation for unified extractor Swift changes Sync unified docs with in-process swift-syntax-rs parsing (post-#22290) Aug 6, 2026
Copilot AI requested a review from jketema August 6, 2026 15:08
Co-authored-by: jketema <93738568+jketema@users.noreply.github.com>
@jketema
jketema force-pushed the copilot/update-md-files-for-unified-extractor branch from bdfc6fc to 51c5d65 Compare August 6, 2026 15:11
@jketema
jketema marked this pull request as ready for review August 6, 2026 15:14
@jketema
jketema requested review from a team as code owners August 6, 2026 15:14
Copilot AI balanced review requested due to automatic review settings August 6, 2026 15:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates unified Swift documentation to reflect in-process swift-syntax-rs parsing.

Changes:

  • Documents current Swift toolchain requirements.
  • Clarifies Bazel/debug binary usage and extractor integration.
  • Updates extractor testing instructions.
Show a summary per file
File Description
unified/AGENTS.md Updates parser architecture and testing guidance.
unified/swift-syntax-rs/README.md Revises prerequisites, build instructions, and integration details.

Review details

  • Files reviewed: 2/2 changed files
  • Comments generated: 1
  • Review effort level: Balanced

Comment thread unified/AGENTS.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants