chore: standardize repository maintenance

.github/FUNDING.yml

@@ -1,15 +1,2 @@
-# These are supported funding model platforms
-
 github: ant-design
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-polar: # Replace with a single Polar username
-buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
-thanks_dev: # Replace with a single thanks.dev username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+open_collective: ant-design

.github/dependabot.yml

@@ -1,11 +1,27 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
 version: 2
 updates:
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: weekly
+      day: monday
+      time: '21:00'
+      timezone: Asia/Shanghai
+    open-pull-requests-limit: 10
+    groups:
+      npm-dependencies:
+        patterns:
+          - '*'
+
+  - package-ecosystem: github-actions
+    directory: '/'
     schedule:
-      interval: "weekly"
+      interval: weekly
+      day: monday
+      time: '21:00'
+      timezone: Asia/Shanghai
+    open-pull-requests-limit: 10
+    groups:
+      github-actions:
+        patterns:
+          - '*'

.github/workflows/codeql.yml

@@ -0,0 +1,43 @@
+name: 'CodeQL'
+
+on:
+  push:
+    branches: ['master']
+  pull_request:
+    branches: ['master']
+  schedule:
+    - cron: '36 13 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [javascript-typescript]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@8aad20d150bbac5944a9f9d289da16a4b0d87c1e
+        with:
+          languages: ${{ matrix.language }}
+          queries: +security-and-quality
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@8aad20d150bbac5944a9f9d289da16a4b0d87c1e
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@8aad20d150bbac5944a9f9d289da16a4b0d87c1e
+        with:
+          category: '/language:${{ matrix.language }}'

.github/workflows/react-doctor.yml

@@ -0,0 +1,22 @@
+name: React Doctor
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+  statuses: write
+
+jobs:
+  react-doctor:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: millionco/react-doctor@0b4f4f4bd248a154e64eb508a48347f71154b3f3

.github/workflows/surge-preview.yml

