2020-03-07 11:45:40 +08:00
|
|
|
"use strict";
|
|
|
|
|
|
|
|
Object.defineProperty(exports, "__esModule", {
|
|
|
|
value: true
|
|
|
|
});
|
|
|
|
exports.default = void 0;
|
|
|
|
|
|
|
|
var _path = require("path");
|
|
|
|
|
2020-03-31 20:40:00 +08:00
|
|
|
var _experimentalUtils = require("@typescript-eslint/experimental-utils");
|
|
|
|
|
2020-03-07 11:45:40 +08:00
|
|
|
var _utils = require("./utils");
|
|
|
|
|
2020-03-31 20:40:00 +08:00
|
|
|
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
|
|
|
|
|
|
|
|
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
|
|
|
|
|
|
|
|
function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
|
|
|
|
|
2020-03-07 11:45:40 +08:00
|
|
|
const reportOnViolation = (context, node, {
|
|
|
|
maxSize: lineLimit = 50,
|
|
|
|
whitelistedSnapshots = {}
|
|
|
|
}) => {
|
|
|
|
const startLine = node.loc.start.line;
|
|
|
|
const endLine = node.loc.end.line;
|
|
|
|
const lineCount = endLine - startLine;
|
|
|
|
const allPathsAreAbsolute = Object.keys(whitelistedSnapshots).every(_path.isAbsolute);
|
|
|
|
|
|
|
|
if (!allPathsAreAbsolute) {
|
|
|
|
throw new Error('All paths for whitelistedSnapshots must be absolute. You can use JS config and `path.resolve`');
|
|
|
|
}
|
|
|
|
|
|
|
|
let isWhitelisted = false;
|
|
|
|
|
2020-06-27 02:01:06 +08:00
|
|
|
if (node.type === _experimentalUtils.AST_NODE_TYPES.ExpressionStatement && 'left' in node.expression && (0, _utils.isExpectMember)(node.expression.left)) {
|
2020-03-07 11:45:40 +08:00
|
|
|
const fileName = context.getFilename();
|
|
|
|
const whitelistedSnapshotsInFile = whitelistedSnapshots[fileName];
|
|
|
|
|
|
|
|
if (whitelistedSnapshotsInFile) {
|
|
|
|
const snapshotName = (0, _utils.getAccessorValue)(node.expression.left.property);
|
|
|
|
isWhitelisted = whitelistedSnapshotsInFile.some(name => {
|
|
|
|
if (name instanceof RegExp) {
|
|
|
|
return name.test(snapshotName);
|
|
|
|
}
|
|
|
|
|
|
|
|
return snapshotName;
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!isWhitelisted && lineCount > lineLimit) {
|
|
|
|
context.report({
|
|
|
|
messageId: lineLimit === 0 ? 'noSnapshot' : 'tooLongSnapshots',
|
|
|
|
data: {
|
|
|
|
lineLimit,
|
|
|
|
lineCount
|
|
|
|
},
|
|
|
|
node
|
|
|
|
});
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
var _default = (0, _utils.createRule)({
|
|
|
|
name: __filename,
|
|
|
|
meta: {
|
|
|
|
docs: {
|
|
|
|
category: 'Best Practices',
|
|
|
|
description: 'disallow large snapshots',
|
|
|
|
recommended: false
|
|
|
|
},
|
|
|
|
messages: {
|
|
|
|
noSnapshot: '`{{ lineCount }}`s should begin with lowercase',
|
|
|
|
tooLongSnapshots: 'Expected Jest snapshot to be smaller than {{ lineLimit }} lines but was {{ lineCount }} lines long'
|
|
|
|
},
|
|
|
|
type: 'suggestion',
|
|
|
|
schema: [{
|
|
|
|
type: 'object',
|
|
|
|
properties: {
|
|
|
|
maxSize: {
|
|
|
|
type: 'number'
|
|
|
|
},
|
2020-03-31 20:40:00 +08:00
|
|
|
inlineMaxSize: {
|
|
|
|
type: 'number'
|
|
|
|
},
|
2020-03-07 11:45:40 +08:00
|
|
|
whitelistedSnapshots: {
|
|
|
|
type: 'object',
|
|
|
|
patternProperties: {
|
|
|
|
'.*': {
|
|
|
|
type: 'array'
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
},
|
|
|
|
additionalProperties: false
|
|
|
|
}]
|
|
|
|
},
|
|
|
|
defaultOptions: [{}],
|
|
|
|
|
|
|
|
create(context, [options]) {
|
|
|
|
if (context.getFilename().endsWith('.snap')) {
|
|
|
|
return {
|
|
|
|
ExpressionStatement(node) {
|
|
|
|
reportOnViolation(context, node, options);
|
|
|
|
}
|
|
|
|
|
|
|
|
};
|
|
|
|
} else if (context.getFilename().endsWith('.js')) {
|
|
|
|
return {
|
|
|
|
CallExpression(node) {
|
|
|
|
if ('property' in node.callee && ((0, _utils.isSupportedAccessor)(node.callee.property, 'toMatchInlineSnapshot') || (0, _utils.isSupportedAccessor)(node.callee.property, 'toThrowErrorMatchingInlineSnapshot'))) {
|
2020-03-31 20:40:00 +08:00
|
|
|
var _options$inlineMaxSiz;
|
|
|
|
|
2020-06-06 22:11:37 +08:00
|
|
|
reportOnViolation(context, node, _objectSpread(_objectSpread({}, options), {}, {
|
2020-03-31 20:40:00 +08:00
|
|
|
maxSize: (_options$inlineMaxSiz = options.inlineMaxSize) !== null && _options$inlineMaxSiz !== void 0 ? _options$inlineMaxSiz : options.maxSize
|
|
|
|
}));
|
2020-03-07 11:45:40 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
return {};
|
|
|
|
}
|
|
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
exports.default = _default;
|