Conversation
There was a problem hiding this comment.
PR Overview
This pull request enhances the parsing logic for GitHub issue bodies by combining unexpected header matches with the previous field when a form template is provided. In addition, the PR updates test cases and fixtures to reflect the new handling and accommodates various field formats in the template.
- Moved the regex matching logic and handling of extra headers inside parseIssue.
- Introduced logic to merge unmatched header sections with the preceding field’s value.
- Updated fixtures (YAML and Markdown) with revised field IDs and labels.
- Adjusted tests to cover multiple scenarios including issues with and without a provided template.
Changes
| File | Description |
|---|---|
| src/index.ts | Refactored parseIssue to incorporate combining of extra header matches when a template is provided. |
| fixtures/extra/template.yml | Updated field definitions and labels to support new parsing behavior. |
| fixtures/extra/issue.md | Adjusted header texts to match updated template definitions. |
| tests/index.test.ts | Rearranged and renamed tests to reflect scenarios with/without templates and with slugified keys. |
| src/format.ts | Made the field parameter optional in formatValue to support changes in parseIssue. |
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
src/index.ts:72
- Appending the full match (match[0]) may include the header markdown, potentially leading to duplicated header text in the field value. Consider appending only the value portion (e.g., match.groups!.value) or adjust the regex capture so that only the intended content is merged.
parsedMatches[parsedMatches.length - 1].groups!.value = parsedMatches[parsedMatches.length - 1].groups!.value + '\n' + match[0]
fixtures/extra/template.yml:148
- [nitpick] For consistency with the other checkbox option labels, consider quoting the label 'Sometimes'. This will help avoid potential parsing inconsistencies and improve readability.
- label: Sometimes
Tip: If you use Visual Studio Code, you can request a review from Copilot before you push from the "Source Control" tab. Learn more
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.

This PR adds special handling for cases like the one mentioned in issue-ops/parser#102
In some situations, a user's issue form input could include markdown. If the provided value contains a match for the regex used to locate form field responses, it was mistakenly added as a separate field response.
This solution combines any such matches with the previous match, resulting in only the parsed values being those corresponding to fields in the form template. However, it is only applied in cases where a template is included in the
parseIssuecall.