123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127 |
- "use strict";
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.default = void 0;
- var _utils = require("@typescript-eslint/utils");
- var _utils2 = require("./utils");
- const isNullLiteral = node => node.type === _utils.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 = expectFnCall => isNullLiteral((0, _utils2.getFirstMatcherArg)(expectFnCall));
- const isFirstArgumentIdentifier = (expectFnCall, name) => (0, _utils2.isIdentifier)((0, _utils2.getFirstMatcherArg)(expectFnCall), name);
- const shouldUseToBe = expectFnCall => {
- const firstArg = (0, _utils2.getFirstMatcherArg)(expectFnCall);
- if (firstArg.type === _utils.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 === _utils.AST_NODE_TYPES.TemplateLiteral;
- };
- const reportPreferToBe = (context, whatToBe, expectFnCall, modifierNode) => {
- context.report({
- messageId: `useToBe${whatToBe}`,
- fix(fixer) {
- var _expectFnCall$args;
- const fixes = [(0, _utils2.replaceAccessorFixer)(fixer, expectFnCall.matcher, `toBe${whatToBe}`)];
- if ((_expectFnCall$args = expectFnCall.args) !== null && _expectFnCall$args !== void 0 && _expectFnCall$args.length && whatToBe !== '') {
- fixes.push(fixer.remove(expectFnCall.args[0]));
- }
- if (modifierNode) {
- fixes.push(fixer.removeRange([modifierNode.range[0] - 1, modifierNode.range[1]]));
- }
- return fixes;
- },
- node: expectFnCall.matcher
- });
- };
- var _default = (0, _utils2.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) {
- const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
- if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
- return;
- }
- const matcherName = (0, _utils2.getAccessorValue)(jestFnCall.matcher);
- const notModifier = jestFnCall.modifiers.find(nod => (0, _utils2.getAccessorValue)(nod) === 'not');
- if (notModifier && ['toBeUndefined', 'toBeDefined'].includes(matcherName)) {
- reportPreferToBe(context, matcherName === 'toBeDefined' ? 'Undefined' : 'Defined', jestFnCall, notModifier);
- return;
- }
- if (!_utils2.EqualityMatcher.hasOwnProperty(matcherName) || jestFnCall.args.length === 0) {
- return;
- }
- if (isNullEqualityMatcher(jestFnCall)) {
- reportPreferToBe(context, 'Null', jestFnCall);
- return;
- }
- if (isFirstArgumentIdentifier(jestFnCall, 'undefined')) {
- const name = notModifier ? 'Defined' : 'Undefined';
- reportPreferToBe(context, name, jestFnCall, notModifier);
- return;
- }
- if (isFirstArgumentIdentifier(jestFnCall, 'NaN')) {
- reportPreferToBe(context, 'NaN', jestFnCall);
- return;
- }
- if (shouldUseToBe(jestFnCall) && matcherName !== _utils2.EqualityMatcher.toBe) {
- reportPreferToBe(context, '', jestFnCall);
- }
- }
- };
- }
- });
- exports.default = _default;
|