Skip to content
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

fix: specification explorer layout issue by bumping schyma #3442

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

catosaurusrex2003
Copy link

@catosaurusrex2003 catosaurusrex2003 commented Dec 2, 2024

The issue was fixed in this PR AceTheCreator/schyma#5

Related issue(s)
#3334

Summary by CodeRabbit

  • Chores
    • Updated the schyma package version to improve performance.
    • Added fast-xml-parser to enhance XML parsing capabilities.
    • Cleaned up the devDependencies by removing the previous entry for fast-xml-parser.

Copy link

coderabbitai bot commented Dec 2, 2024

Walkthrough

The changes in this pull request involve updates to the package.json file for the @asyncapi/website project. The version of the schyma package has been upgraded from ^1.0.4 to ^1.0.5, and the fast-xml-parser package has been added to the devDependencies with version ^4.5.0. Additionally, a previous entry for fast-xml-parser has been removed from devDependencies, indicating a reorganization of dependencies. No other sections of the package.json were altered.

Changes

File Change Summary
package.json Updated schyma version from ^1.0.4 to ^1.0.5; added fast-xml-parser with version ^4.5.0; removed previous entry for fast-xml-parser.

Suggested labels

ready-to-merge

🐰 In the garden, hops a little hare,
With updates and changes, we dance in the air.
Dependencies shift, like leaves in the breeze,
A sprinkle of code, oh how it does please!
From 1.0.4 to 1.0.5, we cheer with delight,
Fast-XML's here, making everything right! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link

netlify bot commented Dec 2, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 52c7cf5
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/674f4c1ec7938e000817a5fb
😎 Deploy Preview https://deploy-preview-3442--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Dec 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.77%. Comparing base (ef509bd) to head (52c7cf5).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3442   +/-   ##
=======================================
  Coverage   67.77%   67.77%           
=======================================
  Files          21       21           
  Lines         664      664           
=======================================
  Hits          450      450           
  Misses        214      214           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9e3696c and 9e03e7e.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • package.json (2 hunks)
🔇 Additional comments (1)
package.json (1)

113-113: Verify the schyma version bump resolves the layout issue.

The version bump of schyma to ^1.0.5 aligns with the PR objective to fix the specification explorer layout issue.

Let's verify this change:

@@ -151,13 +151,13 @@
"eslint-plugin-storybook": "^0.8.0",
"eslint-plugin-tailwindcss": "^3.14.2",
"eslint-plugin-unused-imports": "^3.1.0",
"fast-xml-parser": "^4.5.0",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

The fast-xml-parser addition is unrelated to the specification explorer layout fix

The fast-xml-parser package is being used in the RSS feed testing functionality (tests/build-rss.test.js) to validate XML output from the RSS feed generator. This change appears to have been accidentally included in this PR as it's unrelated to the specification explorer layout fix. It should be moved to a separate PR focused on RSS feed functionality.

🔗 Analysis chain

Clarify the addition of fast-xml-parser.

The addition of fast-xml-parser to devDependencies seems unrelated to the specification explorer layout fix. Please clarify if this change is intentional and necessary for this PR.

Let's check if this dependency is related to schyma or the layout fix:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if fast-xml-parser is a dependency of schyma or used in related files

# Check if fast-xml-parser is a dependency of schyma
curl -s https://registry.npmjs.org/schyma/1.0.5 | jq -r '.dependencies["fast-xml-parser"] // empty'

# Search for fast-xml-parser usage in the codebase
rg -l "fast-xml-parser" --type js --type ts

Length of output: 169


Script:

#!/bin/bash
# Let's check the content of the test file to understand the usage
cat tests/build-rss.test.js

# Let's also check for any recent changes related to RSS or XML parsing
git diff HEAD~1 tests/build-rss.test.js

# Check if there are any other XML-related files
rg -l "\.xml" --type js --type ts

Length of output: 6117


Script:

#!/bin/bash
# Let's check the recent changes to see if RSS functionality was added
git diff HEAD~1 scripts/build-rss.js

# Check the PR description or commit messages for context
git log -1 --pretty=%B

# Let's also check if there are any layout-related changes
rg -l "layout" --type js --type ts

Length of output: 1068


Script:

#!/bin/bash
# Let's check the content of the build-rss.js script to see if it's a new addition
cat scripts/build-rss.js

# Let's also check for any changes in the package.json related to RSS or XML
git diff HEAD~1 package.json

Length of output: 4290

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Dec 2, 2024

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 36
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3442--asyncapi-website.netlify.app/

@catosaurusrex2003 catosaurusrex2003 marked this pull request as draft December 2, 2024 14:06
@catosaurusrex2003 catosaurusrex2003 marked this pull request as ready for review December 2, 2024 14:34
@akshatnema
Copy link
Member

img

@catosaurusrex2003 I don't see any errors in the current website.

@catosaurusrex2003
Copy link
Author

@akshatnema
did u follow the instruction to reproduce the bug mentioned in this issue: #3334 (comment)

If you're still unable to reproduce the issue, could you please let me know what browser you're using? 👀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants