Skip to content

chore: standardize rc footer config#145

Merged
afc163 merged 35 commits into
mainfrom
codex/standardize-rc-config
Jun 29, 2026
Merged

chore: standardize rc footer config#145
afc163 merged 35 commits into
mainfrom
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)
footer Ready Ready Preview, Comment Jun 29, 2026 6:25am

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@afc163, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 59 minutes

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable usage-based reviews in Billing to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information, and refer to the rate limits docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8151efba-e747-45cb-9d53-4871c7f9b4c5

📥 Commits

Reviewing files that changed from the base of the PR and between 9b84dcf and 6020ef1.

📒 Files selected for processing (13)
  • .dumirc.ts
  • .github/dependabot.yml
  • .github/workflows/codeql.yml
  • .github/workflows/main.yml
  • .github/workflows/react-doctor.yml
  • .github/workflows/surge-preview.yml
  • .husky/pre-commit
  • .prettierignore
  • LICENSE
  • README.md
  • README.zh-CN.md
  • package.json
  • tsconfig.json

Walkthrough

将包名从 rc-footer 切换为 @rc-component/footer,同步更新构建输出目录、路径别名、文档示例、站点首页以及 GitHub 相关配置与工作流。

Changes

Footer 包名迁移与站点配置

Layer / File(s) Summary
包元数据与路径解析
package.json, tsconfig.json, .dumirc.ts
包名、发布元数据、TypeScript 路径映射和 dumi 入口解析更新为新的 @rc-component/footer 结构。
输出目录与部署配置
.gitignore, .prettierignore, vercel.json
忽略规则和 Vercel 构建配置改为围绕 docs-dist 输出目录。
文档与示例切换
README.md, docs/index.md, docs/examples/*
README、首页和示例代码改用 @rc-component/footer 的导入、样式和说明文本。
GitHub 资助与工作流
.github/FUNDING.yml, .github/workflows/*.yml
资助配置和 GitHub Actions 工作流新增 CodeQL、测试、React Doctor 与 Surge Preview 配置。

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰 我跳过新路径,耳朵抖三抖,
docs-dist 闪闪,像胡萝卜一兜。
README 换新名,工作流也点头,
叽咕一声:footer 旅程,继续往前走。

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确概括了这次将 rc-footer 配置与包元数据统一到新结构的主要改动。
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.

@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown

React Doctor found no issues. 🎉

Reviewed by React Doctor for commit 6020ef1.

@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@socket-security

socket-security Bot commented Jun 26, 2026

Copy link
Copy Markdown

@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown

✅ Preview is ready!

PR preview ✅ Ready ✅ Ready
🔗 Preview https://react-component-footer-preview-pr-145.surge.sh
📝 Commit6020ef1
⏱️ Build time21.322s
📦 Size1.5 MB · 37 files
🪵 LogsView logs
📱 MobileScan to open preview on mobile

↩️ Previous: ⚡️ 6020ef1 · react-component-footer-preview-pr-145.surge.sh (open ↗) · 2026-06-29 06:27:15 UTC

🤖 Powered by surge-preview

@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 migrates the package from rc-footer to the scoped @rc-component/footer package, updating configuration files, examples, documentation, and build scripts accordingly. The output directory has been renamed from .doc to docs-dist, and support for Vercel deployment has been added. Feedback on these changes highlights two issues: first, the newly introduced rc-np package should be added to devDependencies to ensure reproducible builds; second, a specific path mapping for assets should be added to tsconfig.json to prevent TypeScript from incorrectly searching for assets inside the src 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 tsconfig.json Outdated

@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

🧹 Nitpick comments (1)
package.json (1)

40-40: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

把 lint 范围扩到这次实际修改的示例和配置文件。

Line 40 现在只检查 src/,但本 PR 同时修改了 docs/examples/*.dumirc.ts。这样 npm run lint 通过时,仍然发现不了这些改动里的 ESLint 问题。

建议修改
-    "lint": "eslint src/ --ext .ts,.tsx,.jsx,.js,.md",
+    "lint": "eslint src docs/examples .dumirc.ts --ext .ts,.tsx,.jsx,.js,.md",
🤖 Prompt for 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.

In `@package.json` at line 40, The lint script in package.json only covers src/,
so it misses ESLint issues in the actual files changed by this PR. Update the
lint command to include the docs/examples/* files and the .dumirc.ts config file
alongside the existing src/ and markdown targets, keeping the command tied to
the package.json lint script.
🤖 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/main.yml:
- Around line 14-15: The reusable workflow call in main.yml is over-permissive
because it uses secrets: inherit for the external workflow
react-component/rc-test/.github/workflows/test-utoo.yml. Update the workflow
invocation to stop inheriting all secrets and instead pass only the required
secret explicitly, keeping CODECOV_TOKEN as the sole declared secret for this
call.

In `@README.md`:
- Around line 87-92: The API table still describes the `Column` props using
“footer” in the `className` and `style` descriptions, which looks copied from
the wrong section. Update the wording in the README table for `Column` so the
`className` and `style` entries correctly describe the `Column` component rather
than `footer`, and keep the rest of the `ColumnItem`/`Column` documentation
consistent.

---

Nitpick comments:
In `@package.json`:
- Line 40: The lint script in package.json only covers src/, so it misses ESLint
issues in the actual files changed by this PR. Update the lint command to
include the docs/examples/* files and the .dumirc.ts config file alongside the
existing src/ and markdown targets, keeping the command tied to the package.json
lint script.
🪄 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: 37b752ef-0632-483a-be87-f67e1380f555

📥 Commits

Reviewing files that changed from the base of the PR and between 8578d00 and 9b84dcf.

📒 Files selected for processing (17)
  • .dumirc.ts
  • .github/FUNDING.yml
  • .github/workflows/codeql.yml
  • .github/workflows/main.yml
  • .github/workflows/react-doctor.yml
  • .github/workflows/surge-preview.yml
  • .github/workflows/test.yml
  • .gitignore
  • .prettierignore
  • README.md
  • docs/examples/rows.tsx
  • docs/examples/simple.tsx
  • docs/examples/theme.tsx
  • docs/index.md
  • package.json
  • tsconfig.json
  • vercel.json
💤 Files with no reviewable changes (1)
  • .github/workflows/test.yml

Comment thread .github/workflows/main.yml Outdated
Comment thread README.md 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.77%. Comparing base (8578d00) to head (6020ef1).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #145   +/-   ##
=======================================
  Coverage   97.77%   97.77%           
=======================================
  Files           2        2           
  Lines          45       45           
  Branches       25       25           
=======================================
  Hits           44       44           
  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.

@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

@afc163 afc163 merged commit de99fd0 into main Jun 29, 2026
13 checks passed
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