chore: update tools.json #4088
chore: update tools.json #4088
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg and
sambhavgupta0705
as code owners
WalkthroughThis update modifies two JSON configuration files. The Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ConfigFiles
User->>ConfigFiles: Reads all-tags.json (now pretty-printed)
User->>ConfigFiles: Reads tools-automated.json (with reorganized entries)
Note over ConfigFiles: No change to data, only improved structure and accuracy
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 #4088 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
🧹 Nitpick comments (6)
config/tools-automated.json (6)
53-64: Ensure URL formatting consistency for AsyncAPI.Net (LEGO) entry
ThewebsiteUrlandrepoUrlfields include trailing slashes. To avoid discrepancies when comparing or validating URLs, consider removing the trailing slash to match the style of other entries.
75-95: Disambiguate duplicate "AsyncAPI.Net" entries
There are two entries titled"AsyncAPI.Net"pointing to different repositories. Consider appending the organization name (e.g.,"AsyncAPI.Net (LEGO)"and"AsyncAPI.Net (ByteBardOrg)") to the titles so users can immediately tell them apart.
423-448: ReviewFrameworksgrouping and redundant filter categories
After deduplication, verify thatZod Sockets’sfilters.categoriesaccurately reflect only its framework role. You may remove"code-first"and"dsl"tags here since the grouping itself conveys its primary function.
629-637: Add awebsiteUrlordocsUrlfor AsyncAPI Diff
This entry only provides arepoUrl. Consider including awebsiteUrlordocsUrl(for example, the hosted documentation on asyncapi.com) to improve discoverability.
715-723: Simplify filter categories for AsyncAPI CLI
UnderCLIs, the"AsyncAPI CLI"entry includes both"others"and"cli". Since it’s already under the CLI section, remove"others"fromfilters.categoriesto streamline filtering.
947-964: Disambiguate duplicate "AsyncAPI CLI" entries underOthers
Two entries share the title"AsyncAPI CLI"but point to different repositories. Consider renaming one (e.g.,"AsyncAPI CLI (fork)") or adding context to help readers differentiate them.
📜 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(18 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (5)
- 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: Lighthouse CI
🔇 Additional comments (1)
config/all-tags.json (1)
1-316: Formatting-only update approved
The file has been pretty-printed for better readability without any semantic changes to the tags.
| "title": "HTML Template", | ||
| "description": "HTML template for AsyncAPI Generator. Use it to generate a static docs. It is using AsyncAPI React component under the hood.", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/java-spring-template" | ||
| "repoUrl": "https://github.com/asyncapi/html-template" | ||
| }, | ||
| "filters": { | ||
| "language": [ | ||
| "javascript" | ||
| ], | ||
| "language": "javascript", | ||
| "technology": [ | ||
| "Springboot", | ||
| "Maven", | ||
| "Gradle" | ||
| "HTML" |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Standardize filters.language for HTML Template
Use "JavaScript" instead of "javascript" for consistency with your tags in config/all-tags.json.
| }, | ||
| { | ||
| "title": "Specmatic", | ||
| "description": "An API contract testing tool that helps ensure the correctness APIs by automatically generating test cases and verifying them against the API spec. It simplifies the process of testing APIs and reduces the likelihood of bugs and compatibility issues.", | ||
| "links": { | ||
| "websiteUrl": "https://specmatic.io", | ||
| "docsUrl": "https://specmatic.io/documentation/", | ||
| "repoUrl": "https://github.com/znsio/specmatic" | ||
| }, | ||
| "filters": { | ||
| "language": "kotlin", | ||
| "technology": [ | ||
| "maven" | ||
| ], | ||
| "categories": [ | ||
| "mocking-and-testing" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": false | ||
| } | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Capitalize language tag for Specmatic
Change "kotlin" → "Kotlin" in filters.language to match the capitalization in config/all-tags.json.
| }, | ||
| { | ||
| "title": "Golang AsyncAPI Code Generator", | ||
| "description": "Generate Go user and application boilerplate from AsyncAPI specifications. Can be called from `go generate` without requirements.\n", | ||
| "links": { | ||
| "repoUrl": "https://github.com/lerenn/asyncapi-codegen" | ||
| }, | ||
| "filters": { | ||
| "language": "golang", | ||
| "categories": [ | ||
| "code-generator" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": false | ||
| } |
There was a problem hiding this comment.
Use standardized language tag for Go code generator
The filters.language value "golang" should be "Go/Golang" to align with the tags defined in config/all-tags.json. This ensures consistent filtering across the site.
| "language": [ | ||
| "javascript" | ||
| ], | ||
| "technology": [ | ||
| "Java" | ||
| "Springboot", |
There was a problem hiding this comment.
Fix filters.language for Java Spring Template
It’s currently set as an array ["javascript"]. Replace it with the string "Java" to accurately reflect the template’s language and conform to your tag definitions.
| "title": "nestjs-asyncapi", | ||
| "description": "Utilize decorators to generate AsyncAPI document utilizing DTOs (similar to @nestjs/swagger) and a web UI.", | ||
| "links": { | ||
| "websiteUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET/", | ||
| "repoUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET" | ||
| "repoUrl": "https://github.com/flamewow/nestjs-asyncapi" | ||
| }, | ||
| "filters": { | ||
| "language": "C#", | ||
| "language": "Typescript", | ||
| "technology": [ | ||
| ".NET", | ||
| "ASP.NET" | ||
| "Node.js", |
There was a problem hiding this comment.
Correct language casing and add a websiteUrl for nestjs-asyncapi
- Change
"Typescript"→"TypeScript"to match your standard tag. - Include a
websiteUrlfield (for example, the npm package page) alongsiderepoUrlto give users direct access to installation or docs.
| "title": "asyncapi-python", | ||
| "description": "Easily generate type-safe and async Python applications from AsyncAPI 3 specifications.", | ||
| "links": { | ||
| "repoUrl": "https://github.com/G-USI/asyncapi-python/", | ||
| "websiteUrl": "https://pypi.org/project/asyncapi-python/" | ||
| }, | ||
| "filters": { | ||
| "language": "python", | ||
| "technology": [ | ||
| "amqp" | ||
| ], | ||
| "categories": [ | ||
| "code-generator" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": false | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Standardize Python language tag casing
The filters.language field uses "python", while other Python tools use "Python". Update to "Python" to maintain consistency in filtering.
| "title": "Node.js Websockets Template", | ||
| "description": "Node.js WebSockets template for the AsyncAPI Generator. It showcases how from a single AsyncAPI document you can generate a server and a client at the same time.", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/java-spring-cloud-stream-template" | ||
| "repoUrl": "https://github.com/asyncapi/nodejs-ws-template" | ||
| }, | ||
| "filters": { | ||
| "language": [ | ||
| "javascript" | ||
| ], | ||
| "language": "javascript", | ||
| "technology": [ | ||
| "Spring Cloud Streams", | ||
| "Maven" | ||
| "Node.js" | ||
| ], | ||
| "categories": [ |
There was a problem hiding this comment.
Correct language tag casing for JavaScript templates
In filters.language, change "javascript" → "JavaScript" (capital 'J' and 'S') to match the standardized tag.
| { | ||
| "title": "Zod Sockets", | ||
| "description": "Socket.IO solution with I/O validation and the ability to generate AsyncAPI specification and a contract for consumers.", | ||
| "links": { | ||
| "websiteUrl": "https://www.npmjs.com/package/zod-sockets", | ||
| "repoUrl": "https://github.com/RobinTail/zod-sockets" | ||
| }, | ||
| "filters": { | ||
| "language": "TypeScript", | ||
| "technology": [ | ||
| "Node.js", | ||
| "TypeScript" | ||
| ], | ||
| "categories": [ | ||
| "code-first", | ||
| "dsl", | ||
| "framework" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": false | ||
| } | ||
| }, |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Prevent duplicate listings of Zod Sockets
Zod Sockets appears under Code-first tools, DSL, and now Frameworks. To avoid confusion, remove it from the DSL and/or Code-first tools sections and rely on its presence in the Frameworks grouping—its filters.categories already capture all roles.
| "language": [ | ||
| "javascript" | ||
| ], | ||
| "technology": [ | ||
| "Node.js" | ||
| "Spring Cloud Streams", |
There was a problem hiding this comment.
Fix filters.language for Java Spring Cloud Stream Template
Similarly, change ["javascript"] → "Java" so that filtering and tags remain accurate.
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit