refactor: use new `onPrehydrate` hook for implementation

[danielroe]

This is a PR to test using the new onPrehydrate hook. See https://github.com/nuxt/nuxt/pull/27037.

[coderabbitai[bot]]

Walkthrough

The changes involve significant modifications to the build configuration, dependency management, and component logic within the project. The build.config.ts file has had its build:done hook removed, impacting the automatic transformation of scripts. The package.json now specifies a peer dependency on Nuxt version >=3.12.0, while the src/module.ts file has removed file system operations and added compatibility metadata. Additionally, the NuxtTime.vue component has transitioned to using a lifecycle hook for date formatting, eliminating reliance on external scripts. Various tests have also been updated to reflect these changes.

Changes

File(s)	Change Summary
build.config.ts	Removed build:done hook that transformed and output a script file, affecting the build process.
package.json	Removed esbuild dependency; added nuxt as a peer dependency with version >=3.12.0.
src/module.ts	Removed fs/promises import and associated logic; added compatibility metadata for Nuxt >=3.12.0.
src/runtime/components/NuxtTime.vue	Removed import of external script for date formatting; introduced onPrehydrate lifecycle hook for direct date formatting based on HTML attributes. Removed data-n-time attribute from <time> element.
src/script.mjs	Removed functionality for formatting and displaying date and time in HTML elements with data-n-time attributes.
test/e2e.spec.ts	Modified test cases to remove data-prehydrate-id from matched <time> element and simplified regular expression for document.querySelectorAll.
test/unit.spec.ts	Updated expected HTML output in a test case for <NuxtTime> component by removing data-n-time attribute from inline snapshot.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NuxtTime
    participant BuildProcess

    User->>NuxtTime: Request to display time
    NuxtTime->>NuxtTime: onPrehydrate lifecycle hook
    NuxtTime->>NuxtTime: Format date using attributes
    NuxtTime-->>User: Display formatted time

🐇 In a world where code does play,
The scripts have danced and gone away.
No more hooks to bind and tie,
Just clean and clear, oh my, oh my!
With Nuxt we hop, we leap, we cheer,
For every change brings joy, my dear! 🌟

---

Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits

Files that changed from the base of the PR and between c058f8e9d2b26518c4569c0358afa8e26376f3b0 and e96f909b01f9ff52a290e7ce8a05767c10ebf2f6.

Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

Files selected for processing (7)

• build.config.ts (0 hunks)
• package.json (1 hunks)
• src/module.ts (2 hunks)
• src/runtime/components/NuxtTime.vue (2 hunks)
• src/script.mjs (0 hunks)
• test/e2e.spec.ts (2 hunks)
• test/unit.spec.ts (1 hunks)

Files not reviewed due to no reviewable changes (2)

• build.config.ts
• src/script.mjs

Files skipped from review due to trivial changes (1)

• test/unit.spec.ts

Additional comments not posted (9)

src/module.ts (1)

10-12: LGTM!

The addition of the compatibility field in the module's metadata is a great improvement. It clearly communicates the module's compatibility requirements to users, ensuring that it is used with a compatible version of Nuxt.

The specified version range (>=3.12.0) aligns with the PR objective of migrating to the new onPrehydrate hook, which was introduced in Nuxt 3.12.0.

test/e2e.spec.ts (4)

4-4: Verify the magic-regexp package installation and version compatibility.

Please ensure that the magic-regexp package is properly installed and the version is compatible with the project's requirements. If it's a new dependency, make sure to update the package.json file and lock the version to avoid potential breaking changes in the future.

---

15-15: LGTM!

The change aligns with the PR objective and improves the test by focusing on the essential attributes of the <time> element.

---

17-17: LGTM!

Updating the test snapshot is necessary to keep the tests in sync with the component's behavior. The change looks good.

---

24-24: LGTM!

The simplified regular expression makes the test more resilient to minor variations in the document.querySelectorAll function call while still ensuring that the function is being injected into the HTML. This change improves the test's maintainability and reduces the likelihood of false negatives due to small changes in the function's arguments.

package.json (1)

77-79: LGTM!

The addition of the peerDependencies section is a good practice. It clearly communicates the project's compatibility with nuxt versions and ensures that users have the necessary dependencies installed.

The version constraint >=3.12.0 aligns with the PR objective of migrating to the new onPrehydrate hook and provides flexibility in the choice of nuxt version.

src/runtime/components/NuxtTime.vue (3)

2-2: LGTM!

The import statement for the onPrehydrate hook is correct and aligns with the PR objective of migrating to the new hook provided by Nuxt.

---

61-80: Excellent work on migrating to the onPrehydrate hook!

The implementation of the onPrehydrate hook is well-structured and follows best practices. It effectively retrieves the necessary attributes, constructs the options object, and formats the date accordingly. This change enhances the component's self-sufficiency and eliminates the reliance on external scripts, which aligns with the PR objective.

Great job on improving the component's functionality and readability!

---

Line range hint 90-90: Good call on removing the data-n-time attribute.

The removal of the data-n-time attribute from the <time> element streamlines the component's data binding approach. This change contributes to the overall simplification and refactoring effort, making the component more focused and easier to understand.

---

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.

[socket-security[bot]]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected]	None	0	22.4 MB	typescript-bot
npm/[email protected]	environment, eval, filesystem, network, shell, unsafe	+7	6.41 MB	vitebot
npm/[email protected]	None	0	338 B	danielroe
npm/[email protected]	Transitive: environment, filesystem, network, shell, unsafe	+38	10.1 MB	antfu, oreanno, patak, ...1 more
npm/[email protected]	Transitive: environment, eval, filesystem, unsafe	+23	16 MB	posva, soda, yyx990803

View full report↗︎