feat: Allow variables to have delimiters.

[SharafMohamed]

Description

Remove the throw for variables with delimiters

Known issue

There is no backtracking during lexxing. This means introducing variables containing delimiters can cause other variables to be potentially misclassified as static text. This is fixed in an already prepared future PR, but its dependent on the (also future) simulation PR. Tracked by #116.

Validation performed

Existing tests pass.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[SharafMohamed]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[davidlion]

@coderabbitai Please open an issue for the known issue introduced by this PR and link it to this issue.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get PR details
echo "PR details:"
gh pr view 114 --json title,body,state,url,author

# Get list of files changed in the PR
echo -e "\nFiles changed:"
gh pr view 114 --json files --jq '.files[].path'

# Get PR comments to see if the known issue is mentioned
echo -e "\nPR comments:"
gh pr view 114 --json comments --jq '.comments[].body'

Length of output: 6842

---

🏁 Script executed:

#!/bin/bash
# Create a GitHub issue for the known issue
gh issue create \
  --title "Lexing Backtracking Issue: Variables with Delimiters May Cause Misclassification" \
  --body "## Description

When variables contain delimiters, other variables may be potentially misclassified as static text due to the lack of backtracking during the lexxing process.

## Details

This issue was identified as a known limitation in PR #114 (https://github.com/y-scope/log-surgeon/pull/114) which added support for variables with delimiters.

## Current Status

According to the PR description, this issue is planned to be fixed in a future PR that depends on the upcoming simulation PR.

## References

- Related PR: #114 (https://github.com/y-scope/log-surgeon/pull/114)
" \
  --assignee davidlion

Length of output: 768

---

@davidlion I've created a GitHub issue for the known issue mentioned in PR #114. The issue has been created and assigned to you:

Issue #116: Lexing Backtracking Issue: Variables with Delimiters May Cause Misclassification

The issue documents the known limitation that when variables contain delimiters, other variables may be misclassified as static text due to lack of backtracking during the lexing process, as mentioned in PR #114.