首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

EsLint说找不到规则"jsdoc/require-jsdoc“的定义?

EsLint是一个用于静态代码分析的工具,它可以帮助开发人员在编写代码时发现潜在的问题和错误。"jsdoc/require-jsdoc"是EsLint的一个规则,用于检查是否在函数上使用了JSDoc注释。

当EsLint报错说找不到规则"jsdoc/require-jsdoc"的定义时,可能有以下几个原因:

  1. EsLint配置文件缺少相关规则:在项目的.eslintrc文件中,需要确保已经配置了"jsdoc/require-jsdoc"规则。可以通过添加以下配置来启用该规则:
代码语言:txt
复制
"rules": {
  "jsdoc/require-jsdoc": "error"
}

这样就会强制要求在函数上使用JSDoc注释。

  1. 缺少相关插件:EsLint的规则是通过插件来提供的,可能是缺少了提供"jsdoc/require-jsdoc"规则的插件。可以通过以下命令安装相关插件:
代码语言:txt
复制
npm install eslint-plugin-jsdoc --save-dev

然后在.eslintrc文件中添加插件配置:

代码语言:txt
复制
"plugins": [
  "jsdoc"
]

这样就可以使用"jsdoc/require-jsdoc"规则了。

  1. EsLint版本不兼容:有时候EsLint的版本可能不兼容某些规则,可以尝试升级EsLint的版本来解决该问题。

总结起来,要解决EsLint报错找不到规则"jsdoc/require-jsdoc"的定义,需要确保配置文件中包含该规则,并且安装了相关的插件。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

各种关闭eslint方法总结

