@vpmedia/phaser 1.123.0 → 1.125.0

package/src/phaser/core/scene_manager.test.ts

@@ -20,74 +20,74 @@ const createGame = (isBooted = true): Game =>
 const createManager = (pendingState: ConstructorParameters<typeof SceneManager>[1] = null): SceneManager =>
   new SceneManager(createGame(), pendingState);
 
-describe('SceneManager', () => {
-  describe('add', () => {
-    it('takes a plain hook object and links the game onto it', () => {
+describe('SceneManager', (): void => {
+  describe('add', (): void => {
+    it('takes a plain hook object and links the game onto it', (): void => {
       const manager = createManager();
       const state: SceneState = { create: vi.fn<() => void>() };
       expect(manager.add('menu', state)).toBe(state);
       expect(state.game).toBeDefined();
     });
 
-    it('builds a state from a constructor', () => {
+    it('builds a state from a constructor', (): void => {
       const manager = createManager();
       class Menu extends Scene {}
       expect(manager.add('menu', Menu)).toBeInstanceOf(Menu);
     });
 
-    it('takes a scene instance as-is', () => {
+    it('takes a scene instance as-is', (): void => {
       const manager = createManager();
       const scene = new Scene();
       expect(manager.add('menu', scene)).toBe(scene);
     });
 
-    it('queues the state when the game has not booted', () => {
+    it('queues the state when the game has not booted', (): void => {
       const manager = new SceneManager(createGame(false), null);
       manager.add('menu', { create: vi.fn<() => void>() }, true);
       expect(manager._pendingState).toBe('menu');
     });
 
-    it('starts the state right away once the game has booted', () => {
+    it('starts the state right away once the game has booted', (): void => {
       const manager = createManager();
       manager.add('menu', { create: vi.fn<() => void>() }, true);
       expect(manager._pendingState).toBe('menu');
     });
   });
 
-  describe('boot', () => {
-    it('registers a state given as an object under the default key', () => {
+  describe('boot', (): void => {
+    it('registers a state given as an object under the default key', (): void => {
       const manager = createManager({ create: vi.fn<() => void>() });
       manager.boot();
       expect(manager.states['default']).toBeDefined();
     });
 
-    it('leaves a state given by key alone', () => {
+    it('leaves a state given by key alone', (): void => {
       const manager = createManager('menu');
       manager.boot();
       expect(manager.states['default']).toBeUndefined();
     });
   });
 
-  describe('checkState', () => {
-    it('accepts a state carrying any of the lifecycle hooks', () => {
+  describe('checkState', (): void => {
+    it('accepts a state carrying any of the lifecycle hooks', (): void => {
       const manager = createManager();
       manager.add('menu', { update: vi.fn<() => void>() });
       expect(manager.checkState('menu')).toBe(true);
     });
 
-    it('rejects a state with no hooks at all', () => {
+    it('rejects a state with no hooks at all', (): void => {
       const manager = createManager();
       manager.add('menu', {});
       expect(manager.checkState('menu')).toBe(false);
     });
 
-    it('rejects a key it does not hold', () => {
+    it('rejects a key it does not hold', (): void => {
       expect(createManager().checkState('nope')).toBe(false);
     });
   });
 
-  describe('setCurrentState', () => {
-    it('binds the hooks the state provides and leaves the rest null', () => {
+  describe('setCurrentState', (): void => {
+    it('binds the hooks the state provides and leaves the rest null', (): void => {
       const manager = createManager();
       const create = vi.fn<() => void>();
       manager.add('menu', { create });
@@ -98,7 +98,7 @@ describe('SceneManager', () => {
       expect(manager.onPreloadCallback).toBeNull();
     });
 
-    it('falls back to a no-op for init and shutdown', () => {
+    it('falls back to a no-op for init and shutdown', (): void => {
       const manager = createManager();
       manager.add('menu', {});
       manager.setCurrentState('menu');
@@ -106,7 +106,7 @@ describe('SceneManager', () => {
       expect(manager.onShutDownCallback).toBe(manager.dummy);
     });
 
-    it('calls init with the arguments start was given', () => {
+    it('calls init with the arguments start was given', (): void => {
       const manager = createManager();
       const init = vi.fn<() => void>();
       manager.add('menu', { init, update: vi.fn<() => void>() });
@@ -115,7 +115,7 @@ describe('SceneManager', () => {
       expect(init).toHaveBeenCalledWith('a', 1);
     });
 
-    it('stamps the key onto the state', () => {
+    it('stamps the key onto the state', (): void => {
       const manager = createManager();
       const state: SceneState = { create: vi.fn<() => void>() };
       manager.add('menu', state);
@@ -124,8 +124,8 @@ describe('SceneManager', () => {
     });
   });
 
-  describe('start', () => {
-    it('ignores a key with no lifecycle hooks', () => {
+  describe('start', (): void => {
+    it('ignores a key with no lifecycle hooks', (): void => {
       const manager = createManager();
       manager.add('menu', {});
       manager.start('menu');
@@ -133,8 +133,8 @@ describe('SceneManager', () => {
     });
   });
 
-  describe('update', () => {
-    it('runs the update hook only once the scene has been created', () => {
+  describe('update', (): void => {
+    it('runs the update hook only once the scene has been created', (): void => {
       const manager = createManager();
       const update = vi.fn<() => void>();
       manager.add('menu', { update });
@@ -146,7 +146,7 @@ describe('SceneManager', () => {
       expect(update).toHaveBeenCalledTimes(1);
     });
 
-    it('runs the create hook exactly once', () => {
+    it('runs the create hook exactly once', (): void => {
       const manager = createManager();
       const create = vi.fn<() => void>();
       manager.add('menu', { create });
@@ -157,8 +157,8 @@ describe('SceneManager', () => {
     });
   });
 
-  describe('resize', () => {
-    it('passes the new size to the scene', () => {
+  describe('resize', (): void => {
+    it('passes the new size to the scene', (): void => {
       const manager = createManager();
       const resize = vi.fn<(width: number, height: number) => void>();
       manager.add('menu', { resize });
@@ -168,8 +168,8 @@ describe('SceneManager', () => {
     });
   });
 
-  describe('remove', () => {
-    it('drops the state and unbinds its hooks when it is current', () => {
+  describe('remove', (): void => {
+    it('drops the state and unbinds its hooks when it is current', (): void => {
       const manager = createManager();
       manager.add('menu', { create: vi.fn<() => void>() });
       manager.setCurrentState('menu');
@@ -179,8 +179,8 @@ describe('SceneManager', () => {
     });
   });
 
-  describe('destroy', () => {
-    it('empties the manager', () => {
+  describe('destroy', (): void => {
+    it('empties the manager', (): void => {
       const manager = createManager();
       manager.add('menu', { create: vi.fn<() => void>(), shutdown: vi.fn<() => void>() });
       manager.setCurrentState('menu');

package/src/phaser/core/scene_manager.ts

@@ -137,7 +137,7 @@ export class SceneManager {
       this._pendingState = key;
       this._clearWorld = clearWorld;
       this._clearCache = clearCache;
-      if (args && args.length > 0) {
+      if (args.length > 0) {
         this._args = [...args];
       }
     }
@@ -153,7 +153,7 @@ export class SceneManager {
     this._pendingState = this.current;
     this._clearWorld = clearWorld;
     this._clearCache = clearCache;
-    if (args && args.length > 0) {
+    if (args.length > 0) {
       this._args = [...args];
     }
   }
@@ -359,7 +359,7 @@ export class SceneManager {
    * Get whether the scene has been created.
    * @returns {boolean} True if the scene has been created, false otherwise.
    */
-  public get created() {
+  public get created(): boolean {
     return this._created;
   }
 }

package/src/phaser/core/signal.test.ts

@@ -1,14 +1,14 @@
 import { expect, describe, it } from 'vitest';
 import { Signal } from './signal.js';
 
-describe('Signal', () => {
-  describe('core', () => {
-    it('adds, dispatches to and removes listeners', () => {
+describe('Signal', (): void => {
+  describe('core', (): void => {
+    it('adds, dispatches to and removes listeners', (): void => {
       const signal = new Signal();
-      const listener = (arg: number) => {
+      const listener = (arg: number): void => {
         expect(arg).toBe(1);
       };
-      const listenerOnce = (arg: number) => {
+      const listenerOnce = (arg: number): void => {
         expect(arg).toBe(1);
       };
       signal.add(listener);
@@ -20,14 +20,14 @@ describe('Signal', () => {
       signal.remove(listener);
       expect(signal.has(listener)).toBe(false);
       expect(signal.getNumListeners()).toBe(0);
-      expect(signal.has(() => null)).toBe(false);
+      expect(signal.has((): null => null)).toBe(false);
     });
 
-    it('async', async () => {
+    it('async', async (): Promise<void> => {
       const signal = new Signal();
       const promise = signal.toPromise();
       expect(signal.getNumListeners()).toBe(1);
-      setTimeout(() => {
+      setTimeout((): void => {
         signal.dispatch(1);
       }, 10);
       const result = await promise;

package/src/phaser/core/signal.ts

@@ -185,7 +185,7 @@ export class Signal {
     let n = this._bindings.length;
     while (n) {
       n -= 1;
-      if (context) {
+      if (context !== null) {
         if (this._bindings[n]!.context === context) {
           this._bindings[n]!._destroy();
           this._bindings.splice(n, 1);
@@ -194,7 +194,7 @@ export class Signal {
         this._bindings[n]!._destroy();
       }
     }
-    if (!context) {
+    if (context === null) {
       this._bindings.length = 0;
     }
   }
@@ -275,7 +275,7 @@ export class Signal {
    * Get a bound version of the dispatch function.
    * @returns {Function} A function that will dispatch the signal with the correct context.
    */
-  public get boundDispatch() {
+  public get boundDispatch(): (...args: unknown[]) => void {
     this._boundDispatch ??= (...rest: unknown[]): void => {
       this.dispatch(...rest);
     };

package/src/phaser/core/signal_dispatch.test.ts

@@ -1,9 +1,9 @@
 import { describe, expect, it, vi } from 'vitest';
 import { Signal } from './signal.js';
 
-describe('Signal binding management', () => {
-  describe('add', () => {
-    it('registers a listener and reports it', () => {
+describe('Signal binding management', (): void => {
+  describe('add', (): void => {
+    it('registers a listener and reports it', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       signal.add(listener);
@@ -11,7 +11,7 @@ describe('Signal binding management', () => {
       expect(signal.has(listener)).toBe(true);
     });
 
-    it('returns the existing binding when the same listener is added twice', () => {
+    it('returns the existing binding when the same listener is added twice', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       const first = signal.add(listener);
@@ -20,7 +20,7 @@ describe('Signal binding management', () => {
       expect(signal.getNumListeners()).toBe(1);
     });
 
-    it('treats the same listener under a different context as a separate binding', () => {
+    it('treats the same listener under a different context as a separate binding', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       signal.add(listener, { id: 1 });
@@ -28,7 +28,7 @@ describe('Signal binding management', () => {
       expect(signal.getNumListeners()).toBe(2);
     });
 
-    it('refuses to switch a listener between add and addOnce', () => {
+    it('refuses to switch a listener between add and addOnce', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       signal.add(listener);
@@ -36,18 +36,18 @@ describe('Signal binding management', () => {
     });
   });
 
-  describe('dispatch', () => {
-    it('calls listeners in priority order, highest first', () => {
+  describe('dispatch', (): void => {
+    it('calls listeners in priority order, highest first', (): void => {
       const signal = new Signal();
       const order: string[] = [];
-      signal.add(() => order.push('low'), null, 0);
-      signal.add(() => order.push('high'), null, 10);
-      signal.add(() => order.push('mid'), null, 5);
+      signal.add((): number => order.push('low'), null, 0);
+      signal.add((): number => order.push('high'), null, 10);
+      signal.add((): number => order.push('mid'), null, 5);
       signal.dispatch();
       expect(order).toStrictEqual(['high', 'mid', 'low']);
     });
 
-    it('forwards its arguments', () => {
+    it('forwards its arguments', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       signal.add(listener);
@@ -55,7 +55,7 @@ describe('Signal binding management', () => {
       expect(listener).toHaveBeenCalledWith(1, 'two');
     });
 
-    it('removes an addOnce listener after it fires', () => {
+    it('removes an addOnce listener after it fires', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       signal.addOnce(listener);
@@ -65,20 +65,20 @@ describe('Signal binding management', () => {
       expect(signal.getNumListeners()).toBe(0);
     });
 
-    it('stops propagating once a listener returns false', () => {
+    it('stops propagating once a listener returns false', (): void => {
       const signal = new Signal();
       const later = vi.fn();
-      signal.add(() => false, null, 10);
+      signal.add((): boolean => false, null, 10);
       signal.add(later, null, 0);
       signal.dispatch();
       expect(later).not.toHaveBeenCalled();
     });
 
-    it('stops propagating once halt is called', () => {
+    it('stops propagating once halt is called', (): void => {
       const signal = new Signal();
       const later = vi.fn();
       signal.add(
-        () => {
+        (): void => {
           signal.halt();
         },
         null,
@@ -89,25 +89,25 @@ describe('Signal binding management', () => {
       expect(later).not.toHaveBeenCalled();
     });
 
-    it('survives a listener that removes every listener mid-dispatch', () => {
+    it('survives a listener that removes every listener mid-dispatch', (): void => {
       const signal = new Signal();
       const later = vi.fn();
       signal.add(
-        () => {
+        (): void => {
           signal.removeAll();
         },
         null,
         10
       );
       signal.add(later, null, 0);
-      expect(() => {
+      expect((): void => {
         signal.dispatch();
       }).not.toThrow();
     });
   });
 
-  describe('remove', () => {
-    it('drops the matching binding', () => {
+  describe('remove', (): void => {
+    it('drops the matching binding', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       const other = vi.fn();
@@ -119,7 +119,7 @@ describe('Signal binding management', () => {
       expect(signal.has(other)).toBe(true);
     });
 
-    it('leaves the list alone for an unregistered listener', () => {
+    it('leaves the list alone for an unregistered listener', (): void => {
       const signal = new Signal();
       signal.add(vi.fn());
       signal.remove(vi.fn());
@@ -127,8 +127,8 @@ describe('Signal binding management', () => {
     });
   });
 
-  describe('removeAll', () => {
-    it('clears every listener when given no context', () => {
+  describe('removeAll', (): void => {
+    it('clears every listener when given no context', (): void => {
       const signal = new Signal();
       signal.add(vi.fn(), { id: 1 });
       signal.add(vi.fn(), { id: 2 });
@@ -136,7 +136,7 @@ describe('Signal binding management', () => {
       expect(signal.getNumListeners()).toBe(0);
     });
 
-    it('clears only the listeners bound to the given context', () => {
+    it('clears only the listeners bound to the given context', (): void => {
       const signal = new Signal();
       const context = { id: 1 };
       signal.add(vi.fn(), context);
@@ -146,8 +146,8 @@ describe('Signal binding management', () => {
     });
   });
 
-  describe('memorize', () => {
-    it('replays the last dispatch to a listener added afterwards', () => {
+  describe('memorize', (): void => {
+    it('replays the last dispatch to a listener added afterwards', (): void => {
       const signal = new Signal();
       signal.memorize = true;
       signal.add(vi.fn());
@@ -157,7 +157,7 @@ describe('Signal binding management', () => {
       expect(listener).toHaveBeenCalledWith('remembered');
     });
 
-    it('records nothing while the signal has never had a binding', () => {
+    it('records nothing while the signal has never had a binding', (): void => {
       const signal = new Signal();
       signal.memorize = true;
       signal.dispatch('dropped');
@@ -166,7 +166,7 @@ describe('Signal binding management', () => {
       expect(listener).not.toHaveBeenCalled();
     });
 
-    it('stops replaying once forgotten', () => {
+    it('stops replaying once forgotten', (): void => {
       const signal = new Signal();
       signal.memorize = true;
       signal.add(vi.fn());