chore: update tools.json #4715
chore: update tools.json #4715
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
princerajpoot20 and
sambhavgupta0705
as code owners
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughConfiguration updates to AsyncAPI tools catalog files involving metadata reorganization: tool entries swapped between sections, repository URLs reallocated across multiple tools, ownership flags toggled, language/technology mappings updated, and descriptions added or revised. New Golang AsyncAPI Code Generator entry added; existing tools renamed or reclassified with adjusted categories. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20–25 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4715 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 799 799
Branches 146 146
=========================================
Hits 799 799 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4715--asyncapi-website.netlify.app/ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (6)
config/tools.json (4)
1349-1428: Remove or clarify AsyncAPI Studio duplicates and null descriptions.Three AsyncAPI Studio entries appear in the Editors section with identical titles but different repositories. The first entry (lines 1349–1373) is the official tool with a full description. The other two entries (lines 1376–1400 and 1403–1428) point to test/dev repositories (
action-test-bedandasync-api-issue) with null descriptions, suggesting they are placeholder or test entries that should not appear in a production tools catalog.Remove the non-official entries or populate their descriptions with context explaining their purpose (e.g., community contributions, archived projects).
2846-2924: Three HTML Template entries with duplicate titles and incomplete metadata.The AsyncAPI Generator Templates section contains three HTML Template entries with different repositories but two have null descriptions. Only the first entry (lines 2846–2870) pointing to the official
asyncapi/html-templatehas a description. The other two entries (lines 2873–2897 and 2900–2924) pointing to community forks have null descriptions.If community forks are intentionally included, populate their descriptions to clarify their purpose and differentiate them from the official template. Otherwise, consider keeping only the official entry and official community-endorsed templates.
487-520: Address redundant tool entries that are identical across sections.SIO-AsyncAPI and ZenWave SDK have byte-identical entries across multiple sections, which creates unnecessary data synchronization risk. For example, SIO-AsyncAPI appears identically in both the APIs section (line 57) and Code-first tools section (line 487), and ZenWave SDK has identical entries across Code Generators (line 847) and DSL (line 1537).
However, Zod Sockets shows legitimate multi-categorization—its entries differ across sections (Code-first section lists only "code-first" category, while DSL and Frameworks sections expand this to include additional categories), suggesting intentional categorization rather than redundancy.
Consolidate identical entries using a reference-based structure or implement a sync mechanism to prevent inconsistencies during updates. Document which tools intentionally appear in multiple sections versus which are data artifacts.
2441-2485: Remove the AsyncAPI CLI entry with the non-existent fork repository or replace with correct URL.The CLIs section contains a duplicate AsyncAPI CLI entry (lines 2464–2484) pointing to
https://github.com/hkirat/asyncapi-fork, which does not exist on GitHub. This same pattern repeats in the Others section. Remove this entry or update the repoUrl with the correct repository if a legitimate fork should be listed. Leaving a non-existent repository link will result in 404 errors for users attempting to access it.config/tools-automated.json (2)
996-1047: HTML Template entries have inconsistent descriptions and ownership flags.Three HTML Template entries appear in AsyncAPI Generator Templates with the first entry (lines 996–1011) being official (isAsyncAPIOwner: true) with a proper description, while the other two (lines 1014–1029 and 1032–1047) are community forks with null descriptions and isAsyncAPIOwner: false.
If community templates are intentionally included to support the ecosystem, document their purpose in the description field. If they are outdated or not actively maintained, consider removing them to reduce catalog clutter and confusion.
740-826: Duplicate and unexplained fork entry reduces clarity for users.The
hkirat/asyncapi-forkrepository is included in tools-automated.json in both the "CLIs" section (line 809) and "Others" section (line 1117) alongside the official AsyncAPI CLI. While theisAsyncAPIOwnerflag correctly differentiates ownership (true for official, false for fork), there is no explanation of the fork's purpose, maintenance status, or why it merits inclusion in the official catalog. The fork repository is active but lacks any description on GitHub. Either remove the duplicate fork entries or add documentation clarifying their purpose and recommendation level.
🧹 Nitpick comments (2)
config/tools-automated.json (2)
210-224: Missing technology field in new Golang AsyncAPI Code Generator entry.The new Golang AsyncAPI Code Generator entry (lines 210–224) lacks a "technology" field. Other entries in the Code Generators section include this field to specify the tech stack (e.g., Docker, Maven). For consistency and discoverability, add a technology array (even if empty) or populate it with relevant technologies (e.g., "Go" or build-related tools if applicable).
1-1137: Clarify source-of-truth data flow and tool inclusion criteria for catalog.This automated PR modifies two related but structurally different JSON files. Several data quality concerns suggest a need for clearer governance:
Duplicate entries: Both files contain multiple entries for the same tool (AsyncAPI CLI, HTML Template, AsyncAPI Studio) with different repositories, but without clear rationale for inclusion of non-official forks.
Incomplete metadata: Non-official fork entries have null descriptions, making it impossible for users to understand their purpose or maintenance status.
Structural divergence: tools.json and tools-automated.json use different data structures, which creates maintenance complexity and potential for sync errors.
Recommendations:
- Define clear criteria for including community tools/forks (e.g., must be actively maintained, must have a description explaining the relationship to the official tool)
- Establish a single source-of-truth file with a documented transformation process to generate the other format
- Add metadata to differentiate official AsyncAPI tools from community contributions (the
isAsyncAPIOwnerflag in tools-automated.json is a good start)- Implement validation to prevent duplicate entries without clear differentiation
I can help you develop a data governance strategy or validation schema for the tools catalog if needed.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
config/tools-automated.json(19 hunks)config/tools.json(7 hunks)
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: cypress-run
- GitHub Check: Test NodeJS PR - macos-latest
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Lighthouse CI
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.