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: 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:
- '*'
2 changes: 1 addition & 1 deletion 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 Down
2 changes: 1 addition & 1 deletion 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 Down
88 changes: 88 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
import { FlatCompat } from '@eslint/eslintrc';
import js from '@eslint/js';
import tsEslintPlugin from '@typescript-eslint/eslint-plugin';
import { createRequire } from 'node:module';
import path from 'node:path';
import { fileURLToPath } from 'node:url';

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const require = createRequire(import.meta.url);

const compat = new FlatCompat({
baseDirectory: __dirname,
recommendedConfig: js.configs.recommended,
allConfig: js.configs.all,
});

const recommendedTsRulesConfig = tsEslintPlugin.configs.recommended;
const recommendedTsRulesObject = Array.isArray(recommendedTsRulesConfig)
? recommendedTsRulesConfig.reduce(
(rules, config) => ({ ...rules, ...(config.rules || {}) }),
{},
)
: recommendedTsRulesConfig?.rules || {};
const recommendedTsRules = new Set(Object.keys(recommendedTsRulesObject));
const noopRule = {
meta: { type: 'problem', docs: {}, schema: [] },
create: () => ({}),
};

function normalizeConfig(config) {
const next = { ...config };

if (next.plugins?.['@typescript-eslint']) {
next.plugins = { ...next.plugins };
delete next.plugins['@typescript-eslint'];
}

if (next.rules) {
next.rules = Object.fromEntries(
Object.entries(next.rules).filter(([ruleName]) => {
if (!ruleName.startsWith('@typescript-eslint/')) {
return true;
}
return recommendedTsRules.has(ruleName);
}),
);
}

return next;
}

export default [
{
ignores: [
'node_modules/',
'coverage/',
'es/',
'lib/',
'dist/',
'docs-dist/',
'.dumi/',
'.doc/',
'.vercel/',
'.eslintrc.js',
'src/index.d.ts',
],
},
{
plugins: {
'@typescript-eslint': {
...tsEslintPlugin,
rules: {
...tsEslintPlugin.rules,
'consistent-type-exports': noopRule,
},
},
},
},
...compat.config(require('./.eslintrc.js')).map(normalizeConfig),
{
rules: {
'@typescript-eslint/no-empty-object-type': 'off',
'@typescript-eslint/no-unsafe-function-type': 'off',
'@typescript-eslint/no-unused-vars': 'off',
},
},
Comment on lines +81 to +87

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Since @typescript-eslint/ban-types is removed in v8 and filtered out in normalizeConfig, we do not need to configure it as 'off' here. Removing it simplifies the configuration.

  {
    rules: {
      '@typescript-eslint/no-empty-object-type': 'off',
      '@typescript-eslint/no-unsafe-function-type': 'off',
      '@typescript-eslint/no-unused-vars': 'off',
    },
  },

];
48 changes: 48 additions & 0 deletions global.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/// <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 namespace JSX {
type Element = React.JSX.Element;
interface ElementClass extends React.JSX.ElementClass {}
interface ElementAttributesProperty extends React.JSX.ElementAttributesProperty {}
interface ElementChildrenAttribute extends React.JSX.ElementChildrenAttribute {}
type LibraryManagedAttributes<C, P> = React.JSX.LibraryManagedAttributes<C, P>;
interface IntrinsicAttributes extends React.JSX.IntrinsicAttributes {}
interface IntrinsicClassAttributes<T> extends React.JSX.IntrinsicClassAttributes<T> {}
interface IntrinsicElements extends React.JSX.IntrinsicElements {}
}

declare namespace jest {
interface Matchers<R> {
lastCalledWith(...expected: unknown[]): R;
nthCalledWith(nthCall: number, ...expected: unknown[]): R;
toBeCalled(): R;
toBeCalledTimes(expected: number): R;
toBeCalledWith(...expected: unknown[]): R;
}
}

declare const vi: {
fn: <T extends (...args: any[]) => any = (...args: any[]) => any>(implementation?: T) => jest.MockedFunction<T>;
mock: (moduleName: string, factory?: (importOriginal: <T>() => Promise<T>) => unknown) => void;
spyOn: typeof jest.spyOn;
useFakeTimers: () => void;
useRealTimers: () => void;
advanceTimersByTime: (msToRun: number) => void;
clearAllTimers: () => void;
runAllTimers: () => void;
importActual: <T>(moduleName: string) => Promise<T>;
clearAllMocks: () => void;
resetAllMocks: () => void;
restoreAllMocks: () => void;
};


declare module 'moment/locale/zh-cn';
39 changes: 25 additions & 14 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,34 +45,45 @@
"react-is": "^18.2.0"
},
"devDependencies": {
"@babel/eslint-parser": "^7.29.7",
"@babel/eslint-plugin": "^7.29.7",
"@eslint/eslintrc": "^3.3.5",
"@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",
"@typescript-eslint/eslint-plugin": "^8.62.0",
"@typescript-eslint/parser": "^8.62.0",
"@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",
"eslint": "^9.39.4",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-jest": "^29.15.3",
"eslint-plugin-react": "^7.37.5",
"eslint-plugin-react-hooks": "^7.1.1",
"eslint-plugin-unicorn": "^65.0.1",
"father": "^4.6.23",
"gh-pages": "^6.3.0",
"glob": "^13.0.6",
"husky": "^9.1.7",
"lint-staged": "^16.4.0",
"lint-staged": "^17.0.8",
"prettier": "^3.9.0",
"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"
},
"peerDependencies": {
"react": ">=18.0.0",
Expand Down
12 changes: 12 additions & 0 deletions react-compat.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import * as React from 'react';

declare module 'react' {
type ReactText = string | number;
function useRef<T = undefined>(): React.MutableRefObject<T | undefined>;
function isValidElement<P = any>(object: {} | null | undefined): object is React.ReactElement<P>;
function cloneElement<P = any>(
element: React.ReactElement<P>,
props?: (Partial<P> & React.Attributes) | null,
...children: React.ReactNode[]
): React.ReactElement<P>;
}
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);
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
30 changes: 19 additions & 11 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,41 +1,49 @@
{
"compilerOptions": {
"target": "esnext",
"moduleResolution": "node",
"baseUrl": "./",
"moduleResolution": "bundler",
"jsx": "preserve",
"declaration": true,
"skipLibCheck": true,
"esModuleInterop": true,
"paths": {
"@/*": [
"src/*"
"./src/*"
],
"@@/*": [
".dumi/tmp/*"
"./.dumi/tmp/*"
],
"@rc-component/util": [
"src/index.ts"
"./src/index.ts"
],
"@rc-component/util/es": [
"src"
"./src"
],
"@rc-component/util/es/*": [
"src/*"
"./src/*"
],
"rc-util": [
"src/index.ts"
"./src/index.ts"
],
"rc-util/es": [
"src"
"./src"
],
"rc-util/es/*": [
"src/*"
"./src/*"
]
},
"ignoreDeprecations": "5.0"
"noImplicitAny": false,
"strictNullChecks": false,
"strictPropertyInitialization": false,
"strictFunctionTypes": false,
"strict": false,
"noImplicitThis": false,
"strictBindCallApply": false,
"module": "ESNext"
},
"include": [
"react-compat.d.ts",
"global.d.ts",
".fatherrc.ts",
".dumirc.ts",
"src",
Expand Down
Loading