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

chore: update tools.json #3457

Merged
merged 1 commit into from
Dec 9, 2024
Merged

Conversation

asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Dec 9, 2024

Automated changes by create-pull-request GitHub action

Summary by CodeRabbit

  • New Features

    • Updated color scheme for several programming languages and technologies for a more cohesive look.
    • Added a new entry for "AsyncAPI Modelina" in the Code Generators section.
  • Changes

    • Replaced and updated various entries in the APIs, Code Generators, AsyncAPI Generator Templates, and GitHub Actions sections for clarity and accuracy.

Copy link

coderabbitai bot commented Dec 9, 2024

Walkthrough

The pull request introduces modifications to two configuration files: config/all-tags.json and config/tools-automated.json. The changes in all-tags.json involve updates to the color and borderColor attributes for several programming languages and technologies, standardizing their appearance. In tools-automated.json, significant restructuring occurs, including the replacement and addition of entries in various sections, such as APIs and Code Generators, along with updates to descriptions and technology filters.

Changes

File Change Summary
config/all-tags.json Updated color and borderColor attributes for TypeScript, Kotlin, Scala, Groovy, Markdown, and Shell to a unified color palette.
config/tools-automated.json - Replaced "SIO-AsyncAPI" with "AsyncAPI Server API" in APIs section, updated its description, links, and technology filter.
- Added "AsyncAPI Modelina" in Code Generators section.
- Changed title and description for GitHub Actions from "GitHub Action for Generator" to "GitHub Action for CLI" and updated the technology filter.
- Multiple title and description changes in AsyncAPI Generator Templates, including swapping "Node.js Websockets Template" and "Java Spring Cloud Stream Template".

Possibly related PRs

  • chore: update tools.json #3274: This PR updates the config/all-tags.json file, modifying color and borderColor attributes for TypeScript and Kotlin.
  • chore: update tools.json #3292: Similar to the main PR, this PR updates the config/all-tags.json file, changing color and borderColor for TypeScript, Kotlin, Groovy, and others.
  • chore: update tools.json #3336: This PR changes color and borderColor attributes for multiple technologies in config/all-tags.json, including TypeScript and Kotlin.
  • chore: update tools.json #3404: This PR modifies the config/all-tags.json file, updating color and borderColor for several technologies, including TypeScript and Kotlin.
  • chore: update tools.json #3440: This PR updates the config/all-tags.json file, changing color and borderColor attributes for TypeScript, Kotlin, Scala, and others.

Suggested labels

autoapproved, autoupdate

Suggested reviewers

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

Poem

🐇 In the meadow of code, where colors align,
With hues of TypeScript and Kotlin that shine.
Groovy and Scala join in the dance,
A palette refreshed, giving all a chance.
From tools to templates, the changes are bright,
A vibrant new world, oh what a sight! 🌈


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

netlify bot commented Dec 9, 2024

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit b6cb5b6
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67563bc29668370008aa983a
😎 Deploy Preview https://deploy-preview-3457--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 Dec 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.18%. Comparing base (9976010) to head (b6cb5b6).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3457   +/-   ##
=======================================
  Coverage   70.18%   70.18%           
=======================================
  Files          21       21           
  Lines         664      664           
=======================================
  Hits          466      466           
  Misses        198      198           

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

@asyncapi-bot
Copy link
Contributor Author

⚡️ Lighthouse report for the changes in this PR:

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

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

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

🧹 Outside diff range and nitpick comments (4)
config/all-tags.json (1)

1-1: Consider maintaining distinct colors for different technologies

While standardizing colors (bg-[#61d0f2] and border-[#40ccf7]) creates visual consistency, it might make it harder for users to distinguish between different technologies at a glance. Consider maintaining some color variation while still keeping a cohesive palette.

config/tools-automated.json (3)

Line range hint 407-439: Fix inconsistencies in GitHub Actions section

There are several issues in the GitHub Actions section:

  1. Inconsistent category names: "github-action" vs "github-actions"
  2. Duplicate entries for "GitHub Action for Generator"
  3. Inconsistent descriptions between similar entries

Suggested fixes:

  1. Standardize category to "github-action"
  2. Remove duplicate entry
  3. Ensure consistent descriptions for related tools

Line range hint 721-826: Standardize language field format and values

The language field in template entries has several inconsistencies:

  1. Inconsistent format: some entries use string ("language": "javascript"), others use array ("language": ["javascript"])
  2. Incorrect language attribution: Java templates are marked with JavaScript as their language

Suggested fixes:

  1. Standardize language field format (prefer array format for consistency)
  2. Correct language values to match the actual template language:
-  "language": ["javascript"],
+  "language": ["java"],
   "technology": [
     "Spring Cloud Streams",
     "Maven"
   ],

Duplicate entries and inconsistent fields need to be addressed

Several issues were identified in the tools-automated.json file:

  1. Duplicate tool entries across sections:

    • AsyncAPI CLI appears in both "CLIs" and "Others"
    • AsyncAPI.Net appears in both "Code-first tools" and "Validators"
    • GitHub Action for Generator appears twice in "GitHub Actions"
    • SIO-AsyncAPI appears in both "APIs" and "Code-first tools"
    • ZenWave SDK appears in multiple categories
    • Zod Sockets appears in multiple categories
  2. Inconsistent field formats:

    • Language field uses both string and array formats (3 arrays vs 25 strings)
  3. Category naming inconsistencies:

    • Both "github-action" and "github-actions" are used
    • Some categories appear redundant or could be consolidated

Recommendations:

  • Remove duplicate tool entries or consolidate them under the most appropriate category
  • Standardize the language field to consistently use string format
  • Normalize category names (e.g., standardize "github-action" vs "github-actions")
🔗 Analysis chain

Line range hint 1-900: Verify file structure and cross-references

Let's verify the overall structure and cross-references in the file.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for duplicate entries across sections
echo "Checking for duplicate entries..."
jq -r '.[] | select(.toolsList != null) | .toolsList[] | .title' config/tools-automated.json | sort | uniq -d

# Check for inconsistent category names
echo "Checking for inconsistent category names..."
jq -r '.[] | select(.toolsList != null) | .toolsList[] | .filters.categories[]' config/tools-automated.json | sort | uniq -c | sort -nr

# Check for inconsistent language field formats
echo "Checking language field formats..."
jq -r '.[] | select(.toolsList != null) | .toolsList[] | select(.filters.language != null) | .filters.language | type' config/tools-automated.json | sort | uniq -c

Length of output: 1131

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9976010 and b6cb5b6.

📒 Files selected for processing (2)
  • config/all-tags.json (1 hunks)
  • config/tools-automated.json (9 hunks)

Comment on lines +6 to +22
"title": "AsyncAPI Server API",
"description": "Server API providing official AsyncAPI tools",
"links": {
"websiteUrl": "https://github.com/daler-rahimov/sio-asyncapi",
"docsUrl": "https://github.com/daler-rahimov/sio-asyncapi",
"repoUrl": "https://github.com/daler-rahimov/sio-asyncapi"
"websiteUrl": "https://api.asyncapi.com/v1",
"docsUrl": "https://api.asyncapi.com/v1/docs",
"repoUrl": "https://github.com/asyncapi/server-api"
},
"filters": {
"language": "Python",
"technology": [
"Socket.IO",
"Flask"
"Node.js",
"TypeScript"
],
"categories": [
"code-first",
"api"
],
"hasCommercial": false,
"isAsyncAPIOwner": false
"isAsyncAPIOwner": true
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Remove duplicate entry for SIO-AsyncAPI

The tool "SIO-AsyncAPI" appears in both the "APIs" and "Code-first tools" sections. Consider keeping it in the most appropriate section to avoid confusion.

Also applies to: 26-45

@asyncapi-bot asyncapi-bot merged commit da40c06 into master Dec 9, 2024
34 checks passed
@asyncapi-bot asyncapi-bot deleted the update-tools/regenerateTools branch December 9, 2024 00:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants