-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
chore: update tools.json #4157
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 #4157
Conversation
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThe changes involve swapping the names and metadata of specific technology tags and tool entries within three JSON configuration files. These updates adjust names, descriptions, URLs, and ownership flags for accuracy and consistency, without altering the underlying structure or adding/removing entries. Changes
Sequence Diagram(s)sequenceDiagram
participant ConfigEditor as Config Editor
participant JSONFiles as JSON Config Files
ConfigEditor->>JSONFiles: Swap technology tag names
ConfigEditor->>JSONFiles: Swap tool entry metadata (names, URLs, ownership)
ConfigEditor->>JSONFiles: Update descriptions and reorder entries
JSONFiles-->>ConfigEditor: Updated configuration files
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 #4157 +/- ##
=========================================
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: 6
🧹 Nitpick comments (3)
config/tools-automated.json (3)
75-94: Refactor duplicated AsyncAPI.NET entries across categories
ByteBardOrg’s AsyncAPI.NET metadata is repeated identically in Code-first tools, Converters, and Validators. Consider extracting a shared reference or templating to DRY up this JSON.Also applies to: 251-270, 585-604
119-135: Normalize casing of "TypeScript"
Thelanguagefield is spelled"Typescript"here, but elsewhere uses"TypeScript". Please unify on"TypeScript".
138-157: Unify title and casing for LEGO AsyncAPI.Net entries
Entries titled"AsyncAPI.Net"(LEGO fork) and"AsyncAPI.NET"(ByteBardOrg fork) differ only by casing in title, leading to confusion. Please standardize titles (e.g., use.NETconsistently) and clearly differentiate forks.Also applies to: 273-292, 625-644
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
config/all-tags.json(3 hunks)config/tools-automated.json(18 hunks)config/tools.json(6 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (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: Test NodeJS PR - windows-latest
- GitHub Check: Test NodeJS PR - macos-13
- GitHub Check: Test NodeJS PR - ubuntu-latest
- GitHub Check: Lighthouse CI
🔇 Additional comments (17)
config/all-tags.json (2)
181-184: Verify technology tag swap for Socket.IO and TypeScript
The entries for "Socket.IO" and "TypeScript" have been swapped in the technologies list. Please confirm that this reorder is intentional, consistent across other config files, and doesn’t introduce duplicates or break any consumer logic.Also applies to: 186-189
276-279: Verify technology tag swap for SmartPaste and JetBrains
The "SmartPaste" and "JetBrains" entries were swapped in the array. Ensure this change aligns with the metadata in other config files and doesn't cause duplicate tag definitions.Also applies to: 286-289
config/tools.json (3)
2352-2356: Official AsyncAPI CLI URL is correct
TherepoUrlnow points togithub.com/asyncapi/cli, which aligns with the official repository.
2578-2582: Official asyncapi-preview URL is correct
TherepoUrlpoints to the officialgithub.com/asyncapi/vs-asyncapi-previewrepository and looks good.
3033-3036: Official AsyncAPI CLI URL in Others is correct
TherepoUrlpoints to the officialgithub.com/asyncapi/clirepository and aligns with expectations.config/tools-automated.json (12)
5-25: Approve SIO-AsyncAPI metadata in "APIs" category
Entry for SIO-AsyncAPI has accurate links, filters, and ownership flags. The swap to this section aligns with the PR’s intention.
28-45: Approve AsyncAPI Server API metadata
The Server API entry now correctly setsisAsyncAPIOwnerto true and the technology filters are accurate.
53-72: Approve Zod Sockets under "Code-first tools"
Metadata for Zod Sockets (language, technology, categories) is consistent and accurate.
180-198: Approve AsyncAPI Modelina update
Modelina entry has correct URLs, filters, and updatedisAsyncAPIOwnerflag.
201-217: Approve asyncapi-python metadata
The Python generator entry correctly reflects repo and PyPI URLs, language, and filters.
607-616: Approve AsyncAPI Validation metadata
Validation tool is accurately listed with correct repo URL, language, and category.
736-754: Approve CLI entries for fork and official AsyncAPI CLI
Both the fork (hkirat/asyncapi-fork) and the official (asyncapi/cli) CLI entries in CLIs and Others have been updated correctly with appropriate ownership flags.Also applies to: 1016-1027, 1035-1047
810-825: Approve asyncapi-preview fork under IDE Extensions
The forked VSCode extension entry correctly setsisAsyncAPIOwnerto false and points to the temporary test repo.
831-843: Approve asyncapi-preview official extension
The official VSCode extension entry is now listed withisAsyncAPIOwner: trueand correct repo URL.
846-858: Approve jAsyncAPI IDEA plugin metadata
Metadata for the IntelliJ IDEA plugin is accurate, including URLs and ownership flag.
911-920: Approve Node.js Multiprotocol Template
Multiprotocol template entry has correctjavascriptlanguage and filter settings.
949-957: Approve Node.js Websockets Template
WebSockets template metadata is correct withjavascriptlanguage and technology filters.
| "websiteUrl": "https://www.asyncapi.com/tools/cli", | ||
| "repoUrl": "https://github.com/asyncapi/cli" | ||
| "repoUrl": "https://github.com/hkirat/asyncapi-fork" | ||
| }, |
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.
Remove or clarify forked AsyncAPI CLI entry
A forked repoUrl (hkirat/asyncapi-fork) appears alongside the official CLI; this duplication can confuse users. Please remove or document the purpose of this fork.
🤖 Prompt for AI Agents
In config/tools.json around lines 2330 to 2332, there is an entry for the
AsyncAPI CLI with a forked repoUrl pointing to hkirat/asyncapi-fork, which
duplicates the official CLI entry and may confuse users. Remove this forked
AsyncAPI CLI entry entirely or add a clear comment explaining the purpose of
this fork to clarify why it is included.
| "description": "VSCode extension that enables you to:\n - Preview documentation generated using you AsyncAPI document. It uses AsyncAPI React component under the hood,\n - Create AsyncAPI documents faster using SmartPaste functionality\n", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/vs-asyncapi-preview" | ||
| "repoUrl": "https://github.com/Savio629/testing2" | ||
| }, |
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.
Remove or clarify test asyncapi-preview repository
The repoUrl for asyncapi-preview points to a personal test repo (Savio629/testing2). This likely shouldn't appear in production config. Please correct it to the official extension or remove the test entry.
🤖 Prompt for AI Agents
In config/tools.json around lines 2553 to 2556, the repoUrl for asyncapi-preview
points to a personal test repository (Savio629/testing2), which is inappropriate
for production. Replace this URL with the official AsyncAPI preview extension
repository URL or remove this test entry entirely from the configuration to
ensure only valid production links are present.
| "websiteUrl": "https://www.asyncapi.com/tools/cli", | ||
| "repoUrl": "https://github.com/asyncapi/cli" | ||
| "repoUrl": "https://github.com/hkirat/asyncapi-fork" | ||
| }, |
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.
Remove or clarify forked AsyncAPI CLI entry in Others
Another forked hkirat/asyncapi-fork appears under "Others". This duplicates the CLI entry with a non-official URL; please remove or justify it.
🤖 Prompt for AI Agents
In config/tools.json around lines 3011 to 3013, there is a duplicate entry for
the AsyncAPI CLI under "Others" with a non-official fork URL. Remove this forked
entry to avoid duplication and confusion, keeping only the official AsyncAPI CLI
entry with the correct URLs.
| "title": "SIO-AsyncAPI", | ||
| "description": "This is code-first approach to generate AsyncAPI specification from Socket.IO server.", | ||
| "links": { | ||
| "websiteUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET/", | ||
| "repoUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET" | ||
| "websiteUrl": "https://github.com/daler-rahimov/sio-asyncapi", | ||
| "docsUrl": "https://github.com/daler-rahimov/sio-asyncapi", | ||
| "repoUrl": "https://github.com/daler-rahimov/sio-asyncapi" | ||
| }, | ||
| "filters": { | ||
| "language": "C#", | ||
| "language": "Python", | ||
| "technology": [ | ||
| ".NET", | ||
| "ASP.NET" | ||
| "Socket.IO", | ||
| "Flask" | ||
| ], | ||
| "categories": [ | ||
| "converters", | ||
| "code-first", | ||
| "validator" | ||
| "api" | ||
| ], | ||
| "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.
Remove duplicate SIO-AsyncAPI in "Code-first tools"
SIO-AsyncAPI appears under both "APIs" and "Code-first tools" with identical metadata. If this is unintentional duplication, please remove one occurrence or differentiate the entries.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 97 to 116, the SIO-AsyncAPI entry is
duplicated under both "APIs" and "Code-first tools" with identical metadata.
Review both sections and remove one of the duplicate entries to avoid
redundancy, or if both are needed, differentiate their metadata to clarify their
distinct purposes.
| "title": "Java Spring Cloud Stream Template", | ||
| "description": "Java Spring Cloud Stream template for the AsyncAPI Generator", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/nodejs-template" | ||
| "repoUrl": "https://github.com/asyncapi/java-spring-cloud-stream-template" | ||
| }, | ||
| "filters": { | ||
| "language": "javascript", | ||
| "language": [ | ||
| "javascript" | ||
| ], |
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.
Incorrect language field in Java Spring Cloud Stream Template
The Java Spring Cloud Stream Template is set to "javascript" but should likely be "Java" (or "java") to reflect its implementation language.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 872 to 880, the "language" field for
the Java Spring Cloud Stream Template is incorrectly set to "javascript". Change
the value of the "language" array to "java" to correctly represent the
implementation language of this template.
| "title": "Java Spring Template", | ||
| "description": "Java Spring template for the AsyncAPI Generator", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/nodejs-ws-template" | ||
| "repoUrl": "https://github.com/asyncapi/java-spring-template" | ||
| }, | ||
| "filters": { | ||
| "language": "javascript", | ||
| "language": [ | ||
| "javascript" | ||
| ], |
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.
Incorrect language field in Java Spring Template
The Java Spring Template lists "javascript" as language. Please update to "Java" to match the template’s runtime.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 967 to 975, the Java Spring Template
incorrectly lists "javascript" as the language. Change the value of the
"language" field from "javascript" to "Java" to correctly reflect the template's
runtime language.
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit