Skip to content

chore: standardize repository config#361

Open
afc163 wants to merge 27 commits into
masterfrom
codex/standardize-rc-config
Open

chore: standardize repository config#361
afc163 wants to merge 27 commits into
masterfrom
codex/standardize-rc-config

Conversation

@afc163

@afc163 afc163 commented Jun 26, 2026

Copy link
Copy Markdown
Member

Summary

Standardize this rc-component repository as part of the Ant Design rc-component maintenance sweep.

Tracking issue: ant-design/ant-design#58514

Scope

  • Redesign README.md and README.zh-CN.md with centered title, Ant Design ecosystem branding, aligned badges, scoped Bundlephobia badge, install command, Usage, Development, Release, and License sections.
  • Standardize package metadata, GitHub repo metadata, npm package name, package entry fields, types: "./es/index.d.ts", publishConfig, and release flow through @rc-component/np.
  • Align shared dependencies and scripts for React, testing-library, Jest/Vitest where existing, TypeScript, ESLint, Prettier, Less, dumi, father, Husky, lint-staged, and Dependabot.
  • Use the shared react-component/rc-test/.github/workflows/test-utoo.yml@main workflow, React Doctor, Codecov, CodeQL, updated GitHub Actions versions, and guarded Surge preview fallback.
  • Keep Vercel preview configuration compatible with docs-dist output and remove legacy now-build / Cloudflare Pages residue.
  • Keep API docs, demos, tests, TypeScript checks, funding metadata, and npm package files aligned with the repository standardization matrix.

Notes

  • No breaking runtime behavior is intended.
  • React peer dependency ranges are preserved when narrowing them would be a breaking change.
  • secrets: inherit is kept until react-component/rc-test#176 is merged, then it can be narrowed to explicit CODECOV_TOKEN forwarding.

@vercel

vercel Bot commented Jun 26, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
virtual-list Ready Ready Preview, Comment Jun 28, 2026 4:41am

@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown

❌ Deploy failed

PR preview ❌ Failed ❌ Failed
🔗 Preview https://react-component-virtual-list-preview-pr-361.surge.sh (may be unavailable)
📝 Commit552ae56
🪵 LogsView logs
📋 Build log (last lines)
npm warn exec The following package was not found and will be installed: surge@0.27.4

   Running as afc163@gmail.com (Student)

        project: ./docs-dist
         domain: react-component-virtual-list-preview-pr-361.surge.sh
           size: 51 files, 1.7 MB

   Aborted - you do not have permission to publish to react-component-virtual-list-preview-pr-361.surge.sh

🤖 Powered by surge-preview

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

PR 更新了 Virtual List 的站点与发布配置,重写了 README 和中文文档,并同步调整资金、依赖检查、构建部署和多项 GitHub 工作流配置。

Changes

Virtual List 文档与自动化刷新

