有一个 tslint 规则禁止使用特定函数或全局方法。
以下格式的禁用函数或方法列表:
- 禁止功能:
- 只是函数的名称:“functionName”
- 具有一个元素的数组中的函数名称:["functionName"]
- 以下格式的对象:
{"name": "functionName", "message": "optional explanation message"}
- 禁止方法:
- 包含对象名称、方法名称和可选消息的数组:
["functionName", "methodName", "optional message"]
- 以下格式的对象:
{"name": ["objectName", "methodName"], "message": "optional message"}
- 你也可以禁止深度嵌套的方法:
{"name": ["foo", "bar", "baz"]}bans foo.bar.baz()
- 第一个元素可以包含匹配所有内容的通配符 (*)。
{"name": ["*", "forEach"]} 禁止[].forEach(...), $(...).forEach(...), arr.forEach(...), etc.
配置示例
"ban": [
true,
"eval",
{"name": "$", "message": "please don't"},
["describe", "only"],
{"name": ["it", "only"], "message": "don't focus tests"},
{
"name": ["chai", "assert", "equal"],
"message": "Use 'strictEqual' instead."
},
{"name": ["*", "forEach"], "message": "Use a regular for loop instead."}
]
架构
{
"type": "list",
"listType": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
},
"minLength": 1,
"maxLength": 3
},
{
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
},
"minLength": 1
}
]
},
"message": {
"type": "string"
}
},
"required": [
"name"
]
}
]
}
}