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.

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

feat: add-all-generator-templates-manually #3618

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Light13008
Copy link

@Light13008 Light13008 commented Jan 29, 2025

Description

Summary by CodeRabbit

  • New Features
    • Added 7 new AsyncAPI generator templates for various programming languages and technologies
    • Expanded template options for Go, Node.js, Markdown, Python, .NET, WebSocket, and TypeScript
    • Enhanced code generation and documentation capabilities for AsyncAPI users

Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

Walkthrough

The pull request focuses on updating the config/tools-manual.json file by expanding the "AsyncAPI Generator Templates" section. Seven new template entries have been added, covering various programming languages and technologies such as Go, Node.js, Markdown, Python, .NET, WebSocket, and TypeScript. These templates provide developers with additional options for generating code and documentation from AsyncAPI documents, enhancing the configuration's utility and flexibility.

Changes

File Change Summary
config/tools-manual.json Added 7 new entries to "AsyncAPI Generator Templates" section, including templates for Go Watermill, Node.js, Markdown, Python Paho, .NET RabbitMQ, Node.js WebSocket, and TypeScript NATS

Possibly related PRs

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • derberg
  • akshatnema
  • magicmatatjahu
  • sambhavgupta0705
  • devilkiller-ag
  • asyncapi-bot-eve

Poem

🐰 Templates hopping, config growing bright,
New languages dancing in AsyncAPI's light!
From Go to Node.js, a template parade,
Generating code with each rabbit's serenade!
Flexibility blooms, developers cheer! 🚀


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>, please review it.
    • 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 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 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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. (Beta)
  • @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.

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

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link

netlify bot commented Jan 29, 2025

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 89189e9
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67997d5e4aaba500085b78c7
😎 Deploy Preview https://deploy-preview-3618--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Jan 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ea1ef0f) to head (89189e9).

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #3618   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines          732       732           
=========================================
  Hits           732       732           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Jan 29, 2025

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 34
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3618--asyncapi-website.netlify.app/

@Light13008 Light13008 changed the title Manually added all Generator templates, BUT its not refelecting on Fr… Manually Add Generator Templates Jan 29, 2025
Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
config/tools-manual.json (1)

34-38: Consider enhancing template descriptions and metadata.

To improve user experience, consider:

  1. Adding version information for each template
  2. Expanding descriptions to include:
    • Supported AsyncAPI versions
    • Minimum requirements
    • Example usage

Also applies to: 46-50, 58-62, 70-74, 82-86, 94-98, 106-110

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ea1ef0f and 89189e9.

📒 Files selected for processing (1)
  • config/tools-manual.json (1 hunks)
🔇 Additional comments (3)
config/tools-manual.json (3)

32-118: LGTM! Well-structured template entries.

The added generator templates follow a consistent structure and format.


39-43: LGTM! Consistent categorization and technology tags.

Each template entry has appropriate and consistent categorization with:

  • Specific language tag
  • Relevant technology tags
  • Consistent "generator-template" category

Also applies to: 51-55, 63-67, 75-79, 87-91, 99-103, 111-115


37-37: Verify repository existence and accessibility.

Let's ensure all the referenced repositories exist and are accessible.

Also applies to: 49-49, 61-61, 73-73, 85-85, 97-97, 109-109

✅ Verification successful

All repository URLs are valid and accessible

All referenced AsyncAPI template repositories are confirmed to exist and are publicly accessible on GitHub.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the repositories exist and are accessible

repos=(
  "asyncapi/go-watermill-template"
  "asyncapi/nodejs-template"
  "asyncapi/markdown-template"
  "asyncapi/python-paho-template"
  "asyncapi/dotnet-rabbitmq-template"
  "asyncapi/nodejs-ws-template"
  "asyncapi/ts-nats-template"
)

for repo in "${repos[@]}"; do
  echo "Checking $repo..."
  response=$(curl -s -o /dev/null -w "%{http_code}" "https://github.com/$repo")
  if [ "$response" != "200" ]; then
    echo "Repository $repo returned status $response"
  fi
done

Length of output: 1947

@Light13008 Light13008 changed the title Manually Add Generator Templates feat: Add All Generator Templates Manually Jan 29, 2025
@Light13008 Light13008 changed the title feat: Add All Generator Templates Manually feat: a\dd-all-generator-templates-manually Jan 29, 2025
@Light13008 Light13008 changed the title feat: a\dd-all-generator-templates-manually feat: add-all-generator-templates-manually Jan 29, 2025
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