search

nao1215 / markdown

simple markdown & mermaid builder in golang with
MIT License
72 stars 7 forks source link

Introduce mermaid flowchart syntax #24

Closed nao1215 closed 6 months ago

nao1215 commented 6 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

[!WARNING]

Rate Limit Exceeded

@nao1215 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 31 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. 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](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between cbbac3bc6df26e8e37717d931c1ae7bb54580327 and 3f182a667ca1253f4f5f7f590b9ea30de4148699.

Walkthrough

The recent updates to the Golang markdown package encompass the addition of Mermaid flowchart support, improved resource management with defer f.Close() statements in various files, and the introduction of flowchart generation capabilities in the doc/flowchart package. These changes enhance functionality, ensure proper resource cleanup, and expand the visualization options available to users.

Changes

Files Summary of Changes
README.md Added Mermaid flowchart support.
doc/alert/main.go, doc/generate/main.go, doc/er/main.go, doc/sequence/main.go Implemented defer f.Close() for proper file closure.
doc/badge/main.go, doc/piechart/main.go Added defer f.Close() for resource cleanup.
doc/flowchart/main.go Introduced flowchart generation using Mermaid library.
mermaid/flowchart/flowchart_test.go Added tests for building flowcharts in Mermaid syntax.

🐇💻✨

In the realm of code and light, A rabbit dances with pure delight. Flowcharts bloom, resources tidy, With each link, the code's more tidy. defer f.Close() ensures things are neat, The rabbit's joy, a melody sweet! 🎉🖋️🌟

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 6 months ago

Code Metrics Report

main (cbbac3b) #24 (74ede52) +/-
Coverage 91.8% 93.0% +1.2%
Test Execution Time 1s 2s +1s
Details ``` diff | | main (cbbac3b) | #24 (74ede52) | +/- | |---------------------|----------------|---------------|-------| + | Coverage | 91.8% | 93.0% | +1.2% | | Files | 18 | 24 | +6 | | Lines | 437 | 511 | +74 | + | Covered | 401 | 475 | +74 | - | Test Execution Time | 1s | 2s | +1s | ```

Code coverage of files in pull request scope (89.0% → 92.0%)

Files Coverage +/-
internal/lf.go 66.7% +66.7%
markdown.go 94.4% +0.9%
mermaid/er/entity.go 100.0% 0.0%
mermaid/er/entity_relationship.go 78.3% +1.3%
mermaid/flowchart/config.go 100.0% +100.0%
mermaid/flowchart/flowchart.go 81.2% +81.2%
mermaid/flowchart/link.go 100.0% +100.0%
mermaid/flowchart/node.go 100.0% +100.0%
mermaid/flowchart/oriental.go 100.0% +100.0%
mermaid/piechart/pie_chart.go 87.0% +2.3%
mermaid/sequence/sequence.go 83.9% +1.5%

Reported by octocov

github-actions[bot] commented 6 months ago

Code Metrics Report

main (cbbac3b) #24 (0707276) +/-
Coverage 91.8% 93.0% +1.2%
Test Execution Time 1s 2s +1s
Details ``` diff | | main (cbbac3b) | #24 (0707276) | +/- | |---------------------|----------------|---------------|-------| + | Coverage | 91.8% | 93.0% | +1.2% | | Files | 18 | 24 | +6 | | Lines | 437 | 511 | +74 | + | Covered | 401 | 475 | +74 | - | Test Execution Time | 1s | 2s | +1s | ```

Code coverage of files in pull request scope (89.0% → 92.0%)

Files Coverage +/-
internal/lf.go 66.7% +66.7%
markdown.go 94.4% +0.9%
mermaid/er/entity.go 100.0% 0.0%
mermaid/er/entity_relationship.go 78.3% +1.3%
mermaid/flowchart/config.go 100.0% +100.0%
mermaid/flowchart/flowchart.go 81.2% +81.2%
mermaid/flowchart/link.go 100.0% +100.0%
mermaid/flowchart/node.go 100.0% +100.0%
mermaid/flowchart/oriental.go 100.0% +100.0%
mermaid/piechart/pie_chart.go 87.0% +2.3%
mermaid/sequence/sequence.go 83.9% +1.5%

Reported by octocov

github-actions[bot] commented 6 months ago

Code Metrics Report

main (cbbac3b) #24 (e528633) +/-
Coverage 91.8% 93.0% +1.2%
Test Execution Time 1s 1s 0s
Details ``` diff | | main (cbbac3b) | #24 (e528633) | +/- | |---------------------|----------------|---------------|-------| + | Coverage | 91.8% | 93.0% | +1.2% | | Files | 18 | 24 | +6 | | Lines | 437 | 511 | +74 | + | Covered | 401 | 475 | +74 | | Test Execution Time | 1s | 1s | 0s | ```

Code coverage of files in pull request scope (89.0% → 92.0%)

Files Coverage +/-
internal/lf.go 66.7% +66.7%
markdown.go 94.4% +0.9%
mermaid/er/entity.go 100.0% 0.0%
mermaid/er/entity_relationship.go 78.3% +1.3%
mermaid/flowchart/config.go 100.0% +100.0%
mermaid/flowchart/flowchart.go 81.2% +81.2%
mermaid/flowchart/link.go 100.0% +100.0%
mermaid/flowchart/node.go 100.0% +100.0%
mermaid/flowchart/oriental.go 100.0% +100.0%
mermaid/piechart/pie_chart.go 87.0% +2.3%
mermaid/sequence/sequence.go 83.9% +1.5%

Reported by octocov