-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
chore: update tools.json #4129
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 #4129
Conversation
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThis update modifies three JSON configuration files. It replaces a "Java" technology tag with "JavaScript" in the tags list, reorganizes and corrects tool metadata in the automated tools configuration, and updates tool URLs, descriptions, and category tags in the main tools configuration, including adding a new "Mokapi" tool entry. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Website
participant ConfigFiles
User->>Website: Requests tools/tags data
Website->>ConfigFiles: Loads all-tags.json, tools-automated.json, tools.json
ConfigFiles-->>Website: Returns updated tags and tool metadata
Website-->>User: Displays updated tags and tool listings
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 #4129 +/- ##
=========================================
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: 13
🔭 Outside diff range comments (4)
config/tools.json (1)
1687-1701:⚠️ Potential issueInconsistent category tag for GitHub Action for Generator
The first "GitHub Action for Generator" entry uses"github-actions", which is inconsistent with other action entries ("github-action").Please change:
- "categories": [ - "github-actions" - ], + "categories": [ + "github-action" + ],config/tools-automated.json (3)
251-270:⚠️ Potential issueFix AsyncAPI casing in Converters entry
The description again uses"raw AsyncApi JSON and YAML". Update to"raw AsyncAPI JSON and YAML".
273-292:⚠️ Potential issueCorrect description for LEGO AsyncAPI.NET
This entry still references"OpenAPI JSON and YAML"instead of AsyncAPI. Please correct the description accordingly.
585-604:⚠️ Potential issueFix AsyncAPI casing in Validators entry
The description again references"raw AsyncApi JSON and YAML". It should be"raw AsyncAPI JSON and YAML".
🧹 Nitpick comments (3)
config/tools.json (1)
160-164: Updated ByteBardOrg fork URLs for AsyncAPI.NET
The forked.NETSDK entry correctly references the ByteBardOrg repositories. Consider normalizing title casing betweenAsyncAPI.NetandAsyncAPI.NETfor consistency.config/tools-automated.json (2)
190-204: Refine Go code generator entry
- The
languagefilter is"golang", whereas other Go-based entries typically use"Go"or"Golang"consistently—please standardize.- The description ends with an unnecessary newline (
\n). Consider removing it.
872-881: Minor grammar suggestion for HTML Template
Consider rephrasing to:“HTML template for AsyncAPI Generator. Generates static docs using the AsyncAPI React component.”
This improves clarity and removes the fragment.
📜 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(16 hunks)config/tools.json(12 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (2)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
🔇 Additional comments (15)
config/all-tags.json (1)
260-264: Addition of JavaScript technology tag
This insertion correctly introduces the "JavaScript" tag in the technologies list with colors matching existing tech tags.config/tools.json (7)
128-129: Updated LEGO repository URLs for AsyncAPI.Net
The official.NETSDK entries now point to the correct LEGO organization URL.
860-862: Updated LEGO repository URLs in Converters
The AsyncAPI.Net converter entry has been aligned with the official LEGO repository.
892-896: Updated ByteBardOrg fork URLs in Converters
The forked converter entry now correctly points to ByteBardOrg.
2118-2119: Updated LEGO repository URLs in Validators
The AsyncAPI.Net validator entry now points to the up-to-date LEGO repository.
2150-2154: Updated ByteBardOrg fork URLs in Validators
The forked validator entry correctly references ByteBardOrg.
1770-1809: New Mokapi entry in Mocking and Testing
A "Mokapi" tool has been added with filters includingGo/Golangas the language. Please verify thatGo/Golangcorrectly reflects its implementation; adjust toJavaScriptorTypeScriptif it’s a Node-based tool.
2400-2439: New Mokapi entry in CLIs
This CLI listing mirrors the Mocking and Testing entry. Again, confirm the correct implementation language (Go/Golangvs. JS/TS), and ensure cross-listing is intentional.config/tools-automated.json (7)
116-135: Code-first Zod Sockets metadata looks good
The entry for Zod Sockets under Code-first tools is accurate and consistent with others.
428-447: Frameworks Zod Sockets metadata looks good
The Zod Sockets entry under Frameworks is consistent and well-formed.
652-667: Compare tools addition looks good
The new AsyncAPI Diff entry is well-formed and follows existing patterns.
691-708: New CLIs section & AsyncAPI CLI entry approved
The CLIs category introduction and the AsyncAPI CLI entry are clear, correctly structured, and follow our schema.
912-921: Node.js Websockets Template metadata looks good
This entry is consistent and aligns with the rest of the generator-template section.
972-986: Verify null description for secondary HTML Template
This template’sdescriptionisnull. Is that intentional? If so, please confirm; otherwise, provide a brief description.
989-998: Node.js Multiprotocol Template metadata looks good
The entry is correctly structured and consistent with our generator-template schema.
| "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.
Missing or null description on second GitHub Action entry
The second "GitHub Action for Generator" has "description": null. A descriptive summary is required for tooling UI.
Please provide a meaningful description or remove the null field.
Also applies to: 1722-1722
🤖 Prompt for AI Agents
In config/tools.json at lines 1707 to 1710 and line 1722, the "description"
field for the second "GitHub Action for Generator" entry is set to null, which
is not acceptable for the tooling UI. Replace the null value with a meaningful
descriptive summary of the GitHub Action or remove the "description" field
entirely if no description is available.
| "name": "JavaScript", | ||
| "color": "bg-[#61d0f2]", | ||
| "borderColor": "border-[#40ccf7]" | ||
| } |
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 filters for "Java Template"
The "Java Template" generator is tagged with JavaScript for both language and technology, which contradicts its Java focus.
Please revert the filters to use the Java tag:
- "language": [{ "name": "JavaScript", ... }],
- "technology": [{ "name": "JavaScript", ... }],
+ "language": [{ "name": "Java", ... }],
+ "technology": [{ "name": "Java", ... }],Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In config/tools.json around lines 2835 to 2838, the "Java Template" generator is
incorrectly tagged with "JavaScript" for language and technology filters. Update
these filters to use the "Java" tag instead to correctly reflect its Java focus.
| "title": "Java Template", | ||
| "description": "Java template for the AsyncAPI Generator", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/nodejs-template" | ||
| "repoUrl": "https://github.com/asyncapi/java-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.
Correct language filter for Java Template
The Java Template’s filters.language is ["javascript"]. It should be "Java".
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 930 to 938, the Java Template's
language filter is incorrectly set to "javascript". Change the value of
filters.language from ["javascript"] to ["Java"] to correctly reflect the
template's language.
| "title": "Java Spring Cloud Stream Template", | ||
| "description": "Java Spring Cloud Stream template for the AsyncAPI Generator", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/nodejs-ws-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.
Correct language filter for Java Spring Cloud Stream Template
This entry also has filters.language as ["javascript"]. Please update to "Java".
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 950 to 958, the language filter for
the Java Spring Cloud Stream Template is incorrectly set to "javascript". Change
the value of filters.language from ["javascript"] to ["Java"] to correctly
reflect the template's language.
| "title": "Java Spring Template", | ||
| "description": "Java Spring template for the AsyncAPI Generator", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/java-template" | ||
| "repoUrl": "https://github.com/asyncapi/java-spring-template" | ||
| }, | ||
| "filters": { | ||
| "language": [ | ||
| "javascript" | ||
| ], | ||
| "technology": [ | ||
| "Java" | ||
| "Springboot", | ||
| "Maven", | ||
| "Gradle" | ||
| ], |
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.
Correct language filter for Java Spring Template
The filters.language is set to ["javascript"] for a Java Spring template. Please change it to "Java".
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 890 to 903, the filters.language is
incorrectly set to ["javascript"] for the Java Spring Template. Change the value
of filters.language from ["javascript"] to ["Java"] to correctly reflect the
template's language.
| "title": "AsyncAPI.Net", | ||
| "description": "The AsyncAPI.NET SDK contains a useful object model for AsyncAPI documents in .NET along with common serializers to extract raw OpenAPI JSON and YAML documents from the model.", | ||
| "links": { | ||
| "repoUrl": "https://github.com/flamewow/nestjs-asyncapi" | ||
| "websiteUrl": "https://github.com/LEGO/AsyncAPI.NET/", | ||
| "repoUrl": "https://github.com/LEGO/AsyncAPI.NET" | ||
| }, | ||
| "filters": { | ||
| "language": "Typescript", | ||
| "language": "C#", | ||
| "technology": [ | ||
| "Node.js", | ||
| "NestJS" | ||
| ".NET", | ||
| "ASP.NET" | ||
| ], | ||
| "categories": [ | ||
| "code-first" | ||
| "converters", | ||
| "code-first", | ||
| "validator" | ||
| ], | ||
| "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.
Correct description referencing OpenAPI
This entry’s description mentions "raw OpenAPI JSON and YAML" but should refer to AsyncAPI documents. Also, consider aligning the title formatting (AsyncAPI.Net vs. AsyncAPI.NET).
🤖 Prompt for AI Agents
In config/tools-automated.json between lines 94 and 113, update the description
to correctly reference AsyncAPI documents instead of OpenAPI, changing "raw
OpenAPI JSON and YAML" to "raw AsyncAPI JSON and YAML". Also, standardize the
title formatting to match the repository name by changing "AsyncAPI.Net" to
"AsyncAPI.NET".
| "title": "Glee", | ||
| "description": "Glee — The AsyncAPI framework that will make you smile again :)", | ||
| "links": { | ||
| "websiteUrl": "https://www.npmjs.com/package/zod-sockets", | ||
| "repoUrl": "https://github.com/RobinTail/zod-sockets" | ||
| "repoUrl": "https://github.com/asyncapi/glee" | ||
| }, | ||
| "filters": { | ||
| "language": "TypeScript", | ||
| "technology": [ | ||
| "Node.js", | ||
| "TypeScript" | ||
| ], | ||
| "categories": [ | ||
| "code-first", | ||
| "dsl", | ||
| "framework" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": false | ||
| "isAsyncAPIOwner": true | ||
| } |
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.
Add missing language filter for Glee
The Glee framework entry lacks a language field in its filters (all other frameworks include a language). Please add "language": "TypeScript" to align with its implementation.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 450 to 464, the Glee framework entry
is missing the "language" filter in its "filters" object. Add the key "language"
with the value "TypeScript" to the filters section to match the format of other
frameworks and accurately reflect its implementation language.
| "title": "Mokapi", | ||
| "description": "Your API Mocking Tool for Agile Development. Mock and simulate AsyncAPI and OpenAPI services for local testing, development, and CI pipelines — with a visual dashboard to inspect your mocks.", | ||
| "links": { | ||
| "websiteUrl": "https://www.asyncapi.com/tools/cli", | ||
| "repoUrl": "https://github.com/asyncapi/cli" | ||
| "websiteUrl": "https://mokapi.io", | ||
| "docsUrl": "https://mokapi.io/docs/guides/welcome", | ||
| "repoUrl": "https://github.com/marle3003/mokapi" | ||
| }, | ||
| "filters": { | ||
| "language": "Go/Golang", | ||
| "technology": [ | ||
| "TypeScript" | ||
| "JavaScript", | ||
| "TypeScript", | ||
| "Docker" | ||
| ], | ||
| "categories": [ | ||
| "others", | ||
| "mocking-and-testing", | ||
| "cli" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": true | ||
| "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.
Standardize Mokapi language & tech filters in CLIs
Same as the Mocking and Testing entry, the CLIs entry for Mokapi uses "Go/Golang" and omits Go from the technology list. Please unify the language value and include Go where appropriate.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 740 to 760, the Mokapi entry uses
"Go/Golang" for the language filter but omits "Go" from the technology list,
causing inconsistency with the Mocking and Testing entry. Update the "language"
field to use a standardized value consistent with other entries and add "Go" to
the "technology" array to unify the filters across CLI entries.
| "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" | ||
| }, | ||
| "filters": { | ||
| "technology": [ | ||
| "AsyncAPI Generator" | ||
| ], | ||
| "categories": [ | ||
| "github-actions" | ||
| "github-action" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": true | ||
| "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.
Unify GitHub Actions category naming
As above, the second GitHub Action for Generator uses "github-action". Please align with the chosen convention (e.g., "github-actions") for both entries.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 489 to 503, the category naming for
GitHub Actions is inconsistent, using "github-action" instead of the preferred
"github-actions". Update the "categories" array to replace "github-action" with
"github-actions" to unify the naming convention across all entries.
| "title": "Mokapi", | ||
| "description": "Your API Mocking Tool for Agile Development. Mock and simulate AsyncAPI and OpenAPI services for local testing, development, and CI pipelines — with a visual dashboard to inspect your mocks.", | ||
| "links": { | ||
| "websiteUrl": "https://mokapi.io", | ||
| "docsUrl": "https://mokapi.io/docs/guides/welcome", | ||
| "repoUrl": "https://github.com/marle3003/mokapi" | ||
| }, | ||
| "filters": { | ||
| "language": "Go/Golang", | ||
| "technology": [ | ||
| "JavaScript", | ||
| "TypeScript", | ||
| "Docker" | ||
| ], | ||
| "categories": [ | ||
| "mocking-and-testing", | ||
| "cli" | ||
| ], | ||
| "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.
Standardize Mokapi language & tech filters
- The
languageis"Go/Golang", which deviates from our single-value convention. Choose"Go"or"Golang". - The
technologylist omits Go altogether and instead lists JavaScript/TypeScript. Please include Go and remove or adjust JS/TS if not applicable.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 557 to 577, the "language" filter
for Mokapi should be standardized to a single value, either "Go" or "Golang".
Also, update the "technology" array to include "Go" and remove "JavaScript" and
"TypeScript" if they are not relevant to Mokapi. Ensure the filters accurately
reflect the primary language and technologies used by Mokapi.
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit
New Features
Bug Fixes
Style