Merge pull request #1002 from OpenWebGAL/dev

4.6.2

Author: MakinoharaShoko

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webgal/base",
-  "version": "4.6.1",
+  "version": "4.6.2",
   "description": "A brand new web Visual Novel engine.",
   "repository": "https://github.com/OpenWebGAL/WebGAL.git",
   "author": "Mahiru <Mahiru_@outlook.com>",

packages/parser/.npmignore

@@ -3,4 +3,3 @@ test
 .babelrc
 rollup.config.js
 tsconfig.json
-tsconfig.node.json

packages/parser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webgal-parser",
-  "version": "4.6.1",
+  "version": "4.6.2",
   "description": "WebGAL script parser",
   "scripts": {
     "test": "vitest",
@@ -17,26 +17,16 @@
   "main": "./build/cjs/index.cjs",
   "author": "Mahiru <Mahiru_@outlook.com>",
   "license": "MPL-2.0",
-  "dependencies": {
-    "chevrotain": "^10.5.0",
-    "cloudlogjs": "^1.0.11",
-    "lodash": "^4.17.23",
-    "tsx": "^3.12.7"
-  },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^23.0.2",
-    "@rollup/plugin-json": "^5.0.1",
     "@rollup/plugin-node-resolve": "^15.0.1",
-    "@rollup/plugin-typescript": "^9.0.2",
-    "@types/lodash": "^4.14.189",
     "@types/node": "^18.14.0",
     "@vitest/coverage-c8": "^0.28.5",
+    "rimraf": "^3.0.2",
     "rollup": "^3.29.5",
-    "rollup-plugin-babel": "^4.4.0",
-    "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.34.1",
-    "ts-node": "^10.9.1",
     "tslib": "^2.4.1",
+    "tsx": "^3.12.7",
     "typescript": "^4.9.3",
     "vitest": "^0.28.5"
   },

packages/parser/rollup.config.js

@@ -53,6 +53,7 @@ export default [
         file: "./build/umd/index.global.js",
         name: 'webgalParser',
         format: 'iife',
+        exports: "named",
         sourcemap: !isProd
       },
     ],

packages/parser/src/sceneParser.ts

@@ -5,7 +5,6 @@ import {
   ISentence,
 } from './interface/sceneInterface';
 import { scriptParser } from './scriptParser/scriptParser';
-import uniqWith from 'lodash/uniqWith';
 import { fileType } from './interface/assets';
 import { ConfigMap } from './config/scriptConfig';
 
@@ -54,7 +53,7 @@ export const sceneParser = (
   );
 
   // 开始资源的预加载
-  assetsList = uniqWith(assetsList); // 去重
+  assetsList = deduplicateAssets(assetsList);
   assetsPrefetcher(assetsList);
 
   return {
@@ -65,3 +64,18 @@ export const sceneParser = (
     subSceneList: subSceneList, // 子场景列表
   };
 };
+
+const deduplicateAssets = (assetsList: IAsset[]): IAsset[] => {
+  const seenAssets = new Set<string>();
+  return assetsList.filter((asset) => {
+    if (!asset || typeof asset.url !== 'string' || asset.url === '') {
+      return false;
+    }
+    const assetKey = `${asset.type}:${asset.url}`;
+    if (seenAssets.has(assetKey)) {
+      return false;
+    }
+    seenAssets.add(assetKey);
+    return true;
+  });
+};

packages/parser/src/scriptParser/scriptParser.ts

