-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
chore: update tools.json #4108
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 #4108
Conversation
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThis change updates three JSON configuration files: it swaps the "name" values of two adjacent entries in the "technologies" array within Changes
Sequence Diagram(s)No sequence diagram generated, as the changes are limited to data/configuration updates and do not affect control flow or introduce new features. 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
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4108 +/- ##
=========================================
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: 4
🧹 Nitpick comments (7)
config/tools.json (3)
1687-1689: Review first “GitHub Action for Generator” entry
- Description set to
null(1687)- Repo URL changed to marketplace-validations (1689)
- Category remains
"github-action"(1701)A
nulldescription may degrade UX. Consider providing a brief summary or a placeholder to maintain consistency in the listings.Also applies to: 1701-1703
2291-2291: Clarify official AsyncAPI CLI vs fork in CLIs
The first CLI entry uses the officialasyncapi/cli(2291), the second points to the forkhkirat/asyncapi-fork(2315). Ensure documentation explains the difference and that filters (categories, technology tags) clearly distinguish the official tool from community forks.Also applies to: 2315-2315
2905-2906: Avoid duplicate fork entries in Others category
The “Others” section also lists both the official CLI (asyncapi/cli, 2905–2906) and the fork (hkirat/asyncapi-fork, 2929). Consider consolidating these or moving forks to a separate “Community” section to prevent user confusion.Also applies to: 2929-2929
config/tools-automated.json (4)
75-80: Review Zod Sockets category updates and duplication
- In “Code-first tools” (75–80),
Zod Socketsgaineddslandframeworkcategories.- It’s also reintroduced under “DSL” (399–403).
Confirm the dual listing is intentional and reflects different usage contexts; otherwise, remove one to avoid duplication.
Also applies to: 399-403
97-103: Standardizelanguagefield format for SIO-AsyncAPI
TheSIO-AsyncAPIentries use"language": "Python"(string) rather than an array (["Python"]). Align with the rest of the config by using arrays forlanguage.Also applies to: 33-38
671-677: Consolidate AsyncAPI CLI entries
The official CLI (asyncapi/cli) and fork (hkirat/asyncapi-fork) appear in both “CLIs” and “Others.” Consider a single authoritative listing or a dedicated section for community forks, and ensureisAsyncAPIOwneris flagged correctly.Also applies to: 720-722, 951-953, 971-972
826-830: Standardize language casing in Generator Templates
Several templates use lowercase"javascript"(833, 853, 911) while others use arrays. Update all to["JavaScript"]in an array format to maintain consistency and proper filtering.Also applies to: 847-851, 905-909
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
config/all-tags.json(1 hunks)config/tools-automated.json(22 hunks)config/tools.json(13 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (4)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Lighthouse CI
🔇 Additional comments (5)
config/all-tags.json (1)
271-276:Details
✅ Verification successful
Verify the swap of “JetBrains” and “SmartPaste” entries
The entries for “JetBrains” (271) and “SmartPaste” (276) have been swapped. Ensure that this change aligns with how these technology tags are referenced inconfig/tools.jsonandconfig/tools-automated.jsonso filtering by technology continues to work as expected.Run this script to confirm consistency across configs:
🏁 Script executed:
#!/bin/bash # Verify that "JetBrains" and "SmartPaste" are referenced consistently rg -R '"JetBrains"' config rg -R '"SmartPaste"' configLength of output: 868
🏁 Script executed:
#!/bin/bash # Correctly verify that "JetBrains" and "SmartPaste" are referenced in the tools configs rg '"JetBrains"' config/tools.json config/tools-automated.json rg '"SmartPaste"' config/tools.json config/tools-automated.jsonLength of output: 450
All-tags order change is safe
Verified that both “JetBrains” and “SmartPaste” still appear in config/tools.json and config/tools-automated.json; filtering by tag name is unaffected by their order in all-tags.json. No further action required.config/tools.json (3)
128-130: Confirm ByteBardOrg URLs for AsyncAPI.Net in Code-first tools
TheAsyncAPI.Netentry now points to ByteBardOrg (lines 128–130). Verify that this reflects the intended upstream ownership and that all downstream references (e.g., in documentation or other configs) have been updated accordingly.
163-165: Confirm LEGO URLs for AsyncAPI.Net in Code-first tools
The secondAsyncAPI.Netentry now points to LEGO (lines 163–165). Ensure the distinction between ByteBardOrg and LEGO forks is intentional and documented so users are clear which implementation they’re selecting.
860-862: Validate URL swaps for AsyncAPI.Net in Converters
TheAsyncAPI.Netentries in the “Converters” section have swapped their URLs between ByteBardOrg (860–862) and LEGO (895–897). Confirm these are correct and consistent with the corresponding Code-first tools entries.Also applies to: 895-897
config/tools-automated.json (1)
56-58: Confirm AsyncAPI.Net URL swaps across multiple sections
TheAsyncAPI.Netentries in “Code-first tools” (56–58), “Converters” (254–256), and “Validators” (565–567) have swapped between ByteBardOrg and LEGO. Verify these URLs, ensureisAsyncAPIOwnerflags are set correctly, and thatconfig/tools.jsonmirrors these changes.Also applies to: 254-256, 565-567
| "description": "CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!", | ||
| "links": { | ||
| "repoUrl": "https://github.com/actions-marketplace-validations/asyncapi_github-action-for-generator" | ||
| "repoUrl": "https://github.com/asyncapi/cli" |
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.
Resolve category inconsistency on second GitHub Action entry
- Description updated (1708)
- Repo URL switched to
asyncapi/cli(1710) - Category changed to
"github-actions"(1722)
The extra “s” in "github-actions" differs from the first entry’s "github-action" tag. Standardize to one variant to avoid filter fragmentation.
Also applies to: 1722-1723
| "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/daler-rahimov/sio-asyncapi", | ||
| "docsUrl": "https://github.com/daler-rahimov/sio-asyncapi", | ||
| "repoUrl": "https://github.com/daler-rahimov/sio-asyncapi" | ||
| "repoUrl": "https://github.com/flamewow/nestjs-asyncapi" |
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.
Fix casing and tag consistency for nestjs-asyncapi
languageis"Typescript"(147) but should match"TypeScript".technologylists"NestJS"(150) vs elsewhere"Nest Js".
Standardize casing (TypeScript, NestJS) to prevent mismatches in tag filters.
Also applies to: 147-151
| "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": { | ||
| "websiteUrl": "https://modelina.org", | ||
| "docsUrl": "https://github.com/asyncapi/modelina/tree/master/docs", | ||
| "repoUrl": "https://github.com/asyncapi/modelina" | ||
| "repoUrl": "https://github.com/lerenn/asyncapi-codegen" | ||
| }, |
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.
🛠️ Refactor suggestion
Normalize language keys in “Code Generators”
Entries like Golang AsyncAPI Code Generator (165–169) use "golang" and asyncapi-python (206–211) uses "python". Convert these to arrays with proper casing (["Go/Golang"], ["Python"]) to match other entries.
Also applies to: 206-211
| "toolsList": [ | ||
| { | ||
| "title": "GitHub Action for Generator", | ||
| "description": "CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!", | ||
| "description": null, | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/cli" | ||
| "repoUrl": "https://github.com/actions-marketplace-validations/asyncapi_github-action-for-generator" | ||
| }, |
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.
Unify GitHub Actions category tagging
The two GitHub Action for Generator entries have inconsistent categories: "github-action" vs "github-actions". Consolidate to a single tag (e.g., "github-action") for uniform filtering.
Also applies to: 489-493, 499-500
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit