-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
chore: update tools.json #4142
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 #4142
Conversation
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThis update modifies several JSON configuration files to swap, correct, and update metadata for various tools and technology tags. Changes include swapping names in technology tags, reorganizing tool entries, updating descriptions, repository URLs, and adjusting categorization and metadata for AsyncAPI-related tools. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant JSON Config
participant Website
User->>JSON Config: Request technology/tool metadata
JSON Config-->>Website: Provide updated tool and technology data
Website-->>User: Display updated names, descriptions, and URLs
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 #4142 +/- ##
=========================================
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: 3
🔭 Outside diff range comments (1)
config/all-tags.json (1)
285-289:⚠️ Potential issueRemove redundant duplicate "SmartPaste" tag
TheSmartPasteentry appears twice in succession, leading to duplicate tags. Please remove the redundant block to maintain a unique list of technologies.Apply this diff:
- { - "name": "SmartPaste", - "color": "bg-[#61d0f2]", - "borderColor": "border-[#40ccf7]" - },
🧹 Nitpick comments (10)
config/tools-automated.json (10)
94-98: Nitpick: Normalize "AsyncApi" to "AsyncAPI" in description
The description uses "AsyncApi" instead of the standard "AsyncAPI" acronym. For consistency, update the casing.Apply:
- "description": "The officially maintained fork of the AsyncAPI.NET SDK contains a useful object model for AsyncAPI documents in .NET along with common (de)serializers to extract raw AsyncApi JSON and YAML documents from the model.", + "description": "The officially maintained fork of the AsyncAPI.NET SDK contains a useful object model for AsyncAPI documents in .NET along with common (de)serializers to extract raw AsyncAPI JSON and YAML documents from the model.",
165-174: Optional: Use consistent language tag ("Go" vs "golang")
Thelanguagefield is set to "golang", whereas other Go entries use "Go". Consider normalizing to "Go" for consistency.Apply:
- "language": "golang", + "language": "Go",
180-190: Optional: Normalize casing and URL consistency
- Change
"language": "python"to"Python".- Change
"amqp"to"AMQP".- (Optional) Remove trailing slash from
repoUrlfor consistency.Apply:
- "language": "python", + "language": "Python", - "amqp" + "AMQP" - "repoUrl": "https://github.com/G-USI/asyncapi-python/", + "repoUrl": "https://github.com/G-USI/asyncapi-python"
220-239: Optional: Deduplicate repeated "ZenWave SDK" entries
The "ZenWave SDK" tool appears in multiple categories (Code Generators, Mocking and Testing, CLI). Consider maintaining a single definition and filtering bycategoriesrather than duplicating the entire object.
531-547: Optional: Normalize language tag to "Go"
Thelanguagefield is listed as "Go/Golang". For consistency, consider using "Go" only.Apply:
- "language": "Go/Golang", + "language": "Go",
554-574: Optional: Deduplicate repeated "ZenWave SDK" entries
This tool is listed here and in other categories. Consolidate definitions to a single entry with a multi-valuedcategoriesfilter.
607-611: Nitpick: Normalize "AsyncApi" to "AsyncAPI" in description
Mirrors the change in Code-first: correct casing of the AsyncAPI acronym.Apply:
- "description": "The officially maintained fork of the AsyncAPI.NET SDK contains a useful object model for AsyncAPI documents in .NET along with common (de)serializers to extract raw AsyncApi JSON and YAML documents from the model.", + "description": "The officially maintained fork of the AsyncAPI.NET SDK contains a useful object model for AsyncAPI documents in .NET along with common (de)serializers to extract raw AsyncAPI JSON and YAML documents from the model.",
713-717: Optional: Consolidate "Mokapi" descriptions across categories
Thedescriptionfield here duplicates the entry under Mocking and Testing. Consider referencing a single source or pulling common metadata to avoid drift.
754-779: Optional: Deduplicate repeated "ZenWave SDK" entries
As with Code Generators and Mocking and Testing, this CLI entry duplicates the same tool. Use a single definition filtered bycategories.
810-821: Nitpick: Capitalize "IDEA" and standardize naming
- Change
"description": "Idea plugin..."to"description": "IDEA plugin...".- Consider aligning the title to "jAsyncAPI IDEA Plugin" for consistency.
Apply:
- "description": "Idea plugin for the java-asyncapi - Helps to edit and validate AsyncAPI schemas.", + "description": "IDEA plugin for the java-asyncapi – helps edit and validate AsyncAPI schemas.",
📜 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(21 hunks)config/tools.json(3 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (3)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - macos-13
🔇 Additional comments (4)
config/all-tags.json (1)
276-284: Swap "JetBrains" and "SmartPaste" entries
The metadata for the two adjacent technology tags has been correctly swapped.config/tools.json (2)
1771-1778: Enhance Mokapi description with test data generator details
The updated description now highlights Mokapi’s powerful, fully customizable JavaScript-based test data generator—this aligns with the tool’s capabilities.
1841-1844: Correct Specmatic repository URL
TherepoUrlhas been updated to point at the officialspecmatic/specmaticrepository.config/tools-automated.json (1)
514-517:Details
✅ Verification successful
Verify: Corrected Specmatic
repoUrl
TherepoUrlwas updated; ensure the new URL resolves correctly and that thedocsUrlandwebsiteUrlare still valid.Run:
🏁 Script executed:
#!/bin/bash set -e # Verify Specmatic repo URL returns HTTP 200 curl -I https://github.com/specmatic/specmatic | head -n 1Length of output: 508
Let's also verify the
websiteUrlanddocsUrl:
🏁 Script executed:
#!/bin/bash set -e # Verify Specmatic website URL returns HTTP 200 curl -I https://specmatic.io | head -n 1 # Verify Specmatic docs URL returns HTTP 200 curl -I https://specmatic.io/documentation/ | head -n 1Length of output: 768
Specmatic URLs are valid and reachable
All three links—repoUrl,websiteUrl, anddocsUrl—respond with HTTP 200 as expected. No further action required.• config/tools-automated.json (lines 514–517)
| "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": { | ||
| "websiteUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET/", | ||
| "repoUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET" | ||
| "websiteUrl": "https://github.com/LEGO/AsyncAPI.NET/", | ||
| "repoUrl": "https://github.com/LEGO/AsyncAPI.NET" | ||
| }, |
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.
Critical: Description references OpenAPI instead of AsyncAPI
The description for this LEGO fork of the SDK incorrectly mentions "OpenAPI JSON and YAML". It should reference "AsyncAPI JSON and YAML" to accurately describe the SDK.
Apply:
- "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.",
+ "description": "The AsyncAPI.NET SDK contains a useful object model for AsyncAPI documents in .NET along with common serializers to extract raw AsyncAPI JSON and YAML documents from the model.",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "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": { | |
| "websiteUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET/", | |
| "repoUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET" | |
| "websiteUrl": "https://github.com/LEGO/AsyncAPI.NET/", | |
| "repoUrl": "https://github.com/LEGO/AsyncAPI.NET" | |
| }, | |
| "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 AsyncAPI JSON and YAML documents from the model.", | |
| "links": { | |
| "websiteUrl": "https://github.com/LEGO/AsyncAPI.NET/", | |
| "repoUrl": "https://github.com/LEGO/AsyncAPI.NET" | |
| }, |
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 72 to 77, the description
incorrectly mentions "OpenAPI JSON and YAML" instead of "AsyncAPI JSON and
YAML". Update the description text to replace "OpenAPI" with "AsyncAPI" to
accurately reflect the SDK's purpose.
| "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": { | ||
| "websiteUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET/", | ||
| "repoUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET" | ||
| "websiteUrl": "https://github.com/LEGO/AsyncAPI.NET/", | ||
| "repoUrl": "https://github.com/LEGO/AsyncAPI.NET" |
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.
Critical: Description references OpenAPI instead of AsyncAPI
Same issue as in the Code-first category: the description mentions "OpenAPI". Update it to "AsyncAPI".
Apply:
- "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.",
+ "description": "The AsyncAPI.NET SDK contains a useful object model for AsyncAPI documents in .NET along with common serializers to extract raw AsyncAPI JSON and YAML documents from the model.",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "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": { | |
| "websiteUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET/", | |
| "repoUrl": "https://github.com/ByteBardOrg/AsyncAPI.NET" | |
| "websiteUrl": "https://github.com/LEGO/AsyncAPI.NET/", | |
| "repoUrl": "https://github.com/LEGO/AsyncAPI.NET" | |
| "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.", | |
| + "description": "The AsyncAPI.NET SDK contains a useful object model for AsyncAPI documents in .NET along with common serializers to extract raw AsyncAPI JSON and YAML documents from the model.", | |
| "links": { | |
| "websiteUrl": "https://github.com/LEGO/AsyncAPI.NET/", | |
| "repoUrl": "https://github.com/LEGO/AsyncAPI.NET" |
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 585 to 589, the description
incorrectly references "OpenAPI" instead of "AsyncAPI". Update the description
text to replace "OpenAPI" with "AsyncAPI" to accurately reflect the AsyncAPI.NET
SDK's purpose.
| "title": "asyncapi-preview", | ||
| "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": { | ||
| "websiteUrl": "https://plugins.jetbrains.com/plugin/15673-asyncapi", | ||
| "docsUrl": "https://github.com/asyncapi/jasyncapi-idea-plugin#usage", | ||
| "repoUrl": "https://github.com/asyncapi/jasyncapi-idea-plugin" | ||
| "repoUrl": "https://github.com/asyncapi/vs-asyncapi-preview" | ||
| }, | ||
| "filters": { | ||
| "language": "Kotlin", | ||
| "technology": [ | ||
| "JetBrains", | ||
| "IntelliJ IDEA" | ||
| "VSCode", | ||
| "SmartPaste" |
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.
Critical: Fix grammar and title casing
- Title
asyncapi-previewshould be "AsyncAPI Preview" in Title Case. - In the description, change "using you AsyncAPI document" to "using your AsyncAPI document".
Apply:
- "title": "asyncapi-preview",
+ "title": "AsyncAPI Preview",
- "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",
+ "description": "VSCode extension that enables you to:\n - Preview documentation generated using your AsyncAPI document (uses AsyncAPI React under the hood)\n - Create AsyncAPI documents faster using SmartPaste functionality\n",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "title": "asyncapi-preview", | |
| "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": { | |
| "websiteUrl": "https://plugins.jetbrains.com/plugin/15673-asyncapi", | |
| "docsUrl": "https://github.com/asyncapi/jasyncapi-idea-plugin#usage", | |
| "repoUrl": "https://github.com/asyncapi/jasyncapi-idea-plugin" | |
| "repoUrl": "https://github.com/asyncapi/vs-asyncapi-preview" | |
| }, | |
| "filters": { | |
| "language": "Kotlin", | |
| "technology": [ | |
| "JetBrains", | |
| "IntelliJ IDEA" | |
| "VSCode", | |
| "SmartPaste" | |
| "title": "AsyncAPI Preview", | |
| "description": "VSCode extension that enables you to:\n - Preview documentation generated using your AsyncAPI document (uses AsyncAPI React under the hood)\n - Create AsyncAPI documents faster using SmartPaste functionality\n", | |
| "links": { | |
| "repoUrl": "https://github.com/asyncapi/vs-asyncapi-preview" | |
| }, | |
| "filters": { | |
| "technology": [ | |
| "VSCode", | |
| "SmartPaste" |
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 831 to 839, update the title from
"asyncapi-preview" to "AsyncAPI Preview" using proper title casing. Also, in the
description, correct the phrase "using you AsyncAPI document" to "using your
AsyncAPI document" to fix the grammar.
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit