chore: standardize repository maintenance by afc163 · Pull Request #25 · react-component/async-validator

afc163 · 2026-07-01T02:06:16Z

Summary

Refresh README and README.zh-CN with centered heading, badges, Ant Design ecosystem branding, install, usage, development, release, and license sections.
Align Funding, grouped Dependabot updates, React Doctor, reusable test workflow, Surge preview, and Vercel preview configuration.
Align release documentation and scripts with @rc-component/np; remove legacy duplicated CI or Now configuration where present.
Keep GitHub's default CodeQL setup instead of adding an advanced CodeQL workflow.

Refs ant-design/ant-design#58514

Test

npm run lint
npm run tsc
npm run compile
npm test
npm run build
git diff --check
JSON parse check for package/config files
README consistency scan

Summary by CodeRabbit

New Features
- 新增 React Doctor 与 PR Surge 预览工作流，并新增“✅ test”自动测试流程。
Documentation
- 重写英文 README，并新增 README.zh-CN，更新安装、用法、API 说明与开发发布信息。
Chores
- 更新 ESLint 与 TypeScript 配置，调整构建脚本与依赖版本；完善 Dependabot 与赞助配置；补充 Vercel 部署设置。

coderabbitai · 2026-07-01T02:06:31Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 82ea3941-01ae-4b79-859c-e8382b2c0feb

📥 Commits

Reviewing files that changed from the base of the PR and between 0ae84fc and 8b5ce6c.

📒 Files selected for processing (3)

.eslintrc.js
eslint.config.mjs
package.json

💤 Files with no reviewable changes (1)

.eslintrc.js

🚧 Files skipped from review as they are similar to previous changes (1)

package.json

Walkthrough

本次 PR 更新了 CI/CD 与部署配置、ESLint 和 TypeScript 工具链、package 依赖与脚本、src/index.ts 的类型导出方式，并重写英文 README 且新增中文 README。

Changes

CI/CD 与部署工作流

Layer / File(s)	Summary
工作流与预览发布 `.github/workflows/test.yml`, `.github/workflows/react-doctor.yml`, `.github/workflows/surge-preview.yml`	新增测试复用工作流、React Doctor 检查和 Surge Preview 预览工作流，包含触发条件、权限、并发控制和预览发布步骤。
Dependabot 与资助配置 `.github/dependabot.yml`, `.github/FUNDING.yml`	Dependabot 扩展为 npm 和 github-actions 两个生态，并将资助配置替换为具体账号值。
Vercel 部署配置 `vercel.json`	更新框架、安装命令、构建命令与输出目录配置。

工具链与配置升级

Layer / File(s)	Summary
ESLint 扁平配置迁移 `eslint.config.mjs`	新增 Flat 配置，按 JS、TS 和测试文件分别应用推荐规则、插件和解析器设置。
TypeScript 配置与依赖/脚本升级 `tsconfig.json`, `package.json`	调整模块解析、路径映射、include 范围，以及脚本、描述和依赖版本。
类型导出方式调整 `src/index.ts`	将 `./interface` 的再导出改为仅类型导出。

文档更新

Layer / File(s)	Summary
README 文档更新 `README.md`, `README.zh-CN.md`	重写英文 README 并新增简体中文 README。

Estimated code review effort: 3 (Moderate) | ~25 minutes

Sequence Diagram(s)

sequenceDiagram
  participant GitHubActions
  participant PreviewJob
  participant SurgePreviewAction
  GitHubActions->>PreviewJob: pull_request 触发
  PreviewJob->>PreviewJob: 检查 SURGE_TOKEN
  alt 已配置 token
    PreviewJob->>PreviewJob: 检出代码并构建
    PreviewJob->>SurgePreviewAction: 发布 .docs-dist
    SurgePreviewAction-->>PreviewJob: 返回预览结果
  else 未配置 token
    PreviewJob->>PreviewJob: 跳过预览并输出提示
  end

Poem

小兔子蹦进新仓库，
CI 预览一起跑；
ESLint 换上扁平帽，
README 也会双语笑；
配置整齐，耳朵翘翘 🐰

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	标题与本次“标准化仓库维护”及相关配置更新的主要变更高度一致。
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-infra

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

gemini-code-assist

Code Review

This pull request focuses on updating the repository's documentation, configuration, and dependencies. Key changes include a complete redesign of the English README.md and the addition of a Chinese translation (README.zh-CN.md), configuring Dependabot updates for npm and GitHub Actions, updating the GitHub Funding configuration, adding a vercel.json deployment configuration, and updating various package scripts and devDependencies in package.json. Feedback on the changes points out a redundant ## API heading immediately following the ## Detailed API heading in README.md which should be removed.

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-07-01T02:07:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.41%. Comparing base (75ebc66) to head (8b5ce6c).

Additional details and impacted files

@@           Coverage Diff           @@
##           master      #25   +/-   ##
=======================================
  Coverage   82.41%   82.41%           
=======================================
  Files          25       25           
  Lines         654      654           
  Branches      238      238           
=======================================
  Hits          539      539           
  Misses        114      114           
  Partials        1        1

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

socket-security · 2026-07-01T06:01:35Z

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

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	npm/typescript-eslint@8.62.1
	npm/@types/react-dom@19.2.3
	npm/@types/react@19.2.17
	npm/react@19.2.7
	npm/globals@17.7.0
	npm/eslint-config-prettier@10.1.8
	npm/@eslint/js@9.39.4
	npm/typescript@6.0.3
	npm/react-dom@19.2.7
	npm/lint-staged@17.0.8
	npm/eslint@9.39.4
	npm/eslint-plugin-react-hooks@7.1.1
	npm/eslint-plugin-jest@29.15.4

View full report

socket-security · 2026-07-01T06:24:46Z

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

Copilot

Pull request overview

Standardizes repository maintenance and release/docs automation to align with the Ant Design / rc-component ecosystem, including refreshed documentation, modernized linting, and updated CI workflows.

Changes:

Refreshes README (EN + zh-CN) with updated branding, usage/development/release sections, and consistent badges.
Migrates ESLint configuration to flat config and updates TS/CI settings for a more standardized toolchain.
Adds/aligns GitHub workflows (test, Surge preview, React Doctor) and repository maintenance files (funding, dependabot, Vercel).

Reviewed changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
vercel.json	Adds Vercel build settings for the docs output directory.
tsconfig.json	Updates TS config (module resolution, includes, path aliases).
src/index.ts	Switches to type-only re-export for interfaces.
README.zh-CN.md	Adds a new Simplified Chinese README with updated structure/content.
README.md	Rewrites README with new layout, badges, and updated guidance.
package.json	Updates metadata, scripts, and devDependencies to match standardized maintenance.
eslint.config.mjs	Introduces ESLint flat config and updated ignore/ruleset structure.
.github/workflows/test.yml	Adds reusable test workflow configuration.
.github/workflows/surge-preview.yml	Adds Surge-based preview workflow for PRs.
.github/workflows/react-doctor.yml	Adds React Doctor workflow for PRs and master pushes.
.github/workflows/ci.yml	Removes legacy CI workflow.
.github/FUNDING.yml	Aligns funding configuration with Ant Design org accounts.
.github/dependabot.yml	Adds grouped Dependabot updates for npm and GitHub Actions.
.eslintrc.js	Removes legacy ESLint config in favor of flat config.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

chore: standardize repository maintenance

c7de3bb

gemini-code-assist Bot reviewed Jul 1, 2026

View reviewed changes

Comment thread README.md Outdated

chore: align reusable test workflow

3108633

afc163 mentioned this pull request Jul 1, 2026

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

Closed

afc163 added 4 commits July 1, 2026 11:59

chore: address review feedback

ed0d914

chore: set up utoo for preview builds

391b3b5

chore: use npm install for vercel preview

de21585

chore: align maintenance dependencies

a48f708

chore: fix upgraded test tooling

ec6fd0f

afc163 added 5 commits July 1, 2026 14:26

docs: align Chinese README language switch

550d412

chore: fix upgraded tooling checks

4ea6dd2

chore: align TypeScript 6 tooling checks

2313c27

docs: use npm install in README

0ae84fc

chore: migrate to native eslint flat config

fdfd4c4

Copilot AI review requested due to automatic review settings July 2, 2026 03:54

Copilot started reviewing on behalf of afc163 July 2, 2026 03:54 View session

Copilot AI reviewed Jul 2, 2026

View reviewed changes

Comment thread eslint.config.mjs

chore: address review comments

8b5ce6c

afc163 merged commit 1ec8907 into master Jul 3, 2026
12 checks passed

afc163 deleted the codex/standardize-rc-infra branch July 3, 2026 12:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

chore: standardize repository maintenance#25

chore: standardize repository maintenance#25
afc163 merged 13 commits into
masterfrom
codex/standardize-rc-infra

afc163 commented Jul 1, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 1, 2026 •

edited

Loading

❌ Failed checks (1 warning)

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

Uh oh!

codecov Bot commented Jul 1, 2026 •

edited

Loading

Uh oh!

socket-security Bot commented Jul 1, 2026 •

edited

Loading

Uh oh!

socket-security Bot commented Jul 1, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

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

Uh oh!

Summary

Test

Summary by CodeRabbit

Uh oh!

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

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

❌ Failed checks (1 warning)

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

afc163 commented Jul 1, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 1, 2026 •

edited

Loading

codecov Bot commented Jul 1, 2026 •

edited

Loading

socket-security Bot commented Jul 1, 2026 •

edited

Loading

socket-security Bot commented Jul 1, 2026 •

edited

Loading