chore: update tools.json #4270
chore: update tools.json #4270
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg and
sambhavgupta0705
as code owners
WalkthroughThis update modifies three configuration files. It swaps the "SmartPaste" and "JetBrains" names in the technologies array, reorganizes and updates tool metadata in Changes
Sequence Diagram(s)sequenceDiagram
participant ConfigEditor as Config Editor
participant AllTags as all-tags.json
participant ToolsAuto as tools-automated.json
participant Tools as tools.json
ConfigEditor->>AllTags: Swap "SmartPaste" and "JetBrains" names
ConfigEditor->>ToolsAuto: Reorganize tool entries, update metadata, add new tools/categories
ConfigEditor->>Tools: Add "The Codegen Project", swap repo URLs/descriptions for existing tools
Estimated code review effort🎯 4 (Complex) | ⏱️ ~35 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
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 #4270 +/- ##
=========================================
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:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4270--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: 1
🔭 Outside diff range comments (5)
config/all-tags.json (1)
276-289: Duplicate technology tags introduce inconsistency
SmartPastenow appears twice (lines 281-284 and 286-289), and the newJetBrainstag (lines 276-279) does not replace any previous occurrence.
Duplicated tags will break any logic relying on a unique set (e.g., filtering or colouring in the UI).Action items
• Keep only one entry per tag.
• Verify there is no earlier hidden duplicate ofJetBrainsto avoid the same issue.config/tools.json (1)
1716-1754: Inconsistent metadata across the two “GitHub Action for Generator” recordsIssues observed:
- Title duplicated twice with divergent content.
- First record (
lines 1716-1735) has an emptydescription, while the second has a meaningful one.- Category key differs:
"github-action"vs"github-actions"(plural).- The first record’s repo URL points to
actions-marketplace-validations/…which appears to be an automated mirror rather than the source; the second points toasyncapi/cli(which isn’t the generator).These discrepancies will confuse catalogue consumers and search filters.
Recommended:
• Pick a single authoritative entry.
• Ensuredescription,categories, andrepoUrlare correct and consistent.
• Use the singular category name already used elsewhere (github-action).config/tools-automated.json (3)
72-92: Avoid confusing duplicate naming for the .NET SDK forksWe now have two separate entries named “AsyncAPI.NET” (this one pointing at ByteBardOrg) and another later named “AsyncAPI.Net” (LEGO fork). Having almost-identical titles will confuse readers and any automated tooling that does look-ups by
title.
Consider appending a short qualifier, for example “AsyncAPI.NET (ByteBard fork)” vs “AsyncAPI.NET (LEGO fork)”, and/or adding a distinguishingidfield.
138-158: Description refers to OpenAPI instead of AsyncAPIThe description for “AsyncAPI.Net” still talks about “extract raw OpenAPI JSON and YAML documents”. That looks copy-pasted from the OpenAPI fork and is misleading for users searching for an AsyncAPI library.
914-933: Wrong language declared for Java templatesBoth “Java Spring Template” and “Java Template” declare
"language": ["javascript"]. This breaks language-based filtering and search. Replace with"Java"(array or string, but value must be correct).
♻️ Duplicate comments (2)
config/tools.json (1)
3104-3108: Second occurrence of the duplicate – please de-duplicateSee previous comment; both need to be tidied to maintain a single source of truth.
config/tools-automated.json (1)
1010-1028: Same language mismatch for Spring Cloud Stream templateThe Spring Cloud Stream template repeats the
"javascript"language value. Correct to"Java"to keep data consistent.
🧹 Nitpick comments (6)
config/tools.json (2)
776-805: Minor polish for the new “The Codegen Project” entryThe
docsUrlcontains a double slash (…org//docs). While most browsers will normalise this, it’s untidy and may break link-equality checks.Please trim the extra
/before merging.
2388-2392: Still duplicated “AsyncAPI CLI” entries after repository swapEven after adjusting one
repoUrl, both entries remain, differing only by the repo. Consider consolidating into a single record with the correct source to prevent UI duplication.config/tools-automated.json (4)
93-114: Consistent casing for language & technology fields
languageis “TypeScript” here, which is correct, but earlier in the same category (nestjs-asyncapi) we use “Typescript”. Normalise the capitalisation (TypeScript) across the whole file to keep filters reliable.
472-486: Inconsistent category token between similar GitHub-Action entriesThe first entry uses
"github-action"while the second uses"github-actions". Down-stream categorisation will treat these as two different groups. Pick one slug (the singular form seems to be used elsewhere).
510-531: Mixed capitalisation in language & category namesSpecmatic entry uses lower-case
"kotlin"and category"CLIs"(plural, capitalised). Elsewhere we use"Kotlin"and"cli". Please align with the established lower-case singular convention.
351-360: ‘React JS’ vs ‘React js’Capitalisation of “React JS” is inconsistent with “React js”. Standardise (prefer “React JS”) to avoid duplicate tags.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
config/all-tags.json(2 hunks)config/tools-automated.json(23 hunks)config/tools.json(8 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: asyncapi-bot
PR: asyncapi/website#0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch
Learnt from: akshatnema
PR: asyncapi/website#3378
File: scripts/markdown/check-markdown.js:1-1
Timestamp: 2024-11-25T18:41:29.632Z
Learning: When updating workflows for the AsyncAPI website repository, use `.github/workflows/if-nodejs-pr-testing.yml` to include environment variables and secrets for Node.js PR testing.
Learnt from: bandantonio
PR: asyncapi/website#3393
File: markdown/blog/socketio-part2.md:506-506
Timestamp: 2024-11-13T20:40:29.580Z
Learning: When performing rebranding updates, there's no need to update the titles of bug reports in `dashboard.json`, even if they contain the old name.
Learnt from: akshatnema
PR: asyncapi/website#3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: scripts/markdown/check-editlinks.js:58-59
Timestamp: 2025-01-08T15:15:00.759Z
Learning: In the AsyncAPI codebase, batch processing operations (like in the Dashboard script and check-editlinks.js) follow a sequential pattern using await in loops, which is the preferred approach for maintaining consistency across the codebase.
config/all-tags.json (1)
Learnt from: bandantonio
PR: #3393
File: markdown/blog/socketio-part2.md:506-506
Timestamp: 2024-11-13T20:40:29.580Z
Learning: When performing rebranding updates, there's no need to update the titles of bug reports in dashboard.json, even if they contain the old name.
config/tools.json (1)
Learnt from: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
config/tools-automated.json (5)
Learnt from: anshgoyalevil
PR: #3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in tests/fixtures/markdown/check-edit-links-data.js intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: bandantonio
PR: #4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Learnt from: anshgoyalevil
PR: #3557
File: tests/markdown/check-edit-links.test.js:20-46
Timestamp: 2025-01-14T14:58:38.076Z
Learning: In the AsyncAPI website codebase, the edit-page-config.json contains a fallback match entry that ensures determineEditLink function always has a valid target.value, making null checks unnecessary.
Learnt from: akshatnema
PR: #3423
File: tests/index.test.js:2-7
Timestamp: 2025-01-18T08:44:43.614Z
Learning: In the AsyncAPI website project, JavaScript test files must include the .ts extension when importing TypeScript files (e.g., require('../scripts/build-rss.ts')). This is a project-specific requirement enforced by the linting rules and build setup, even though it differs from typical Node.js behavior.
Learnt from: akshatnema
PR: #3136
File: tests/fixtures/tools/automated-tools.json:8-9
Timestamp: 2024-11-01T12:48:22.034Z
Learning: In the tests/fixtures/tools/automated-tools.json file, the language field within the filters object can be either a string or an array. Both formats are acceptable and supported in the codebase.
⏰ 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). (7)
- 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: Test NodeJS PR - windows-latest
- GitHub Check: Lighthouse CI
🔇 Additional comments (4)
config/tools.json (2)
2364-2375: Fork URL replaces the official CLI — confirm intent
repoUrlnow targetshkirat/asyncapi-fork.
If this is intentional (e.g., the fork is the canonical home), please also update the title or description to reflect it.
Otherwise, restore the officialasyncapi/clirepository to avoid fragmenting traffic.
3081-3094: Duplicate entry in “Others” category mirrors the CLI duplication aboveSame remarks as for the CLI list: two nearly identical items risk confusing users and skewing statistics. Consolidate or clearly mark the fork if genuinely needed.
config/tools-automated.json (2)
180-198: Questionable technology tags for ModelinaModelina is a library/CLI; listing “React JS” and “Docker” as technologies is misleading. Unless the project now ships a React UI and Docker is required, drop or replace these tags so search results stay relevant.
834-852: JetBrains technologies swapped with VSCode extension belowThe IDEA plugin correctly lists JetBrains tech, but the following VSCode extension entry (
asyncapi-preview) now points to a test repository (Savio629/testing2). Verify that swapping of repo URLs between the official and test bed wasn’t accidental.
| "Code Generators": { | ||
| "description": "The following is a list of tools that generate code from an AsyncAPI document; not the other way around.", | ||
| "toolsList": [ | ||
| { | ||
| "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.
🛠️ Refactor suggestion
Language value “golang” breaks existing filter expectations
Previous tools use “Go” or “Go/Golang”. Introducing a lowercase "golang" variant will fragment filtering in the UI. Pick one spelling (“Go” or “Go/Golang”) and reuse it everywhere.
🤖 Prompt for AI Agents
In config/tools-automated.json between lines 161 and 178, the language value
"golang" is inconsistent with previous entries that use "Go" or "Go/Golang". To
fix this, replace the lowercase "golang" with the consistent spelling "Go" or
"Go/Golang" throughout the file to maintain uniform filtering behavior in the
UI.
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit
New Features
Improvements
Bug Fixes