Fix restrictive regex validation for descriptions in IDL files #227
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.
Problem:
The ACT build process was failing when IDL descriptions contained common special characters like ampersand (&) and hash (#), throwing validation errors such as:
"invalid description for method CrsObject.GetName"
Root Cause:
Two regex patterns in componentdefinition.go were overly restrictive:
descriptionIsValid()
- for method/class/function descriptionserrorDescriptionIsValid()
- for error descriptionsThese patterns excluded commonly used characters that are safe and appropriate for documentation text.
Solution:
Expanded both regex patterns to include additional safe characters:
(hash/pound) - for identifiers, issue numbers, etc.