@@ -0,0 +1,48 @@
+name: Surge Preview
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+  pull-requests: write
+  checks: write
+
+jobs:
+  preview:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: surge-preview-${{ github.event.pull_request.number }}
+      cancel-in-progress: true
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+      - name: Check Surge token
+        id: surge-token
+        env:
+          SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
+        run: |
+          if [ -n "$SURGE_TOKEN" ]; then
+            echo "enabled=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "enabled=false" >> "$GITHUB_OUTPUT"
+          fi
+      - name: Build preview
+        if: ${{ steps.surge-token.outputs.enabled == 'true' }}
+        run: |
+          npm install
+          npm run build
+      - uses: afc163/surge-preview@bf90a5a86111f6311ca42f0a5a0f80fb0fb03cec
+        if: ${{ steps.surge-token.outputs.enabled == 'true' }}
+        env:
+          SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
+        with:
+          surge_token: ${{ env.SURGE_TOKEN }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          dist: .docs-dist
+          failOnError: false
+          setCommitStatus: false
+      - name: Skip Surge preview
+        if: ${{ steps.surge-token.outputs.enabled != 'true' }}
+        run: echo "SURGE_TOKEN is not configured; skip Surge preview."

.github/workflows/test.yml

@@ -0,0 +1,16 @@
+name: ✅ test
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    uses: react-component/rc-test/.github/workflows/test-utoo.yml@main
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -1,85 +1,80 @@
-# @rc-component/async-validator
-
-[![NPM version][npm-image]][npm-url]
-[![npm download][download-image]][download-url]
-[![build status][github-actions-image]][github-actions-url]
-[![Codecov][codecov-image]][codecov-url]
-[![dumi][dumi-image]][dumi-url]
-
-[npm-image]: http://img.shields.io/npm/v/@rc-component/async-validator.svg?style=flat-square
-[npm-url]: http://npmjs.org/package/@rc-component/async-validator
-[travis-image]: https://img.shields.io/travis/react-component/async-validator/master?style=flat-square
-[travis-url]: https://travis-ci.com/react-component/async-validator
-[github-actions-image]: https://github.com/react-component/async-validator/actions/workflows/ci.yml/badge.svg
-[github-actions-url]: https://github.com/react-component/async-validator/actions/workflows/ci.yml
-[codecov-image]: https://img.shields.io/codecov/c/github/react-component/async-validator/master.svg?style=flat-square
-[codecov-url]: https://app.codecov.io/gh/react-component/async-validator
-[david-url]: https://david-dm.org/react-component/async-validator
-[david-image]: https://david-dm.org/react-component/async-validator/status.svg?style=flat-square
-[david-dev-url]: https://david-dm.org/react-component/async-validator?type=dev
-[david-dev-image]: https://david-dm.org/react-component/async-validator/dev-status.svg?style=flat-square
-[download-image]: https://img.shields.io/npm/dm/@rc-component/async-validator.svg?style=flat-square
-[download-url]: https://npmjs.org/package/@rc-component/async-validator
-[bundlephobia-url]: https://bundlephobia.com/package/@rc-component/async-validator
-[bundlephobia-image]: https://badgen.net/bundlephobia/minzip/@rc-component/async-validator
-[dumi-url]: https://github.com/umijs/dumi
-[dumi-image]: https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square
-
-Validate form asynchronous. A variation of https://github.com/freeformsystems/async-validate
+<div align="center">
+  <h1>@rc-component/async-validator</h1>
+  <p><sub><a href="https://ant.design"><img alt="Ant Design" height="14" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" style="vertical-align: -0.125em;" /></a> Part of the Ant Design ecosystem.</sub></p>
+  <p>✅ Async validation engine for schema-based form rules.</p>
+
+  <p>
+    <a href="https://npmjs.org/package/@rc-component/async-validator"><img alt="NPM version" src="https://img.shields.io/npm/v/@rc-component/async-validator.svg?style=flat-square"></a>
+    <a href="https://npmjs.org/package/@rc-component/async-validator"><img alt="npm downloads" src="https://img.shields.io/npm/dm/@rc-component/async-validator.svg?style=flat-square"></a>
+    <a href="https://github.com/react-component/async-validator/actions/workflows/test.yml"><img alt="build status" src="https://github.com/react-component/async-validator/actions/workflows/test.yml/badge.svg"></a>
+    <a href="https://app.codecov.io/gh/react-component/async-validator"><img alt="Codecov" src="https://img.shields.io/codecov/c/github/react-component/async-validator/master.svg?style=flat-square"></a>
+    <a href="https://bundlephobia.com/package/@rc-component/async-validator"><img alt="bundle size" src="https://img.shields.io/bundlephobia/minzip/@rc-component/async-validator?style=flat-square"></a>
+    <a href="https://github.com/umijs/dumi"><img alt="dumi" src="https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square"></a>
+  </p>
+</div>
+
+<p align="center">English | [简体中文](./README.zh-CN.md)</p>
+
+## Highlights
+
+| Area    | Support                                              |
+| ------- | ---------------------------------------------------- |
+| Purpose | Async validation engine for schema-based form rules. |
+| Package | `@rc-component/async-validator`                      |
+| Release | `@rc-component/np` / `rc-np`                         |
 
 ## Install
 
 ```bash
-npm i @rc-component/async-validator
+npm install @rc-component/async-validator
 ```
 
 ## Usage
 
-Basic usage involves defining a descriptor, assigning it to a schema and passing the object to be validated and a callback function to the `validate` method of the schema:
-
-```js
+```tsx | pure
 import Schema from '@rc-component/async-validator';
-const descriptor = {
-  name: {
-    type: 'string',
-    required: true,
-    validator: (rule, value) => value === 'muji',
-  },
-  age: {
-    type: 'number',
-    asyncValidator: (rule, value) => {
-      return new Promise((resolve, reject) => {
-        if (value < 18) {
-          reject('too young'); // reject with error message
-        } else {
-          resolve();
-        }
-      });
-    },
-  },
-};
-const validator = new Schema(descriptor);
-validator.validate({ name: 'muji' }, (errors, fields) => {
-  if (errors) {
-    // validation failed, errors is an array of all errors
-    // fields is an object keyed by field name with an array of
-    // errors per field
-    return handleErrors(errors, fields);
-  }
+
+const validator = new Schema({
+  name: { type: 'string', required: true },
+});
+
+validator.validate({ name: 'Ant Design' }).then(() => {
   // validation passed
 });
+```
 
-// PROMISE USAGE
-validator
-  .validate({ name: 'muji', age: 16 })
-  .then(() => {
-    // validation passed or without error message
-  })
-  .catch(({ errors, fields }) => {
-    return handleErrors(errors, fields);
-  });
+## API
+
+| API                                     | Description                                |
+| --------------------------------------- | ------------------------------------------ |
+| `new Schema(descriptor)`                | Create a validator from a rule descriptor. |
+| `validate(source, options?, callback?)` | Validate source data and return a Promise. |
+| `messages`                              | Customize validation messages.             |
+
+## Development
+
+```bash
+npm install
+npm start
+npm test
+npm run coverage
+npm run lint
+npm run tsc
+npm run compile
+```
+
+The dumi site runs at `http://localhost:8000`.
+
+## Release
+
+```bash
+npm run prepublishOnly
 ```
 
+The release flow is handled by `@rc-component/np` through the `rc-np` command when the package uses the shared release flow.
+
+## Detailed API
+
 ## API
 
 ### Validate
@@ -478,4 +473,4 @@ Open coverage/ dir
 
 ## License
 
-Everything is [MIT](https://en.wikipedia.org/wiki/MIT_License).
+@rc-component/async-validator is released under the [MIT](./LICENSE.md) license.