Skip to content

Conversation

@Doradx
Copy link
Contributor

@Doradx Doradx commented Jul 16, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved extraction of code content from Notion code blocks to ensure accurate conversion to markdown.

@coderabbitai
Copy link

coderabbitai bot commented Jul 16, 2025

Walkthrough

The change updates the way code content is extracted from Notion "code" blocks by switching from using the rich_text property to the text property when collecting plain text for markdown conversion. No other logic or exported interfaces are modified.

Changes

File(s) Change Summary
src/notion-to-md.ts Switched code content extraction from block.code.rich_text to block.code.text for markdown generation.

Poem

In Notion’s code, a subtle shift,
From rich_text fields, we gently lift—
Now plain text flows from “text” anew,
Markdown shines with lines more true.
A hop, a skip, a bunny cheer,
For code blocks now are crystal clear!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.

CodeRabbit Configuration 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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 69642ce and 81719cb.

📒 Files selected for processing (1)
  • src/notion-to-md.ts (1 hunks)

case "code":
{
const codeContent = block.code.rich_text.map((t: any) => t.plain_text).join("\n");
const codeContent = block.code.text.map((t: any) => t.plain_text).join("\n");
Copy link

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Verify that block.code.text is the correct property according to the Notion API.

The change from block.code.rich_text to block.code.text looks syntactically correct and maintains the same extraction logic. However, please confirm that the text property exists on code blocks and has the expected structure with plain_text fields.


🌐 Web query:

What is the correct property name for extracting text content from Notion code blocks according to the latest Notion API documentation?

💡 Result:

According to the latest Notion API documentation, to extract the text content from a Notion code block, you should reference the rich_text array within the block’s type-specific object, and then access the plain_text property of the rich text elements.

For a code block object, the structure is:

{
  "object": "block",
  "type": "code",
  "code": {
    "caption": [ ... ],
    "rich_text": [
      {
        "type": "text",
        "plain_text": "your code here",
        ...
      }
    ],
    "language": "python"
  }
}
  • The correct property path to the text content is:
    code.rich_text[].plain_text

You need to iterate through the rich_text array inside the code object and concatenate the plain_text fields to obtain the full text content of the code block[10].

All rich_text objects will include a plain_text property, which provides a convenient way for developers to access unformatted text from the Notion block[10].

This approach is consistent for extracting plain text from other rich-text-based block types (e.g., paragraphs, headings) as well[3][10].

Summary:

  • Use code.rich_text[].plain_text to extract the text content of a Notion code block via the Notion API[10].

Citations:


Use code.rich_text instead of code.text for Notion code blocks

The Notion API places code content in block.code.rich_text, not block.code.text. Please revert the property change to match the official spec.

Location to fix:

  • src/notion-to-md.ts, line 503

Updated snippet:

- const codeContent = block.code.text.map((t: any) => t.plain_text).join("\n");
+ const codeContent = block.code.rich_text.map((t: any) => t.plain_text).join("\n");
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const codeContent = block.code.text.map((t: any) => t.plain_text).join("\n");
const codeContent = block.code.rich_text.map((t: any) => t.plain_text).join("\n");
🤖 Prompt for AI Agents
In src/notion-to-md.ts at line 503, the code incorrectly accesses code content
using block.code.text, but according to the Notion API spec, the correct
property is block.code.rich_text. Update the code to use block.code.rich_text
instead of block.code.text to properly retrieve the code content.

@souvikinator
Copy link
Owner

Hi @Doradx thanks for the PR. Can you elaborate the issue that you faced and how this fixes it? Looking at Notion docs I can see the current logic works fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants