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

Change to the new components #45

Merged
merged 3 commits into from
Nov 16, 2024
Merged

Change to the new components #45

merged 3 commits into from
Nov 16, 2024

Conversation

5ouma
Copy link
Owner

@5ouma 5ouma commented Nov 16, 2024

⚠️ Issue

close #


✏️ Description

Add new meta properties.


🔄 Type of the Change

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

Email is not needed anymore.
Get data for new page.
@5ouma 5ouma added the 🧨 Breaking Change Includes breaking changes label Nov 16, 2024
@5ouma 5ouma requested a review from Copilot November 16, 2024 05:58
@prlabeler prlabeler bot added the 🎉 New Feature Introduce a new feature label Nov 16, 2024
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 (9d03989) to head (f510d56).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #45   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           17        13    -4     
  Lines          228       167   -61     
  Branches        21        17    -4     
=========================================
- Hits           228       167   -61     

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

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 18 changed files in this pull request and generated 6 suggestions.

Files not reviewed (13)
  • meta.tmpl.json: Language not supported
  • src/components/Contact/Contact.astro: Language not supported
  • src/components/Contact/snapshots/Contact.test.ts.snap: Language not supported
  • src/components/Homepage/Homepage.astro: Language not supported
  • src/components/Homepage/snapshots/Homepage.test.ts.snap: Language not supported
  • src/components/SNS/SNS.astro: Language not supported
  • src/pages/index.astro: Language not supported
  • src/test/snapshots/index.test.ts.snap: Language not supported
  • src/components/Contact/Contact.stories.ts: Evaluated as low risk
  • src/components/Contact/Contact.test.ts: Evaluated as low risk
  • src/components/Contact/story.ts: Evaluated as low risk
  • src/components/Homepage/Homepage.stories.ts: Evaluated as low risk
  • src/components/Homepage/Homepage.test.ts: Evaluated as low risk
Comments skipped due to low confidence (2)

src/libs/sns.ts:21

  • The new URL construction logic may introduce unintended behavior. Verify that the new logic correctly handles both Fediverse and non-Fediverse services.
const url: string = `https://${isFediverse(service) ? id.split('@')[2] : specified.url}/${isFediverse(service) ? `@${id.split('@')[1]}` : id}`;

src/libs/sns.ts:21

  • Ensure that the new URL construction logic is covered by tests to verify its correctness for both Fediverse and non-Fediverse services.
const url: string = `https://${isFediverse(service) ? id.split('@')[2] : specified.url}/${isFediverse(service) ? `@${id.split('@')[1]}` : id}`;

src/types/services.ts Show resolved Hide resolved
src/types/services.ts Show resolved Hide resolved
src/types/services.ts Show resolved Hide resolved
src/types/services.ts Show resolved Hide resolved
src/types/services.ts Show resolved Hide resolved
src/types/services.ts Show resolved Hide resolved
Add new information to the page.
Copy link
Contributor

🔦 Lighthouse Result

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

Copy link

coderabbitai bot commented Nov 16, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces significant changes across multiple files, primarily focusing on the removal of the Contact and Homepage components, along with their associated tests and story definitions. The meta.tmpl.json file has been updated to remove the contacts field and add new fields such as email, sns, and card. Additionally, the SNS component has been integrated, reflecting a shift towards social media links. Changes in the services object also update URL formats for several services. Overall, the modifications streamline the structure and focus on social networking services.

Changes

File Change Summary
meta.tmpl.json Removed contacts array, updated homepage field position, added new fields: email, sns, and card.
src/components/Contact/*.astro Files deleted, including Contact.astro, Contact.stories.ts, and Contact.test.ts, which were related to rendering and testing the Contact component.
src/components/Contact/story.ts File deleted, contained exported constants for various social media services.
src/components/Homepage/*.astro Files deleted, including Homepage.astro, Homepage.stories.ts, and Homepage.test.ts, which were related to rendering and testing the Homepage component.
src/components/Homepage/story.ts File deleted, contained exported constants for URLs.
src/components/SNS/SNS.astro Updated imports and data structure to use getSNS instead of getContact.
src/libs/meta.test.ts Updated test expectations: removed contacts, added expectations for sns and card.
src/libs/sns.ts Renamed contact type to sns, updated getContact to getSNS, modified URL construction logic.
src/pages/index.astro Removed Contact and Homepage components, added Access and SNS components, updated layout and CSS styles accordingly.
src/types/meta.ts Removed contacts property, added email, sns, and card properties.
src/types/services.ts Updated URLs for several services to relative paths, removed Mail service.

Possibly related PRs

  • Initialize the Astro project #1: The main PR modifies the meta.tmpl.json file, while this PR initializes the Astro project and adds repository-related files, which may include the initial structure for JSON files.
  • Add homepage component #7: The main PR introduces new fields in meta.tmpl.json, and this PR adds a homepage component that may utilize the updated metadata structure.
  • Add contact component #9: The main PR removes the contacts field in meta.tmpl.json, and this PR adds a contact component that could be related to how contact information is structured in the metadata.
  • Add index page and default layout template #13: The main PR modifies the structure of meta.tmpl.json, and this PR introduces a default layout template that may utilize the updated metadata.
  • Enhance the TypeScript types #27: The main PR changes the contacts field in meta.tmpl.json, and this PR enhances TypeScript types, which may include types related to the metadata structure.
  • Use snapshot test #41: The main PR modifies meta.tmpl.json, and this PR implements snapshot testing, which could include tests for components that utilize the metadata.
  • Add card component #43: The main PR updates the metadata structure in meta.tmpl.json, and this PR introduces a card component that may display information based on the updated metadata.

Warning

Rate limit exceeded

@5ouma has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 50 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 9d03989 and f510d56.


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.

@5ouma
Copy link
Owner Author

5ouma commented Nov 16, 2024

@coderabbitai full review

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: 2

🧹 Outside diff range and nitpick comments (5)
src/types/meta.ts (1)

8-10: LGTM! Consider adding JSDoc comments.

The type definitions are well-structured and properly use TypeScript features. However, please consider adding JSDoc comments to document:

  • The purpose and expected format of the card field
  • The difference between sns and the old contacts array
  • Any validation requirements for these fields

Example documentation:

export type meta = Readonly<{
  name: string;
  description: string;
  icon: string;
  homepage: string;
+ /** Email address for contact (optional) */
  email?: string;
