IT技术 - typescriptreact组件中的react/props类型eslint错误 - 吾爱随笔录

typescriptreact组件中的react/props类型eslint错误

IT技术 reactjs typescript eslint

2021-05-11 03:23:33

我正在尝试设置一个typescript-react-eslint项目并且无法通过此样板组件的 eslint 错误：

import * as React from "react";

interface ButtonProps {
  children?: React.ReactNode,
  onClick?: (e: any) => void,
}

const styles = {
  border: "1px solid #eee",
  borderRadius: 3,
  backgroundColor: "#FFFFFF",
  cursor: "pointer",
  fontSize: 15,
  padding: "3px 10px",
  margin: 10
};

const Button: React.FunctionComponent<ButtonProps> = props => (
  <button onClick={props.onClick} style={styles} type="button">
    {props.children}
  </button>
);

Button.defaultProps = {
  children: null,
  onClick: () => {}
};
export default Button;

错误是：

  19:26  error  'onClick' is missing in props validation   react/prop-types
  20:12  error  'children' is missing in props validation  react/prop-types

似乎是在抱怨<button>未定义html 的接口？否则它可能是Button组件本身，但它不应该从<ButtonProps>我传递的接口中获取类型信息吗？

我尝试明确设置children并onClick像这样：

Button.propTypes = {
  children?: React.ReactNode,
  onClick?: (e: any) => void
};

它绕过了 eslint 错误，但组件本身停止工作。我究竟做错了什么？

PS这是我的 .eslintrc.json

{
    "env": {
        "browser": true,
        "commonjs": true,
        "es6": true
    },
    "extends": [
        "eslint:recommended",
        "plugin:react/recommended",
        "plugin:@typescript-eslint/eslint-recommended"
    ],
    "globals": {
        "Atomics": "readonly",
        "SharedArrayBuffer": "readonly"
    },
    "settings": {
        "react": {
            "pragma": "React",
            "version": "detect"
        }
    },
    "parser": "@typescript-eslint/parser",
    "parserOptions": {
        "ecmaFeatures": {
            "jsx": true
        },
        "ecmaVersion": 2018,
        "sourceType": "module"
    },
    "plugins": [
        "react",
        "@typescript-eslint"
    ],
    "rules": {
        "indent": [
            "error",
            2
        ],
        "linebreak-style": [
            "error",
            "unix"
        ],
        "quotes": [
            "error",
            "double"
        ],
        "semi": [
            "error",
            "always"
        ]
    }
}

4个回答

我最终将组件重写为：

const Button = ({ children, onClick }: ButtonProps) => {
  return <button onClick={onClick} style={styles} type="button">
    {children}
  </button>;
};

这: React.FC<ButtonProps>部分被 eslint 忽略了，所以我决定以更直接的方式提供 prop 类型

这个规则对 TypeScript 没有意义，因为你已经在检查类型了。

在这个问题中，您找到了一种禁用此规则的简单方法，只需在您的 eslint 配置中添加：

  rules: {
    'react/prop-types': 0
  }

为了更具可读性，您可以使用“off”代替“0”。

更多信息到你的答案..

首先，这两种方式对于声明类型都是正确的，但是 React.FC 有一些额外的好处。 https://github.com/typescript-cheatsheets/react-typescript-cheatsheet/blob/master/README.md#function-components

在您的场景中，您可能正在使用 eslint-react-plugin，它为 eslint 推荐了规则 'plugin:react/recommended'，
检查 proptypes 的规则就是其中之一，检查typescript示例。 https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prop-types.md

所以 react/prop-types 规则会和 TS Interfaces 冲突，这就是为什么它会显示那个错误，一旦你添加：ButtonProps，我们就不必提供 React.FC

eslint-plugin-react@^7.25.0看起来已经解决了这个问题，使用那些React.FC<IProps>与react/prop-types验证规则。

所以代替

const Example: React.FC<IProps> = (props: IProps) => ...

更新后现在可以正常工作而不会发出警告

const Example: React.FC<IProps> = (props) => ...

其它你可能感兴趣的问题

上一篇是否有密封双挤出机热端之类的东西？下一篇getFieldValue 或 Formik 中的类似工具