Skip to content

chore: update plugin prompt #3506

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 11 commits into from
Apr 15, 2025
Merged

chore: update plugin prompt #3506

merged 11 commits into from
Apr 15, 2025

Conversation

liweijie0812
Copy link
Collaborator

@liweijie0812 liweijie0812 commented Feb 26, 2025

🤔 这个 PR 的性质是?

  • 日常 bug 修复
  • 新特性提交
  • 文档改进
  • 演示代码改进
  • 组件样式/交互改进
  • CI/CD 改进
  • 重构
  • 代码风格优化
  • 测试用例
  • 分支合并
  • 其他

🔗 相关 Issue

💡 需求背景和解决方案

📝 更新日志

  • docs(ConfigProvider): 增加 globalConfig API 文档,规范 API 文档顺序

  • feat(Layout): 子组件 Content 新增 content API

  • plugin: 新增ConfigProvider等组件的编辑器提示功能

  • 本条 PR 不需要纳入 Changelog

☑️ 请求合并前的自查清单

⚠️ 请自检并全部勾选全部选项⚠️

  • 文档已补充或无须补充
  • 代码演示已提供或无须提供
  • TypeScript 定义已补充或无须补充
  • Changelog 已提供或无须提供

Copy link
Contributor

github-actions bot commented Feb 26, 2025

完成

Copy link

pkg-pr-new bot commented Feb 26, 2025

Open in StackBlitz

npm i https://pkg.pr.new/tdesign-vue@3506

commit: 7f0ba09

@liweijie0812 liweijie0812 requested a review from Copilot February 27, 2025 23:36
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

PR Overview

This PR updates plugin prompt functionality and documentation by introducing new prop definitions and refining component APIs.

  • Added new prop definitions for Layout (including "direction", "content", and "default") and ConfigProvider (via "globalConfig").
  • Updated component index files and documentation in both Chinese and English to reflect the new APIs.
  • Removed outdated timestamp comments from auto-generated files.

Reviewed Changes

File Description
src/layout/props.ts Added layout prop definitions with a validator for the "direction".
src/config-provider/props.ts Introduced "globalConfig" prop for ConfigProvider.
src/layout/content-props.ts Added new "content" and "default" props for Layout content management.
site/site.config.mjs Updated documentation path for ConfigProvider.
src/config-provider/index.ts Re-exported types and updated imports for ConfigProvider.
src/layout/type.ts Updated layout types with a new TdContentProps interface.
src/config-provider/config-provider.en-US.md Updated English documentation for ConfigProvider API.
src/layout/content.tsx Refactored content rendering to use renderContent and imported props.
src/config-provider/type.ts Added new TdConfigProviderProps interface.
src/layout/layout.en-US.md Updated English documentation for Layout props, including Content.
src/config-provider/config-provider.md Updated Chinese documentation for ConfigProvider API.
src/layout/index.ts Exported new ContentProps type.
src/config-provider/config-provider.tsx Updated to import shared props instead of defining them inline.
src/layout/aside-props.ts Removed outdated timestamp comment.
src/layout/footer-props.ts Removed outdated timestamp comment.
src/layout/header-props.ts Removed outdated timestamp comment.
src/layout/layout.md Updated API documentation for layout with clarified table headers.

Copilot reviewed 21 out of 21 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (3)

src/layout/content-props.ts:16

  • [nitpick] The property name 'default' may be ambiguous because it can conflict with Vue's default slot and is a reserved keyword. Consider renaming it to a more descriptive alternative.
default: {

src/config-provider/config-provider.en-US.md:63

  • [nitpick] Consider using standard English punctuation (e.g. a period) instead of Chinese punctuation for clarity.
global config。Typescript:`GlobalConfigProvider`

src/layout/content.tsx:12

  • [nitpick] Using both 'default' and 'content' as identifiers in the renderContent call can be confusing. Consider clarifying their roles or renaming one for better clarity.
return <main class={`${this.classPrefix}-layout__content`}>{renderContent(this, 'default', 'content')}</main>;

@liweijie0812 liweijie0812 added the 🏃🏻 in progress someone is handling label Mar 7, 2025
@liweijie0812
Copy link
Collaborator Author

/update-snapshot

Copy link
Contributor

⏳ 正在运行快照更新。。。 CI: Open

@uyarn uyarn removed the 🏃🏻 in progress someone is handling label Apr 15, 2025
@uyarn uyarn merged commit df57369 into develop Apr 15, 2025
9 checks passed
@uyarn uyarn deleted the chore/helper branch April 15, 2025 09:41
@github-actions github-actions bot mentioned this pull request Apr 15, 2025
16 tasks
uyarn added a commit that referenced this pull request Apr 15, 2025
* chore: update plugin prompt

* chore: revert change

* chore: update site config

* chore: update helper

* chore(helper): remove t-typograph

* chore: update snapshot

* chore(helper): remove TTooltipLite

* chore: update message docs

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Uyarn <[email protected]>
uyarn added a commit that referenced this pull request Apr 15, 2025
* chore: add default issue labels (#3539)

* chore: update snapshot since dependency bug fix (#3532)

* chore: update snapshot

* chore: update test case

* chore: update snapshot

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* ci(pkg-pr-new): add running conditions (#3541)

* feat(Icon): upgrade tdesign-icons-vue to 0.3.4 (#3546)

* feat(Icon): upgrade tdesign-icons-vue to 0.3.4

* chore: update snapshot

* docs(card): fix card api documentation text (#3548)

* test(Guide): mockDelay time changed from 60s to 200s (#3543)

* chore(vitest): filter log (#3542)

* docs(CONTRIBUTING): improve readability of development workflow section in CONTRIBUTING.md (#3552)

* 优化 CONTRIBUTING.md 内容

1. 添加tdesign-common仓库链接地址,避免在github搜索中浪费时间
2. 优化了一些表达内容,如:"遵循使用"显冗余,去除使用

* 优化 CONTRIBUTING.md 内容

1. 内容和DEVELOP_GUIDE.md 应一致

* docs: optimize usage tips (#3553)

* docs: 优化使用注意事项显示

* docs: 更新英文文档

* feat(Form): support right required mark (#3562)

* feat: support right required mark

* feat: usage

* fix(Select): remote search scene error (#3559)

* fix(Select): remote search scene error

* chore: update snapshot

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix(imageviewer): fix scale precision bug(#3563)

* fix(transfer): ensure nodes with empty children arrays render correctly (#3535)

* chore: upgrade vite to security version (#3564)

* feat(drawer): add DrawerPlugin (#3501)

* feat: drawerPlugin

* chore: className & Demo

* test: update

* fix(select): fix select keys props has content not work  (#3540)

* chore: update plugin prompt and docs content(#3506)

* chore: update plugin prompt

* chore: revert change

* chore: update site config

* chore: update helper

* chore(helper): remove t-typograph

* chore: update snapshot

* chore(helper): remove TTooltipLite

* chore: update message docs

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Uyarn <[email protected]>

* chore: fix site build after upgrading to vite 4+ (#3567)

* chore: update snapshot

* chore: release 1.11.2-naruto

---------

Co-authored-by: 阿菜 Cai <[email protected]>
Co-authored-by: liweijie0812 <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: TDesign bot <[email protected]>
Co-authored-by: betavs <[email protected]>
Co-authored-by: Firebasky <[email protected]>
Co-authored-by: Wesley <[email protected]>
Co-authored-by: hello-ishine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants