@litecanvas/plugin-migrate 0.0.4 → 0.1.1

package/README.md

@@ -17,7 +17,10 @@ litecanvas({
   loop: { init, draw },
 })
 
-use(pluginMigrate)
+use(pluginMigrate, {
+  // set to `false` to not show warnings in the console (default is true)
+  warnings: true,
+})
 
 function draw() {
   clear(0)

package/dist/dist.js

@@ -1,2 +1,2 @@
-(()=>{var P={mute:!1};function f(a,c={}){if(c=Object.assign({},P,c),a.stat(1))throw'Plugin Migrate should be loaded before the "init" event';let l=a.stat(0);function n(t,e,s=""){c.mute||console.warn(`[Migrate] warning: ${t} is removed. `+(e?`Use ${e} instead. `:"")+s)}function d(t){return n("seed()","rseed()"),t&&a.rseed(t),a.stat(9)}let p="";function h(t){n("textstyle()","the 5th param of text()"),p=t}let g=a.text;function b(t,e,s,o=3,i=p){g(t,e,s,o,i)}function w(t,e,s,o){n("print()","text()"),b(t,e,s,o)}function y(t,e){n("textmetrics()","ctx().measureText()");let s=a.ctx(),o=a.stat(10),i=a.stat(11);s.font=`${p||""} ${~~(e||o)}px ${i}`;let m=s.measureText(t);return m.height=m.actualBoundingBoxAscent+m.actualBoundingBoxDescent,m}function x(t,e,s,o){n("cliprect()","clip()");let i=a.ctx();i.beginPath(),i.rect(t,e,s,o),i.clip()}function _(t,e,s){n("clipcirc()","clip()");let o=a.ctx();o.beginPath(),o.arc(t,e,s,0,a.TWO_PI),o.clip()}function A(t){n("getcolor()","stat(5)");let e=stat(5);return e[~~t%e.length]}function E(t){n("blendmode()","ctx().globalCompositeOperation");let e=a.ctx();e.globalCompositeOperation=t}function C(t){n("clear()","cls()"),a.cls(t)}function T(t,e,s,o,i,m,X=!0){return n("transform()","ctx().setTransform() or ctx().transform()"),a.ctx()[X?"setTransform":"transform"](t,e,s,o,i,m)}function k(){return n("mousepos()","MX and MY"),[MX,MY]}function M(t){n("setfps()","framerate()"),a.framerate(t)}let r=a.def;function u(t,e){switch(t){case"W":case"WIDTH":r("W",e),r("WIDTH",e);break;case"H":case"HEIGHT":r("H",e),r("HEIGHT",e);break;case"T":case"ELAPSED":r("T",e),r("ELAPSED",e);break;case"CX":case"CENTERX":r("CX",e),r("CENTERX",e);break;case"CY":case"CENTERY":r("CY",e),r("CENTERY",e);break;case"MX":case"MOUSEX":r("MX",e),r("MOUSEX",e);break;case"MY":case"MOUSEY":r("MY",e),r("MOUSEY",e);break;default:r(t,e);break}}function S(t,e){n("setvar()","def()"),u(t,e)}function Y(t,e){if(l.autoscale)throw"resize() don't works with autoscale enabled";n("resize()",null,"Avoid changing the canvas dimensions at runtime."),a.CANVAS.width=t,u("W",t),u("CX",t/2),a.CANVAS.height=e,u("H",e),u("CY",e/2),a.emit("resized",1)}for(let t of["W","H","T","CX","CY","MX","MY"])a[t]!=null&&u(t,a[t]);if(n("FPS","some library to measure the FPS","Recommendation: https://github.com/mrdoob/stats.js/"),r("FPS",""),l.fps&&a.framerate(l.fps),l.background>=0){let t=stat(5);a.CANVAS.style.backgroundColor=t[~~l.background%t.length]}return{def:u,seed:d,print:w,clear:C,setfps:M,setvar:S,textstyle:h,textmetrics:y,text:b,cliprect:x,clipcirc:_,blendmode:E,transform:T,getcolor:A,mousepos:k,resize:Y}}window.pluginMigrate=f;})();
+(()=>{var o=(a,c="Assertion failed")=>{if(!a)throw new Error(c)};var _=(a,c,m,l,s,h,f,b)=>(o(isFinite(a),"colrect: 1st param must be a number"),o(isFinite(c),"colrect: 2nd param must be a number"),o(isFinite(m),"colrect: 3rd param must be a number"),o(isFinite(l),"colrect: 4th param must be a number"),o(isFinite(s),"colrect: 5th param must be a number"),o(isFinite(h),"colrect: 6th param must be a number"),o(isFinite(f),"colrect: 7th param must be a number"),o(isFinite(b),"colrect: 8th param must be a number"),a<s+f&&a+m>s&&c<h+b&&c+l>h);var x=(a,c,m,l,s,h)=>(o(isFinite(a),"colcirc: 1st param must be a number"),o(isFinite(c),"colcirc: 2nd param must be a number"),o(isFinite(m),"colcirc: 3rd param must be a number"),o(isFinite(l),"colcirc: 4th param must be a number"),o(isFinite(s),"colcirc: 5th param must be a number"),o(isFinite(h),"colcirc: 6th param must be a number"),(l-a)*(l-a)+(s-c)*(s-c)<=(m+h)*(m+h));var Et=2*Math.PI;var he=Math.PI/2;var $=4,fe=1<<$,V=8,de=1<<V;var j={warnings:!0};function g(a,c={}){if(c=Object.assign({},j,c),a.stat(1))throw'Plugin Migrate should be loaded before the "init" event';let l=a.stat(0);function s(t,e,r=""){c.warnings&&console.warn(`[Migrate] warning: ${t} is removed. `+(e?`Use ${e} instead. `:"")+r)}function h(t){return s("seed()","rseed()"),t&&a.rseed(t),a.stat(9)}let f="";function b(t){s("textstyle()","the 5th param of text()"),f=t}let w=a.text;function y(t,e,r,i=3,p=f){w(t,e,r,i,p)}function M(t,e,r,i){s("print()","text()"),y(t,e,r,i)}function E(t,e){s("textmetrics()","ctx().measureText()");let r=a.ctx(),i=a.stat(10),p=a.stat(11);r.font=`${f||""} ${~~(e||i)}px ${p}`;let d=r.measureText(t);return d.height=d.actualBoundingBoxAscent+d.actualBoundingBoxDescent,d}function T(t,e,r,i){s("cliprect()","clip()");let p=a.ctx();p.beginPath(),p.rect(t,e,r,i),p.clip()}function A(t,e,r){s("clipcirc()","clip()");let i=a.ctx();i.beginPath(),i.arc(t,e,r,0,a.TWO_PI),i.clip()}function C(t){s("getcolor()","stat(5)");let e=stat(5);return e[~~t%e.length]}function k(t){s("blendmode()","ctx().globalCompositeOperation");let e=a.ctx();e.globalCompositeOperation=t}function I(t){s("clear()","cls()"),a.cls(t)}function S(t,e,r,i,p,d,B=!0){return s("transform()","ctx().setTransform() or ctx().transform()"),a.ctx()[B?"setTransform":"transform"](t,e,r,i,p,d)}function P(){return s("mousepos()","MX and MY"),[MX,MY]}function O(t){s("setfps()","framerate()"),a.framerate(t)}let n=a.def;function u(t,e){switch(t){case"W":case"WIDTH":n("W",e),n("WIDTH",e);break;case"H":case"HEIGHT":n("H",e),n("HEIGHT",e);break;case"T":case"ELAPSED":n("T",e),n("ELAPSED",e);break;case"CX":case"CENTERX":n("CX",e),n("CENTERX",e);break;case"CY":case"CENTERY":n("CY",e),n("CENTERY",e);break;case"MX":case"MOUSEX":n("MX",e),n("MOUSEX",e);break;case"MY":case"MOUSEY":n("MY",e),n("MOUSEY",e);break;default:n(t,e);break}}function R(t,e){s("setvar()","def()"),u(t,e)}a.listen("resized",v);function v(){u("CX",a.W/2),u("CY",a.H/2)}v(),u("CANVAS",a.canvas());function F(t,e){if(l.autoscale)throw"resize() don't works with autoscale enabled";s("resize()",null,"Avoid changing the canvas dimensions at runtime."),a.CANVAS.width=t,u("W",t),u("CX",t/2),a.CANVAS.height=e,u("H",e),u("CY",e/2),a.emit("resized",1)}for(let t of["W","H","T","CX","CY","MX","MY"])a[t]!=null&&u(t,a[t]);if(s("FPS","some library to measure the FPS","Recommendation: https://github.com/mrdoob/stats.js/"),n("FPS",""),l.fps&&a.framerate(l.fps),l.background>=0){let t=stat(5);a.CANVAS.style.backgroundColor=t[~~l.background%t.length]}function L(t){return s("path()","`new Path2D`","See https://developer.mozilla.org/en-US/docs/Web/API/Path2D"),new Path2D(t)}let Y=a.fill;function z(t,e){if(s("fill(color, path)"),e instanceof Path2D){let r=a.stat(5),i=a.ctx();i.fillStyle=r[~~t%r.length],a.ctx().fill(e)}else Y(t)}let N=a.stroke;function X(t,e){if(s("stroke(color, path)"),e instanceof Path2D){let r=a.stat(5),i=a.ctx();i.strokeStyle=r[~~t%r.length],a.ctx().stroke(e)}else N(t)}let H=a.clip;function D(t){s("clip(path)","clip(callback)","E.g: `clip((ctx) => ctx.rect(0, 0, 200, 200))`"),t instanceof Path2D?a.ctx().clip(t):H(t)}return{def:u,seed:h,print:M,clear:I,setfps:O,setvar:R,textstyle:b,textmetrics:E,text:y,cliprect:T,clipcirc:A,blendmode:k,transform:S,getcolor:C,mousepos:P,resize:F,path:L,fill:z,stroke:X,clip:D,colrect:_,colcirc:x}}window.pluginMigrate=g;})();
 /*! pluginMigrate for litecanvas v0.0.1 by Luiz Bills | MIT Licensed */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@litecanvas/plugin-migrate",
-  "version": "0.0.4",
+  "version": "0.1.1",
   "description": "Sometimes upgrading litecanvas to a new version can be a lot of work. This plugin makes this easier, by restoring the Litecanvas APIs that were removed in newer versions, and additionally shows warnings in the browser console when removed and/or deprecated APIs are used.",
   "author": "Luiz Bills <luizbills@pm.me>",
   "license": "MIT",
@@ -12,6 +12,7 @@
     "type": "git",
     "url": "git+https://github.com/litecanvas/plugin-migrate.git#main"
   },
