Javascript 无法让eslint在Ember类、道具和动作上抛出没有jsDoc的警告
我正在我的余烬项目中设置eslint。我想强制所有函数、类、操作和属性都用jsDoc记录 我面临的问题是,我似乎无法让强制在操作、组件声明或对象属性上工作 我最初尝试过“requirejsdoc”,但也注意到该规则已被弃用。然后,我使用以下配置安装了eslint插件jsdoc:Javascript 无法让eslint在Ember类、道具和动作上抛出没有jsDoc的警告,javascript,ember.js,eslint,jsdoc,Javascript,Ember.js,Eslint,Jsdoc,我正在我的余烬项目中设置eslint。我想强制所有函数、类、操作和属性都用jsDoc记录 我面临的问题是,我似乎无法让强制在操作、组件声明或对象属性上工作 我最初尝试过“requirejsdoc”,但也注意到该规则已被弃用。然后,我使用以下配置安装了eslint插件jsdoc: rules: [ ... 'jsdoc/check-examples': 0, 'jsdoc/check-param-names': 1, 'jsdoc/check-tag-names': 1, 'j
rules: [
...
'jsdoc/check-examples': 0,
'jsdoc/check-param-names': 1,
'jsdoc/check-tag-names': 1,
'jsdoc/check-types': 1,
'jsdoc/newline-after-description': 1,
'jsdoc/no-undefined-types': 1,
'jsdoc/require-description': 1,
'jsdoc/require-description-complete-sentence': 1,
'jsdoc/require-example': 1,
'jsdoc/require-hyphen-before-param-description': 1,
'jsdoc/require-param': 1,
'jsdoc/require-param-description': 1,
'jsdoc/require-param-name': 1,
'jsdoc/require-param-type': 1,
'jsdoc/require-returns': 1,
'jsdoc/require-returns-check': 1,
'jsdoc/require-returns-description': 1,
'jsdoc/require-returns-type': 1,
]
还是没有运气。你知道如何让下面的工作正常吗
//如果没有记录,则抛出eslint警告
导出默认组件。扩展({
someProp:false,//如果没有记录,则抛出eslint警告
行动:{
someAction(){}//如果没有记录,则抛出eslint警告
}
});
所有其他自然函数定义都按预期工作,只是试图让这些情况正常工作。谢谢 由于不推荐使用
require-jsdoc
,检查类声明和函数上是否存在jsdoc注释的正确方法是安装插件并使用jsdoc/require-jsdoc
规则
一旦你有:
规则:[
...
“jsdoc/require jsdoc”:1,
...
]
ESLint将开始警告缺少注释。如果您确实包含一些注释,那么所有其他规则(如jsdoc/require description
或jsdoc/require param
)都将强制执行
请注意,jsdoc/require jsdoc
规则需要一些配置,如果您希望它不仅仅应用于函数声明。例如:
规则:[
...
'jsdoc/require jsdoc':[1,{'require':{
函数表达式:对,
类声明:true
}}],
...
]
由于require-jsdoc
已被弃用,检查类声明和函数上是否存在jsdoc注释的正确方法是安装插件并使用jsdoc/require-jsdoc
规则
一旦你有:
规则:[
...
“jsdoc/require jsdoc”:1,
...
]
ESLint将开始警告缺少注释。如果您确实包含一些注释,那么所有其他规则(如jsdoc/require description
或jsdoc/require param
)都将强制执行
请注意,jsdoc/require jsdoc
规则需要一些配置,如果您希望它不仅仅应用于函数声明。例如:
规则:[
...
'jsdoc/require jsdoc':[1,{'require':{
函数表达式:对,
类声明:true
}}],
...
]
规则
元素应该是json对象而不是数组。在代码中,似乎是在[]
之间定义它,而不是在{}
之间定义它。如果是这样的话,它可能与它有关。这是我写问题时的错误,它是一个对象。我解决了这个问题,结果发现我需要打开一个新的终端会话来让我的VIM ALE反映这些变化(这是另一个问题):)谢谢你的建议!您的配置中是否有“”插件“:[“jsdoc”]
?规则
元素应该是json对象而不是数组。在代码中,似乎是在[]
之间定义它,而不是在{}
之间定义它。如果是这样的话,它可能与它有关。这是我写问题时的错误,它是一个对象。我解决了这个问题,结果发现我需要打开一个新的终端会话来让我的VIM ALE反映这些变化(这是另一个问题):)谢谢你的建议!您的配置中是否有“”插件“:[“jsdoc”]
?