这个项目能做什么
eslint-plugin-react 是 ESLint 的 React 专用 linting 规则集合。它帮助开发者强制执行 React 最佳实践、捕获常见错误,并在 React 项目中保持一致的代码风格。
通过 npm 安装非常简单:npm install eslint eslint-plugin-react --save-dev。该插件同时适用于旧版 .eslintrc 配置系统和 ESLint v8.21.0 引入的较新的 eslint.config.js flat config 系统。
该插件导出多个可共享配置:recommended(强制执行 React 良好实践)、all(包含所有可用规则)和 jsx-runtime(用于 React 17+ 的新 JSX 转换)。Flat config 变体也可用,分别为 flat.recommended、flat.all 和 flat['jsx-runtime']。这些配置会自动在 parser options 中启用 JSX。
配置支持 react.pragma、react.fragment、react.version、react.createClass、propWrapperFunctions、componentWrapperFunctions、formComponents 和 linkComponents 的共享设置。这些设置允许为使用 MobX observer、styled-components、自定义表单组件或自定义链接组件的项目进行定制。
该插件包含大量规则,涵盖 JSX 格式化(jsx-indent、jsx-curly-spacing、jsx-props-no-multi-spaces)、组件定义(display-name、function-component-definition)、props 验证(jsx-no-duplicate-props、default-props-match-prop-types)、hooks(hook-use-state、forward-ref-uses-ref)、可访问性(button-has-type、iframe-missing-sandbox)、安全性(jsx-no-target-blank、jsx-no-script-url)等更多内容。许多规则可通过 --fix CLI 选项自动修复,部分规则通过编辑器集成提供手动修复建议。
规则列表包含以叉号标记的已弃用规则,该插件同时保持与 ESLint v8 和 v9 的兼容性。
评论
0 评分人数达到10人后显示
登录后参与讨论。