Clean up TODO/FIXME/XXX comments across codebase

.gitignore

@@ -1,6 +1,7 @@
 # IDE
 .idea
 *.sw*
+.claude
 
 # OS
 .DS_Store

packages/melonjs/src/camera/camera2d.js

@@ -587,7 +587,6 @@ export default class Camera2d extends Renderable {
 	 * @returns {Vector2d}
 	 */
 	localToWorld(x, y, v) {
-		// TODO memoization for one set of coords (multitouch)
 		v = v || vector2dPool.get();
 		v.set(x, y).add(this.pos).sub(game.world.pos);
 		if (!this.currentTransform.isIdentity()) {
@@ -604,7 +603,6 @@ export default class Camera2d extends Renderable {
 	 * @returns {Vector2d} a vector with the converted local coordinates
 	 */
 	worldToLocal(x, y, v) {
-		// TODO memoization for one set of coords (multitouch)
 		v = v || vector2dPool.get();
 		v.set(x, y);
 		if (!this.currentTransform.isIdentity()) {

packages/melonjs/src/level/tiled/TMXTileMap.js

@@ -454,8 +454,8 @@ export default class TMXTileMap {
 					settings.tint.parseHex(settings.tintcolor, true);
 				}
 
-				/// XXX Clean/rewrite all this part to remove object
-				/// specific instantiation logic/details from here
+				// TODO: clean/rewrite this part to remove object-specific
+				// instantiation logic from here (see getObjects refactoring plan)
 
 				// groups can contains either text, objects or layers
 				if (settings instanceof TMXLayer) {

packages/melonjs/src/math/color.ts

@@ -561,8 +561,6 @@ export class Color {
 	 * @returns Reference to this object for method chaining
 	 */
 	parseRGB(rgbColor: string) {
-		// TODO : Memoize this function by caching its input
-
 		const match = rgbaRx.exec(rgbColor);
 		if (!match) {
 			return this.parseHex(rgbColor as `#${string}`);
@@ -583,8 +581,6 @@ export class Color {
 	 * @returns Reference to this object for method chaining
 	 */
 	parseHex(hexColor: `#${string}`, argb = false) {
-		// TODO : Memoize this function by caching its input
-
 		let match: RegExpExecArray | null;
 		if ((match = hex8Rx.exec(hexColor))) {
 			// #AARRGGBB or #RRGGBBAA
@@ -663,9 +659,6 @@ export class Color {
 	 * @returns The color in "#RRGGBB" format
 	 */
 	toHex() {
-		// TODO : Memoize this function by caching its result until any of
-		// the r,g,b,a values are changed
-
 		return `#${toHex(this.r)}${toHex(this.g)}${toHex(this.b)}`;
 	}
 
@@ -675,9 +668,6 @@ export class Color {
 	 * @returns The color in "#RRGGBBAA" format
 	 */
 	toHex8(alpha = this.alpha) {
-		// TODO : Memoize this function by caching its result until any of
-		// the r,g,b,a values are changed
-
 		return `#${toHex(this.r)}${toHex(this.g)}${toHex(this.b)}${toHex(alpha * 255)}`;
 	}
 
@@ -686,9 +676,6 @@ export class Color {
 	 * @returns The color in "rgb(R,G,B)" format
 	 */
 	toRGB() {
-		// TODO : Memoize this function by caching its result until any of
-		// the r,g,b,a values are changed
-
 		return `rgb(${this.r},${this.g},${this.b})` as const;
 	}
 
@@ -698,9 +685,6 @@ export class Color {
 	 * @returns The color in "rgba(R,G,B,A)" format
 	 */
 	toRGBA(alpha = this.alpha) {
-		// TODO : Memoize this function by caching its result until any of
-		// the r,g,b,a values are changed
-
 		return `rgba(${this.r},${this.g},${this.b},${alpha})` as const;
 	}
 }

packages/melonjs/src/math/observableVector3d.ts

@@ -393,10 +393,10 @@ export class ObservableVector3d {
 	/**
 	 * Rotate this vector (counter-clockwise) by the specified angle (in radians) around the z axis
 	 * @param angle - The angle to rotate (in radians)
-	 * @param [v] - an optional point to rotate around (on the same z axis)
+	 * @param [v] - an optional point to rotate around
 	 * @returns Reference to this object for method chaining
 	 */
-	rotate(angle: number, v?: Vector2d | Point) {
+	rotate(angle: number, v?: Vector2d | Point | Vector3d) {
 		let cx = 0;
 		let cy = 0;
 
@@ -405,7 +405,6 @@ export class ObservableVector3d {
 			cy = v.y;
 		}
 
-		// TODO also rotate on the z axis if the given vector is a 3d one
 		const x = this.x - cx;
 		const y = this.y - cy;
 

packages/melonjs/src/math/vector3d.ts

@@ -308,10 +308,10 @@ export class Vector3d {
 	/**
 	 * Rotate this vector (counter-clockwise) by the specified angle (in radians) around the z axis
 	 * @param angle - The angle to rotate (in radians)
-	 * @param [v] - an optional point to rotate around (on the same z axis)
+	 * @param [v] - an optional point to rotate around
 	 * @returns Reference to this object for method chaining
 	 */
-	rotate(angle: number, v?: XYPoint) {
+	rotate(angle: number, v?: XYPoint | Vector3d) {
 		let cx = 0;
 		let cy = 0;
 
@@ -320,7 +320,6 @@ export class Vector3d {
 			cy = v.y;
 		}
 
-		// TODO also rotate on the z axis if the given vector is a 3d one
 		const x = this.x - cx;
 		const y = this.y - cy;
 

packages/melonjs/src/renderable/container.js

@@ -270,7 +270,6 @@ export default class Container extends Renderable {
 			// if the child is a container
 			if (child instanceof Container) {
 				// add all container child bodies
-				// TODO: make it recursive ?
 				child.forEach((cchild) => {
 					if (cchild.body instanceof Body) {
 						worldContainer.addBody(cchild.body);
@@ -342,7 +341,6 @@ export default class Container extends Renderable {
 				// if the child is a container
 				if (child instanceof Container) {
 					// add all container child bodies
-					// TODO: make it recursive ?
 					child.forEach((cchild) => {
 						if (cchild.body instanceof Body) {
 							worldContainer.addBody(cchild.body);

packages/melonjs/src/renderable/draggable.js

@@ -88,7 +88,7 @@ export class Draggable extends Renderable {
 	 */
 	dragMove(e) {
 		if (this.dragging === true) {
-			this.pos.set(e.gameX, e.gameY, this.pos.z); //TODO : z ?
+			this.pos.set(e.gameX, e.gameY, this.pos.z);
 			this.pos.sub(this.grabOffset);
 		}
 	}

packages/melonjs/src/renderable/renderable.js

@@ -648,7 +648,7 @@ export default class Renderable extends Rect {
 		if (typeof this._absPos === "undefined") {
 			this._absPos = vector2dPool.get();
 		}
-		// XXX Cache me or something
+		// TODO: cache the absolute position and invalidate when pos or ancestor changes
 		this._absPos.set(this.pos.x, this.pos.y);
 		if (
 			typeof this.ancestor !== "undefined" &&

packages/melonjs/src/renderable/sprite.js

@@ -406,7 +406,7 @@ export default class Sprite extends Renderable {
 			const frameObjectName = frameObject.name;
 			if (typeof frameObjectName === "number") {
 				if (typeof this.textureAtlas[frameObjectName] !== "undefined") {
-					// TODO: adding the cache source coordinates add undefined entries in webGL mode
+					// see https://github.com/melonjs/melonJS/issues/1281
 					this.anim[name].frames[i] = Object.assign(
 						{},
 						this.textureAtlas[frameObjectName],

packages/melonjs/src/renderable/text/text.js

@@ -173,7 +173,8 @@ export default class Text extends Renderable {
 		}
 
 		// the canvas Texture used to render this text
-		// XXX: offscreenCanvas is currently disabled for text rendering due to issue in WebGL mode
+		// offscreenCanvas is currently disabled for text rendering due to issue in WebGL mode
+		// see https://github.com/melonjs/melonJS/issues/1180
 		this.canvasTexture = new CanvasRenderTarget(2, 2, {
 			offscreenCanvas: false,
 		});

packages/melonjs/src/video/texture/atlas.js

@@ -282,7 +282,7 @@ export class TextureAtlas {
 	 * @returns {object} the created region
 	 */
 	addRegion(name, x, y, w, h) {
-		// TODO: Require proper atlas regions instead of caching arbitrary region keys
+		// see https://github.com/melonjs/melonJS/issues/1281
 		if (renderer.settings.verbose === true) {
 			console.warn("Adding texture region", name, "for texture", this);
 		}
@@ -367,7 +367,7 @@ export class TextureAtlas {
 		let region = this.getRegion(name);
 
 		if (typeof region === "undefined") {
-			// TODO: Require proper atlas regions instead of caching arbitrary region keys
+			// see https://github.com/melonjs/melonJS/issues/1281
 			const keys = name.split(",");
 			region = this.addRegion(name, +keys[0], +keys[1], +keys[2], +keys[3]);
 		}
@@ -397,7 +397,7 @@ export class TextureAtlas {
 				(s.y + sh) / h, // v1 (bottom)
 			]);
 			// Cache source coordinates
-			// TODO: Remove this when the Batcher only accepts a region name
+			// see https://github.com/melonjs/melonJS/issues/1281
 			const key = s.x + "," + s.y + "," + w + "," + h;
 			atlas[key] = atlas[name];
 		}

packages/melonjs/src/video/texture/cache.js

@@ -48,7 +48,7 @@ class TextureCache {
 		}
 
 		// No units available
-		// TODO: Merge textures instead of throwing an exception
+		// see https://github.com/melonjs/melonJS/issues/1280
 		throw new Error(
 			"Texture cache overflow: " +
 				this.max_size +

packages/melonjs/src/video/webgl/webgl_renderer.js

@@ -424,7 +424,7 @@ export default class WebGLRenderer extends Renderer {
 			image,
 		);
 
-		// FIXME: Remove old cache entry and texture when changing the repeat mode
+		// see https://github.com/melonjs/melonJS/issues/1278
 		this.currentCompositor.uploadTexture(texture);
 
 		return texture;
@@ -843,7 +843,7 @@ export default class WebGLRenderer extends Renderer {
 	 */
 	setAntiAlias(enable = false) {
 		super.setAntiAlias(enable);
-		// TODO: perhaps handle GLNEAREST or other options with texture binding
+		// see https://github.com/melonjs/melonJS/issues/1279
 	}
 
 	/**