jest snapshot - TS migration

packages/jest-snapshot/dts/natural-compare.d.ts

@@ -0,0 +1,4 @@
+declare module 'natural-compare' {
+  const NaturalCompare: (a: string, b: string) => number;
+  export default NaturalCompare;
+}

packages/jest-snapshot/package.json

@@ -10,6 +10,7 @@
   "main": "build/index.js",
   "dependencies": {
     "@babel/types": "^7.0.0",
+    "@jest/types": "^24.1.0",
     "chalk": "^2.0.1",
     "jest-diff": "^24.0.0",
     "jest-matcher-utils": "^24.0.0",
@@ -23,7 +24,10 @@
   "devDependencies": {
     "@types/mkdirp": "^0.5.2",
     "@types/semver": "^5.5.0",
-    "prettier": "^1.13.4"
+    "expect": "^24.1.0",
+    "jest-haste-map": "^24.0.0",
+    "prettier": "^1.13.4",
+    "pretty-format": "^24.0.0"
   },
   "engines": {
     "node": ">= 6"

packages/jest-snapshot/src/State.js → packages/jest-snapshot/src/State.ts

@@ -4,12 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
  */
 
-import type {Path, SnapshotUpdateState} from 'types/Config';
-
 import fs from 'fs';
+import {Config} from '@jest/types';
+
 import {getTopFrame, getStackTraceLines} from 'jest-message-util';
 import {
   saveSnapshotFile,
@@ -19,41 +18,43 @@ import {
   testNameToKey,
   unescape,
 } from './utils';
-import {saveInlineSnapshots, type InlineSnapshot} from './inline_snapshots';
+import {saveInlineSnapshots, InlineSnapshot} from './inline_snapshots';
+import {SnapshotData} from './types';
 
-export type SnapshotStateOptions = {|
-  updateSnapshot: SnapshotUpdateState,
-  getPrettier: () => null | any,
-  getBabelTraverse: () => Function,
-  expand?: boolean,
-|};
+export type SnapshotStateOptions = {
+  updateSnapshot: Config.SnapshotUpdateState;
+  getPrettier: () => null | any;
+  getBabelTraverse: () => Function;
+  expand?: boolean;
+};
 
-export type SnapshotMatchOptions = {|
-  testName: string,
-  received: any,
-  key?: string,
-  inlineSnapshot?: string,
-  error?: Error,
-|};
+export type SnapshotMatchOptions = {
+  testName: string;
+  received: any;
+  key?: string;
+  inlineSnapshot?: string;
+  error?: Error;
+};
 
 export default class SnapshotState {
-  _counters: Map<string, number>;
-  _dirty: boolean;
-  _index: number;
-  _updateSnapshot: SnapshotUpdateState;
-  _snapshotData: {[key: string]: string};
-  _snapshotPath: Path;
-  _inlineSnapshots: Array<InlineSnapshot>;
-  _uncheckedKeys: Set<string>;
-  _getBabelTraverse: () => Function;
-  _getPrettier: () => null | any;
+  private _counters: Map<string, number>;
+  private _dirty: boolean;
+  private _index: number;
+  private _updateSnapshot: Config.SnapshotUpdateState;
+  private _snapshotData: SnapshotData;
+  private _snapshotPath: Config.Path;
+  private _inlineSnapshots: Array<InlineSnapshot>;
+  private _uncheckedKeys: Set<string>;
+  private _getBabelTraverse: () => Function;
+  private _getPrettier: () => null | any;
+
   added: number;
   expand: boolean;
   matched: number;
   unmatched: number;
   updated: number;
 
-  constructor(snapshotPath: Path, options: SnapshotStateOptions) {
+  constructor(snapshotPath: Config.Path, options: SnapshotStateOptions) {
     this._snapshotPath = snapshotPath;
     const {data, dirty} = getSnapshotData(
       this._snapshotPath,
@@ -83,23 +84,27 @@ export default class SnapshotState {
     });
   }
 
-  _addSnapshot(
+  private _addSnapshot(
     key: string,
     receivedSerialized: string,
-    options: {isInline: boolean, error?: Error},
+    options: {isInline: boolean; error?: Error},
   ) {
     this._dirty = true;
     if (options.isInline) {
       const error = options.error || new Error();
-      const lines = getStackTraceLines(error.stack);
+      const lines = getStackTraceLines(error.stack || '');
       const frame = getTopFrame(lines);
       if (!frame) {
         throw new Error(
           "Jest: Couldn't infer stack frame for inline snapshot.",
         );
       }
       this._inlineSnapshots.push({
-        frame,
+        frame: {
+          column: frame.column,
+          file: frame.file as string,
+          line: frame.line,
+        },
         snapshot: receivedSerialized,
       });
     } else {
@@ -251,7 +256,7 @@ export default class SnapshotState {
     }
   }
 
-  fail(testName: string, received: any, key?: string) {
+  fail(testName: string, _: any, key?: string) {
     this._counters.set(testName, (this._counters.get(testName) || 0) + 1);
     const count = Number(this._counters.get(testName));
 

packages/jest-snapshot/src/__tests__/inline_snapshots.test.js → packages/jest-snapshot/src/__tests__/inline_snapshots.test.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
+ *
  */
 
 jest.mock('fs');
@@ -23,40 +23,27 @@ const existsSync = fs.existsSync;
 const statSync = fs.statSync;
 const readdirSync = fs.readdirSync;
 beforeEach(() => {
-  // $FlowFixMe mock
   fs.writeFileSync = jest.fn();
-  // $FlowFixMe mock
   fs.readFileSync = jest.fn();
-  // $FlowFixMe mock
   fs.existsSync = jest.fn(() => true);
-  // $FlowFixMe mock
   fs.statSync = jest.fn(filePath => ({
     isDirectory: () => !filePath.endsWith('.js'),
   }));
-  // $FlowFixMe mock
   fs.readdirSync = jest.fn(() => []);
 
   prettier.resolveConfig.sync.mockReset();
 });
 afterEach(() => {
-  // $FlowFixMe mock
   fs.writeFileSync = writeFileSync;
-  // $FlowFixMe mock
   fs.readFileSync = readFileSync;
-  // $FlowFixMe mock
   fs.existsSync = existsSync;
-  // $FlowFixMe mock
   fs.statSync = statSync;
-  // $FlowFixMe mock
   fs.readdirSync = readdirSync;
 });
 
 test('saveInlineSnapshots() replaces empty function call with a template literal', () => {
   const filename = path.join(__dirname, 'my.test.js');
-  // $FlowFixMe mock
-  fs.readFileSync = (jest.fn(
-    () => `expect(1).toMatchInlineSnapshot();\n`,
-  ): any);
+  fs.readFileSync = jest.fn(() => `expect(1).toMatchInlineSnapshot();\n`);
 
   saveInlineSnapshots(
     [
@@ -79,10 +66,7 @@ test.each([['babylon'], ['flow'], ['typescript']])(
   'saveInlineSnapshots() replaces existing template literal - %s parser',
   parser => {
     const filename = path.join(__dirname, 'my.test.js');
-    // $FlowFixMe mock
-    fs.readFileSync = (jest.fn(
-      () => 'expect(1).toMatchInlineSnapshot(`2`);\n',
-    ): any);
+    fs.readFileSync = jest.fn(() => 'expect(1).toMatchInlineSnapshot(`2`);\n');
 
     prettier.resolveConfig.sync.mockReturnValue({parser});
 
@@ -108,10 +92,9 @@ test.each([['babylon'], ['flow'], ['typescript']])(
 
 test('saveInlineSnapshots() replaces existing template literal with property matchers', () => {
   const filename = path.join(__dirname, 'my.test.js');
-  // $FlowFixMe mock
-  fs.readFileSync = (jest.fn(
+  fs.readFileSync = jest.fn(
     () => 'expect(1).toMatchInlineSnapshot({}, `2`);\n',
-  ): any);
+  );
 
   saveInlineSnapshots(
     [
@@ -132,10 +115,7 @@ test('saveInlineSnapshots() replaces existing template literal with property mat
 
 test('saveInlineSnapshots() throws if frame does not match', () => {
   const filename = path.join(__dirname, 'my.test.js');
-  // $FlowFixMe mock
-  fs.readFileSync = (jest.fn(
-    () => 'expect(1).toMatchInlineSnapshot();\n',
-  ): any);
+  fs.readFileSync = jest.fn(() => 'expect(1).toMatchInlineSnapshot();\n');
 
   const save = () =>
     saveInlineSnapshots(
@@ -154,10 +134,7 @@ test('saveInlineSnapshots() throws if frame does not match', () => {
 
 test('saveInlineSnapshots() throws if multiple calls to to the same location', () => {
   const filename = path.join(__dirname, 'my.test.js');
-  // $FlowFixMe mock
-  fs.readFileSync = (jest.fn(
-    () => 'expect(1).toMatchInlineSnapshot();\n',
-  ): any);
+  fs.readFileSync = jest.fn(() => 'expect(1).toMatchInlineSnapshot();\n');
 
   const frame = {column: 11, file: filename, line: 1};
   const save = () =>
@@ -174,10 +151,7 @@ test('saveInlineSnapshots() throws if multiple calls to to the same location', (
 
 test('saveInlineSnapshots() uses escaped backticks', () => {
   const filename = path.join(__dirname, 'my.test.js');
-  // $FlowFixMe mock
-  fs.readFileSync = (jest.fn(
-    () => 'expect("`").toMatchInlineSnapshot();\n',
-  ): any);
+  fs.readFileSync = jest.fn(() => 'expect("`").toMatchInlineSnapshot();\n');
 
   const frame = {column: 13, file: filename, line: 1};
   saveInlineSnapshots([{frame, snapshot: '`'}], prettier, babelTraverse);
@@ -190,10 +164,9 @@ test('saveInlineSnapshots() uses escaped backticks', () => {
 
 test('saveInlineSnapshots() works with non-literals in expect call', () => {
   const filename = path.join(__dirname, 'my.test.js');
-  // $FlowFixMe mock
-  fs.readFileSync = (jest.fn(
+  fs.readFileSync = jest.fn(
     () => `expect({a: 'a'}).toMatchInlineSnapshot();\n`,
-  ): any);
+  );
   prettier.resolveConfig.sync.mockReturnValue({
     bracketSpacing: false,
     singleQuote: true,

packages/jest-snapshot/src/__tests__/matcher.test.js → packages/jest-snapshot/src/__tests__/matcher.test.ts

@@ -13,7 +13,10 @@ it(`matcher returns matcher name, expected and actual values`, () => {
   const actual = 'a';
   const expected = 'b';
   const matcher = toMatchSnapshot.bind({
-    snapshotState: {match: (testName, received) => ({actual, expected})},
+    snapshotState: {
+      // @ts-ignore
+      match: (testName: string, received: any) => ({actual, expected}), // eslint-disable-line
+    },
   });
 
   const matcherResult = matcher({a: 1});

packages/jest-snapshot/src/__tests__/plugins.test.js → packages/jest-snapshot/src/__tests__/plugins.test.ts

@@ -9,7 +9,7 @@
 
 beforeEach(() => jest.resetModules());
 
-const testPath = names => {
+const testPath = (names: string[]) => {
   const {addSerializer, getSerializers} = require('../plugins');
   const prev = getSerializers();
   const added = names.map(name =>

packages/jest-snapshot/src/__tests__/throw_matcher.test.js → packages/jest-snapshot/src/__tests__/throw_matcher.test.ts

@@ -5,11 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  *
  */
+
 'use strict';
 
 const {toThrowErrorMatchingSnapshot} = require('../');
 
-let matchFn;
+let matchFn: jest.Mock;
 
 beforeEach(() => {
   matchFn = jest.fn(() => ({
@@ -33,7 +34,7 @@ it('throw matcher can take func', () => {
 });
 
 describe('throw matcher from promise', () => {
-  let throwMatcher;
+  let throwMatcher: typeof toThrowErrorMatchingSnapshot;
 
   beforeEach(() => {
     throwMatcher = toThrowErrorMatchingSnapshot.bind({

packages/jest-snapshot/src/__tests__/utils.test.js → packages/jest-snapshot/src/__tests__/utils.test.ts

@@ -177,8 +177,8 @@ test('escaping', () => {
       'exports[`key`] = `"\'\\\\`;\n',
   );
 
-  // eslint-disable-next-line no-unused-vars
-  const exports = {};
+  // @ts-ignore
+  const exports = {}; // eslint-disable-line
   // eslint-disable-next-line no-eval
   const readData = eval('var exports = {}; ' + writtenData + ' exports');
   expect(readData).toEqual({key: data});