+ /** Array of social network service links */
  sns: Readonly<{ service: serviceName; id: string }>[];
+ /** Card identifier or URL (format TBD) */
  card: string;
}>;
src/libs/meta.test.ts (1)

11-12: Enhance test coverage for new properties

While the basic type checking is good, consider adding more specific test cases for the new properties:

  1. Verify the structure of items in the sns array
  2. Validate the format of the card string

Consider adding these additional test cases:

test("sns items structure", () => {
  expect(data.sns).toEqual(
    expect.arrayContaining([
      expect.objectContaining({
        name: expect.any(String),
        url: expect.any(String)
      })
    ])
  );
});

test("card string format", () => {
  expect(data.card).toMatch(/^https?:\/\//); // Assuming it's a URL
});
src/components/SNS/SNS.astro (1)

Line range hint 31-40: Consider improving color contrast ratios

The current color mixing implementation might not guarantee sufficient contrast ratios for accessibility.

Consider updating the color mixing to ensure WCAG compliance:

-      color: color-mix(in srgb, var(--accent-color) 20%, var(--foreground));
+      color: color-mix(in srgb, var(--accent-color) 40%, var(--foreground));
       border-color: color-mix(
         in srgb,
-        var(--accent-color) 60%,
+        var(--accent-color) 80%,
         var(--foreground)
       );
src/pages/index.astro (2)

16-24: Consider enhancing list accessibility

While the list structure is good, consider adding role="list" to reinforce semantics, especially useful for screen readers in certain contexts.

-        <ul aria-label="Contacts">
+        <ul aria-label="Contacts" role="list">

41-44: Consider adding larger screen breakpoints

While the mobile breakpoint is good, consider adding optimizations for larger screens (e.g., >64rem) to better utilize available space.

  @media (max-width: 40rem) {
    main,
    #contacts {
      flex-direction: column;
    }
  }
+
+  @media (min-width: 64rem) {
+    main {
+      max-width: 80rem;
+      margin: 2rem auto;
+    }
+  }
🛑 Comments failed to post (2)
src/libs/sns.ts (1)

21-23: 🛠️ Refactor suggestion

Simplify URL construction logic for better readability and performance.

The current implementation:

  1. Splits the ID multiple times unnecessarily
  2. Uses nested ternary operations that reduce readability
  3. Could benefit from intermediate variables for clarity

Consider this refactoring:

-  const url: string = `https://${
-    isFediverse(service) ? id.split("@")[2] : specified.url
-  }/${isFediverse(service) ? `@${id.split("@")[1]}` : id}`;
+  const url: string = isFediverse(service)
+    ? (() => {
+        const [, username, domain] = id.split("@");
+        return `https://${domain}/@${username}`;
+      })()
+    : `https://${specified.url}/${id}`;

This refactoring:

  • Splits the ID only once for Fediverse services
  • Improves readability by separating the logic
  • Uses destructuring for clearer variable names
📝 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.

  const url: string = isFediverse(service)
    ? (() => {
        const [, username, domain] = id.split("@");
        return `https://${domain}/@${username}`;
      })()
    : `https://${specified.url}/${id}`;
src/types/services.ts (1)

9-9: ⚠️ Potential issue

Add HTTPS protocol to service URLs

The URLs for multiple services are missing the HTTPS protocol, which could cause issues with URL handling and is a security best practice. This was previously flagged in earlier reviews but the changes persist.

Apply this diff to add the HTTPS protocol:

-    url: "bsky.app/profile",
+    url: "https://bsky.app/profile",
-    url: "www.facebook.com",
+    url: "https://www.facebook.com",
-    url: "github.com",
+    url: "https://github.com",
-    url: "www.instagram.com",
+    url: "https://www.instagram.com",
-    url: "posts.cv",
+    url: "https://posts.cv",
-    url: "twitter.com",
+    url: "https://twitter.com",

Also applies to: 14-14, 19-19, 24-24, 39-39, 44-44

@5ouma 5ouma merged commit 72e2bea into main Nov 16, 2024
12 checks passed
@5ouma 5ouma deleted the feat-page branch November 16, 2024 06:10
@github-actions github-actions bot mentioned this pull request Nov 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧨 Breaking Change Includes breaking changes 🎉 New Feature Introduce a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant