-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
chore: update tools.json #4181
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 #4181
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe changes update and reorder entries in three JSON configuration files for AsyncAPI tools and technologies. Adjustments include correcting tool metadata, categories, languages, technologies, ownership flags, and repository URLs, removing duplicates, and swapping entries for consistency. No code logic is altered, as the modifications are limited to configuration data for tool listings and references. Changes
Sequence Diagram(s)No sequence diagram generated, as changes are limited to static configuration data. Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (3)
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 project configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4181 +/- ##
=========================================
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:
|
There was a problem hiding this 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
🧹 Nitpick comments (4)
config/tools.json (2)
2354-2354: Clarify community fork entry
The secondary AsyncAPI CLI entry now points to the community fork athttps://github.com/hkirat/asyncapi-fork. Consider distinguishing this in the title or description (e.g., "AsyncAPI CLI (community fork)") to avoid confusion.
3035-3035: Differentiate community fork in "Others"
The community fork entry under Others points tohttps://github.com/hkirat/asyncapi-fork. As above, consider clarifying in the title or description that this is a community-maintained fork.config/tools-automated.json (2)
1016-1028: Suggest differentiating duplicate AsyncAPI CLI title
Two entries under Others share the exact title"AsyncAPI CLI". Consider appending a qualifier (e.g.,"(fork)") to one to avoid user confusion.
1034-1047: Suggest appending qualifier to CLI fork title
The forked CLI entry should be distinguishable from the official one—e.g.,"AsyncAPI CLI (fork)".
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
config/tools-automated.json(18 hunks)config/tools.json(6 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (5)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Test NodeJS PR - ubuntu-latest
- GitHub Check: Test NodeJS PR - macos-13
🔇 Additional comments (23)
config/tools.json (4)
2331-2331: Confirm official CLI repo link
The primary AsyncAPI CLI entry’srepoUrlhas been updated tohttps://github.com/asyncapi/cli. This aligns with the official repository.
2555-2555: Confirm official VSCode extension repo link
The first asyncapi-preview entry’srepoUrlhas been corrected tohttps://github.com/asyncapi/vs-asyncapi-preview. This matches the official extension repository.
2581-2581: Verify second VSCode extension entry
The second asyncapi-preview entry now points athttps://github.com/Savio629/testing2, which looks like a placeholder or test repo. Please confirm this is intentional and replace with the correct extension repository if not.
3012-3012: Confirm official CLI repo link in "Others"
The AsyncAPI CLI entry under Others has been updated tohttps://github.com/asyncapi/cli, matching the official CLI.config/tools-automated.json (19)
72-91: Metadata update forSIO-AsyncAPIlooks good
Reordering the entry under Code-first tools and retaining its Python/Socket.IO/Flask metadata aligns correctly with its purpose.
94-113: Zod Sockets entry approved
The updated description, links, and filter categories (code-first,dsl,framework) accurately reflect the tool’s capabilities.
116-135: AsyncAPI.NET (ByteBardOrg) entry approved
C#/.NET filters and converter/validator tags are correctly applied.
180-203: Verify cross-listing ofZenWave SDK
This tool now appears across multiple categories (Code Generators, DSL, CLIs, Mocking and Testing). Confirm that intentional duplication aligns with the site's taxonomy.Would you like a shell script to list all occurrences of
ZenWave SDKin both configuration files?
225-243: AsyncAPI Modelina metadata approved
Filters, ownership flag, and categorization (code-generator) are correct.
399-423: DSL category entries approved
BothZenWave SDKandZod Socketsare valid domain-specific language tools and have appropriate tags.
443-465: Frameworks category entries approved
GleeandZod Socketsare properly listed as framework-level tools.
531-554: VerifyZenWave SDKunder Mocking and Testing
The SDK again appears here. Please ensure cross-listing is intentional and users can discover it sensibly.
557-577: Mokapi metadata approved
Go/Golang & CLI tags align with the tool’s functionality.
585-600: AsyncAPI Validation entry approved
TypeScript validator metadata is correct.
603-614: AsyncAPI.NET under Validators approved
Reusing the C#/.NET SDK for validation is acceptable given its filter tags.
714-737: VerifyZenWave SDKunder CLIs
Again cross-listed. Confirm this duplication is intended and documented in the UI.
740-760: Mokapi under CLIs approved
CLI tags and description align.
763-779: AsyncAPI CLI fork metadata approved
Forked CLI entry is properly flagged withisAsyncAPIOwner: false.
831-843: asyncapi-preview (fork) metadata approved
Forked extension entry is properly flagged withisAsyncAPIOwner: false.
911-930: Java Spring Template metadata approved
Generator-template tags and links appear correct.
971-986: Node.js Multiprotocol Template approved
All fields match the intended template capabilities.
813-825:Details
✅ Verification successful
asyncapi-preview (official) metadata approved
Official VSCode extension listing looks correct.Ensure the
repoUrlswap forasyncapi-previewis mirrored in the primarytools.json:
🏁 Script executed:
#!/bin/bash echo "Automated config preview URLs:" jq -r '.["IDE Extensions"].toolsList[] | select(.title=="asyncapi-preview") | .links.repoUrl' config/tools-automated.json echo "Primary config preview URLs:" jq -r '.["IDE Extensions"].toolsList[] | select(.title=="asyncapi-preview") | .links.repoUrl' config/tools.jsonLength of output: 545
Configuration Verified: repoUrl Swap Mirrored
Bothconfig/tools-automated.jsonandconfig/tools.jsoninclude the same updatedrepoUrlentries for asyncapi-preview:
- https://github.com/asyncapi/vs-asyncapi-preview
- https://github.com/Savio629/testing2
No further action required.
695-711:Details
✅ Verification successful
AsyncAPI CLI official metadata approved
Official CLI listing is accurate.Please verify that the
repoUrlfor "AsyncAPI CLI" matches betweenconfig/tools-automated.jsonandconfig/tools.json:
🏁 Script executed:
#!/bin/bash echo "Automated config:" jq -r '.CLIs.toolsList[] | select(.title=="AsyncAPI CLI") | .links.repoUrl' config/tools-automated.json echo "Primary config:" jq -r '.CLIs.toolsList[] | select(.title=="AsyncAPI CLI") | .links.repoUrl' config/tools.jsonLength of output: 431
Repository URLs are consistent across automated and primary configs
Bothconfig/tools-automated.jsonandconfig/tools.jsonlist identicalrepoUrlentries for “AsyncAPI CLI”:No discrepancies found—ready to merge.
| "title": "nestjs-asyncapi", | ||
| "description": "Utilize decorators to generate AsyncAPI document utilizing DTOs (similar to @nestjs/swagger) and a web UI.", | ||
| "links": { | ||
| "websiteUrl": "https://www.npmjs.com/package/zod-sockets", | ||
| "repoUrl": "https://github.com/RobinTail/zod-sockets" | ||
| "repoUrl": "https://github.com/flamewow/nestjs-asyncapi" | ||
| }, | ||
| "filters": { | ||
| "language": "TypeScript", | ||
| "language": "Typescript", | ||
| "technology": [ | ||
| "Node.js", | ||
| "TypeScript" | ||
| "NestJS" | ||
| ], | ||
| "categories": [ | ||
| "code-first", | ||
| "dsl", | ||
| "framework" | ||
| "code-first" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": false | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent language casing for nestjs-asyncapi
The language field is set to "Typescript", while other entries use the "TypeScript" spelling. Please standardize the casing to "TypeScript" for consistency across the file.
--- a/config/tools-automated.json
+++ b/config/tools-automated.json
@@ -58,7 +58,7 @@
"filters": {
- "language": "Typescript",
+ "language": "TypeScript",
"technology": [
"Node.js",
"NestJS"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "title": "nestjs-asyncapi", | |
| "description": "Utilize decorators to generate AsyncAPI document utilizing DTOs (similar to @nestjs/swagger) and a web UI.", | |
| "links": { | |
| "websiteUrl": "https://www.npmjs.com/package/zod-sockets", | |
| "repoUrl": "https://github.com/RobinTail/zod-sockets" | |
| "repoUrl": "https://github.com/flamewow/nestjs-asyncapi" | |
| }, | |
| "filters": { | |
| "language": "TypeScript", | |
| "language": "Typescript", | |
| "technology": [ | |
| "Node.js", | |
| "TypeScript" | |
| "NestJS" | |
| ], | |
| "categories": [ | |
| "code-first", | |
| "dsl", | |
| "framework" | |
| "code-first" | |
| ], | |
| "hasCommercial": false, | |
| "isAsyncAPIOwner": false | |
| } | |
| "title": "nestjs-asyncapi", | |
| "description": "Utilize decorators to generate AsyncAPI document utilizing DTOs (similar to @nestjs/swagger) and a web UI.", | |
| "links": { | |
| "repoUrl": "https://github.com/flamewow/nestjs-asyncapi" | |
| }, | |
| "filters": { | |
| "language": "TypeScript", | |
| "technology": [ | |
| "Node.js", | |
| "NestJS" | |
| ], | |
| "categories": [ | |
| "code-first" | |
| ], | |
| "hasCommercial": false, | |
| "isAsyncAPIOwner": false | |
| } |
🤖 Prompt for AI Agents
In config/tools-automated.json between lines 53 and 69, the language field for
the nestjs-asyncapi entry is set to "Typescript" which is inconsistent with
other entries using "TypeScript". Change the value of the language field to
"TypeScript" to maintain consistent casing throughout the file.
6fe75e6 to
ab41668
Compare
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit