Move non-test toPlainObject out of common/src/testUtil (#2003)

Move toPlainObject.ts to util; create testUtil/spyToPlainObject.ts.

---------

Co-authored-by: Barry Jaspan <[email protected]>
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

Author: 3 people

packages/common/src/index.ts

@@ -50,7 +50,7 @@ export * from "./types/SpokenForm";
 export * from "./util/textFormatters";
 export * from "./types/snippet.types";
 export * from "./testUtil/fromPlainObject";
-export * from "./testUtil/toPlainObject";
+export * from "./testUtil/spyToPlainObject";
 export { default as DefaultMap } from "./util/DefaultMap";
 export * from "./types/GeneralizedRange";
 export * from "./types/RangeOffsets";
@@ -92,3 +92,4 @@ export * from "./getFakeCommandServerApi";
 export * from "./types/TestCaseFixture";
 export * from "./util/getEnvironmentVariableStrict";
 export * from "./util/CompositeKeyDefaultMap";
+export * from "./util/toPlainObject";

packages/common/src/testUtil/TestCaseSnapshot.ts

@@ -3,7 +3,7 @@ import {
   SelectionPlainObject,
   SerializedMarks,
   TargetPlainObject,
-} from "./toPlainObject";
+} from "../util/toPlainObject";
 
 export type TestCaseSnapshot = {
   documentContents: string;

packages/common/src/testUtil/fromPlainObject.ts

@@ -5,7 +5,7 @@ import type {
   PositionPlainObject,
   RangePlainObject,
   SelectionPlainObject,
-} from "./toPlainObject";
+} from "../util/toPlainObject";
 
 export function plainObjectToPosition({
   line,

packages/common/src/testUtil/spyToPlainObject.ts

@@ -0,0 +1,30 @@
+import type { Message, SpyIDERecordedValues } from "..";
+import {
+  PlainFlashDescriptor,
+  PlainHighlight,
+  generalizedRangeToPlainObject,
+} from "../util/toPlainObject";
+
+export interface PlainSpyIDERecordedValues {
+  messages: Message[] | undefined;
+  flashes: PlainFlashDescriptor[] | undefined;
+  highlights: PlainHighlight[] | undefined;
+}
+
+export function spyIDERecordedValuesToPlainObject(
+  input: SpyIDERecordedValues,
+): PlainSpyIDERecordedValues {
+  return {
+    messages: input.messages,
+    flashes: input.flashes?.map((descriptor) => ({
+      style: descriptor.style,
+      range: generalizedRangeToPlainObject(descriptor.range),
+    })),
+    highlights: input.highlights?.map((highlight) => ({
+      highlightId: highlight.highlightId,
+      ranges: highlight.ranges.map((range) =>
+        generalizedRangeToPlainObject(range),
+      ),
+    })),
+  };
+}

packages/common/src/types/TestCaseFixture.ts

@@ -1,6 +1,6 @@
 import { Command, CommandLatest } from "..";
 import { TestCaseSnapshot } from "../testUtil/TestCaseSnapshot";
-import { PlainSpyIDERecordedValues } from "../testUtil/toPlainObject";
+import { PlainSpyIDERecordedValues } from "../testUtil/spyToPlainObject";
 
 export type ThrownError = {
   name: string;

packages/common/src/testUtil/toPlainObject.ts renamed to packages/common/src/util/toPlainObject.ts

@@ -1,10 +1,4 @@
-import type {
-  CharacterRange,
-  GeneralizedRange,
-  LineRange,
-  Message,
-  SpyIDERecordedValues,
-} from "..";
+import type { CharacterRange, GeneralizedRange, LineRange } from "..";
 import { FlashStyle, isLineRange } from "..";
 import { Token } from "../types/Token";
 import { Selection } from "../types/Selection";
@@ -27,22 +21,16 @@ export type CharacterRangePlainObject = {
 
 export type GeneralizedRangePlainObject = CharacterRangePlainObject | LineRange;
 
-interface PlainFlashDescriptor {
+export interface PlainFlashDescriptor {
   style: keyof typeof FlashStyle;
   range: GeneralizedRangePlainObject;
 }
 
-interface PlainHighlight {
+export interface PlainHighlight {
   highlightId: string | undefined;
   ranges: GeneralizedRangePlainObject[];
 }
 
-export interface PlainSpyIDERecordedValues {
-  messages: Message[] | undefined;
-  flashes: PlainFlashDescriptor[] | undefined;
-  highlights: PlainHighlight[] | undefined;
-}
-
 export type SelectionPlainObject = {
   anchor: PositionPlainObject;
   active: PositionPlainObject;
@@ -148,21 +136,3 @@ export function characterRangeToPlainObject(
     end: positionToPlainObject(range.end),
   };
 }
-
-export function spyIDERecordedValuesToPlainObject(
-  input: SpyIDERecordedValues,
-): PlainSpyIDERecordedValues {
-  return {
-    messages: input.messages,
-    flashes: input.flashes?.map((descriptor) => ({
-      style: descriptor.style,
-      range: generalizedRangeToPlainObject(descriptor.range),
-    })),
-    highlights: input.highlights?.map((highlight) => ({
-      highlightId: highlight.highlightId,
-      ranges: highlight.ranges.map((range) =>
-        generalizedRangeToPlainObject(range),
-      ),
-    })),
-  };
-}