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

fix(): add textContent into props if brick has default slot #4583

Merged
merged 1 commit into from
Dec 19, 2024

Conversation

weareoutman
Copy link
Member

@weareoutman weareoutman commented Dec 19, 2024

Also support event tags in brick doc comment

依赖检查

组件之间的依赖声明,是微服务组件架构下的重要信息,请确保其正确性。

请勾选以下两组选项其中之一:

  • 本次 MR 没有使用上游组件(例如框架、后台组件等)的较新版本提供的特性。

或者:

  • 本次 MR 使用了上游组件(例如框架、后台组件等)的较新版本提供的特性。
  • 在对应的文件中更新了该上游组件的依赖版本(或确认了当前声明的依赖版本已包含本次 MR 使用的新特性)。

提交信息检查

Git 提交信息将决定包的版本发布及自动生成的 CHANGELOG,请检查工作内容与提交信息是否相符,并在以下每组选项中都依次确认。

破坏性变更是针对于下游使用者而言,可以通过本次改动对下游使用者的影响来识别变更类型:

  • 下游使用者不做任何改动,仍可以正常工作时,那么它属于普通变更。
  • 反之,下游使用者不做改动就无法正常工作时,那么它属于破坏性变更。

例如,构件修改了一个属性名,小产品 Storyboard 中需要使用新属性名才能工作,那么它就是破坏性变更。
又例如,构件还没有任何下游使用者,那么它的任何变更都是普通变更。

破坏性变更:

  • ⚠️ 本次 MR 包含破坏性变更的提交,请继续确认以下所有选项:
  • 没有更好的兼容方案,必须做破坏性变更。
  • 使用了 feat 作为提交类型。
  • 标注了 BREAKING CHANGE: 你的变更说明
  • 同时更新了本仓库中所有下游使用者的调用。
  • 同时更新了本仓库中所有下游使用者对该子包的依赖为即将发布的 major 版本。
  • 同时为其它仓库的 Migrating 做好了准备,例如文档或批量改动的方法。
  • 手动验证过破坏性变更在 Migrate 后可以正常工作。
  • 破坏性变更所在的提交没有意外携带其它子包的改动。

新特性:

  • 本次 MR 包含新特性的提交,且该提交不带有破坏性变更,并使用了 feat 作为提交类型。
  • 给新特性添加了单元测试。
  • 手动验证过新特性可以正常工作。

问题修复:

  • 本次 MR 包含问题修复的提交,且该提交不带有新特性或破坏性变更,并使用了 fix 作为提交类型。
  • 给问题修复添加了单元测试。
  • 手动验证过问题修复得到解决。

杂项工作:

即所有对下游使用者无任何影响、且没有必要显示在 CHANGELOG 中的改动,例如修改注释、测试用例、开发文档等:

  • 本次 MR 包含杂项工作的提交,且该提交不带有问题修复、新特性或破坏性变更,并使用了 chore, docs, test 等作为提交类型。

Summary by CodeRabbit

  • 新功能

    • 增强了事件处理和属性管理功能,支持解析和存储事件详情到清单中。
    • 新增默认插槽检查,允许清单中添加文本内容属性。
  • 依赖更新

    • devDependencies 中添加了新的开发依赖 @types/doctrine,版本为 ^0.0.9

Copy link

coderabbitai bot commented Dec 19, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/build-next-bricks/src/makeBrickManifest.js

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "@next-core/eslint-config-next" to extend from. Please check that the name of the config is correct.

The config "@next-core/eslint-config-next" was referenced from the config file in "/.eslintrc".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

概述

代码变更步骤

Walkthrough

本次变更涉及两个主要文件:package.jsonpackages/build-next-bricks/src/makeBrickManifest.js。在 package.json 中,添加了一个新的开发依赖 @types/doctrine。在 makeBrickManifest.js 文件中,增强了事件处理和属性管理功能,新增了对事件标签的处理逻辑,并为具有默认插槽的组件添加了文本内容属性。

变更详情

文件 变更说明
package.json devDependencies 中添加 @types/doctrine@^0.0.9 依赖
packages/build-next-bricks/src/makeBrickManifest.js 1. 新增事件标签处理逻辑
2. 为具有默认插槽的组件添加 textContent 属性

📜 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 6199dc4 and 79a40ec.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (2)
  • package.json (1 hunks)
  • packages/build-next-bricks/src/makeBrickManifest.js (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • package.json
  • packages/build-next-bricks/src/makeBrickManifest.js

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.

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

Files not reviewed (1)
  • package.json: Language not supported
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.

Actionable comments posted: 0

🧹 Nitpick comments (2)
packages/build-next-bricks/src/makeBrickManifest.js (2)

108-121: 代码实现良好,建议补充文档说明

事件标签的处理逻辑实现完整,包含了适当的错误处理。建议在代码注释中添加示例,说明如何正确使用 @event 标签。

建议添加如下示例注释:

 // 主动声明原生事件,例如 eo-button 构件的 click 事件
+/**
+ * 示例:
+ * @event click - 当按钮被点击时触发
+ */

135-143: 建议完善 textContent 属性的实现

当前实现有以下几点可以改进:

  1. 建议将描述文本抽取为常量,便于后续国际化
  2. 需要在 manifest.types 中添加对应的类型注解

建议按如下方式修改:

+const TEXT_CONTENT_DESCRIPTION = "文本内容";
+
 // 如果有默认插槽,代表有默认属性 textContent
 const hasDefaultSlot = manifest.slots.some((slot) => !slot.name);
 if (hasDefaultSlot) {
   manifest.properties.push({
     name: "textContent",
     type: "string",
-    description: "文本内容",
+    description: TEXT_CONTENT_DESCRIPTION,
   });
+  manifest.types.properties.push({
+    name: "textContent",
+    annotation: {
+      type: "keyword",
+      value: "string",
+    },
+  });
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 05dcac8 and 6199dc4.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (2)
  • package.json (1 hunks)
  • packages/build-next-bricks/src/makeBrickManifest.js (2 hunks)
🔇 Additional comments (1)
package.json (1)

46-46: 建议验证是否有更新的版本可用

@types/doctrine 的版本 0.0.9 相对较旧,建议检查是否有更新的版本以获得更完整的类型定义支持。

✅ Verification successful

@types/doctrine 0.0.9 是最新版本,无需更新

经验证,@types/doctrine 的最新版本就是 0.0.9,虽然版本号较低但确实是当前最新的类型定义包。主包 doctrine 当前版本为 3.0.0,保持稳定。

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 检查 @types/doctrine 的最新版本
npm view @types/doctrine versions --json | jq -r '.[-1]'

# 检查主包 doctrine 的最新版本
npm view doctrine version

Length of output: 98

Copy link

cypress bot commented Dec 19, 2024

next-core    Run #10842

Run Properties:  status check passed Passed #10842  •  git commit 47a5d11ee8 ℹ️: Merge 79a40ec50c5f7192323cff271781218205b0173b into 05dcac875a88ec5420199db23156...
Project next-core
Branch Review steve/v3-refine-docs
Run status status check passed Passed #10842
Run duration 00m 25s
Commit git commit 47a5d11ee8 ℹ️: Merge 79a40ec50c5f7192323cff271781218205b0173b into 05dcac875a88ec5420199db23156...
Committer Shenwei Wang
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 16
View all changes introduced in this branch ↗︎

Also support event tags in brick doc comment
@qiaofengxi qiaofengxi merged commit c169a27 into v3 Dec 19, 2024
7 checks passed
@qiaofengxi qiaofengxi deleted the steve/v3-refine-docs branch December 19, 2024 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants