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.

Sign up for GitHub

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

Jump to bottom

Language recognition for code blocks #16263

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Language recognition for code blocks #16263

wants to merge 1 commit into from

Conversation

theannachen
Copy link

@theannachen theannachen commented Apr 21, 2024 •
edited by coderabbitai bot

Type autoformat: Adds new autoformatting for language selection. Closes #12212 .

Type codeblock: Closes #12212 .

Functionality Changes
Codeblocks can no longer be created by "" and must contain a space after the triple graves (i.e. " ").

Instead of the default or the last language always being used by the shortcut, codeblocks can now be created with specific languages by adding them after the , such as python. After the name, the space will then create the block.

If the language used is not a valid language, it will create an undefined codeblock.

Summary by CodeRabbit

  • New Features
    • Enhanced the autoformatting of code blocks in the editor to support language specification directly through markdown-like syntax.
    • Improved handling of code blocks without specified languages to ensure correct formatting.
    • Updated the creation of empty code blocks to automatically remove placeholder text when initiating a new code block with language or whitespace.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 21, 2024 •
edited

Walkthrough

The recent updates to the CKEditor5's autoformat feature enhance the handling of code blocks. The modifications allow users to specify the programming language immediately after typing the triple backticks, which aligns with common markdown practices. This update improves the user experience by enabling language-specific formatting as soon as a code block is initiated.

Changes

File Path Change Summary
.../ckeditor5-autoformat/src/autoformat.ts Modified blockAutoformatEditing to support language specifier for code blocks.
.../ckeditor5-autoformat/tests/autoformat.js Adjusted test cases to handle code blocks with and without language specifiers.
.../ckeditor5-autoformat/tests/manual/autoformat.md Updated manual to reflect the creation of empty code blocks with optional language specifiers.

Assessment against linked issues

Objective Addressed Explanation
Enable passing code type with the code block (#12212) ✅
Mimic markdown editor behavior by adding code block after space or enter (#12212) ✅

In summary, the changes effectively address the objectives outlined in the linked issue #12212, enhancing the functionality of the CKEditor5 autoformat feature to include language-specific code blocks that are initiated with either a space or an enter key, mimicking common markdown behaviors.

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 1d1ef14 and 3a6d6f8.
Files selected for processing (3)
  • packages/ckeditor5-autoformat/src/autoformat.ts (1 hunks)
  • packages/ckeditor5-autoformat/tests/autoformat.js (3 hunks)
  • packages/ckeditor5-autoformat/tests/manual/autoformat.md (1 hunks)
Additional Context Used
LanguageTool (7)
packages/ckeditor5-autoformat/tests/manual/autoformat.md (7)

Near line 9: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ock to replace it with a list item. 1. Type > and press the space at the beginnin...

Near line 11: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...k to replace it with a block quote. 1. Type 1 followed by a . or ) and press ...

Near line 11: Unpaired symbol: ‘(’ seems to be missing
Context: ...uote. 1. Type 1 followed by a . or ) and press space (at the beginning of a...

Near line 13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...place it with a numbered list item. 1. Type *foobar*/_foobar_ to italicize `foo...

Near line 17: Possible typo: you repeated a whitespace
Context: ... foobar to mark as code `foobar`. ``` should be removed. 1. Type~~foo...

Near line 19: Possible spelling mistake found.
Context: ...ld be removed. 1. Type ~~foobar~~ to strikethrough foobar. ~~ should be removed. 1. T...

Near line 29: Possible spelling mistake found.
Context: ... inline formatting (bold, italic, code, strikethrough) after a soft break (Shift+<...

Additional comments not posted (10)
packages/ckeditor5-autoformat/tests/manual/autoformat.md (2)

21-21: The addition of specifying a language when creating a code block enhances usability and aligns with common markdown practices.

23-23: The update to allow creating an empty code block with any whitespace following the backticks is a useful enhancement.

packages/ckeditor5-autoformat/src/autoformat.ts (2)

195-203: The implementation for autoformatting code blocks with a specified language is correctly handled. The regex pattern and conditions are well-defined.

204-204: The handling of code blocks without a specified language, using the previous language choice, is a thoughtful feature that enhances user experience.

packages/ckeditor5-autoformat/tests/autoformat.js (6)

512-512: The test for replacing triple grave accents with a code block in a paragraph is correctly implemented and verifies the functionality as expected.

521-521: The test for handling triple grave accents within a heading element is well-implemented and covers an important scenario.

530-530: The test for replacing triple grave accents in a non-empty paragraph is thorough and ensures the feature works as intended even with additional text.

539-539: The test correctly ensures that triple grave accents are not replaced within numbered list items, preserving list formatting.

548-548: The test ensures that triple grave accents are not replaced within bulleted list items, which is important for list integrity.

557-557: The test for not replacing triple grave accents when already in a code block is crucial and well-implemented.

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.

@theannachen
Copy link
Author

I signed the CLA, but the signature had my username twice (theannachen theannachen). I don't know if that's pertinent.

@theannachen
Copy link
Author

Also closes #15860

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Block formatting, enable passing code type with the code block ```
1 participant
@theannachen