[// 此项是用来配置vue.js风格,就是写代码时候要规范写,如果你使用vs-code我觉得应该可以避免出错 "plugin:vue/essential", "@vue..."parser": "babel-eslint"//此项是用来指定eslint解析器,解析器必须符合规则,babel-eslint解析器是对babel解析器包装使其与ESLint解析...语法检测,文件为根目录下 package.json文件(规则写在rules内) 格式: rules: { "规则名": [规则值, 规则配置] } 规则值: "off"或者0 //关闭规则关闭..."warn"或者1 //在打开规则作为警告(不影响退出代码) "error"或者2 //把规则作为一个错误(退出代码触发时为1) 3、eslint 规则配置参数 "no-alert":...() "valid-jsdoc": 0,//jsdoc规则 "valid-typeof": 2,//必须使用合法typeof值 "vars-on-top": 2,//var必须放在作用域顶部 "wrap-iife

15.7K21
  • 手把手教你在vue-cli3中配置eslint

    "indent": [1, 4] }, "parserOptions": { "parser": "babel-eslint"//此项是用来指定eslint解析器,解析器必须符合规则...,babel-eslint解析器是对babel解析器包装使其与ESLint解析 } } 做完这个配置以后,顺带了解了一下eslint语法检测和基本配置规则 vue-cli3官方文档...修改eslint语法检测,文件为根目录下 package.json文件(规则写在rules内)格式 rules: { "规则名": [规则值, 规则配置] } 规则值 "off"或者...0 //关闭规则关闭 "warn"或者1 //在打开规则作为警告(不影响退出代码) "error"或者2 //把规则作为一个错误(退出代码触发时为1) eslint基本配置项 "no-alert...() "valid-jsdoc": 0,//jsdoc规则 "valid-typeof": 2,//必须使用合法typeof值 "vars-on-top": 2,//var必须放在作用域顶部 "wrap-iife

    4.6K42

    《Node.js在CLI下工程化体系实践》成都OSC源创会分享总结

    此处不得不提及ESLintESLint于2013年6月推出最新版本v4.6.0,是一款适用于Javascript和JSX代码规范检查工具,相比JSLint和JSHint而言,它更加灵活,支持自定义配置...Javascript规范制定原则: 不重复造轮子,基于eslint:recommend 配置并改进 能够帮助发现代码错误规则,全部开启 配置不应该依赖于某个具体项目,而应尽可能合理 帮助保持团队代码风格统一...一方面,我们觉得eslint:recommend 里面的部分配置定义错误级别过于严格,比如代码里面出现了console会导致校验错误,另一方面,它没有包含ESLint最佳实践和其它规则。...我们定义部分规则解释如下: 规则名称 错误级别 说明 for-direction error for 循环方向要求必须正确 getter-return error getter必须有返回值,并且禁止返回值为...valid-jsdoc off 函数注释一定要遵守jsdoc规则 no-template-curly-in-string warn 在字符串里面出现{和}进行警告 accessor-pairs warn

    99420

    Node.js 在 CLI 下工程化体系实践

    此处不得不提及ESLintESLint于2013年6月推出最新版本v4.6.0,是一款适用于Javascript和JSX代码规范检查工具,相比JSLint和JSHint而言,它更加灵活,支持自定义配置...Javascript规范制定原则: 不重复造轮子,基于eslint:recommend 配置并改进 能够帮助发现代码错误规则,全部开启 配置不应该依赖于某个具体项目,而应尽可能合理 帮助保持团队代码风格统一...一方面,我们觉得eslint:recommend 里面的部分配置定义错误级别过于严格,比如代码里面出现了console会导致校验错误,另一方面,它没有包含ESLint最佳实践和其它规则。...我们定义部分规则解释如下: 规则名称 错误级别 说明 for-direction error for 循环方向要求必须正确 getter-return error getter必须有返回值,并且禁止返回值为...valid-jsdoc off 函数注释一定要遵守jsdoc规则 no-template-curly-in-string warn 在字符串里面出现{和}进行警告 accessor-pairs warn

    1.1K10

    《Node.js在CLI下工程化体系实践》成都OSC源创会分享总结

    此处不得不提及ESLintESLint于2013年6月推出最新版本v4.6.0,是一款适用于Javascript和JSX代码规范检查工具,相比JSLint和JSHint而言,它更加灵活,支持自定义配置...Javascript规范制定原则: 不重复造轮子,基于eslint:recommend 配置并改进 能够帮助发现代码错误规则,全部开启 配置不应该依赖于某个具体项目,而应尽可能合理 帮助保持团队代码风格统一...一方面,我们觉得eslint:recommend 里面的部分配置定义错误级别过于严格,比如代码里面出现了console会导致校验错误,另一方面,它没有包含ESLint最佳实践和其它规则。...我们定义部分规则解释如下: 规则名称 错误级别 说明 for-direction error for 循环方向要求必须正确 getter-return error getter必须有返回值,并且禁止返回值为...valid-jsdoc off 函数注释一定要遵守jsdoc规则 no-template-curly-in-string warn 在字符串里面出现{和}进行警告 accessor-pairs warn

    2K71

    Eslint使用入门指南

    Eslint保持其插件特性,让开发人员自定义定制属于自己规则,也可以去遵循一些大社区或者团队规范直接继承下来用于使用,其所有规则都是可插入,同时为了方便使用,也对其内置了一些规则。...YAML - 使用 .eslintrc.yaml 或 .eslintrc.yml 去定义配置结构 JSON - 使用 .eslintrc.json 去定义配置结构,ESLint JSON 文件允许...在return,throw,continue,break语句后不允许出现不可能到达语句 2 use-isnan 要求检查NaN时候使用isNaN() 2 valid-jsdoc 强制JSDoc...下面这些配置值得推荐: eslint:recommended ESLint内置推荐规则在么有讲到 所有打钩就是内置规则 eslint:all:ESLint 内置所有规则eslint-config-standard...eslintrc 中自定义默认配置; 通常我们都习惯把 ESLint 配置文件放到项目根目录,因此可以为了避免 ESLint 校验时候往父级目录查找配置文件,所以需要在配置文件中加上 root: true

    2.1K20

    关于eslint使用规则,和各种报错对应规则

    ESLint 主要有以下特点: 默认规则包含所有 JSLint、JSHint 中存在规则,易迁移; 规则可配置性高:可设置「警告」、「错误」两个 error 等级,或者直接禁用; 包含代码风格检测规则...(可以丢掉 JSCS 了); 支持插件扩展、自定义规则。...下面一下如何配置: 比如,我写vue过程中,出现了下面的warning: WARNING Compiled with 1 warnings11:26:30http://eslint.org/docs...ESLint: 使用 .eslintrc 文件(支持 JSON 和 YAML 两种语法); 在 package.json 中添加 eslintConfig 配置块;直接在代码文件中定义。...() "valid-jsdoc": 0,//jsdoc规则 "valid-typeof": 2,//必须使用合法typeof值 "vars-on-top": 2,//var必须放在作用域顶部 "wrap-iife

    3.8K50

    关于eslint使用规则,和各种报错对应规则

    ESLint 主要有以下特点: 默认规则包含所有 JSLint、JSHint 中存在规则,易迁移; 规则可配置性高:可设置「警告」、「错误」两个 error 等级,或者直接禁用; 包含代码风格检测规则...(可以丢掉 JSCS 了); 支持插件扩展、自定义规则。...下面一下如何配置: 比如,我写vue过程中,出现了下面的warning: WARNING Compiled with 1 warnings11:26:30 http://eslint.org/docs...还有一种万能方法,就是在报错JS文件中第一行写上 /* eslint-disable */ 如下图 这样就可以和Eslint携手并进了 配置(我主要用第三种方法,为了方便查看,特记录如下:) 可以通过以下三种方式配置...() "valid-jsdoc": 0,//jsdoc规则 "valid-typeof": 2,//必须使用合法typeof值 "vars-on-top": 2,//var必须放在作用域顶部 "wrap-iife

    8.7K70

    开源库架构实战——从0到1搭建属于你自己开源库

    --Donald Knuth 众所周知,eslint 是一个开源 JavaScript代码检查工具,可以用来校验我们代码,给代码定义一个规范,团队成员按照这个代码规范进行开发,这保证了代码规范。...另外,eslint 初衷是为了让开发者创建自己代码检测规则,使其可以在编码过程中发现问题,扩展性强。为了方便使用,eslint 也内置了一些规则,也可以在这基础上去增加自定义规则。...eslint --init 选择您最熟悉构建工具 ?...JSDoc 分析源代码是我们书写符合 Docblock 格式代码注释,它会智能帮我们生成美观 API 文档页面,我们要做,只是简单跑一句jsdoc命令就可以了。...工具选型 构建: webpack4 Rollup 测试工具: Jest 持续集成: Travis CI API 文档生成工具: JSDoc 代码规范: eslint prettier lint-staged

    1.3K20

    一统江湖大前端(5)editorconfig + eslint——你代码里藏着你优雅

    使用方法 eslintRules规则集包含近200条javascript编码规则,可以帮助我们检查编程中语法错误,以及对一些指定最佳实践进行限制,减少整个工程中奇葩代码片段和各种奇技淫巧,为开发者提供...3.手动使用eslint进行语法检查 在包含.eslintrc文件目录下,用一个简易函数来测试eslint校验功能,如下所示可以看到,规则集中配置对强制使用全等和禁止使用默认alert类提示限制在...5.建议 eslint规则集中涉及超过200条规则,笔者自己仍然在学习中,强烈建议前端开发者对此进行系统地专题学习,不仅需要了解配置规则是在限制什么,更要搞清楚为什么要做这样限制,相信大部分规则学习下来.../** + Tab 生成jsdoc风格前置注释信息,未来是可以输出文档或配合单元测试。...if + Tab 生成if条件判断语句代码结构 for + Tab 生成正向循环或反向循环代码结构 fun + Tab 生成函数声明代码结构 其他自定义代码片段 可自定义快捷键及代码片段,并指定若干可配置焦点

    1.2K30

    前端规范落地,团队级解决方案

    也就是ESLint 检查编码规范; 用 Prettier 插件自动保存为规划化格式; 用 Commitizen 约定提交规范; 动手解决 本文案例运行环境和编辑器 node ^16.13.1...运行项目: cd 项目目录 npm run serve 2、配置 ESLint 规则 ESLint 是代码检测工具,在上一步创建项目的操作中,我们已经把 ESLint 集成在项目中了。...], parserOptions: { // 指明解析器 parser: 'babel-eslint' }, /* * 这里非常重要,项目的主要配置规则是写在这里!!!...…… * * "off" 或 0 - 关闭规则 * "warn" 或 1 - 开启规则,使用警告级别的错误:warn (不会导致程序退出) * "error" 或 2 - 开启规则...规范参考 airbnb规范 google规范 百度EFE规范 京东Aotu规范 JS代码备注规范:JSDoc 阮一峰 Commit message 和 Change log 编写指南 ---- 如果本文对你有帮助

    78240

    写代码之前请先看看开发文档规范

    每一个方法都有自己使用说明 安装 jsdoc 选中所写函, 按下 ctrl+shift+p, 选中 gen jsdoc /** * 描述 * @author ken * @date 2021-05...,组件独立于自己文件内 // 只有一个组件形式 GlobalFooter src index.vue index.js // 用于导出组件 // 多个组件形式 RightContent...BlankLayout.vue 10. src/locales 存放多语言 en-us xxx.js zh-cn xxx.js 11. src/plugin 用于存放一些三方插件,自定义插件...global.less //全局样式 vars.less // 变量定义 color.less // 颜色值变量定义 15. src/utils 用于存放一些公用工具方法,像拷贝方法,去重方法 copyObj.util.js...比如 eslint 一些规范问题,在提交代码之前,请使用以下命令,检测是否有警告,或者错误,或者定义变量没有使用,一定要处理掉,不要把这些警告,错误提交上 github npm run lint

    40330

    可能是目前最详细从零开始配置 TypeScript 项目的教程

    进行解析,因此为了在 ESLint 中支持 TypeScript 代码检查需要制作额外定义解析器[54](Custom Parsers,ESLint 定义解析器功能需要基于 ESTree[55...因此如果想基于 @typescript-eslint/eslint-plugin 进行自定义规则,则可参考 TypeScript Supported Rules[63]。...Prettier 与 ESLint 区别在于 Prettier 专注于统一格式规则,从而减轻 ESLint 在格式规则校验,而对于质量规则 则交给专业 ESLint 进行处理。...理论上而言,在项目中开启 ESLint extends 中设置带有格式规则校验规则集,那么就需要通过 eslint-config-prettier 插件关闭可能产生冲突格式规则: { "extends...://github.com/jsdoc/jsdoc [124] esdoc: https://github.com/esdoc/esdoc [125] Document This For jsdoc:

    4.9K22
    领券