chore: standardize repository config by afc163 · Pull Request #361 · react-component/virtual-list

afc163 · 2026-06-26T09:51:18Z

Summary

Redesign README with npm/bundlephobia badges, Ant Design brand context, installation, usage, API, development, and release sections.
Standardize repository config: package scripts, dumi/father/tsconfig, FUNDING, Dependabot, Vercel preview, Surge preview fallback, React Doctor, and CodeQL workflow.
Remove the legacy now-build path and align preview output on docs-dist.

Test plan

npm run tsc
npm test -- --runInBand
npm run lint
npm run build
npx vercel build --yes

Refs ant-design/ant-design#58514

Summary by CodeRabbit

New Features
- 新增文档站点预览与自动化部署流程（输出到 docs-dist），并加入 Surge 预览与 React Doctor 任务。
Bug Fixes
- 优化在不同发布场景下的基础路径与资源加载，提升页面跳转与访问稳定性。
Documentation
- 重写 README（含 Examples/API/开发与发布说明），新增 README.zh-CN，并更新文档标题与水平滚动示例。
CI & Automation
- 更新测试、CodeQL、Dependabot 调度与基础配置；新增资金信息配置。

vercel · 2026-06-26T09:51:24Z

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

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

github-actions · 2026-06-26T09:51:29Z

❌ Deploy failed

	❌ Failed
	🔗 Preview ~~https://react-component-virtual-list-preview-pr-361.surge.sh~~ _{(may be unavailable)}
	📝 Commit	`c099201`
	🪵 Logs	View 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 · 2026-06-26T09:51:33Z

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`	包描述、`docs-dist` 输出、发布脚本、部署配置和忽略规则被更新。
文档内容 `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
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	标题准确概括了本次对仓库配置、CI、文档和部署设置的统一调整。
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.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch codex/standardize-rc-config

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.

.dumirc.ts

ESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox.

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 · 2026-06-26T09:51:54Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	npm/@types/node@24.13.2 ⏵ 26.0.1
	npm/glob@13.0.6
	npm/prettier@3.9.1

View full report

gemini-code-assist

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.

codecov · 2026-06-26T09:52:59Z

Codecov Report

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

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

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

vercel · 2026-06-26T18:01:55Z

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 · 2026-06-26T18:01:56Z

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 · 2026-06-27T17:37:23Z

All alerts resolved. Learn more about Socket for GitHub.

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

View full report

coderabbitai

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

chore: standardize repository config

bbca1c7

gemini-code-assist Bot reviewed Jun 26, 2026

View reviewed changes

Comment thread package.json Outdated

Comment thread .dumirc.ts

Comment thread tsconfig.json Outdated

vercel Bot deployed to Production – virtual-list June 26, 2026 09:56 View deployment

vercel Bot deployed to Preview – virtual-list June 26, 2026 09:56 View deployment

coderabbitai Bot reviewed Jun 26, 2026

View reviewed changes

Comment thread .github/workflows/react-component-ci.yml

Comment thread README.md Outdated

chore: address review feedback

ec16320

vercel Bot deployed to Preview – virtual-list June 26, 2026 10:04 View deployment

chore: fix surge preview inputs

129262e

vercel Bot deployed to Preview – virtual-list June 26, 2026 10:09 View deployment

afc163 mentioned this pull request Jun 26, 2026

Track rc component repository standardization ant-design/ant-design#58514

Open

chore: address AI review feedback

cfe5019

vercel Bot deployed to Preview – virtual-list June 26, 2026 17:44 View deployment

docs: standardize README release details

be558d1

afc163 added 7 commits June 27, 2026 02:17

docs: clarify Ant Design ecosystem note

5a51454

docs: refine README usage and ecosystem note

5e42665

ci: isolate surge preview token

b425b8c

docs: add Chinese README

8a704be

docs: add Ant Design logo to README

2597425

docs: refine bilingual README branding

5341593

chore: standardize rc tooling and docs

c18bb90

afc163 added 2 commits June 28, 2026 02:01

chore: address standardization review comments

a7cfa75

ci: update GitHub Actions versions

f128609

ci: use resolvable CodeQL action ref

14baf82

vercel Bot deployed to Preview – virtual-list June 28, 2026 04:39 View deployment

afc163 added 5 commits June 28, 2026 13:47

ci: use test-utoo workflow from main

4e87a53

ci: use actions checkout v7

d860a63

chore: standardize package metadata

b3f5b37

ci: standardize dependabot updates

921093d

chore: refine preview workflow ignores

c099201

coderabbitai Bot reviewed Jun 28, 2026

View reviewed changes

Comment thread package.json

Uh oh!

Conversation

afc163 commented Jun 26, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Summary by CodeRabbit

Uh oh!

vercel Bot commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ Deploy failed

Uh oh!

coderabbitai Bot commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

socket-security Bot commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vercel Bot commented Jun 26, 2026

Uh oh!

vercel Bot commented Jun 26, 2026

Uh oh!

socket-security Bot commented Jun 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

afc163 commented Jun 26, 2026 •

edited by coderabbitai Bot

Loading

vercel Bot commented Jun 26, 2026 •

edited

Loading

github-actions Bot commented Jun 26, 2026 •

edited

Loading

coderabbitai Bot commented Jun 26, 2026 •

edited

Loading

socket-security Bot commented Jun 26, 2026 •

edited

Loading

codecov Bot commented Jun 26, 2026 •

edited

Loading

socket-security Bot commented Jun 27, 2026 •

edited

Loading