jest snapshot - TS migration

packages/jest-snapshot/src/State.ts

@@ -39,6 +39,7 @@ export type SnapshotMatchOptions = {
 export default class SnapshotState {
   private _counters: Map<string, number>;
   private _dirty: boolean;
+  // @ts-ignore
   private _index: number;
   private _updateSnapshot: Config.SnapshotUpdateState;
   private _snapshotData: SnapshotData;

packages/jest-snapshot/src/mock_serializer.ts

@@ -7,15 +7,15 @@
  *
  */
 
-import {Config, NewPlugin, Printer, Refs} from 'pretty-format';
+import {PrettyFormat} from '@jest/types';
 
 export const serialize = (
   val: any,
-  config: Config,
+  config: PrettyFormat.Config,
   indentation: string,
   depth: number,
-  refs: Refs,
-  printer: Printer,
+  refs: PrettyFormat.Refs,
+  printer: PrettyFormat.Printer,
 ): string => {
   // Serialize a non-default name, even if config.printFunctionName is false.
   const name = val.getMockName();
@@ -46,6 +46,6 @@ export const serialize = (
 
 export const test = (val: any) => val && !!val._isMockFunction;
 
-const plugin: NewPlugin = {serialize, test};
+const plugin: PrettyFormat.NewPlugin = {serialize, test};
 
 export default plugin;

packages/jest-snapshot/src/plugins.ts

@@ -7,7 +7,9 @@
  *
  */
 
-import prettyFormat, {Plugin} from 'pretty-format';
+import prettyFormat from 'pretty-format';
+import {PrettyFormat} from '@jest/types';
+
 import jestMockSerializer from './mock_serializer';
 
 const {
@@ -19,7 +21,7 @@ const {
   AsymmetricMatcher,
 } = prettyFormat.plugins;
 
-let PLUGINS: Array<Plugin> = [
+let PLUGINS: Array<PrettyFormat.Plugin> = [
   ReactTestComponent,
   ReactElement,
   DOMElement,
@@ -30,7 +32,7 @@ let PLUGINS: Array<Plugin> = [
 ];
 
 // Prepend to list so the last added is the first tested.
-export const addSerializer = (plugin: Plugin) => {
+export const addSerializer = (plugin: PrettyFormat.Plugin) => {
   PLUGINS = [plugin].concat(PLUGINS);
 };
 

packages/jest-types/src/PrettyFormat.ts

@@ -0,0 +1,117 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+export type Colors = {
+  comment: {close: string; open: string};
+  content: {close: string; open: string};
+  prop: {close: string; open: string};
+  tag: {close: string; open: string};
+  value: {close: string; open: string};
+};
+type Indent = (arg0: string) => string;
+export type Refs = Array<any>;
+type Print = (arg0: any) => string;
+
+export type Theme = {
+  comment: string;
+  content: string;
+  prop: string;
+  tag: string;
+  value: string;
+};
+
+type ThemeReceived = {
+  comment?: string;
+  content?: string;
+  prop?: string;
+  tag?: string;
+  value?: string;
+};
+
+export type Options = {
+  callToJSON: boolean;
+  escapeRegex: boolean;
+  escapeString: boolean;
+  highlight: boolean;
+  indent: number;
+  maxDepth: number;
+  min: boolean;
+  plugins: Plugins;
+  printFunctionName: boolean;
+  theme: Theme;
+};
+
+export type OptionsReceived = {
+  callToJSON?: boolean;
+  escapeRegex?: boolean;
+  escapeString?: boolean;
+  highlight?: boolean;
+  indent?: number;
+  maxDepth?: number;
+  min?: boolean;
+  plugins?: Plugins;
+  printFunctionName?: boolean;
+  theme?: ThemeReceived;
+};
+
+export type Config = {
+  callToJSON: boolean;
+  colors: Colors;
+  escapeRegex: boolean;
+  escapeString: boolean;
+  indent: string;
+  maxDepth: number;
+  min: boolean;
+  plugins: Plugins;
+  printFunctionName: boolean;
+  spacingInner: string;
+  spacingOuter: string;
+};
+
+export type Printer = (
+  val: any,
+  config: Config,
+  indentation: string,
+  depth: number,
+  refs: Refs,
+  hasCalledToJSON?: boolean,
+) => string;
+
+type Test = (arg0: any) => boolean;
+
+export type NewPlugin = {
+  serialize: (
+    val: any,
+    config: Config,
+    indentation: string,
+    depth: number,
+    refs: Refs,
+    printer: Printer,
+  ) => string;
+  test: Test;
+};
+
+type PluginOptions = {
+  edgeSpacing: string;
+  min: boolean;
+  spacing: string;
+};
+
+type OldPlugin = {
+  print: (
+    val: any,
+    print: Print,
+    indent: Indent,
+    options: PluginOptions,
+    colors: Colors,
+  ) => string;
+  test: Test;
+};
+
+export type Plugin = NewPlugin | OldPlugin;
+
+export type Plugins = Array<Plugin>;

packages/jest-types/src/index.ts

@@ -11,5 +11,14 @@ import * as SourceMaps from './SourceMaps';
 import * as TestResult from './TestResult';
 import * as Mocks from './Mocks';
 import * as Transform from './Transform';
+import * as PrettyFormat from './PrettyFormat';
 
-export {Config, Console, SourceMaps, TestResult, Mocks, Transform};
+export {
+  Config,
+  Console,
+  SourceMaps,
+  TestResult,
+  Mocks,
+  Transform,
+  PrettyFormat,
+};

packages/pretty-format/package.json

@@ -21,6 +21,7 @@
     "@types/ansi-styles": "^3.2.1",
     "@types/react": "*",
     "@types/react-test-renderer": "*",
+    "@jest/types": "^24.1.0",
     "immutable": "4.0.0-rc.9",
     "react": "*",
     "react-dom": "*",

packages/pretty-format/src/index.ts

@@ -18,8 +18,6 @@ import {
   Theme,
 } from './types';
 
-export * from './types';
-
 import {
   printIteratorEntries,
   printIteratorValues,
@@ -522,4 +520,4 @@ prettyFormat.plugins = {
   ReactTestComponent,
 };
 
-export default prettyFormat;
+export = prettyFormat;

packages/pretty-format/src/types.ts

@@ -5,113 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-export type Colors = {
-  comment: {close: string; open: string};
-  content: {close: string; open: string};
-  prop: {close: string; open: string};
-  tag: {close: string; open: string};
-  value: {close: string; open: string};
-};
-type Indent = (arg0: string) => string;
-export type Refs = Array<any>;
-type Print = (arg0: any) => string;
+import {PrettyFormat} from '@jest/types';
 
-export type Theme = {
-  comment: string;
-  content: string;
-  prop: string;
-  tag: string;
-  value: string;
-};
-
-type ThemeReceived = {
-  comment?: string;
-  content?: string;
-  prop?: string;
-  tag?: string;
-  value?: string;
-};
-
-export type Options = {
-  callToJSON: boolean;
-  escapeRegex: boolean;
-  escapeString: boolean;
-  highlight: boolean;
-  indent: number;
-  maxDepth: number;
-  min: boolean;
-  plugins: Plugins;
-  printFunctionName: boolean;
-  theme: Theme;
-};
-
-export type OptionsReceived = {
-  callToJSON?: boolean;
-  escapeRegex?: boolean;
-  escapeString?: boolean;
-  highlight?: boolean;
-  indent?: number;
-  maxDepth?: number;
-  min?: boolean;
-  plugins?: Plugins;
-  printFunctionName?: boolean;
-  theme?: ThemeReceived;
-};
-
-export type Config = {
-  callToJSON: boolean;
-  colors: Colors;
-  escapeRegex: boolean;
-  escapeString: boolean;
-  indent: string;
-  maxDepth: number;
-  min: boolean;
-  plugins: Plugins;
-  printFunctionName: boolean;
-  spacingInner: string;
-  spacingOuter: string;
-};
-
-export type Printer = (
-  val: any,
-  config: Config,
-  indentation: string,
-  depth: number,
-  refs: Refs,
-  hasCalledToJSON?: boolean,
-) => string;
-
-type Test = (arg0: any) => boolean;
-
-export type NewPlugin = {
-  serialize: (
-    val: any,
-    config: Config,
-    indentation: string,
-    depth: number,
-    refs: Refs,
-    printer: Printer,
-  ) => string;
-  test: Test;
-};
-
-type PluginOptions = {
-  edgeSpacing: string;
-  min: boolean;
-  spacing: string;
-};
-
-type OldPlugin = {
-  print: (
-    val: any,
-    print: Print,
-    indent: Indent,
-    options: PluginOptions,
-    colors: Colors,
-  ) => string;
-  test: Test;
-};
-
-export type Plugin = NewPlugin | OldPlugin;
-
-export type Plugins = Array<Plugin>;
+export = PrettyFormat;

packages/pretty-format/tsconfig.json

@@ -3,5 +3,9 @@
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "build"
+  },
+  "references": [{
+    "path": "../jest-types"
   }
+  ]
 }