Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support continuation mark and catch invalid escape sequence #535

Merged

Conversation

Huy-DNA
Copy link
Contributor

@Huy-DNA Huy-DNA commented Mar 11, 2024

Summary

  • Support continuation mark
  • Ignore slash for invalid escape character
  • Use test name for reporting failed test case (easier to debug)
  • Support escaping triple quotes
    image

Issue

(issue link here)

Lasting Changes (Technical)

  • Lexer: escape sequence handling
  • A new compiler error for invalid escape sequence.

Checklist

Please check directly on the box once each of these are done

  • Documentation (if necessary)
  • Tests (integration test/unit test)
  • Integration Tests Passed
  • Code Review

Summary by CodeRabbit

  • New Features

    • Enhanced escape sequence handling and error messages in the parser.
    • Added test cases for valid and invalid escape sequences, and unclosed strings in DBML files.
    • Updated package versions for @dbml/cli, @dbml/core, and @dbml/parse to 3.4.1-alpha.0.
  • Bug Fixes

    • Corrected a typo in the output of multiline strings in test files.
  • Documentation

    • Enhanced error documentation with a new INVALID_ESCAPE_SEQUENCE error code.

@Huy-DNA Huy-DNA added the PR: New Feature 🚀 A type of pull request used for changelog categories label Mar 11, 2024
@nguyenalter nguyenalter requested a review from NQPhuc March 19, 2024 07:40
Copy link

coderabbitai bot commented Apr 11, 2024

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/*.lock

Walkthrough

The recent updates to the dbml-parse package focus on enhancing string handling and error management. Key improvements include the addition of new error codes for invalid escape sequences, refined parsing for various escape sequences, and updates to handle unclosed strings. The changes also correct existing bugs and improve test coverage for these scenarios.

Changes

Files Change Summary
.../errors.ts, .../lexer/lexer.ts Introduced INVALID_ESCAPE_SEQUENCE error and improved escape sequence handling in Lexer. Removed unused lodash import.
.../tests/interpreter/output/multiline_string.out.json Corrected typo in a multiline string.
.../tests/lexer/input/*.in.dbml Added new test files for valid and invalid escape sequences and unclosed strings.
.../tests/lexer/output/*.out.json New JSON outputs detailing results from parsing tests, including error diagnostics and structured data on unclosed strings and escape sequences.

🐰✨
A hop, a skip, a code deploy,
New tales of strings that coyly toy.
Errors caught, and bugs now shy,
In DBML, no string shall lie.
Cheers to code that now sings true,
With every push, our joy renews! 🎉
🐰✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link
Contributor

@NQPhuc NQPhuc left a comment

Choose a reason for hiding this comment

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

LGTM!

@Huy-DNA Huy-DNA merged commit e75d2f7 into master Apr 11, 2024
3 checks passed
@Huy-DNA Huy-DNA deleted the support-continuation-mark-and-catch-invalid-escape-sequence branch April 11, 2024 11:38
@coderabbitai coderabbitai bot mentioned this pull request Apr 25, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: New Feature 🚀 A type of pull request used for changelog categories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants