Fix snapshot serializer require, restructure pretty-format.

jestjs · Apr 28, 2017 · 89412c5 · 89412c5
1 parent 4f020f6
commit 89412c5
Show file tree

Hide file tree

Showing 20 changed files with 72 additions and 47 deletions.
diff --git a/.flowconfig b/.flowconfig
@@ -7,6 +7,7 @@
 .*/dangerfile.js
 
 [options]
+module.name_mapper='^pretty-format$' -> '<PROJECT_ROOT>/packages/pretty-format/src/index.js'
 module.name_mapper='^types/\(.*\)$' -> '<PROJECT_ROOT>/types/\1.js'
 module.name_mapper='\(jest-[^/]*\)' -> '<PROJECT_ROOT>/packages/\1/src/index.js'
 

diff --git a/packages/jest-diff/src/index.js b/packages/jest-diff/src/index.js
@@ -12,11 +12,13 @@
 
 import type {DiffOptions} from './diffStrings';
 
-const ReactElementPlugin = require('pretty-format/build/plugins/ReactElement');
-const ReactTestComponentPlugin = require('pretty-format/build/plugins/ReactTestComponent');
-const AsymmetricMatcherPlugin = require('pretty-format/build/plugins/AsymmetricMatcher');
-const HTMLElementPlugin = require('pretty-format/build/plugins/HTMLElement');
-const ImmutablePlugins = require('pretty-format/build/plugins/ImmutablePlugins');
+const {
+  ReactElement,
+  ReactTestComponent,
+  AsymmetricMatcher,
+  HTMLElement,
+  Immutable,
+} = require('pretty-format').plugins;
 
 const chalk = require('chalk');
 const diffStrings = require('./diffStrings');
@@ -26,11 +28,11 @@ const prettyFormat = require('pretty-format');
 const {NO_DIFF_MESSAGE, SIMILAR_MESSAGE} = require('./constants');
 
 const PLUGINS = [
-  ReactTestComponentPlugin,
-  ReactElementPlugin,
-  AsymmetricMatcherPlugin,
-  HTMLElementPlugin,
-].concat(ImmutablePlugins);
+  ReactTestComponent,
+  ReactElement,
+  AsymmetricMatcher,
+  HTMLElement,
+].concat(Immutable);
 const FORMAT_OPTIONS = {
   plugins: PLUGINS,
 };

diff --git a/packages/jest-jasmine2/src/index.js b/packages/jest-jasmine2/src/index.js
@@ -80,6 +80,7 @@ function jasmine2(
   )({
     config,
     globalConfig,
+    localRequire: runtime.requireModule.bind(runtime),
     testPath,
   });
 

diff --git a/packages/jest-jasmine2/src/setup-jest-globals.js b/packages/jest-jasmine2/src/setup-jest-globals.js
@@ -11,6 +11,7 @@
 'use strict';
 
 import type {GlobalConfig, Path, ProjectConfig} from 'types/Config';
+import type {Plugin} from 'types/PrettyFormat';
 
 const {getState, setState} = require('jest-matchers');
 const {initializeSnapshotState, addSerializer} = require('jest-snapshot');
@@ -24,6 +25,7 @@ const {
 export type SetupOptions = {|
   config: ProjectConfig,
   globalConfig: GlobalConfig,
+  localRequire: (moduleName: string) => Plugin,
   testPath: Path,
 |};
 
@@ -104,12 +106,16 @@ const patchJasmine = () => {
   })(global.jasmine.Spec);
 };
 
