Verify Gifs Filename Linter

.github/workflows/gifs.yml

@@ -0,0 +1,18 @@
+name: Verify Gifs Filename
+
+on:
+    push:
+        branches: [master]
+    pull_request:
+        branches: [master]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - name: Verify Gifs Filename
+              run: |
+                  npm install
+                  npm run compile:test
+                  npm run test:gifs

package.json

@@ -238,7 +238,8 @@
         "lint:fix": "eslint src --ext ts --fix && prettier --write src",
         "test": "node ./out/test/runTest.js",
         "test:coverage": "COVERAGE=1 node ./out/test/runTest.js",
-        "test:web": "vscode-test-web --browserType=chromium --extensionDevelopmentPath=. --extensionTestsPath=dist/web/test/suite/index.js"
+        "test:web": "vscode-test-web --browserType=chromium --extensionDevelopmentPath=. --extensionTestsPath=dist/web/test/suite/index.js",
+        "test:gifs": "node ./out/test/gifs.js"
     },
     "devDependencies": {
         "@rbarilani/remove-source-map-url-webpack-plugin": "^1.1.0",

src/test/gifs.ts

@@ -0,0 +1,72 @@
+import * as fs from 'fs';
+
+const pets = [
+    'cat',
+    'chicken',
+    'clippy',
+    'cockatiel',
+    'crab',
+    'dog',
+    'fox',
+    'mod',
+    'rocky',
+    'rubber-duck',
+    'snake',
+    'totoro',
+    'zappy',
+];
+
+const colors = [
+    'red',
+    'white',
+    'purple',
+    'gray',
+    'yellow',
+    'green',
+    'black',
+    'brown',
+    'lightbrown',
+];
+const states = [
+    'idle',
+    'run',
+    'swipe',
+    'land',
+    'walk',
+    'walk_fast',
+    'wallclimb',
+    'wallgrab',
+    'with_ball',
+    'fall_from_grab',
+    'jump',
+    'lie',
+];
+
+const fps = ['8fps'];
+
+const gifFilenamePattern = new RegExp(
+    `^(${colors.join('|')})_(${states.join('|')})_(${fps.join('|')}).gif$`,
+);
+
+function checkGifFilenames(folder: string) {
+    const filenames = fs.readdirSync(folder);
+    filenames.forEach((filename) => {
+        if (pets.includes(filename)) {
+            const petFolder = `${folder}/${filename}`;
+            const petFilenames = fs.readdirSync(petFolder);
+            petFilenames.forEach((petFilename) => {
+                if (
+                    petFilename.endsWith('.gif') &&
+                    !gifFilenamePattern.test(petFilename)
+                ) {
+                    console.error(
+                        `Filename "${petFilename}" does not match pattern in folder ${petFolder}. The pattern should be petColor_petState_8fps.gif.`,
+                    );
+                }
+            });
+        }
+    });
+}
+
+const mediaFolder = './media';
+checkGifFilenames(mediaFolder);