fix: Resolve XML validation error in OutputGitRepoXML function #16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fixed XML generation to properly handle special characters and CDATA sections - Added protection against premature CDATA termination by escaping "]]>" sequences - Improved XML formatting with consistent indentation and structure - Simplified token placeholder replacement without breaking formatting
This commit adds support for a .gptinclude file, which allows users to explicitly specify which files should be included in the repository export. The feature complements the existing .gptignore functionality: - When both .gptinclude and .gptignore exist, files are first filtered by the include patterns, then any matching ignore patterns are excluded - Added new command-line flag: -I/--include to specify a custom path to the .gptinclude file - Default behavior looks for .gptinclude in repository root - Added comprehensive tests for the new functionality - Updated README.md with documentation and examples With this change, users gain more fine-grained control over which parts of their repositories are processed by git2gpt, making it easier to focus on specific areas when working with AI language models.
This commit fixes an issue where the XML export would fail with "unexpected EOF in CDATA section" errors when file content contained the CDATA end marker sequence ']]>'. The fix implements a proper CDATA handling strategy that: - Detects all occurrences of ']]>' in file content - Splits the content around these markers - Creates properly nested CDATA sections to preserve the original content - Ensures all XML output is well-formed regardless of source content This approach maintains the efficiency of CDATA for storing large code blocks while ensuring compatibility with all possible file content. Fixes the XML validation error that would occur when processing files containing CDATA end marker sequences.
There was a problem hiding this comment.
Pull Request Overview
This PR fixes XML validation errors and improves file filtering by adding support for an include list alongside the existing ignore list. Key changes include:
- Enhancing the OutputGitRepoXML function to safely handle CDATA sections.
- Introducing functions to generate and process a .gptinclude file alongside .gptignore.
- Updating command-line flags and function signatures in ProcessGitRepo and processRepository.
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| prompt/prompt.go | Updated XML output handling, added include list functions, and adjusted repo processing logic. |
| prompt/gptinclude_test.go | Added test cases for the new include filtering functionality. |
| cmd/root.go | Added a new flag for the include file and updated ProcessGitRepo invocation. |
| README.md | Updated documentation to cover include file usage along with ignore file usage. |
Files not reviewed (1)
- .gptinclude: Language not supported
Comments suppressed due to low confidence (2)
prompt/prompt.go:324
- [nitpick] Consider renaming variable 'process' to 'shouldProcess' for improved readability and clarity.
process := shouldProcess(relativeFilePath, includeList, ignoreList)
prompt/prompt.go:135
- Consider handling the error returned from getIgnoreList instead of ignoring it, to ensure any issues with reading the ignore file are properly reported.
ignoreList, _ = getIgnoreList(ignoreFilePath)
|
|
||
| // Split content around CDATA end marker (]]>) and create multiple CDATA sections | ||
| contents := file.Contents | ||
| result.WriteString(" <contents>") |
There was a problem hiding this comment.
Ensure that the algorithm splitting file.Contents into multiple CDATA sections properly handles consecutive ']]>' sequences to avoid malformed XML.
You are right. I messed up with the branches. Thank you again for this amazing project! |
chand1012
approved these changes
Apr 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request: Fix XML validation error in OutputGitRepoXML function
Description
This PR fixes the XML validation error that occurs when using the
-xflag to export repositories as XML. The specific error message was:Changes Made
OutputGitRepoXMLfunction inprompt/prompt.goto properly handle XML special characters&,<,>,",') in file pathsTesting Done
I tested this fix by:
git2gpt -x -s -e -o output.xml .on repositories containing files with special XML characters]]>) to ensure they're properly escapedRelated Issue
Fixes #15
Before/After
Before: The tool fails with XML validation errors when files contain special characters
After: The tool successfully generates valid XML regardless of file content