-module.exports = ({config, globalConfig, testPath}: SetupOptions) => {
+module.exports = ({
+  config,
+  globalConfig,
+  localRequire,
+  testPath,
+}: SetupOptions) => {
   // Jest tests snapshotSerializers in order preceding built-in serializers.
   // Therefore, add in reverse because the last added is the first tested.
   config.snapshotSerializers.concat().reverse().forEach(path => {
-    // $FlowFixMe
-    addSerializer(require(path));
+    addSerializer(localRequire(path));
   });
   setState({testPath});
   patchJasmine();

diff --git a/packages/jest-matcher-utils/src/index.js b/packages/jest-matcher-utils/src/index.js
@@ -12,16 +12,16 @@
 
 const chalk = require('chalk');
 const prettyFormat = require('pretty-format');
-const AsymmetricMatcherPlugin = require('pretty-format/build/plugins/AsymmetricMatcher');
-const ReactElementPlugin = require('pretty-format/build/plugins/ReactElement');
-const HTMLElementPlugin = require('pretty-format/build/plugins/HTMLElement');
-const ImmutablePlugins = require('pretty-format/build/plugins/ImmutablePlugins');
-
-const PLUGINS = [
-  AsymmetricMatcherPlugin,
-  ReactElementPlugin,
-  HTMLElementPlugin,
-].concat(ImmutablePlugins);
+const {
+  AsymmetricMatcher,
+  ReactElement,
+  HTMLElement,
+  Immutable,
+} = require('pretty-format').plugins;
+
+const PLUGINS = [AsymmetricMatcher, ReactElement, HTMLElement].concat(
+  Immutable,
+);
 
 export type ValueType =
   | 'array'

diff --git a/packages/jest-snapshot/src/plugins.js b/packages/jest-snapshot/src/plugins.js
@@ -9,19 +9,19 @@
  */
 'use strict';
 
-const ReactElementPlugin = require('pretty-format/build/plugins/ReactElement');
-const ReactTestComponentPlugin = require('pretty-format/build/plugins/ReactTestComponent');
-const HTMLElementPlugin = require('pretty-format/build/plugins/HTMLElement');
-const ImmutablePlugins = require('pretty-format/build/plugins/ImmutablePlugins');
+import type {Plugin} from 'types/PrettyFormat';
 
-let PLUGINS = [
-  ReactElementPlugin,
-  ReactTestComponentPlugin,
-  HTMLElementPlugin,
-].concat(ImmutablePlugins);
+const {
+  HTMLElement,
+  Immutable,
+  ReactElement,
+  ReactTestComponent,
+} = require('pretty-format').plugins;
+
+let PLUGINS = [HTMLElement, ReactElement, ReactTestComponent].concat(Immutable);
 
 // Prepend to list so the last added is the first tested.
-exports.addSerializer = (plugin: any) => {
+exports.addSerializer = (plugin: Plugin) => {
   PLUGINS = [plugin].concat(PLUGINS);
 };
 

diff --git a/packages/pretty-format/README.md b/packages/pretty-format/README.md
@@ -117,8 +117,8 @@ prettyFormat(obj, {
 
 ```js
 const prettyFormat = require('pretty-format');
-const reactTestPlugin = require('pretty-format/build/plugins/ReactTestComponent');
-const reactElementPlugin = require('pretty-format/build/plugins/ReactElement');
+const reactTestPlugin = require('pretty-format').plugins.ReactTestComponent;
+const reactElementPlugin = require('pretty-format').plugins.ReactElement;
 
 const React = require('react');
 const renderer = require('react-test-renderer');

diff --git a/packages/pretty-format/src/index.js b/packages/pretty-format/src/index.js
@@ -11,7 +11,13 @@
 
 'use strict';
 
-import type {Colors, Refs, StringOrNull, Plugins, Options} from './types.js';
+import type {
+  Colors,
+  Refs,
+  StringOrNull,
+  Plugins,
+  Options,
+} from 'types/PrettyFormat';
 
 const style = require('ansi-styles');
 
@@ -949,4 +955,13 @@ function prettyFormat(val: any, initialOptions?: InitialOptions): string {
   );
 }
 
+prettyFormat.plugins = {
+  AsymmetricMatcher: require('./plugins/AsymmetricMatcher'),
+  ConvertAnsi: require('./plugins/ConvertAnsi'),
+  HTMLElement: require('./plugins/HTMLElement'),
+  Immutable: require('./plugins/ImmutablePlugins'),
+  ReactElement: require('./plugins/ReactElement'),
+  ReactTestComponent: require('./plugins/ReactTestComponent'),
+};
+
 module.exports = prettyFormat;
diff --git a/packages/pretty-format/src/plugins/AsymmetricMatcher.js b/packages/pretty-format/src/plugins/AsymmetricMatcher.js
@@ -9,7 +9,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const asymmetricMatcher = Symbol.for('jest.asymmetricMatcher');
 const SPACE = ' ';

diff --git a/packages/pretty-format/src/plugins/ConvertAnsi.js b/packages/pretty-format/src/plugins/ConvertAnsi.js
@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const ansiRegex = require('ansi-regex');
 

diff --git a/packages/pretty-format/src/plugins/HTMLElement.js b/packages/pretty-format/src/plugins/HTMLElement.js
@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const escapeHTML = require('./lib/escapeHTML');
 const HTML_ELEMENT_REGEXP = /(HTML\w*?Element)/;

diff --git a/packages/pretty-format/src/plugins/ImmutableList.js b/packages/pretty-format/src/plugins/ImmutableList.js
@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

diff --git a/packages/pretty-format/src/plugins/ImmutableMap.js b/packages/pretty-format/src/plugins/ImmutableMap.js
@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

diff --git a/packages/pretty-format/src/plugins/ImmutableOrderedMap.js b/packages/pretty-format/src/plugins/ImmutableOrderedMap.js
@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

diff --git a/packages/pretty-format/src/plugins/ImmutableOrderedSet.js b/packages/pretty-format/src/plugins/ImmutableOrderedSet.js
@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

diff --git a/packages/pretty-format/src/plugins/ImmutableSet.js b/packages/pretty-format/src/plugins/ImmutableSet.js
@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

diff --git a/packages/pretty-format/src/plugins/ImmutableStack.js b/packages/pretty-format/src/plugins/ImmutableStack.js
@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
+import type {Colors, Indent, Options, Print, Plugin} from 'types/PrettyFormat';
 
 const printImmutable = require('./lib/printImmutable');
 

diff --git a/packages/pretty-format/src/plugins/ReactTestComponent.js b/packages/pretty-format/src/plugins/ReactTestComponent.js
@@ -18,7 +18,7 @@ import type {
   Plugin,
   ReactTestObject,
   ReactTestChild,
-} from '../types.js';
+} from 'types/PrettyFormat';
 
 const escapeHTML = require('./lib/escapeHTML');
 

diff --git a/packages/pretty-format/src/plugins/lib/printImmutable.js b/packages/pretty-format/src/plugins/lib/printImmutable.js
@@ -10,7 +10,7 @@
 
 'use strict';
 
-import type {Colors, Indent, Options, Print} from '../../types.js';
+import type {Colors, Indent, Options, Print} from 'types/PrettyFormat';
 
 const IMMUTABLE_NAMESPACE = 'Immutable.';
 const SPACE = ' ';

diff --git a/packages/pretty-format/src/types.js → types/PrettyFormat.js b/packages/pretty-format/src/types.js → types/PrettyFormat.js