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

Add sitemap for better support #48

Merged
merged 2 commits into from
Nov 16, 2024
Merged

Add sitemap for better support #48

merged 2 commits into from
Nov 16, 2024

Conversation

5ouma
Copy link
Owner

@5ouma 5ouma commented Nov 16, 2024

⚠️ Issue

close #


✏️ Description

Astro will treat better with the site option.


🔄 Type of the Change

  • 🎉 New Feature
  • 🧰 Bug
  • 🛡️ Security
  • 📖 Documentation
  • 🏎️ Performance
  • 🧹 Refactoring
  • 🧪 Testing
  • 🔧 Maintenance
  • 🎽 CI
  • 🧠 Meta

Astro will treat better with `site` option.
@5ouma 5ouma requested a review from Copilot November 16, 2024 06:22
@prlabeler prlabeler bot added the 🎉 New Feature Introduce a new feature label Nov 16, 2024

Choose a reason for hiding this comment

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

Copilot reviewed 2 out of 3 changed files in this pull request and generated no suggestions.

Files not reviewed (1)
  • package.json: Language not supported
bun.lockb Show resolved Hide resolved
Copy link

codecov bot commented Nov 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a29e6ca) to head (f41b5fb).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #48   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           13        13           
  Lines          172       172           
  Branches        17        17           
=========================================
  Hits           172       172           

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

Copy link
Contributor

github-actions bot commented Nov 16, 2024

🔦 Lighthouse Result

performance accessibility best-practices seo
🟧 75 🟢 100 🟢 100 🟧 63
📊 Score Scale
Fail Average Pass
🔺 0-49 🟧 50-89 🟢 90-100

Copy link

coderabbitai bot commented Nov 16, 2024

Walkthrough

The pull request introduces modifications to the astro.config.ts and package.json files. In astro.config.ts, a new sitemap integration is added, replacing the icon integration, which is then re-added after the AstroPWA configuration. A new site property is introduced, referencing meta.card. The package.json file is updated to include the new dependency @astrojs/sitemap version 3.2.1. These changes enhance site mapping functionality while maintaining existing configurations.

Changes

File Change Summary
astro.config.ts - Added sitemap integration, replacing icon, which is re-added later.
- Introduced new property site in the exported configuration object.
package.json - Added new dependency "@astrojs/sitemap": "3.2.1" in dependencies.

Possibly related PRs

  • Support PWA with Vite #30: The changes in this PR also modify astro.config.ts to enhance PWA capabilities, which is directly related to the configuration updates in the main PR.
  • Allow viewing offline PWA #31: This PR introduces additional configurations in astro.config.ts for PWA functionality, aligning with the integration of the sitemap and other features in the main PR.

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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

@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.

Caution

Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
package.json (1)

17-17: LGTM! Consider using caret version range

The addition of @astrojs/sitemap is appropriate for implementing the sitemap feature. However, consider using the caret version range (^3.2.1) to automatically accept compatible updates while maintaining major version stability.

-    "@astrojs/sitemap": "3.2.1",
+    "@astrojs/sitemap": "^3.2.1",
astro.config.ts (1)

Line range hint 13-35: Consider enhancing PWA configuration for better device support

The current PWA configuration could be improved in several areas:

  1. Consider adding multiple icon sizes for better device compatibility
  2. The cache size limit (2.2MB) seems arbitrary and might need adjustment based on your actual asset sizes

Consider updating the configuration like this:

  AstroPWA({
    manifest: {
      name: meta.name,
      short_name: meta.name,
      description: meta.description,
-     icons: [{ src: meta.icon }],
+     icons: [
+       { src: meta.icon, sizes: "192x192", type: "image/png" },
+       { src: meta.icon, sizes: "512x512", type: "image/png" },
+       { src: meta.icon, sizes: "512x512", type: "image/png", purpose: "maskable" }
+     ],
      orientation: "landscape",
      display: "fullscreen",
      theme_color: "#f4f4f4",
    },
    workbox: {
-     maximumFileSizeToCacheInBytes: 1024 * 1024 * 2.2,
+     maximumFileSizeToCacheInBytes: 3 * 1024 * 1024, // 3MB rounded value
      globPatterns: ["**/*.{html,js,woff2}"],
      navigateFallback: "/",
      runtimeCaching: [
        {
          handler: "NetworkFirst",
          options: { cacheName: "icon" },
          urlPattern: () => true,
        },
      ],
    },
  }),
🛑 Comments failed to post (1)
astro.config.ts (1)

12-12: 🛠️ Refactor suggestion

Consider reordering integrations for optimal sitemap generation

The sitemap integration should typically run last in the integration chain to ensure it captures all routes, including those generated by other integrations.

Apply this diff to reorder the integrations:

const integrations: AstroIntegration[] = [
-  sitemap(),
  AstroPWA({
    // ... PWA config
  }),
  icon(),
+  sitemap(),
];

Also applies to: 36-36

@5ouma 5ouma merged commit 86ac841 into main Nov 16, 2024
13 checks passed
@5ouma 5ouma deleted the feat-astro-sitemap branch November 16, 2024 06:34
@github-actions github-actions bot mentioned this pull request Nov 16, 2024
@coderabbitai coderabbitai bot mentioned this pull request Nov 22, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎉 New Feature Introduce a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant