suggest mermaid syntax highlighting #3389
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe changes involve modifications to the Changes
Possibly related PRs
Suggested reviewers
Poem
Warning Rate limit exceeded@trajan0x has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 40 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
Deploying sanguine-fe with
|
| Latest commit: |
4101bb1
|
| Status: | ⚡️ Build in progress... |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
.vscode/extensions.json(1 hunks)
🧰 Additional context used
🪛 Biome
.vscode/extensions.json
[error] 18-18: Expected an array, an object, or a literal but instead found ']'.
Expected an array, an object, or a literal here.
(parse)
[error] 19-19: Expected a property but instead found '}'.
Expected a property here.
(parse)
🔇 Additional comments (2)
.vscode/extensions.json (2)
2-6: LGTM! Well-documented file format explanation.
The added comments clearly explain the JSONC format and its features, which is helpful for future maintainers.
16-17: LGTM! Appropriate extension choices for Mermaid support.
The combination of these extensions provides both rendering and syntax highlighting capabilities for Mermaid diagrams.
Let's verify the extensions' metadata:
✅ Verification successful
mermaid" -g "*.md"
Search for any Mermaid-related configuration or documentation
echo -e "\n=== Searching for Mermaid-related configuration or documentation ==="
rg -i "mermaid" -g "!.vscode/" -g ".{md,json,yaml,yml}"
---
mermaid' "$file" || rg -A 5 -B 1 'mermaid' "$file"
done
LGTM! The Mermaid extensions are essential for the codebase
The repository actively uses Mermaid diagrams in multiple README files for documentation:
services/omnirpc/modules/harmonyproxy/README.md: Contains a sequence diagram showing proxy flowethergo/submitter/README.md: Uses a graph diagram for nonce locking visualizationethergo/listener/README.md: Includes a sequence diagram for listener architecture
The added VS Code extensions are necessary as they provide:
- Rendering support for these diagrams in VS Code's Markdown preview
- Syntax highlighting for better diagram authoring experience
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify VSCode extension metadata
# Check both extensions' latest versions, download counts, and ratings
gh api \
-H "Accept: application/vnd.github+json" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/repos/mjbvz/vscode-markdown-mermaid/releases/latest
gh api \
-H "Accept: application/vnd.github+json" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/repos/bpruitt-goddard/vscode-mermaid-syntax-highlight/releases/latest
Length of output: 653
Script:
#!/bin/bash
# Let's try a different approach by checking if there are any Mermaid-related files or documentation in the repository
# This will help verify if the extensions are being used appropriately
# Search for Mermaid diagrams in markdown files
echo "=== Searching for Mermaid diagrams in markdown files ==="
rg -l "Length of output: 216
Script:
#!/bin/bash
# Let's try a simpler approach to search for Mermaid-related content
# Search for Mermaid diagrams in markdown files
echo "=== Searching for Mermaid diagrams in markdown files ==="
rg -l 'mermaid' -g '*.md'
# Search for Mermaid-related configuration
echo -e "\n=== Searching for Mermaid configuration ==="
rg -i 'mermaid' -g '!.vscode/extensions.json' -g '*.{json,yaml,yml}'
Length of output: 508
Script:
#!/bin/bash
# Let's check the content of one of the README files to verify Mermaid usage
echo "=== Checking Mermaid diagram content in README files ==="
for file in services/omnirpc/modules/harmonyproxy/README.md ethergo/submitter/README.md ethergo/listener/README.md contrib/promexporter/internal/gql/dfk/README.md contrib/git-changes-action/README.md; do
echo -e "\n=== Content from $file ==="
rg -A 5 -B 1 'Length of output: 216
Script:
#!/bin/bash
# Let's examine one README file at a time
echo "=== Checking services/omnirpc/modules/harmonyproxy/README.md ==="
cat services/omnirpc/modules/harmonyproxy/README.md
echo -e "\n=== Checking ethergo/submitter/README.md ==="
cat ethergo/submitter/README.md
echo -e "\n=== Checking ethergo/listener/README.md ==="
cat ethergo/listener/README.md
Length of output: 9330
.vscode/extensions.json
Outdated
| ], | ||
| } No newline at end of file | ||
| } |
There was a problem hiding this comment.
Fix JSON formatting issues.
There are two formatting issues to address:
- Remove the trailing comma after the last array item
- Add a newline at the end of file
Apply this diff to fix the formatting:
"dbaeumer.vscode-eslint",
"editorconfig.editorconfig",
"juanblanco.solidity",
"golang.go",
"bierner.markdown-mermaid",
- "bpruitt-goddard.mermaid-markdown-syntax-highlighting",
+ "bpruitt-goddard.mermaid-markdown-syntax-highlighting"
],
- }
+ }
+📝 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.
| ], | |
| } | |
| \ No newline at end of file | |
| } | |
| "dbaeumer.vscode-eslint", | |
| "editorconfig.editorconfig", | |
| "juanblanco.solidity", | |
| "golang.go", | |
| "bierner.markdown-mermaid", | |
| "bpruitt-goddard.mermaid-markdown-syntax-highlighting" | |
| ], | |
| } | |
🧰 Tools
🪛 Biome
[error] 18-18: Expected an array, an object, or a literal but instead found ']'.
Expected an array, an object, or a literal here.
(parse)
[error] 19-19: Expected a property but instead found '}'.
Expected a property here.
(parse)
Description
Add mermaid to cursor/vscode
Summary by CodeRabbit
"bierner.markdown-mermaid""bpruitt-goddard.mermaid-markdown-syntax-highlighting"