feat: add support for relative time formatting

[danielroe]

Implement relative time formatting using Intl.RelativeTimeFormat.

• NuxtTime.vue:
  • Add relative prop to enable relative time formatting.
  • Update formatter computed property to use Intl.RelativeTimeFormat when relative is true.
  • Update formattedDate computed property to use formatter.value.format for relative time.
• script.mjs:
  • Update script to use Intl.RelativeTimeFormat for relative time formatting.
  • Add check for relative attribute to determine if relative time formatting should be used.
• README.md:
  • Add section to mention support for Intl.RelativeTimeFormat.
  • Provide example of using relative prop in <NuxtTime> component.
• e2e.spec.ts:
  • Add test case to cover relative time formatting using relative prop.
• unit.spec.ts:
  • Add unit test to cover relative time formatting using relative prop.

---

For more details, open the Copilot Workspace session.

Summary by CodeRabbit

• New Features

  • Added support for relative time formatting in Nuxt Time using the Intl.RelativeTimeFormat API. Set the relative prop to true to display time relative to the current time, such as "5 minutes ago."

• Tests

  • Added end-to-end and unit tests to verify the correct display of relative time.

[coderabbitai[bot]]

[!WARNING]

Rate limit exceeded

@danielroe has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 18 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

Files that changed from the base of the PR and between ab3b64e6bddb92f158bf9e9da505aca7f19d2962 and 0bc359017026f34e7a0efa295918239fbe49073f.

Walkthrough

The update introduces support for relative time formatting in the Nuxt Time component using the Intl.RelativeTimeFormat API. A new relative property allows users to display timestamps in a relative format, such as "5 minutes ago," enhancing the time display functionality and improving user readability. Additionally, a compatibilityDate property has been added to the Nuxt configuration, and new tests have been implemented to ensure the correct functionality of the relative time feature.

Changes

Files	Change Summary
README.md	Updated documentation with details about the new relative prop for relative time formatting.
playground/nuxt.config.ts	Added compatibilityDate property to indicate version compatibility for the application.
playground/pages/index.vue	Introduced <NuxtTime> component to display relative time format based on the current date and time.
src/runtime/components/NuxtTime.vue	Introduced relative prop and updated formattedDate computed property for conditional time formatting.
test/e2e.spec.ts	Added end-to-end test case to verify the proper display of relative time on a webpage.
test/unit.spec.ts	Added unit test case for relative time display in <NuxtTime> component.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NuxtTimeComponent
    participant IntlRelativeTimeFormat
    participant IntlDateTimeFormat

    User->>NuxtTimeComponent: Load component with date and relative=true
    NuxtTimeComponent->>IntlRelativeTimeFormat: Format date relative to now
    IntlRelativeTimeFormat-->>NuxtTimeComponent: Return relative time string
    NuxtTimeComponent-->>User: Display relative time (e.g., "5 minutes ago")

    User->>NuxtTimeComponent: Load component with date and relative=false
    NuxtTimeComponent->>IntlDateTimeFormat: Format date as absolute
    IntlDateTimeFormat-->>NuxtTimeComponent: Return formatted date string
    NuxtTimeComponent-->>User: Display absolute time (e.g., "2024-07-18 12:00")

Poem

🐇 In the world of time, we took a leap,
Now "5 minutes ago" is yours to keep.
With Intl's magic, the hours flow,
Readable dates, like rivers, now show.
For users and devs, a treat so sweet,
Time's dance made simple, an update neat.
🌟

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 generate interesting stats about this repository and render them as a table. -- @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.