chore: update tools.json #3692
chore: update tools.json #3692
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve and
derberg
as code owners
WalkthroughThe changes modify two JSON configuration files. In Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
Documentation and Community
|
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3692 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 20 20
Lines 732 732
=========================================
Hits 732 732 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (3)
config/tools-automated.json (3)
723-742: 🛠️ Refactor suggestion
⚠️ Potential issueGenerator Templates – Java Spring Template Language Mismatch:
The "Java Spring Template" entry under "AsyncAPI Generator Templates" specifies its language as["javascript"], which appears inconsistent with its title suggesting a Java-based template. It is recommended to change the language filter to["Java"].Example diff:
- "language": [ - "javascript" - ], + "language": [ + "Java" + ],
799-817: 🛠️ Refactor suggestion
⚠️ Potential issueGenerator Templates – Java Spring Cloud Stream Template Language Mismatch:
In the "Java Spring Cloud Stream Template" entry, the language filter is listed as["javascript"]. For a Java Spring–based template, it would be more accurate to use["Java"].Example diff:
- "language": [ - "javascript" - ], + "language": [ + "Java" + ],
820-837: 🛠️ Refactor suggestion
⚠️ Potential issueGenerator Templates – Java Template Language Review:
Similarly, the "Java Template" entry specifies["javascript"]as the language. To correctly represent a Java-based template, please update the language filter to["Java"].Example diff:
- "language": [ - "javascript" - ], + "language": [ + "Java" + ],
🧹 Nitpick comments (1)
config/tools-automated.json (1)
75-92: Code-first Tools – nestjs-asyncapi Update:
The "nestjs-asyncapi" entry now features an updated title, description, and repository URL. One minor note: the language filter is set to"Typescript"(line 81), but for consistency across the codebase it is recommended to use"TypeScript".Example diff:
- "language": "Typescript", + "language": "TypeScript",
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
config/all-tags.json(1 hunks)config/tools-automated.json(17 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (6)
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Test NodeJS PR - macos-13
- GitHub Check: Lighthouse CI
🔇 Additional comments (15)
config/all-tags.json (1)
1-44: Visual Styling Update for Tags:
The complete JSON content has been replaced to update the visual presentation of technology tags. The new color and borderColor values (for example, for "Scala", "Jenkins", "Flask" set tobg-[#D7C7F2]/border-[#A387D2]and several others tobg-[#61d0f2]/border-[#40ccf7]) appear consistent and aligned with the new design guidelines.config/tools-automated.json (14)
5-26: APIs Section – SIO-AsyncAPI Tool Update:
The first tool entry under the "APIs" section now uses the title "SIO-AsyncAPI" with an updated description and GitHub links. The filters correctly designate the language as "Python" and list the relevant technologies ("Socket.IO", "Flask"). Please verify that its inclusion here (separate from similar entries later) is intentional.
27-46: APIs Section – AsyncAPI Server API Update:
The second tool entry now titled "AsyncAPI Server API" provides updated website, documentation, and repository URLs. The filter setting"isAsyncAPIOwner": trueis appropriate for an official API entry.
53-72: Code-first Tools – AsyncAPI.Net Entry:
The "AsyncAPI.Net" tool has an updated description and revised repository links. Its filters now indicate the C# language with ".NET" and "ASP.NET" as associated technologies, along with the categories "converters," "code-first," and "validator."
94-113: Code-first Tools – SIO-AsyncAPI Duplicate Entry:
Another "SIO-AsyncAPI" tool entry is present in the Code-first Tools section (lines 94–113) with the same details as in the APIs section. If listing the tool in multiple categories is intentional, please ensure that its duplication is clearly differentiated in any UI or filtering logic.
116-136: Code-first Tools – Zod Sockets Information Update:
The "Zod Sockets" entry reflects updated title, description, and repository information. The filters correctly indicate"TypeScript"as the language. No issues are observed; just confirm that the tool’s capabilities (I/O validation and AsyncAPI specification generation) are fully communicated in its documentation.
143-167: Code Generators – ZenWave SDK Update:
The "ZenWave SDK" tool now offers streamlined details with updated links and a clear description. The filters list "Java" along with related technologies and categories, providing clear guidance for users looking for code generation support.
205-222: Code Generators – asyncapi-python Reversion:
The "asyncapi-python" entry has been reverted to its original description and repository links. The filters (language set to"python"and technology"amqp") now appear to correctly represent the tool’s functionality.
337-357: DSL Section – Zod Sockets Entry:
The DSL category now includes a "Zod Sockets" tool entry (lines 337–357) with updated links and filters. Note that this tool also appears in the Code-first Tools section; please confirm that the dual listing is intentional to improve discoverability.
499-518: Validators – AsyncAPI.Net Update:
The "AsyncAPI.Net" entry under Validators has updated links and description that now match those in the Code-first Tools section. The filter settings (language"C#", technologies".NET"and"ASP.NET") are consistent.
521-537: Validators – AsyncAPI Validation Update:
The "AsyncAPI Validation" tool now describes a message validation package with updated repository links and filter settings (language"TypeScript"and technology"Node.js"). This naming swap with the "AsyncAPI.Net" entry should be double-checked to ensure that the intended functionality is correctly represented.
697-715: IDE Extensions – jAsyncAPI - IDEA Plugin Update:
The "jAsyncAPI - IDEA plugin" entry now includes refreshed repository, website, and documentation URLs along with updated filter values (language"Kotlin", technologies"JetBrains"and"IntelliJ IDEA"). This update improves clarity for users targeting JetBrains IDEs.
745-761: Generator Templates – HTML Template Update:
The "HTML Template" entry shows updated repository links and a refined description. The language is currently set to"javascript", which may be acceptable for a template generating static docs that use web components. Just verify that this choice aligns with the intended categorization.
763-779: Generator Templates – Node.js Websockets Template Update:
The "Node.js Websockets Template" entry has updated details and repository links. The filters appear consistent with the tool’s purpose, and no issues were observed.
781-797: Generator Templates – Node.js Multiprotocol Template Update:
The "Node.js Multiprotocol Template" provides a detailed description and updated repository link along with appropriate filters. Everything appears to be in order for this tool’s multi-protocol capabilities.
| "title": "GitHub Action for Generator", | ||
| "description": null, | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/github-action-for-cli" | ||
| "repoUrl": "https://github.com/actions-marketplace-validations/asyncapi_github-action-for-generator" | ||
| }, | ||
| "filters": { | ||
| "technology": [ | ||
| "AsyncAPI CLI" | ||
| "AsyncAPI Generator" | ||
| ], | ||
| "categories": [ | ||
| "github-action" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": true | ||
| "isAsyncAPIOwner": false | ||
| } |
There was a problem hiding this comment.
GitHub Actions – Incomplete Description:
The second tool in the "GitHub Actions" section (lines 426–440) now has a null description. A missing description can affect usability and clarity; please consider adding an appropriate description.
| { | ||
| "title": "AsyncAPI CLI", | ||
| "description": "One CLI to rule them all. \nThis is a CLI that aims to integrate all AsyncAPI tools that you need while AsyncAPI document development and maintainance. \nYou can use it to generate docs or code, validate AsyncAPI document and event create new documents.\n", | ||
| "links": { | ||
| "websiteUrl": "https://www.asyncapi.com/tools/cli", | ||
| "repoUrl": "https://github.com/hkirat/asyncapi-fork" | ||
| }, | ||
| "filters": { | ||
| "technology": [ | ||
| "TypeScript" | ||
| ], | ||
| "categories": [ | ||
| "others", | ||
| "cli" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": false | ||
| } | ||
| } | ||
| ] |
There was a problem hiding this comment.
CLIs – Duplicate AsyncAPI CLI Entry:
In the "CLIs" section, there are two entries for "AsyncAPI CLI." The second entry (lines 632–649) points to a different repository (hkirat/asyncapi-fork). This duplication might confuse end users. Consider consolidating these entries or clearly differentiating their intended use cases.
| { | ||
| "title": "AsyncAPI CLI", | ||
| "description": "One CLI to rule them all. \nThis is a CLI that aims to integrate all AsyncAPI tools that you need while AsyncAPI document development and maintainance. \nYou can use it to generate docs or code, validate AsyncAPI document and event create new documents.\n", | ||
| "links": { | ||
| "websiteUrl": "https://www.asyncapi.com/tools/cli", | ||
| "repoUrl": "https://github.com/hkirat/asyncapi-fork" | ||
| }, | ||
| "filters": { | ||
| "technology": [ | ||
| "TypeScript" | ||
| ], | ||
| "categories": [ | ||
| "others", | ||
| "cli" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": false | ||
| } |
There was a problem hiding this comment.
Others – Duplicate AsyncAPI CLI Entry:
The "Others" section includes a second occurrence of "AsyncAPI CLI" (lines 863–880) with a repository link pointing to https://github.com/hkirat/asyncapi-fork. Given its duplication with the "CLIs" section, please verify whether the difference in repository sources is intentional or if the entries should be merged.
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit
Style
Documentation