Remove use of constructor.name (#1580)

Fixes #1300

## Checklist

- [ ] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [ ] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [ ] I have not broken the cheatsheet

---------

Co-authored-by: Pokey Rule <[email protected]>

Author: AndreasArvidsson

.eslintrc.json

@@ -46,6 +46,10 @@
         "checkLoops": false
       }
     ],
+    "no-restricted-syntax": [
+      "error",
+      "MemberExpression[object.property.name='constructor'][property.name='name']"
+    ],
     "no-throw-literal": "warn",
     "semi": "off"
   },

packages/cursorless-engine/src/processTargets/targets/BaseTarget.ts

@@ -1,13 +1,14 @@
+import type { TargetPlainObject, TargetPosition } from "@cursorless/common";
 import {
   NoContainingScopeError,
   Range,
   Selection,
   TextEditor,
+  rangeToPlainObject,
 } from "@cursorless/common";
 import { isEqual } from "lodash";
-import type { TargetPosition } from "@cursorless/common";
-import type { EditNewActionType, Target } from "../../typings/target.types";
 import type { EditWithRangeUpdater } from "../../typings/Types";
+import type { EditNewActionType, Target } from "../../typings/target.types";
 import { isSameType } from "../../util/typeUtils";
 import { toPositionTarget } from "../modifiers/toPositionTarget";
 import {
@@ -41,6 +42,7 @@ export default abstract class BaseTarget<
   in out TParameters extends MinimumTargetParameters,
 > implements Target
 {
+  protected abstract readonly type: string;
   protected readonly state: CommonTargetParameters;
   isLine = false;
   isToken = true;
@@ -194,6 +196,25 @@ export default abstract class BaseTarget<
     return toPositionTarget(this, position);
   }
 
+  /**
+   * Converts the target to a plain object representation.
+   *
+   * Note that this implementation is quite incomplete, but is suitable for
+   * round-tripping {@link UntypedTarget} objects and capturing the fact that an
+   * object is not an un typed target if it is not, via the {@link type}
+   * attribute.  In the future, we should override this method in subclasses to
+   * provide a more complete representation.
+   * @returns A plain object representation of the target
+   */
+  toPlainObject(): TargetPlainObject {
+    return {
+      type: this.type,
+      contentRange: rangeToPlainObject(this.contentRange),
+      isReversed: this.isReversed,
+      hasExplicitRange: this.hasExplicitRange,
+    };
+  }
+
   abstract get insertionDelimiter(): string;
   abstract getLeadingDelimiterTarget(): Target | undefined;
   abstract getTrailingDelimiterTarget(): Target | undefined;

packages/cursorless-engine/src/processTargets/targets/DocumentTarget.ts

@@ -3,6 +3,7 @@ import { shrinkRangeToFitContent } from "../../util/selectionUtils";
 import { BaseTarget, CommonTargetParameters, PlainTarget } from "./";
 
 export default class DocumentTarget extends BaseTarget<CommonTargetParameters> {
+  type = "DocumentTarget";
   insertionDelimiter = "\n";
   isLine = true;
 

packages/cursorless-engine/src/processTargets/targets/ImplicitTarget.ts

@@ -7,6 +7,7 @@ import { BaseTarget, CommonTargetParameters } from ".";
  * - The implicit anchor in the range `"take past air"`
  */
 export default class ImplicitTarget extends BaseTarget<CommonTargetParameters> {
+  type = "ImplicitTarget";
   insertionDelimiter = "";
   isRaw = true;
   hasExplicitScopeType = false;

packages/cursorless-engine/src/processTargets/targets/InteriorTarget.ts

@@ -13,6 +13,7 @@ export interface InteriorTargetParameters extends MinimumTargetParameters {
 }
 
 export default class InteriorTarget extends BaseTarget<InteriorTargetParameters> {
+  type = "InteriorTarget";
   insertionDelimiter = " ";
   private readonly fullInteriorRange: Range;
 

packages/cursorless-engine/src/processTargets/targets/LineTarget.ts

@@ -6,6 +6,7 @@ import { tryConstructPlainTarget } from "../../util/tryConstructTarget";
 import { createContinuousLineRange } from "../targetUtil/createContinuousRange";
 
 export default class LineTarget extends BaseTarget<CommonTargetParameters> {
+  type = "LineTarget";
   insertionDelimiter = "\n";
   isLine = true;
 

packages/cursorless-engine/src/processTargets/targets/NotebookCellTarget.ts

@@ -7,6 +7,7 @@ import {
 import { Target } from "../../typings/target.types";
 
 export default class NotebookCellTarget extends BaseTarget<CommonTargetParameters> {
+  type = "NotebookCellTarget";
   insertionDelimiter = "\n";
   isNotebookCell = true;
 
@@ -36,6 +37,7 @@ interface NotebookCellPositionTargetParameters extends CommonTargetParameters {
 }
 
 export class NotebookCellPositionTarget extends BaseTarget<NotebookCellPositionTargetParameters> {
+  type = "NotebookCellPositionTarget";
   insertionDelimiter = "\n";
   isNotebookCell = true;
   public position: TargetPosition;

packages/cursorless-engine/src/processTargets/targets/ParagraphTarget.ts

@@ -13,6 +13,7 @@ import { isSameType } from "../../util/typeUtils";
 import { createContinuousLineRange } from "../targetUtil/createContinuousRange";
 
 export default class ParagraphTarget extends BaseTarget<CommonTargetParameters> {
+  type = "ParagraphTarget";
   insertionDelimiter = "\n\n";
   isLine = true;
 

packages/cursorless-engine/src/processTargets/targets/PlainTarget.ts

@@ -9,6 +9,7 @@ interface PlainTargetParameters extends CommonTargetParameters {
  * just consists of the content itself. Its insertion delimiter is empty string.
  */
 export default class PlainTarget extends BaseTarget<PlainTargetParameters> {
+  type = "PlainTarget";
   insertionDelimiter = "";
 
   constructor(parameters: PlainTargetParameters) {

packages/cursorless-engine/src/processTargets/targets/PositionTarget.ts

@@ -11,6 +11,7 @@ interface PositionTargetParameters extends CommonTargetParameters {
 }
 
 export default class PositionTarget extends BaseTarget<PositionTargetParameters> {
+  type = "PositionTarget";
   insertionDelimiter: string;
   isRaw: boolean;
   private position: TargetPosition;

packages/cursorless-engine/src/processTargets/targets/RawSelectionTarget.ts

@@ -6,6 +6,7 @@ import { BaseTarget, CommonTargetParameters } from ".";
  * inherited from the source in the case of a bring after a bring before
  */
 export default class RawSelectionTarget extends BaseTarget<CommonTargetParameters> {
+  type = "RawSelectionTarget";
   insertionDelimiter = "";
   isRaw = true;
   isToken = false;

packages/cursorless-engine/src/processTargets/targets/ScopeTypeTarget.ts

@@ -28,6 +28,7 @@ export interface ScopeTypeTargetParameters extends CommonTargetParameters {
 }
 
 export default class ScopeTypeTarget extends BaseTarget<ScopeTypeTargetParameters> {
+  type = "ScopeTypeTarget";
   private scopeTypeType_: SimpleScopeTypeType;
   private removalRange_?: Range;
   private interiorRange_?: Range;

packages/cursorless-engine/src/processTargets/targets/SubTokenWordTarget.ts

@@ -13,6 +13,7 @@ export interface SubTokenTargetParameters extends CommonTargetParameters {
 }
 
 export default class SubTokenWordTarget extends BaseTarget<SubTokenTargetParameters> {
+  type = "SubTokenWordTarget";
   private leadingDelimiterRange_?: Range;
   private trailingDelimiterRange_?: Range;
   insertionDelimiter: string;

packages/cursorless-engine/src/processTargets/targets/SurroundingPairTarget.ts

@@ -29,6 +29,7 @@ interface SurroundingPairTargetParameters extends CommonTargetParameters {
 }
 
 export default class SurroundingPairTarget extends BaseTarget<SurroundingPairTargetParameters> {
+  type = "SurroundingPairTarget";
   insertionDelimiter = " ";
   private interiorRange_: Range;
   private boundary_: [Range, Range];

packages/cursorless-engine/src/processTargets/targets/TokenTarget.ts

@@ -8,6 +8,7 @@ import {
 } from "../targetUtil/insertionRemovalBehaviors/TokenInsertionRemovalBehavior";
 
 export default class TokenTarget extends BaseTarget<CommonTargetParameters> {
+  type = "TokenTarget";
   insertionDelimiter = " ";
 
   getLeadingDelimiterTarget(): Target | undefined {

packages/cursorless-engine/src/processTargets/targets/UntypedTarget.ts

@@ -19,6 +19,7 @@ interface UntypedTargetParameters extends CommonTargetParameters {
  * - Expand to nearest containing pair when asked for boundary or interior
  */
 export default class UntypedTarget extends BaseTarget<UntypedTargetParameters> {
+  type = "UntypedTarget";
   insertionDelimiter = " ";
   hasExplicitScopeType = false;
 

packages/cursorless-engine/src/testUtil/takeSnapshot.ts

@@ -12,7 +12,6 @@ import {
   TextEditor,
 } from "@cursorless/common";
 import type { StoredTargetMap } from "../core/StoredTargets";
-import { targetToPlainObject } from "./targetToPlainObject";
 
 export async function takeSnapshot(
   storedTargets: StoredTargetMap | undefined,
@@ -48,21 +47,24 @@ export async function takeSnapshot(
 
   const thatMarkTargets = storedTargets?.get("that");
   if (thatMarkTargets != null && !excludeFields.includes("thatMark")) {
-    snapshot.thatMark = thatMarkTargets.map(targetToPlainObject);
+    snapshot.thatMark = thatMarkTargets.map((target) => target.toPlainObject());
   }
 
   const sourceMarkTargets = storedTargets?.get("source");
   if (sourceMarkTargets != null && !excludeFields.includes("sourceMark")) {
-    snapshot.sourceMark = sourceMarkTargets.map(targetToPlainObject);
+    snapshot.sourceMark = sourceMarkTargets.map((target) =>
+      target.toPlainObject(),
+    );
   }
 
   const instanceReferenceMarkTargets = storedTargets?.get("instanceReference");
   if (
     instanceReferenceMarkTargets != null &&
     !excludeFields.includes("instanceReferenceMark")
   ) {
-    snapshot.instanceReferenceMark =
-      instanceReferenceMarkTargets.map(targetToPlainObject);
+    snapshot.instanceReferenceMark = instanceReferenceMarkTargets.map(
+      (target) => target.toPlainObject(),
+    );
   }
 
   if (extraFields.includes("timeOffsetSeconds")) {

packages/cursorless-engine/src/testUtil/targetToPlainObject.ts

@@ -9,11 +9,13 @@ import type { ModifyIfUntypedStage } from "../processTargets/modifiers/Condition
 import type {
   Range,
   Selection,
-  TextEditor,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-imports
   Snippet,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-imports
   SnippetVariable,
+  TargetPlainObject,
+  TargetPosition,
+  TextEditor,
 } from "@cursorless/common";
 import type {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-imports
@@ -23,7 +25,6 @@ import type {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-imports
   UntypedTarget,
 } from "../processTargets/targets";
-import type { TargetPosition } from "@cursorless/common";
 import type { EditWithRangeUpdater } from "./Types";
 
 export type EditNewActionType = "edit" | "insertLineAfter";
@@ -155,4 +156,11 @@ export interface Target {
    * @param position The position to use, eg `start`, `end`, `before`, `after`
    */
   toPositionTarget(position: TargetPosition): Target;
+  /**
+   * Constructs an object suitable for serialization by json. This is used to
+   * capture targets for testing and recording test cases.
+   *
+   * @returns A plain object that can be json serialized
+   */
+  toPlainObject(): TargetPlainObject;
 }

packages/cursorless-engine/src/typings/target.types.ts

@@ -838,7 +838,7 @@
     "uninstall-local": "bash ./scripts/uninstall-local.sh",
     "esbuild": "pnpm run esbuild:base --sourcemap",
     "esbuild:watch": "pnpm run esbuild:base --sourcemap --watch",
-    "esbuild:prod": "pnpm run esbuild:base --minify --keep-names",
+    "esbuild:prod": "pnpm run esbuild:base --minify",
     "populate-dist": "tsx --conditions=cursorless:bundler ./src/scripts/populateDist/index.ts",
     "init-launch-sandbox": "tsx --conditions=cursorless:bundler src/scripts/initLaunchSandbox.ts",
     "preprocess-svg-hats": "tsx --conditions=cursorless:bundler src/scripts/preprocessSvgHats.ts",