Merge pull request #590 from Shopify/converts-missing-files

Converts ResizeMirror test to typescript
Shopify · Oct 12, 2023 · 39a9895 · 39a9895
2 parents 717a4b5 + f05efb3
commit 39a9895
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 22 deletions.
diff --git a/.changeset/smooth-coins-brush.md b/.changeset/smooth-coins-brush.md
@@ -0,0 +1,5 @@
+---
+'@shopify/draggable': patch
+---
+
+Fixes VSCode search to exclude generated files/folders
diff --git a/.changeset/sour-ravens-pull.md b/.changeset/sour-ravens-pull.md
@@ -0,0 +1,5 @@
+---
+'@shopify/draggable': patch
+---
+
+Converts ResizeMirror test to typescript
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -7,11 +7,11 @@
     "coverage": true
   },
   "search.exclude": {
-    "**/node_modules": true,
-    ".rollup.cache": true,
-    "coverage": true,
-    "build": true,
-    "docs": true
+    "node_modules/**/*": true,
+    ".rollup.cache/**/*": true,
+    "coverage/**/*": true,
+    "build/**/*": true,
+    "docs/**/*": true
   },
   "[typescript]": {
     "editor.formatOnSave": false,

diff --git a/...s/ResizeMirror/tests/ResizeMirror.test.js → ...s/ResizeMirror/tests/ResizeMirror.test.ts b/...s/ResizeMirror/tests/ResizeMirror.test.js → ...s/ResizeMirror/tests/ResizeMirror.test.ts
@@ -9,8 +9,12 @@ import {
   DRAG_DELAY,
   drag,
 } from 'helper';
+import {FixMeAny} from 'shared/types';
 
-import {Draggable} from '../../..';
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+// @ts-ignore
+import Draggable from '../../../Draggable';
+/* eslint-enable @typescript-eslint/ban-ts-comment */
 import ResizeMirror from '..';
 
 const sampleMarkup = `
@@ -36,17 +40,17 @@ describe('ResizeMirror', () => {
     height: smallerDraggableDimensions.height * 2,
   };
 
-  let sandbox;
-  let containers;
-  let draggable;
-  let draggables;
-  let smallerDraggable;
-  let largerDraggable;
+  let sandbox: HTMLDivElement;
+  let containers: HTMLElement[];
+  let draggable: FixMeAny;
+  let draggables: HTMLElement[];
+  let smallerDraggable: HTMLElement;
+  let largerDraggable: HTMLElement;
 
   beforeEach(() => {
     sandbox = createSandbox(sampleMarkup);
-    containers = sandbox.querySelectorAll('.Container');
-    draggables = sandbox.querySelectorAll('li');
+    containers = [...sandbox.querySelectorAll<HTMLElement>('.Container')];
+    draggables = [...sandbox.querySelectorAll<HTMLElement>('li')];
 
     smallerDraggable = draggables[0];
     largerDraggable = draggables[1];
@@ -71,7 +75,7 @@ describe('ResizeMirror', () => {
     waitForDragDelay();
     await waitForPromisesToResolve();
 
-    const mirror = document.querySelector('.draggable-mirror');
+    const mirror = document.querySelector<HTMLElement>('.draggable-mirror')!;
 
     expect(mirror.style).toMatchObject({
       width: `${smallerDraggableDimensions.width}px`,
@@ -104,7 +108,7 @@ describe('ResizeMirror', () => {
     waitForDragDelay();
     await waitForPromisesToResolve();
 
-    const mirror = document.querySelector('.draggable-mirror');
+    const mirror = document.querySelector<HTMLElement>('.draggable-mirror')!;
 
     moveMouse(largerDraggable);
     waitForRequestAnimationFrame();
@@ -119,7 +123,7 @@ describe('ResizeMirror', () => {
     waitForDragDelay();
     await waitForPromisesToResolve();
 
-    const mirror = document.querySelector('.draggable-mirror');
+    const mirror = document.querySelector<HTMLElement>('.draggable-mirror')!;
 
     const mockedAppendChild = withMockedAppendChild(() => {
       moveMouse(smallerDraggable);
@@ -145,19 +149,28 @@ describe('ResizeMirror', () => {
   });
 });
 
-function mockDimensions(element, {width = 0, height = 0}) {
+function mockDimensions(element: HTMLElement, {width = 0, height = 0}) {
   Object.assign(element.style, {
     width: `${width}px`,
     height: `${height}px`,
   });
 
-  element.getBoundingClientRect = () => ({
+  const properties = {
     width,
     height,
     top: 0,
     left: 0,
     right: width,
     bottom: height,
+    x: 0,
+    y: 0,
+  };
+
+  element.getBoundingClientRect = () => ({
+    ...properties,
+    toJSON() {
+      return {...properties};
+    },
   });
 
   return element;
@@ -168,13 +181,16 @@ function waitForNextRequestAnimationFrame() {
   waitForRequestAnimationFrame();
 }
 
-function withMockedAppendChild(callback) {
+function withMockedAppendChild(callback: () => void) {
   const mock = jest.fn();
   const appendChild = Node.prototype.appendChild;
-  Node.prototype.appendChild = function (...args) {
+  /* eslint-disable @typescript-eslint/ban-ts-comment */
+  // @ts-ignore
+  Node.prototype.appendChild = function (this: Node, ...args) {
     mock(...args);
     return appendChild.call(this, ...args);
   };
+  /* eslint-enable @typescript-eslint/ban-ts-comment */
   callback();
   Node.prototype.appendChild = appendChild;
   return mock;

diff --git a/src/Plugins/SwapAnimation/index.js → src/Plugins/SwapAnimation/index.ts b/src/Plugins/SwapAnimation/index.js → src/Plugins/SwapAnimation/index.ts
diff --git a/test/helpers/module.ts b/test/helpers/module.ts
@@ -15,7 +15,7 @@ import {
 interface Options {
   from: HTMLElement;
   to: HTMLElement;
-  sensor: 'mouse' | 'touch' | 'drag';
+  sensor?: 'mouse' | 'touch' | 'drag';
 }
 
 export function drag({from, to, sensor = 'mouse'}: Options) {