eslint-plugin-jest 23.19.0 → 23.20.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [23.20.0](https://github.com/jest-community/eslint-plugin-jest/compare/v23.19.0...v23.20.0) (2020-07-30)
+
+
+### Features
+
+* **no-large-snapshots:** deprecate `whitelistedSnapshots` for new name ([#632](https://github.com/jest-community/eslint-plugin-jest/issues/632)) ([706f5c2](https://github.com/jest-community/eslint-plugin-jest/commit/706f5c2bc54797f0f32178fab1d194d9a4309f70))
+
 # [23.19.0](https://github.com/jest-community/eslint-plugin-jest/compare/v23.18.2...v23.19.0) (2020-07-27)
 
 

package/docs/rules/no-large-snapshots.md

@@ -122,8 +122,8 @@ If only `maxSize` is provided on options, the value of `maxSize` will be used to
 both snapshot types (Inline and External).
 
 Since `eslint-disable` comments are not preserved by Jest when updating
-snapshots, you can use the `whitelistedSnapshots` option to have specific
-snapshots allowed regardless of their size.
+snapshots, you can use the `allowedSnapshots` option to have specific snapshots
+allowed regardless of their size.
 
 This option takes a map, with the key being the absolute filepath to a snapshot
 file, and the value an array of values made up of strings and regular
@@ -141,7 +141,7 @@ module.exports = {
     'jest/no-large-snapshots': [
       'error',
       {
-        whitelistedSnapshots: {
+        allowedSnapshots: {
           '/path/to/file.js.snap': ['snapshot name 1', /a big snapshot \d+/],
         },
       },
@@ -161,7 +161,7 @@ module.exports = {
     'jest/no-large-snapshots': [
       'error',
       {
-        whitelistedSnapshots: {
+        allowedSnapshots: {
           [path.resolve('test/__snapshots__/get.js.snap')]: ['full request'],
           [path.resolve('test/__snapshots__/put.js.snap')]: ['full request'],
         },

package/lib/rules/no-large-snapshots.js

@@ -19,26 +19,27 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 const reportOnViolation = (context, node, {
   maxSize: lineLimit = 50,
-  whitelistedSnapshots = {}
+  whitelistedSnapshots = {},
+  allowedSnapshots = 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);
+  const allPathsAreAbsolute = Object.keys(allowedSnapshots).every(_path.isAbsolute);
 
   if (!allPathsAreAbsolute) {
-    throw new Error('All paths for whitelistedSnapshots must be absolute. You can use JS config and `path.resolve`');
+    throw new Error('All paths for allowedSnapshots must be absolute. You can use JS config and `path.resolve`');
   }
 
-  let isWhitelisted = false;
+  let isAllowed = false;
 
   if (node.type === _experimentalUtils.AST_NODE_TYPES.ExpressionStatement && 'left' in node.expression && (0, _utils.isExpectMember)(node.expression.left)) {
     const fileName = context.getFilename();
-    const whitelistedSnapshotsInFile = whitelistedSnapshots[fileName];
+    const allowedSnapshotsInFile = allowedSnapshots[fileName];
 
-    if (whitelistedSnapshotsInFile) {
+    if (allowedSnapshotsInFile) {
       const snapshotName = (0, _utils.getAccessorValue)(node.expression.left.property);
-      isWhitelisted = whitelistedSnapshotsInFile.some(name => {
+      isAllowed = allowedSnapshotsInFile.some(name => {
         if (name instanceof RegExp) {
           return name.test(snapshotName);
         }
@@ -48,7 +49,7 @@ const reportOnViolation = (context, node, {
     }
   }
 
-  if (!isWhitelisted && lineCount > lineLimit) {
+  if (!isAllowed && lineCount > lineLimit) {
     context.report({
       messageId: lineLimit === 0 ? 'noSnapshot' : 'tooLongSnapshots',
       data: {
@@ -82,6 +83,12 @@ var _default = (0, _utils.createRule)({
         inlineMaxSize: {
           type: 'number'
         },
+        allowedSnapshots: {
+          type: 'object',
+          additionalProperties: {
+            type: 'array'
+          }
+        },
         whitelistedSnapshots: {
           type: 'object',
           patternProperties: {
@@ -97,6 +104,10 @@ var _default = (0, _utils.createRule)({
   defaultOptions: [{}],
 
   create(context, [options]) {
+    if ('whitelistedSnapshots' in options) {
+      console.warn('jest/no-large-snapshots: the "whitelistedSnapshots" option has been renamed to "allowedSnapshots"');
+    }
+
     if (context.getFilename().endsWith('.snap')) {
       return {
         ExpressionStatement(node) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "23.19.0",
+  "version": "23.20.0",
   "description": "Eslint rules for Jest",
   "keywords": [
     "eslint",