feat: export as markdown #245
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThe changes introduce new functionality to the Changes
Poem
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
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (1)
src/components/molecules/RunContent.tsx (1)
167-171: Improve accessibility and consistency of download optionsThe Markdown download option should follow accessibility best practices and maintain consistency with other download options.
-<Typography - onClick={downloadMarkdown} -> - <a style={{ textDecoration: 'none', cursor: 'pointer' }}>Download as Markdown</a> -</Typography> +<Typography> + <Button + component="a" + onClick={downloadMarkdown} + sx={{ textDecoration: 'none' }} + aria-label="Download data as Markdown" + > + Download as Markdown + </Button> +</Typography>Consider:
- Using Material-UI Button component for better accessibility
- Adding proper ARIA labels
- Maintaining consistent styling with other download options
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
src/components/molecules/RunContent.tsx(4 hunks)
🔇 Additional comments (1)
src/components/molecules/RunContent.tsx (1)
Line range hint 61-171: Verify table data handling consistency
Let's verify that the table data handling is consistent across all export formats.
✅ Verification successful
Table data handling is consistent across export formats
The code review shows that:
- The table data is consistently sourced from
row.serializableOutputfor all export formats (JSON, CSV, and Markdown) - The conversion functions (
convertToCSVandconvertToMarkdown) handle the data uniformly:- Both use the same
columnsarray for headers - Both handle empty/undefined values appropriately
- Both properly escape special characters (CSV uses JSON.stringify, Markdown escapes pipe characters)
- Both use the same
- The download implementations follow the same secure pattern using
BlobandURL.createObjectURL
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for table data handling patterns across the codebase
echo "Checking table data handling patterns..."
rg -A 5 "serializableOutput" --type typescript
# Look for similar download implementations
echo "Checking download implementations..."
rg -A 10 "download.*Blob" --type typescript
Length of output: 336
Script:
#!/bin/bash
# Search for table data handling patterns across the codebase
echo "Checking table data handling patterns..."
rg -A 5 "serializableOutput"
# Look for similar download implementations
echo "Checking download implementations..."
rg -A 10 "download.*Blob"
# Look for CSV and Markdown conversion functions
echo "Checking data conversion implementations..."
rg -A 10 "convertTo(CSV|Markdown)"
Length of output: 15309
Comment on lines
+96
to
+107
| const downloadMarkdown = () => { | ||
| const markdownContent = convertToMarkdown(tableData, columns); | ||
| const blob = new Blob([markdownContent], { type: 'text/markdown;charset=utf-8;' }); | ||
| const url = URL.createObjectURL(blob); | ||
|
|
||
| const link = document.createElement("a"); | ||
| link.href = url; | ||
| link.setAttribute("download", "data.md"); | ||
| document.body.appendChild(link); | ||
| link.click(); | ||
| document.body.removeChild(link); | ||
| }; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add cleanup and error handling to downloadMarkdown function
The current implementation might cause memory leaks and doesn't handle potential errors.
const downloadMarkdown = () => {
- const markdownContent = convertToMarkdown(tableData, columns);
- const blob = new Blob([markdownContent], { type: 'text/markdown;charset=utf-8;' });
- const url = URL.createObjectURL(blob);
+ try {
+ const markdownContent = convertToMarkdown(tableData, columns);
+ const blob = new Blob([markdownContent], { type: 'text/markdown;charset=utf-8;' });
+ const url = URL.createObjectURL(blob);
- const link = document.createElement("a");
- link.href = url;
- link.setAttribute("download", "data.md");
- document.body.appendChild(link);
- link.click();
- document.body.removeChild(link);
+ const link = document.createElement("a");
+ link.href = url;
+ link.setAttribute("download", "data.md");
+ document.body.appendChild(link);
+ link.click();
+ document.body.removeChild(link);
+ URL.revokeObjectURL(url);
+ } catch (error) {
+ console.error('Failed to download markdown:', error);
+ // Consider adding user feedback here
+ }
};The changes:
- Add error handling with try-catch
- Clean up the URL object to prevent memory leaks
- Consider adding user feedback for errors
📝 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 downloadMarkdown = () => { | |
| const markdownContent = convertToMarkdown(tableData, columns); | |
| const blob = new Blob([markdownContent], { type: 'text/markdown;charset=utf-8;' }); | |
| const url = URL.createObjectURL(blob); | |
| const link = document.createElement("a"); | |
| link.href = url; | |
| link.setAttribute("download", "data.md"); | |
| document.body.appendChild(link); | |
| link.click(); | |
| document.body.removeChild(link); | |
| }; | |
| const downloadMarkdown = () => { | |
| try { | |
| const markdownContent = convertToMarkdown(tableData, columns); | |
| const blob = new Blob([markdownContent], { type: 'text/markdown;charset=utf-8;' }); | |
| const url = URL.createObjectURL(blob); | |
| const link = document.createElement("a"); | |
| link.href = url; | |
| link.setAttribute("download", "data.md"); | |
| document.body.appendChild(link); | |
| link.click(); | |
| document.body.removeChild(link); | |
| URL.revokeObjectURL(url); | |
| } catch (error) { | |
| console.error('Failed to download markdown:', error); | |
| // Consider adding user feedback here | |
| } | |
| }; |
Comment on lines
+61
to
+81
| const convertToMarkdown = (data: any[], columns: string[]): string => { | ||
|
|
||
| const headerRow = `| ${columns.join(' | ')} |`; | ||
|
|
||
| // Create separator row for Markdown tables | ||
| const separatorRow = `| ${columns.map(() => '---').join(' | ')} |`; | ||
|
|
||
|
|
||
| const dataRows = data.map(row => | ||
| `| ${columns.map(col => { | ||
|
|
||
| const value = row[col]; | ||
| return value === undefined || value === "" ? "-" : | ||
|
|
||
| String(value).replace(/\|/g, '\\|').replace(/\n/g, ' '); | ||
| }).join(' | ')} |` | ||
| ); | ||
|
|
||
|
|
||
| return [headerRow, separatorRow, ...dataRows].join('\n'); | ||
| }; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance the robustness of Markdown conversion
The implementation needs improvements in type safety and data handling:
-const convertToMarkdown = (data: any[], columns: string[]): string => {
+interface TableData {
+ [key: string]: string | number | boolean | null | undefined;
+}
+
+const convertToMarkdown = (data: TableData[], columns: string[]): string => {
const headerRow = `| ${columns.join(' | ')} |`;
const separatorRow = `| ${columns.map(() => '---').join(' | ')} |`;
const dataRows = data.map(row =>
`| ${columns.map(col => {
const value = row[col];
- return value === undefined || value === "" ? "-" :
- String(value).replace(/\|/g, '\\|').replace(/\n/g, ' ');
+ if (value === null || value === undefined || value === "") {
+ return "-";
+ }
+ return String(value)
+ .replace(/\|/g, '\\|')
+ .replace(/\n/g, ' ')
+ .replace(/\[/g, '\\[')
+ .replace(/\]/g, '\\]')
+ .replace(/\*/g, '\\*')
+ .replace(/_/g, '\\_');
}).join(' | ')} |`
);
return [headerRow, separatorRow, ...dataRows].join('\n');
};The changes:
- Add proper TypeScript interface for table data
- Handle null values explicitly
- Escape additional Markdown special characters
- Remove unnecessary empty lines
📝 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 convertToMarkdown = (data: any[], columns: string[]): string => { | |
| const headerRow = `| ${columns.join(' | ')} |`; | |
| // Create separator row for Markdown tables | |
| const separatorRow = `| ${columns.map(() => '---').join(' | ')} |`; | |
| const dataRows = data.map(row => | |
| `| ${columns.map(col => { | |
| const value = row[col]; | |
| return value === undefined || value === "" ? "-" : | |
| String(value).replace(/\|/g, '\\|').replace(/\n/g, ' '); | |
| }).join(' | ')} |` | |
| ); | |
| return [headerRow, separatorRow, ...dataRows].join('\n'); | |
| }; | |
| interface TableData { | |
| [key: string]: string | number | boolean | null | undefined; | |
| } | |
| const convertToMarkdown = (data: TableData[], columns: string[]): string => { | |
| const headerRow = `| ${columns.join(' | ')} |`; | |
| const separatorRow = `| ${columns.map(() => '---').join(' | ')} |`; | |
| const dataRows = data.map(row => | |
| `| ${columns.map(col => { | |
| const value = row[col]; | |
| if (value === null || value === undefined || value === "") { | |
| return "-"; | |
| } | |
| return String(value) | |
| .replace(/\|/g, '\\|') | |
| .replace(/\n/g, ' ') | |
| .replace(/\[/g, '\\[') | |
| .replace(/\]/g, '\\]') | |
| .replace(/\*/g, '\\*') | |
| .replace(/_/g, '\\_'); | |
| }).join(' | ')} |` | |
| ); | |
| return [headerRow, separatorRow, ...dataRows].join('\n'); | |
| }; |
amhsirak
added
Status: In Review
amhsirak
removed
the
Status: Work In Progess
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit