chore: update migrate #3021
chore: update migrate #3021
Conversation
Walkthrough该 PR 主要更新了 NutUI React 的迁移说明文档，将重点由从 1.x 到 2.x 的升级调整为从 2.x 到 3.x 的更新进程。文档中移除了 codemod CLI 工具的升级说明，新增了针对 Babel 导入插件自定义名称函数的介绍，使组件导入路径更加灵活。同时，新增了 Changes
Sequence Diagram(s)sequenceDiagram
participant 开发者 as 开发者
participant Babel as Babel 导入插件
participant NutUI as NutUI React Taro包
开发者->>Babel: 提供自定义名称函数
Babel->>NutUI: 依据自定义规则处理组件导入
NutUI-->>开发者: 返回对应组件
Possibly related PRs
Suggested reviewers
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
added
action:review
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## feat_v3.x #3021 +/- ##
==========================================
Coverage 85.82% 85.82%
==========================================
Files 281 281
Lines 18494 18494
Branches 2803 2803
==========================================
Hits 15873 15873
Misses 2616 2616
Partials 5 5 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
migrate-from-v2.md (1)
178-186:⚠️ Potential issueUploader 组件重大更新
Uploader 组件中移除了内部 ajax 逻辑、多个网络配置 props 及事件触发函数，同时新增了onOverCount、onUploadQueueChange属性和upload方法，并调整了类型定义。此处更新幅度较大，建议确保文档中详细描述每项变更的细节，以及可能的迁移指南和示例，帮助使用者平滑过渡。
🧹 Nitpick comments (11)
migrate-from-v2.md (11)
21-22: 更新不兼容变更说明
新增的说明“从 NutUI React 2.x 到 NutUI React 3.x 存在一些不兼容更新，需要仔细阅读不兼容更新内容，并依次处理。”清晰地提示了升级过程中的关键注意事项，建议确认文档中有更多不兼容示例以帮助开发者理解。
33-46: H5 配置中 customName 函数的更新
在 H5 的 Babel 配置中，新增加的"customName"函数用于生成组件导入路径。请确认返回值@nutui/nutui-react-taro/dist/es/packages/${name.toLowerCase()}符合预期，并与库结构保持一致。
54-66: Taro 配置中 customName 函数的更新
在 Taro 配置中，同样新增了"customName"函数，返回值与 H5 配置保持统一。建议验证此配置在实际项目中能正确解析组件路径，并符合预期。
104-108: Grid 组件更新建议
Grid 组件中将square属性默认值调整为 true，并新增了两个主题变量。然而，列表中第 108 行仅有一个单独的破折号，显得不完整。建议检查是否有遗漏的信息或移除此多余的破折号以优化文档排版。
128-131: NavBar 组件 API 调整说明
移除titleAlign属性并新增title属性，同时说明当存在 children 时采用 left 对齐。该说明清晰，但建议补充示例说明在何种场景下 children 会触发 left 对齐。
138-139: SideNavBar 弃用提醒格式问题
SideNavBar 弃用提醒中使用了强调标记，存在多余的空格 (“** 该组件即将被废弃。请使用 SideBar **”)。建议去除标记内的空格，使其符合 markdownlint MD037 规范，例如改为 “该组件即将被废弃。请使用 SideBar”。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
138-138: Spaces inside emphasis markers
null(MD037, no-space-in-emphasis)
138-138: Spaces inside emphasis markers
null(MD037, no-space-in-emphasis)
164-166: Rate 组件 API 更新
新增了size属性和showScore属性，用于控制图标大小和显示评分文案。建议在文档中添加具体示例，说明这两个属性的使用效果。
172-174: TextArea 组件 API 更新说明
为 TextArea 组件新增了plain与status属性，同时移除了一些基础样式变量。建议在文档中补充如何使用这两个属性及推荐的样式变量示例，便于开发者理解变更影响。
207-208: InfiniteLoading 组件 API 补充
新增了对target属性的说明，用于监听目标元素。建议在文档中添加具体示例，确保用户能理解如何正确使用该属性。
238-240: CountDown 组件新增 type 属性
新增的type属性用于设置组件变体类型，建议补充详细说明及示例，帮助用户理解不同类型之间的差异。
245-247: Empty 组件主题变量调整
移除了--nutui-empty-title-margin-top和--nutui-empty-description-margin-top主题变量。建议在文档中提醒开发者如有需要，可采用新的变量或调整样式策略。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
migrate-from-v2.md(5 hunks)src/packages/backtop/doc.taro.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
migrate-from-v2.md
138-138: Spaces inside emphasis markers
null
(MD037, no-space-in-emphasis)
138-138: Spaces inside emphasis markers
null
(MD037, no-space-in-emphasis)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build
- GitHub Check: test
🔇 Additional comments (8)
migrate-from-v2.md (8)
73-77: 新增组件部分
文档中新增了 “SideBar” 和 “PickerView” 两个组件。建议在后续版本中为这些组件提供详细的使用示例和说明，帮助开发者快速上手。
88-89: Button 组件 API 调整
移除了样式变量--nutui-button-default-font-weight。请确认这一变更不会对现有主题定制产生负面影响，如有必要在变更说明中指出备选方案或升级提示。
120-122: Indicator 组件 API 更新
新增了type和color属性，以及调整了total属性的默认值。建议在文档中补充详细说明和使用示例，帮助用户理解这些变化的目的和使用场景。
134-135: Pagination 组件 itemRender 类型更新
itemRender属性类型已更新为(page: any, index: number) => ReactNode，建议仔细验证此更改对现有用例的兼容性，并在文档中提供相关说明或示例。
194-196: BackTop 组件 Taro 版本更新确认
在 BackTop 的 API 调整中，明确指出 Taro 版本新增了对鸿蒙端的支持，并增加了scrollRes属性。建议确保文档在描述该属性时与其它平台保持一致，并补充说明此属性实际作用。
215-216: Switch 组件属性类型更新
activeText和inactiveText属性的类型更新为ReactNode，这将允许更灵活的文本内容展示。该变更说明明确，建议在后续提供具体示例以展示可定制的效果。
230-231: Badge 组件 API 调整
Badge 组件新增size属性，并移除了color属性，通过 CSS 变量--nutui-badge-background-color实现背景色定制。建议在文档中明确示例，帮助用户快速了解如何进行样式定制。
254-256: Price 组件 API 更新
Price 组件更新中增加了'xlarge'尺寸并新增color属性，用以支持更多价格显示样式。建议检查各平台显示效果是否一致，并在文档中补充示例说明。
| @@ -61,7 +61,7 @@ import { BackTop } from '@nutui/nutui-react-taro' | |||
| | threshold | 页面垂直滚动多高后出现 | `number` | `200` | | |||
| | zIndex | 设置组件页面层级 | `number` | `900` | | |||
| | duration | 设置动画持续时间，为 0 时表示无动画 | `number` | `1000` | | |||
| | scrollRes | 被监听容器滚动时的回调参数，主要用于 rn、鸿蒙端 | `PageScrollObejct` | `-` | | |||
| | scrollRes | 被监听容器滚动时的回调参数 | `PageScrollObejct` | `-` | | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
检查属性类型拼写
在 scrollRes 属性的类型描述中出现了 PageScrollObejct，可能存在拼写错误。建议将其更正为 PageScrollObject，以保持文档的准确性。
-| `PageScrollObejct`
+| `PageScrollObject`📝 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.
| | scrollRes | 被监听容器滚动时的回调参数 | `PageScrollObejct` | `-` | | |
| | scrollRes | 被监听容器滚动时的回调参数 | `PageScrollObject` | `-` | |
Summary by CodeRabbit