You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
136 lines
4.2 KiB
136 lines
4.2 KiB
"use strict"; |
|
|
|
Object.defineProperty(exports, "__esModule", { |
|
value: true |
|
}); |
|
exports.default = void 0; |
|
|
|
var _experimentalUtils = require("@typescript-eslint/experimental-utils"); |
|
|
|
var _utils = require("./utils"); |
|
|
|
const isNullLiteral = node => node.type === _experimentalUtils.AST_NODE_TYPES.Literal && node.value === null; |
|
/** |
|
* Checks if the given `ParsedEqualityMatcherCall` is a call to one of the equality matchers, |
|
* with a `null` literal as the sole argument. |
|
*/ |
|
|
|
|
|
const isNullEqualityMatcher = matcher => isNullLiteral(getFirstArgument(matcher)); |
|
|
|
const isFirstArgumentIdentifier = (matcher, name) => (0, _utils.isIdentifier)(getFirstArgument(matcher), name); |
|
|
|
const shouldUseToBe = matcher => { |
|
const firstArg = getFirstArgument(matcher); |
|
|
|
if (firstArg.type === _experimentalUtils.AST_NODE_TYPES.Literal) { |
|
// regex literals are classed as literals, but they're actually objects |
|
// which means "toBe" will give different results than other matchers |
|
return !('regex' in firstArg); |
|
} |
|
|
|
return firstArg.type === _experimentalUtils.AST_NODE_TYPES.TemplateLiteral; |
|
}; |
|
|
|
const getFirstArgument = matcher => { |
|
return (0, _utils.followTypeAssertionChain)(matcher.arguments[0]); |
|
}; |
|
|
|
const reportPreferToBe = (context, whatToBe, matcher, modifier) => { |
|
const modifierNode = (modifier === null || modifier === void 0 ? void 0 : modifier.negation) || (modifier === null || modifier === void 0 ? void 0 : modifier.name) === _utils.ModifierName.not && (modifier === null || modifier === void 0 ? void 0 : modifier.node); |
|
context.report({ |
|
messageId: `useToBe${whatToBe}`, |
|
|
|
fix(fixer) { |
|
var _matcher$arguments; |
|
|
|
const fixes = [fixer.replaceText(matcher.node.property, `toBe${whatToBe}`)]; |
|
|
|
if ((_matcher$arguments = matcher.arguments) !== null && _matcher$arguments !== void 0 && _matcher$arguments.length && whatToBe !== '') { |
|
fixes.push(fixer.remove(matcher.arguments[0])); |
|
} |
|
|
|
if (modifierNode) { |
|
fixes.push(fixer.removeRange([modifierNode.property.range[0] - 1, modifierNode.property.range[1]])); |
|
} |
|
|
|
return fixes; |
|
}, |
|
|
|
node: matcher.node.property |
|
}); |
|
}; |
|
|
|
var _default = (0, _utils.createRule)({ |
|
name: __filename, |
|
meta: { |
|
docs: { |
|
category: 'Best Practices', |
|
description: 'Suggest using `toBe()` for primitive literals', |
|
recommended: false |
|
}, |
|
messages: { |
|
useToBe: 'Use `toBe` when expecting primitive literals', |
|
useToBeUndefined: 'Use `toBeUndefined` instead', |
|
useToBeDefined: 'Use `toBeDefined` instead', |
|
useToBeNull: 'Use `toBeNull` instead', |
|
useToBeNaN: 'Use `toBeNaN` instead' |
|
}, |
|
fixable: 'code', |
|
type: 'suggestion', |
|
schema: [] |
|
}, |
|
defaultOptions: [], |
|
|
|
create(context) { |
|
return { |
|
CallExpression(node) { |
|
if (!(0, _utils.isExpectCall)(node)) { |
|
return; |
|
} |
|
|
|
const { |
|
matcher, |
|
modifier |
|
} = (0, _utils.parseExpectCall)(node); |
|
|
|
if (!matcher) { |
|
return; |
|
} |
|
|
|
if (((modifier === null || modifier === void 0 ? void 0 : modifier.name) === _utils.ModifierName.not || modifier !== null && modifier !== void 0 && modifier.negation) && ['toBeUndefined', 'toBeDefined'].includes(matcher.name)) { |
|
reportPreferToBe(context, matcher.name === 'toBeDefined' ? 'Undefined' : 'Defined', matcher, modifier); |
|
return; |
|
} |
|
|
|
if (!(0, _utils.isParsedEqualityMatcherCall)(matcher)) { |
|
return; |
|
} |
|
|
|
if (isNullEqualityMatcher(matcher)) { |
|
reportPreferToBe(context, 'Null', matcher); |
|
return; |
|
} |
|
|
|
if (isFirstArgumentIdentifier(matcher, 'undefined')) { |
|
const name = (modifier === null || modifier === void 0 ? void 0 : modifier.name) === _utils.ModifierName.not || modifier !== null && modifier !== void 0 && modifier.negation ? 'Defined' : 'Undefined'; |
|
reportPreferToBe(context, name, matcher, modifier); |
|
return; |
|
} |
|
|
|
if (isFirstArgumentIdentifier(matcher, 'NaN')) { |
|
reportPreferToBe(context, 'NaN', matcher); |
|
return; |
|
} |
|
|
|
if (shouldUseToBe(matcher) && matcher.name !== _utils.EqualityMatcher.toBe) { |
|
reportPreferToBe(context, '', matcher); |
|
} |
|
} |
|
|
|
}; |
|
} |
|
|
|
}); |
|
|
|
exports.default = _default; |