@@ -40,7 +40,7 @@ export const scriptParser = (
   const commentSplit = sentenceRaw.split(/(?<!\\);/);
   let newSentenceRaw = commentSplit[0];
   newSentenceRaw = newSentenceRaw.replaceAll('\\;',';');
-  const sentenceComment = commentSplit[1] ?? '';
+  const sentenceComment = commentSplit.slice(1).join(';');
   if (newSentenceRaw.trim() === '') {
     // 注释提前返回
     return {

packages/parser/test/parser.test.ts

@@ -1,7 +1,7 @@
 import SceneParser from "../src/index";
 import { ADD_NEXT_ARG_LIST, SCRIPT_CONFIG } from "../src/config/scriptConfig";
 import { expect, test } from "vitest";
-import { commandType, ISentence } from "../src/interface/sceneInterface";
+import { commandType, IAsset, ISentence } from "../src/interface/sceneInterface";
 import * as fsp from 'fs/promises';
 import { fileType } from "../src/interface/assets";
 
@@ -223,6 +223,39 @@ test("say statement applies asset setter to vocal named argument", async () => {
   });
 });
 
+test("scene assets are deduplicated by type and url", async () => {
+  let prefetchedAssets: IAsset[] = [];
+  const parser = new SceneParser((assetList) => {
+    prefetchedAssets = assetList;
+  }, (fileName, assetType) => {
+    return fileName;
+  }, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG);
+
+  const result = parser.parse(`changeBg:shared.webp;
+changeFigure:shared.webp;
+changeBg:shared.webp;`, 'test', 'test');
+
+  expect(result.assetsList).toEqual([
+    { name: "shared.webp", url: 'shared.webp', type: fileType.background, lineNumber: 0 },
+    { name: "shared.webp", url: 'shared.webp', type: fileType.figure, lineNumber: 1 },
+  ]);
+  expect(prefetchedAssets).toEqual(result.assetsList);
+});
+
+test("scene assets skip entries with empty urls", async () => {
+  const parser = new SceneParser((assetList) => {
+  }, (fileName, assetType) => {
+    if (assetType === fileType.vocal) {
+      return '';
+    }
+    return fileName;
+  }, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG);
+
+  const result = parser.parse(`say:123 -vocal=missing.mp3;`, 'test', 'test');
+
+  expect(result.assetsList).toEqual([]);
+});
+
 test("wait command", async () => {
   const parser = new SceneParser((assetList) => {
   }, (fileName, assetType) => {
@@ -326,6 +359,25 @@ test("escaped semicolon is preserved in content and inline comment is preserved"
   expect(result.sentenceList).toContainEqual(expectSentenceItem);
 });
 
+test("inline comment preserves following semicolons", async () => {
+  const parser = new SceneParser((assetList) => {
+  }, (fileName, assetType) => {
+    return fileName;
+  }, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG);
+
+  const result = parser.parse(`say:123; first; second; third`, 'test', 'test');
+  const expectSentenceItem: ISentence = {
+    command: commandType.say,
+    commandRaw: "say",
+    content: "123",
+    args: [],
+    sentenceAssets: [],
+    subScene: [],
+    inlineComment: "first; second; third"
+  };
+  expect(result.sentenceList).toContainEqual(expectSentenceItem);
+});
+
 test("comment-only line keeps comment in content", async () => {
   const parser = new SceneParser((assetList) => {
   }, (fileName, assetType) => {
@@ -344,3 +396,22 @@ test("comment-only line keeps comment in content", async () => {
   };
   expect(result.sentenceList).toContainEqual(expectSentenceItem);
 });
+
+test("comment-only line preserves following semicolons", async () => {
+  const parser = new SceneParser((assetList) => {
+  }, (fileName, assetType) => {
+    return fileName;
+  }, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG);
+
+  const result = parser.parse(`; first; second; third`, 'test', 'test');
+  const expectSentenceItem: ISentence = {
+    command: commandType.comment,
+    commandRaw: "comment",
+    content: "first; second; third",
+    args: [{ key: 'next', value: true }],
+    sentenceAssets: [],
+    subScene: [],
+    inlineComment: ""
+  };
+  expect(result.sentenceList).toContainEqual(expectSentenceItem);
+});

packages/parser/tsconfig.json

@@ -4,7 +4,7 @@
     "declarationDir": "build/types",
     "target": "ESNext",
     "useDefineForClassFields": true,
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
+    "lib": ["ESNext"],
     "allowJs": false,
     "skipLibCheck": false,
     "esModuleInterop": false,
@@ -17,13 +17,12 @@
     "resolveJsonModule": true,
     "isolatedModules": true,
     "noEmit": true,
-    "jsx": "react-jsx",
+    "types": ["node"],
     "paths": {
       "@/*": ["./src/*"]
     }
   },
   "include": [
     "src"
-  ],
-  "references": [{ "path": "./tsconfig.node.json"}]
+  ]
 }

packages/parser/tsconfig.node.json

@@ -1,6 +1,6 @@
 {
   "name": "webgal-engine",
-  "version": "4.6.1",
+  "version": "4.6.2",
   "scripts": {
     "dev": "vite --host --port 3000",
     "build": "node scripts/update-engine-version.js && cross-env NODE_ENV=production tsc && vite build --base=./",