Layer / File(s) Summary
路径与别名
.dumirc.ts, tsconfig.json
GH_PAGES 下的基础路径计算和 @rc-component/virtual-list 相关路径映射被更新。
构建与发布
.dumirc.ts, package.json, vercel.json, .gitignore, .prettierignore, .fatherrc.ts
包描述、docs-dist 输出、发布脚本、部署配置、忽略规则和 Father 配置被更新。
文档内容
README.md, README.zh-CN.md, docs/index.md, docs/demo/horizontal-scroll.md
README、中文 README、首页标题和示例引用的内容被更新。
仓库设置
.github/FUNDING.yml, .github/dependabot.yml
Funding 配置和 Dependabot 的更新计划被调整。
GitHub Actions
.github/workflows/*
CodeQL、复用测试、React Doctor 和 Surge Preview 工作流被更新。

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

我是小兔,蹦进新站台,
docs-dist 亮起,胡萝卜也开怀。
路径一跳,别名轻轻改,
README 翻新,示例排排来。
预览和工作流,咚咚跑得快 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确概括了本次对仓库配置与文档进行标准化的主要改动。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/standardize-rc-config

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

Comment @coderabbitai help to get the list of available commands.

@socket-security

socket-security Bot commented Jun 26, 2026

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request updates the repository configuration, documentation, and build scripts to align with modern rc-component standards. It introduces a revamped README, configures Dumi for documentation, updates TypeScript paths, and adds Vercel deployment settings. The review feedback highlights a few critical issues: the gh-pages script in package.json incorrectly scopes the GH_PAGES environment variable, a redundant alias is defined in .dumirc.ts, and the tsconfig.json file includes an incorrect path for the examples directory.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread package.json Outdated
Comment thread .dumirc.ts
Comment thread tsconfig.json Outdated
@codecov

codecov Bot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.50%. Comparing base (2e032d4) to head (552ae56).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #361   +/-   ##
=======================================
  Coverage   97.50%   97.50%           
=======================================
  Files          19       19           
  Lines         800      800           
  Branches      193      191    -2     
=======================================
  Hits          780      780           
  Misses         20       20           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/react-component-ci.yml:
- Around line 14-15: The reusable workflow call in react-component/rc-test
should not inherit all repository secrets while pointing at a mutable branch.
Update the workflow reference in
react-component/rc-test/.github/workflows/test-utoo.yml from main to a fixed
commit SHA, and replace secrets: inherit with an explicit secrets mapping that
passes only CODECOV_TOKEN. Keep the change in the workflow job that uses the
reusable workflow so the remote workflow gets only the minimum secret it
actually needs.

In `@README.md`:
- Around line 88-98: Update the Release section in README so it matches the
actual prepublishOnly workflow: describe that publishing first runs npm run
compile and then rc-np, and clarify that rc-np comes from the `@rc-component/np`
package. Keep the wording aligned with the existing Release heading and the
prepublishOnly script reference so readers understand the full release flow.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c05c0246-b4da-4cb4-a1d6-38bdda4f3ed7

📥 Commits

Reviewing files that changed from the base of the PR and between 2e032d4 and bbca1c7.

📒 Files selected for processing (15)
  • .dumirc.ts
  • .github/FUNDING.yml
  • .github/dependabot.yml
  • .github/workflows/codeql.yml
  • .github/workflows/main.yml
  • .github/workflows/react-component-ci.yml
  • .github/workflows/react-doctor.yml
  • .github/workflows/surge-preview.yml
  • .gitignore
  • README.md
  • docs/demo/horizontal-scroll.md
  • docs/index.md
  • package.json
  • tsconfig.json
  • vercel.json
💤 Files with no reviewable changes (1)
  • .github/workflows/main.yml

Comment thread .github/workflows/react-component-ci.yml
Comment thread README.md Outdated
@vercel

vercel Bot commented Jun 26, 2026

Copy link
Copy Markdown

Deployment failed with the following error:

Resource is limited - try again in 24 hours (more than 100, code: "api-deployments-free-per-day").

Learn More: https://vercel.com/afc163s-projects?upgradeToPro=build-rate-limit

@vercel

vercel Bot commented Jun 26, 2026

Copy link
Copy Markdown

Deployment failed with the following error:

Resource is limited - try again in 24 hours (more than 100, code: "api-deployments-free-per-day").

Learn More: https://vercel.com/react-component?upgradeToPro=build-rate-limit

@socket-security

socket-security Bot commented Jun 27, 2026

Copy link
Copy Markdown

Warning

Review the following alerts detected in dependencies.

According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.

Action Severity Alert  (click "▶" to expand/collapse)
Warn High
Obfuscated code: npm eslint-plugin-unicorn is 90.0% likely obfuscated

Confidence: 0.90

Location: Package overview

From: package.jsonnpm/eslint-plugin-unicorn@56.0.1

ℹ Read more on: This package | This alert | What is obfuscated code?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support@socket.dev.

Suggestion: Packages should not obfuscate their code. Consider not using packages with obfuscated code.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/eslint-plugin-unicorn@56.0.1. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

View full report

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@package.json`:
- Around line 50-71: The Node version declaration is still too low for the
current dependency set, so update the repository’s engines.node requirement in
package.json to a 20+ baseline to match cross-env and other modern packages.
Make the change in the package manifest alongside the dependency updates, and
ensure any related setup/docs that reference the supported Node version are kept
in sync with the new minimum.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 73a61b5e-5a43-4a84-9b27-171ec0c64d78

📥 Commits

Reviewing files that changed from the base of the PR and between ec16320 and c099201.

📒 Files selected for processing (11)
  • .dumirc.ts
  • .github/dependabot.yml
  • .github/workflows/codeql.yml
  • .github/workflows/react-component-ci.yml
  • .github/workflows/react-doctor.yml
  • .github/workflows/surge-preview.yml
  • .prettierignore
  • README.md
  • README.zh-CN.md
  • package.json
  • tsconfig.json
✅ Files skipped from review due to trivial changes (4)
  • .github/workflows/react-doctor.yml
  • .prettierignore
  • README.zh-CN.md
  • README.md
🚧 Files skipped from review as they are similar to previous changes (4)
  • .github/workflows/surge-preview.yml
  • .github/workflows/codeql.yml
  • tsconfig.json
  • .dumirc.ts

Comment thread package.json Outdated
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.

1 participant