+  "type": "module",
   "main": "src/index.js",
   "keywords": [
     "litecanvas"
@@ -19,10 +20,19 @@
   "scripts": {
     "dev": "esbuild src/_web.js --bundle --watch --outfile=dist/dist.js --servedir=.",
     "build": "esbuild src/_web.js --bundle --minify --outfile=dist/dist.js",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "test": "ava --tap | tap-min"
   },
   "devDependencies": {
-    "esbuild": "^0.25.5"
+    "esbuild": "^0.25.5",
+    "@litecanvas/jsdom-extras": "^1.1.0",
+    "@types/jsdom": "^21.1.7",
+    "ava": "^6.4.0",
+    "jsdom": "^26.1.0",
+    "tap-min": "^3.0.0"
+  },
+  "dependencies": {
+    "@litecanvas/utils": "latest"
   },
   "peerDependencies": {
     "litecanvas": "latest"
@@ -30,5 +40,10 @@
   "files": [
     "dist",
     "src"
-  ]
+  ],
+  "ava": {
+    "files": [
+      "tests/**/*.js"
+    ]
+  }
 }

package/src/index.js

@@ -1,7 +1,9 @@
 import "litecanvas"
 
+import { colrect, colcirc } from "@litecanvas/utils"
+
 const defaults = {
-  mute: false,
+  warnings: true,
 }
 
 /**
@@ -21,7 +23,7 @@ export default function plugin(engine, config = {}) {
   const settings = engine.stat(0)
 
   function warn(old, current, extra = "") {
-    if (!config.mute)
+    if (config.warnings)
       console.warn(
         `[Migrate] warning: ${old} is removed. ` +
           (current ? `Use ${current} instead. ` : "") +
@@ -163,6 +165,17 @@ export default function plugin(engine, config = {}) {
     _def(key, value)
   }
 
+  // restore CX and CY removed in v0.84
+  engine.listen("resized", onResize)
+  function onResize() {
+    _def("CX", engine.W / 2)
+    _def("CY", engine.H / 2)
+  }
+  onResize()
+
+  // restore CANVAS removed in v0.84
+  _def("CANVAS", engine.canvas())
+
   function resize(width, height) {
     if (settings.autoscale) {
       throw "resize() don't works with autoscale enabled"
@@ -203,6 +216,57 @@ export default function plugin(engine, config = {}) {
       colors[~~settings.background % colors.length]
   }
 
+  // restore path()
+  function path(arg) {
+    warn(
+      "path()",
+      "`new Path2D`",
+      "See https://developer.mozilla.org/en-US/docs/Web/API/Path2D"
+    )
+    return new Path2D(arg)
+  }
+
+  const _core_fill = engine.fill
+  function fill(color, path) {
+    warn("fill(color, path)")
+    if (path instanceof Path2D) {
+      const colors = engine.stat(5)
+      const _ctx = engine.ctx()
+      _ctx.fillStyle = colors[~~color % colors.length]
+      engine.ctx().fill(path)
+    } else {
+      _core_fill(color)
+    }
+  }
+
+  const _core_stroke = engine.stroke
+  function stroke(color, path) {
+    warn("stroke(color, path)")
+    if (path instanceof Path2D) {
+      const colors = engine.stat(5)
+      const _ctx = engine.ctx()
+      _ctx.strokeStyle = colors[~~color % colors.length]
+      engine.ctx().stroke(path)
+    } else {
+      _core_stroke(color)
+    }
+  }
+
+  const _core_clip = engine.clip
+  function clip(pathOrCallback) {
+    warn(
+      "clip(path)",
+      "clip(callback)",
+      "E.g: `clip((ctx) => ctx.rect(0, 0, 200, 200))`"
+    )
+    if (pathOrCallback instanceof Path2D) {
+      const _ctx = engine.ctx()
+      _ctx.clip(pathOrCallback)
+    } else {
+      _core_clip(pathOrCallback)
+    }
+  }
+
   return {
     def: _def,
     seed,
@@ -220,5 +284,13 @@ export default function plugin(engine, config = {}) {
     getcolor,
     mousepos,
     resize,
+    path,
+    fill,
+    stroke,
+    clip,
+
+    // restore collision utils
+    colrect,
+    colcirc,
   }
 }