Chore: Cleanup scripts, build tooling (#160)

pixijs · Apr 13, 2024 · 5893d3b · 5893d3b
1 parent db40858
commit 5893d3b
Show file tree

Hide file tree

Showing 13 changed files with 90 additions and 104 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,3 +1,11 @@
 {
-  "extends": "@pixi/eslint-config"
-}
+    "root": true,
+    "extends": ["@pixi/eslint-config"],
+    "rules": {
+        "linebreak-style": "off",
+        "camelcase": "off"
+    },
+    "ignorePatterns": [
+        "dist"
+    ]
+}
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,32 @@
+name: Automation
+on:
+    push:
+      branches: [ '**' ]
+      tags: [ '**' ]
+    release:
+      types: [ published ]
+    pull_request:
+      branches: [ '**' ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Install xvfb
+      run: sudo apt-get install xvfb
+    - name: Use Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 20
+    - name: Install dependencies
+      run: npm ci
+    - name: Build
+      run: npm run build
+    - name: Test
+      run:  xvfb-run --auto-servernum npm test
+    - name: Upload to Release
+      if: github.event_name == 'release'
+      uses: softprops/action-gh-release@v2
+      with:
+        files: dist/*
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
diff --git a/.gitignore b/.gitignore
@@ -46,3 +46,4 @@ lib
 
 # Intellij
 *.iml
+example.api.json*
diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ enough manner.
 
 ### Basic demo :pen:
 
-[webgl](https://pixijs.github.io/tilemap/basic.html)
+[webgl](https://pixijs.io/tilemap/examples/basic.html)
 
 ### Settings :page_facing_up:
 
@@ -82,11 +82,11 @@ Canvas fallback is 5x slower than vanilla rpgmaker. Webgl version is faster and
 
 ### RPGMaker demo
 
-[webgl](https://pixijs.github.io/tilemap/): [zoomin](https://pixijs.github.io/tilemap/?scale=0.6) and [zoomout](https://pixijs.github.io/tilemap/?scale=1.4)
+[webgl](https://pixijs.io/tilemap/examples/): [zoomin](https://pixijs.io/tilemap/examples/?scale=0.6) and [zoomout](https://pixijs.io/tilemap/examples/?scale=1.4)
 
-[retina webgl](https://pixijs.github.io/tilemap/?resolution=2): [zoomin](https://pixijs.github.io/pixi-tilemap/?resolution=2&scale=0.6) and [zoomout](https://pixijs.github.io/pixi-tilemap/?resolution=2&scale=1.4)
+[retina webgl](https://pixijs.io/tilemap/examples/?resolution=2): [zoomin](https://pixijs.io/tilemap/examples/?resolution=2&scale=0.6) and [zoomout](https://pixijs.io/tilemap/?resolution=2&scale=1.4)
 
-[canvas](https://pixijs.github.io/tilemap/?canvas)
+[canvas](https://pixijs.io/tilemap/examples/?canvas)
 
 ## More tutorials :link:
 

diff --git a/examples/basic.html b/examples/basic.html
@@ -5,7 +5,6 @@
     <title>PIXI-TILEMAP minimal test</title>
     <link type="text/css" media="all" rel="stylesheet" href="css/main.css"/>
     <script src="https://pixijs.download/dev/pixi.js"></script>
-<!--    <script src="lib/pixi.js"></script>-->
     <script src="../dist/pixi-tilemap.js"></script>
 </head>
 <body>

diff --git a/examples/demo/basic.js b/examples/demo/basic.js
@@ -16,24 +16,29 @@ const use_webgpu = new URLSearchParams(window.location.search).get('webgpu') !==
     document.body.appendChild(app.canvas);
     app.stage.addChild(tilemap);
 
-    const loadAssets = async () => {
+    const loadAssets = async () =>
+    {
         PIXI.Assets.add({ alias: 'atlas', src: 'assets/atlas.json' });
         PIXI.Assets.add({ alias: 'button', src: 'assets/button.png' });
         await PIXI.Assets.load(['atlas', 'button']);
     };
 
-    const buildTilemap = () => {
+    const buildTilemap = () =>
+    {
         // Clear everything, like a PIXI.Graphics
         tilemap.clear();
 
         const size = 32;
 
         // if you are too lazy, just specify filename and pixi will find it in cache
-        for (let i = 0; i < 7; i++) {
-            for (let j = 0; j < 5; j++) {
+        for (let i = 0; i < 7; i++)
+        {
+            for (let j = 0; j < 5; j++)
+            {
                 tilemap.tile('grass.png', i * size, j * size);
 
-                if (i % 2 === 1 && j % 2 === 1) {
+                if (i % 2 === 1 && j % 2 === 1)
+                {
                     tilemap.tile('tough.png', i * size, j * size);
                 }
             }
@@ -43,7 +48,7 @@ const use_webgpu = new URLSearchParams(window.location.search).get('webgpu') !==
         const textures = PIXI.Assets.get('atlas').textures;
 
         tilemap.tile(textures['brick.png'], 2 * size, 2 * size);
-        tilemap.tile(textures['brick_wall.png'], 2 * size, 3 * size, {alpha: 0.6});
+        tilemap.tile(textures['brick_wall.png'], 2 * size, 3 * size, { alpha: 0.6 });
 
         // chest will be animated!
         // old way: animate on rebuild
@@ -59,10 +64,10 @@ const use_webgpu = new URLSearchParams(window.location.search).get('webgpu') !==
         // 3 multiplies the 100ms we have in setInterval by 3, making the duration 300ms
         tilemap.tile(textures['chest.png'], 5 * size, 4 * size).tileAnimX(34, 2).tileAnimDivisor(3);
         // You can alternatively set it by passing animDivisor option when creating the tile. Below a frame duration is 600ms
-        tilemap.tile(textures['chest.png'], 8 * size, 4 * size, {animX: 34, animCountX: 2, animDivisor: 6});
+        tilemap.tile(textures['chest.png'], 8 * size, 4 * size, { animX: 34, animCountX: 2, animDivisor: 6 });
 
-        // button does not appear in the atlas, but tilemap wont surrender, it will create second layer for special for buttons
-        // buttons will appear above everything
+        // button does not appear in the atlas, but tilemap wont surrender, it will
+        // create second layer for special for buttons buttons will appear above everything
         tilemap.tile(PIXI.Assets.get('button'), 6 * size, 2 * size);
 
         // if you want rotations:
@@ -71,13 +76,15 @@ const use_webgpu = new URLSearchParams(window.location.search).get('webgpu') !==
         // canvas in pixi-tilemap does not work with rotate!!!!
         const origTex = textures['chest.png'];
 
-        for (let i = 0; i < 8; i++) {
+        for (let i = 0; i < 8; i++)
+        {
             const frame = origTex.frame.clone();
             const orig = origTex.orig.clone();
             const trim = origTex.orig.clone();
             const rotate = i * 2;
 
-            if (rotate % 4 === 2) {
+            if (rotate % 4 === 2)
+            {
                 orig.width = frame.height;
                 orig.height = frame.width;
             }
@@ -90,7 +97,8 @@ const use_webgpu = new URLSearchParams(window.location.search).get('webgpu') !==
         }
     };
 
-    const initialize = () => {
+    const initialize = () =>
+    {
         buildTilemap();
 
         const pic = new PIXI.Sprite(PIXI.Assets.get('button'));
@@ -99,7 +107,8 @@ const use_webgpu = new URLSearchParams(window.location.search).get('webgpu') !==
         app.stage.addChild(pic);
 
         let frame = 0;
-        const animShader = () => {
+        const animShader = () =>
+        {
             // animate X and Y frames
             tilemap.tileAnim = [frame, frame];
             frame++;
@@ -111,7 +120,8 @@ const use_webgpu = new URLSearchParams(window.location.search).get('webgpu') !==
         setInterval(animShader, 100);
     };
 
-    const runApp = async () => {
+    const runApp = async () =>
+    {
         await loadAssets();
         initialize();
     };

diff --git a/examples/index.html b/examples/index.html
@@ -14,7 +14,6 @@
         }
     </style>
     <script src="https://pixijs.download/dev/pixi.js"></script>
-<!--    <script src="lib/pixi.js"></script>-->
     <script src="../dist/pixi-tilemap.js"></script>
     <script src="demo/rpgmaker.js"></script>
     <script src="demo/main.js"></script>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -39,7 +39,7 @@
     "release": "xs release",
     "docs": "xs docs",
     "deploy": "xs deploy",
-    "test": "xs build,docs"
+    "test": "xs test"
   },
   "files": [
     "lib",
@@ -69,12 +69,6 @@
     "docsGoogleAnalytics": "UA-103772589-3",
     "docsTitle": "PixiJS Tilemap API Documentation",
     "docsDescription": "Documentation for PixiJS Tilemap library",
-    "docsKeyword": "docs, documentation, pixi, pixijs, filters, webgl, ascii, bloom, convolution, cross-hatch, dotfilter, emboss, pixelate, twist, tiltshift",
-    "lint": [
-      "src",
-      "scripts"
-    ],
-    "deployFiles": "{dist,screenshots,examples,docs,demo}/**",
-    "moduleSource": "src/index.ts"
+    "docsKeyword": "docs, documentation, pixi, pixijs, filters, webgl, ascii, bloom, convolution, cross-hatch, dotfilter, emboss, pixelate, twist, tiltshift"
   }
 }
diff --git a/test/Tilemap.test.ts b/test/Tilemap.test.ts
@@ -1,25 +1,22 @@
-import { describe, it, expect } from 'vitest';
-import { BaseTexture, Texture } from '@pixi/core';
+import { Texture } from 'pixi.js';
 import { Tilemap } from '../';
 
 describe('Tilemap', () =>
 {
     it('should calculate local bounds', () =>
     {
-        const texture = new Texture(new BaseTexture(null, {
-            width: 100,
-            height: 100,
-        }));
-        const tilemap = new Tilemap([texture.baseTexture]);
+        const canvas = Object.assign(document.createElement('canvas'), { width: 100, height: 100 });
+        const texture = Texture.from(canvas);
+        const tilemap = new Tilemap([texture.source]);
 
         tilemap.tile(texture, 0, 0);
         tilemap.tile(texture, 100, 0);
 
         const bounds = tilemap.getLocalBounds();
 
-        expect(bounds.x).to.equal(0);
-        expect(bounds.y).to.equal(0);
-        expect(bounds.width).to.equal(200);
-        expect(bounds.height).to.equal(100);
+        expect(bounds.x).toEqual(0);
+        expect(bounds.y).toEqual(0);
+        expect(bounds.width).toEqual(200);
+        expect(bounds.height).toEqual(100);
     });
 });
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,22 +1,15 @@
 {
+    "extends": "@pixi/extension-scripts/tsconfig",
     "compilerOptions": {
-        "target": "es6",
-        "noImplicitAny": true,
-        "removeComments": false,
-        "preserveConstEnums": true,
-        "sourceMap": true,
-        "inlineSources": true,
-        "declaration": true,
-        "esModuleInterop": true,
-        "moduleResolution": "node",
-        "allowSyntheticDefaultImports": true,
-        "skipLibCheck": true
+        // TODO: Remove this when null checks are strict
+        "strictNullChecks": false
     },
     "include": [
         "src/**/*"
     ],
     "exclude": [
-        "node_modules/**/*",
-        "dist"
+        "node_modules",
+        "dist",
+        "lib"
     ]
 }