Skip to content

chore: add type=module in sites #3363

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

Merged
merged 1 commit into from
Apr 28, 2025
Merged

chore: add type=module in sites #3363

merged 1 commit into from
Apr 28, 2025

Conversation

kagol
Copy link
Member

@kagol kagol commented Apr 28, 2025

PR

给 sites 增加 "type": "module",便于 Node.js 脚本导入和解析 TinyVue 组件文档。

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Chores
    • Updated project configuration to explicitly use ECMAScript modules in example and documentation packages.
    • Adjusted the order of some dependencies in the documentation package configuration for improved readability.

Copy link

coderabbitai bot commented Apr 28, 2025

Walkthrough

The changes introduce the "type": "module" field to the package.json files in two separate example project directories, thereby designating both as ECMAScript modules (ESM). Additionally, in one package.json, the order of two dependencies was rearranged without altering their versions or any other metadata. No changes were made to scripts, other dependencies, or public/exported entities.

Changes

File(s) Change Summary
examples/sites/demos/pc/app/package.json Added "type": "module" field to specify ECMAScript module usage.
examples/sites/package.json Added "type": "module" field and reordered two dependencies; no version or other changes made.

Poem

In the warren of code, a module appears,
With "type": "module", we hop past old fears.
Packages shuffled, dependencies dance,
ESM bunnies now leap at the chance!
With every new field, our code hops ahead—
A modernized meadow for rabbits to tread.
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ad7174 and 73eb550.

📒 Files selected for processing (2)
  • examples/sites/demos/pc/app/package.json (1 hunks)
  • examples/sites/package.json (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (3)
examples/sites/demos/pc/app/package.json (1)

6-6: Explicit ES module flag added
Adding "type": "module" correctly configures this example to use ESM, enabling Node.js to parse and import TinyVue component documentation.

Please verify that all import statements include explicit file extensions (e.g., import Foo from './Foo.js') and that your target Node.js version supports ESM mode without additional flags.

examples/sites/package.json (2)

3-3: Mark top-level package as ESM
The addition of "type": "module" ensures that the docs site and its tooling (Vite, Node scripts) correctly handle ES module resolution.

Double-check that any existing CommonJS require calls are migrated to import syntax and that your build scripts remain compatible.


37-37: Non-functional dependency reorder
Swapping the order of @opentiny/vue-flowchart and @vueuse/core does not change functionality. This adjustment appears to be solely stylistic.

Also applies to: 52-52


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@github-actions github-actions bot added the chore label Apr 28, 2025
Copy link

Walkthrough: 此PR为sites目录下的package.json文件增加了"type": "module"字段,以便Node.js脚本导入和解析TinyVue组件文档。

Changes:

文件 概述
examples/sites/demos/pc/app/package.json 增加了"type": "module"字段
examples/sites/package.json 增加了"type": "module"字段,并进行了其他字段的调整

@@ -1,5 +1,6 @@
{
"name": "@opentiny/vue-docs",
"type": "module",

Choose a reason for hiding this comment

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

Ensure that adding "type": "module" does not affect any existing scripts or dependencies that might rely on CommonJS modules.

@Issues-translate-bot
Copy link

Bot detected the issue body's language is not English, translate it automatically.


Walkthrough: This PR adds the "type": "module" field to the package.json file under the sites directory, so that the Node.js script can import and parse the TinyVue component documents.

Changes:

Documents Overview
examples/sites/demos/pc/app/package.json Added "type": "module" field
examples/sites/package.json Added "type": "module" field and adjusted other fields

@zzcr zzcr merged commit 666bb0f into dev Apr 28, 2025
9 of 11 checks passed
@zzcr zzcr deleted the kagol/add-type-module-in-sites branch April 28, 2025 06:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants