Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .eslintrc.js

This file was deleted.

8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ updates:
time: '21:00'
timezone: Asia/Shanghai
open-pull-requests-limit: 10
groups:
npm-dependencies:
patterns:
- '*'

- package-ecosystem: github-actions
directory: '/'
Expand All @@ -17,3 +21,7 @@ updates:
time: '21:00'
timezone: Asia/Shanghai
open-pull-requests-limit: 10
groups:
github-actions:
patterns:
- '*'
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">
<h1>@rc-component/util</h1>
<p><sub><img alt="Ant Design" height="14" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" style="vertical-align: -0.125em;" /> Part of the Ant Design ecosystem.</sub></p>
<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>🛠️ Shared React utilities for rc-component packages.</p>

<p>
Expand All @@ -15,7 +15,6 @@

<p align="center">English | <a href="./README.zh-CN.md">简体中文</a></p>


## Highlights

- Built for React and maintained by the rc-component team.
Expand Down
19 changes: 9 additions & 10 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">
<h1>@rc-component/util</h1>
<p><sub><img alt="Ant Design" height="14" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" style="vertical-align: -0.125em;" /> Ant Design 生态的一部分。</sub></p>
<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> Ant Design 生态的一部分。</sub></p>
<p>🛠️ rc-component 共享工具集合,包含 DOM、React 和测试辅助能力。</p>

<p>
Expand All @@ -15,7 +15,6 @@

<p align="center"><a href="./README.md">English</a> | 简体中文</p>


## 特性

- 面向 React 构建,并由 rc-component 团队维护。
Expand Down Expand Up @@ -58,14 +57,14 @@ npm start

该包提供在 rc-component 和 Ant Design 包中复用的小型聚焦工具。优先导入公开入口;针对 DOM、React 或测试辅助能力,可使用子路径导入。

| 范围 | 示例 |
| --------------- | ---------------------------------------------------------------------------------- |
| React hooks | `useEvent`, `useLayoutEffect`, `useMergedState`, `useState` 辅助方法 |
| React 工具 | `Children/toArray`, `composeRef`, `pickAttrs`, `Portal` |
| DOM 工具 | `Dom/canUseDom`, `Dom/contains`, `Dom/dynamicCSS`, `Dom/focus`, `getScrollBarSize` |
| 异步辅助方法 | `raf`, `raf.cancel` |
| 警告工具 | `warning`, `noteOnce`, `resetWarned` |
| 测试工具 | `test/domHook` 用于 DOM 原型 spy |
| 范围 | 示例 |
| ------------ | ---------------------------------------------------------------------------------- |
| React hooks | `useEvent`, `useLayoutEffect`, `useMergedState`, `useState` 辅助方法 |
| React 工具 | `Children/toArray`, `composeRef`, `pickAttrs`, `Portal` |
| DOM 工具 | `Dom/canUseDom`, `Dom/contains`, `Dom/dynamicCSS`, `Dom/focus`, `getScrollBarSize` |
| 异步辅助方法 | `raf`, `raf.cancel` |
| 警告工具 | `warning`, `noteOnce`, `resetWarned` |
| 测试工具 | `test/domHook` 用于 DOM 原型 spy |

`docs/examples` 中的示例覆盖了常用的子路径辅助工具。

Expand Down
111 changes: 111 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
import js from '@eslint/js';
import { defineConfig } from 'eslint/config';
import prettier from 'eslint-config-prettier';
import jest from 'eslint-plugin-jest';
import react from 'eslint-plugin-react';
import reactHooks from 'eslint-plugin-react-hooks';
import globals from 'globals';
import tseslint from 'typescript-eslint';

export default defineConfig([
{
plugins: {
'@typescript-eslint': tseslint.plugin,
},
},
{
linterOptions: {
reportUnusedDisableDirectives: 'off',
},
},
{
ignores: [
'node_modules/',
'coverage/',
'es/',
'lib/',
'dist/',
'docs-dist/',
'.dumi/',
'.doc/',
'.vercel/',
'src/index.d.ts',
],
},
{
files: ['**/*.{js,jsx,ts,tsx}'],
extends: [
js.configs.recommended,
react.configs.flat.recommended,
react.configs.flat['jsx-runtime'],
prettier,
],
plugins: {
'react-hooks': reactHooks,
},
languageOptions: {
globals: {
...globals.browser,
...globals.node,
},
},
settings: {
react: {
version: 'detect',
},
},
rules: {
'no-async-promise-executor': 'off',
'no-empty-pattern': 'off',
'no-irregular-whitespace': 'off',
'no-prototype-builtins': 'off',
'no-useless-escape': 'off',
'no-extra-boolean-cast': 'off',
'no-undef': 'off',
'no-unused-vars': 'off',
'react/no-find-dom-node': 'off',
'react/display-name': 'off',
'react/no-unknown-property': 'off',
'react/prop-types': 'off',
'react-hooks/exhaustive-deps': 'warn',
'react-hooks/rules-of-hooks': 'error',
},
},
{
files: ['**/*.{ts,tsx}'],
extends: [...tseslint.configs.recommended],
rules: {
'@typescript-eslint/ban-ts-comment': 'off',
'@typescript-eslint/no-empty-object-type': 'off',
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-unsafe-function-type': 'off',
'@typescript-eslint/no-unnecessary-type-constraint': 'off',
'@typescript-eslint/no-unused-vars': 'off',
},
},
Comment thread
afc163 marked this conversation as resolved.
{
files: ['src/**/*.{ts,tsx}'],
languageOptions: {
parserOptions: {
projectService: true,
tsconfigRootDir: import.meta.dirname,
},
Comment on lines +89 to +92
},
},
{
files: ['tests/**/*.{js,jsx,ts,tsx}', '**/*.{test,spec}.{js,jsx,ts,tsx}'],
extends: [jest.configs['flat/recommended']],
rules: {
'jest/no-disabled-tests': 'off',
'jest/no-done-callback': 'off',
'jest/no-identical-title': 'off',
'jest/expect-expect': 'off',
'jest/no-alias-methods': 'off',
'jest/no-conditional-expect': 'off',
'jest/no-export': 'off',
'jest/no-standalone-expect': 'off',
'jest/valid-expect': 'off',
'jest/valid-title': 'off',
},
},
]);
11 changes: 11 additions & 0 deletions global.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/// <reference types="jest" />
/// <reference types="node" />
/// <reference types="react" />
/// <reference types="react-dom" />
/// <reference types="@testing-library/jest-dom" />

declare module '*.css';
declare module '*.less';
declare module 'jsonp';

declare module 'moment/locale/zh-cn';
42 changes: 24 additions & 18 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,34 +45,40 @@
"react-is": "^18.2.0"
},
"devDependencies": {
"@eslint/js": "^9.39.4",
"@rc-component/father-plugin": "^2.2.0",
"@rc-component/np": "^1.0.4",
"@testing-library/react": "^15.0.7",
"@types/jest": "^29.5.14",
"@testing-library/dom": "^10.4.1",
"@testing-library/jest-dom": "^6.9.1",
"@testing-library/react": "^16.3.2",
"@types/jest": "^30.0.0",
"@types/node": "^26.0.1",
"@types/react": "^18.3.31",
"@types/react-dom": "^18.3.7",
"@types/react-is": "^19.0.0",
"@types/responselike": "^1.0.0",
"@types/react": "^19.2.17",
"@types/react-dom": "^19.2.3",
"@types/react-is": "^19.2.0",
"@types/responselike": "^1.0.3",
"@types/warning": "^3.0.4",
"@umijs/fabric": "^4.0.1",
"cross-env": "^10.1.0",
"dumi": "^2.4.35",
"eslint": "^8.57.1",
"eslint-plugin-jest": "^27.9.0",
"eslint-plugin-unicorn": "^56.0.1",
"father": "^4.6.23",
"dumi": "^2.4.38",
"eslint": "^9.39.4",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-jest": "^29.15.4",
"eslint-plugin-react": "^7.37.5",
"eslint-plugin-react-hooks": "^7.1.1",
"father": "^4.6.24",
"gh-pages": "^6.3.0",
"glob": "^13.0.6",
"globals": "^17.7.0",
"husky": "^9.1.7",
"lint-staged": "^16.4.0",
"prettier": "^3.9.0",
"lint-staged": "^17.0.8",
"prettier": "^3.9.4",
"rc-test": "^7.1.3",
"react": "^18.3.1",
"react": "^19.2.7",
"react-19": "npm:react@19.0.0",
"react-dom": "^18.3.1",
"react-dom": "^19.2.7",
"react-dom-19": "npm:react-dom@19.0.0",
"typescript": "^5.9.3",
"gh-pages": "^6.3.0"
"typescript": "^6.0.3",
"typescript-eslint": "^8.62.1"
},
"peerDependencies": {
"react": ">=18.0.0",
Expand Down
1 change: 0 additions & 1 deletion src/test/domHook.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/ban-types */
/* eslint-disable no-param-reassign */
const NO_EXIST = { __NOT_EXIST: true };

Expand Down
4 changes: 3 additions & 1 deletion tests/hooks-17.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ import * as React from 'react';
import { renderToString } from 'react-dom/server';
import useId, { resetUuid } from '../src/hooks/useId';

const isReact19 = React.version.startsWith('19');

jest.mock('react', () => {
const react = jest.requireActual('react');

Expand Down Expand Up @@ -51,7 +53,7 @@ describe('hooks-17', () => {
{ hydrate: true, container: holder },
);

matchId(container, 'rc_unique_1');
matchId(container, isReact19 ? 'rc_unique_0' : 'rc_unique_1');

errorSpy.mockRestore();
process.env.NODE_ENV = originEnv;
Expand Down
9 changes: 6 additions & 3 deletions tests/ref.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import {
useComposeRef,
} from '../src/ref';

const isReact19 = React.version.startsWith('19');

describe('ref', () => {
const errSpy = jest.spyOn(console, 'error');

Expand Down Expand Up @@ -117,7 +119,7 @@ describe('ref', () => {
</Holder>,
);
expect(supportRef(FC)).toBeFalsy();
expect(supportRef(holderRef.current.props.children)).toBeFalsy();
expect(supportRef(holderRef.current.props.children)).toBe(isReact19);
});

it('forwardRef function component', () => {
Expand Down Expand Up @@ -163,7 +165,7 @@ describe('ref', () => {
</Holder>,
);
expect(supportRef(MemoFC)).toBeFalsy();
expect(supportRef(holderRef.current.props.children)).toBeFalsy();
expect(supportRef(holderRef.current.props.children)).toBe(isReact19);
});

it('memo of forwardRef function component', () => {
Expand Down Expand Up @@ -196,7 +198,7 @@ describe('ref', () => {
it('FC', () => {
const FC = () => <div />;
const RefFC = React.forwardRef(FC);
Comment thread
afc163 marked this conversation as resolved.
expect(supportNodeRef(<FC />)).toBeFalsy();
expect(supportNodeRef(<FC />)).toBe(isReact19);
expect(supportNodeRef(<RefFC />)).toBeTruthy();
});

Expand All @@ -218,6 +220,7 @@ describe('ref', () => {
const node = <div ref={ref} />;

expect(getNodeRef(node)).toBe(ref);
expect(getNodeRef(null)).toBeNull();

expect(errSpy).not.toHaveBeenCalled();
});
Expand Down
45 changes: 13 additions & 32 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,50 +1,31 @@
{
"compilerOptions": {
"target": "esnext",
"moduleResolution": "node",
"baseUrl": "./",
"moduleResolution": "bundler",
"jsx": "preserve",
"declaration": true,
"skipLibCheck": true,
"esModuleInterop": true,
"paths": {
"@/*": [
"src/*"
],
"@@/*": [
".dumi/tmp/*"
],
"@rc-component/util": [
"src/index.ts"
],
"@rc-component/util/es": [
"src"
],
"@rc-component/util/es/*": [
"src/*"
],
"rc-util": [
"src/index.ts"
],
"rc-util/es": [
"src"
],
"rc-util/es/*": [
"src/*"
]
"@/*": ["./src/*"],
"@@/*": ["./.dumi/tmp/*"],
"@rc-component/util": ["./src/index.ts"],
"@rc-component/util/es": ["./src"],
"@rc-component/util/es/*": ["./src/*"],
"rc-util": ["./src/index.ts"],
"rc-util/es": ["./src"],
"rc-util/es/*": ["./src/*"]
},
"ignoreDeprecations": "5.0"
"strict": false,
"module": "ESNext"
},
"include": [
"global.d.ts",
".fatherrc.ts",
".dumirc.ts",
"src",
"tests",
"docs/examples"
],
"exclude": [
"docs-dist",
"lib",
"es"
]
"exclude": ["docs-dist", "lib", "es"]
}
Loading