webgal-parser 4.3.11 → 4.3.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/build/cjs/config/scriptConfig.d.ts +6 -0
  2. package/build/{types → cjs}/index.d.ts +0 -0
  3. package/build/cjs/index.js +17665 -0
  4. package/build/cjs/index.js.map +1 -0
  5. package/build/{types → cjs}/interface/assets.d.ts +0 -0
  6. package/build/{types → cjs}/interface/runtimeInterface.d.ts +0 -0
  7. package/build/{types → cjs}/interface/sceneInterface.d.ts +0 -0
  8. package/build/{types → cjs}/sceneParser.d.ts +0 -0
  9. package/build/{types → cjs}/scriptParser/argsParser.d.ts +0 -0
  10. package/build/{types → cjs}/scriptParser/assetsScanner.d.ts +0 -0
  11. package/build/{types → cjs}/scriptParser/commandParser.d.ts +0 -0
  12. package/build/{types → cjs}/scriptParser/contentParser.d.ts +0 -0
  13. package/build/{types → cjs}/scriptParser/scriptParser.d.ts +0 -0
  14. package/build/{types → cjs}/scriptParser/subSceneScanner.d.ts +0 -0
  15. package/build/es/config/scriptConfig.d.ts +6 -0
  16. package/{index.d.ts → build/es/index.d.ts} +10 -10
  17. package/build/es/index.js +17661 -0
  18. package/build/es/index.js.map +1 -0
  19. package/{interface → build/es/interface}/assets.d.ts +12 -12
  20. package/{interface → build/es/interface}/runtimeInterface.d.ts +9 -9
  21. package/{interface → build/es/interface}/sceneInterface.d.ts +94 -91
  22. package/{sceneParser.d.ts → build/es/sceneParser.d.ts} +14 -14
  23. package/{scriptParser → build/es/scriptParser}/argsParser.d.ts +9 -9
  24. package/{scriptParser → build/es/scriptParser}/assetsScanner.d.ts +9 -9
  25. package/{scriptParser → build/es/scriptParser}/commandParser.d.ts +9 -9
  26. package/{scriptParser → build/es/scriptParser}/contentParser.d.ts +9 -9
  27. package/{scriptParser → build/es/scriptParser}/scriptParser.d.ts +9 -9
  28. package/{scriptParser → build/es/scriptParser}/subSceneScanner.d.ts +7 -7
  29. package/package.json +7 -5
  30. package/rollup.config.js +45 -29
  31. package/{config → src/config}/scriptConfig.ts +0 -0
  32. package/{index.ts → src/index.ts} +0 -0
  33. package/{interface → src/interface}/assets.ts +0 -0
  34. package/{interface → src/interface}/runtimeInterface.ts +0 -0
  35. package/{interface → src/interface}/sceneInterface.ts +0 -0
  36. package/{sceneParser.ts → src/sceneParser.ts} +0 -0
  37. package/{scriptParser → src/scriptParser}/argsParser.ts +0 -0
  38. package/{scriptParser → src/scriptParser}/assetsScanner.ts +0 -0
  39. package/{scriptParser → src/scriptParser}/commandParser.ts +0 -0
  40. package/{scriptParser → src/scriptParser}/contentParser.ts +0 -0
  41. package/{scriptParser → src/scriptParser}/scriptParser.ts +1 -1
  42. package/{scriptParser → src/scriptParser}/subSceneScanner.ts +0 -0
  43. package/test/{test.ts → parser.test.ts} +22 -9
  44. package/build/index.global.js +0 -482
  45. package/build/index.global.js.map +0 -1
  46. package/build/index.js +0 -460
  47. package/build/index.js.map +0 -1
  48. package/config/scriptConfig.js +0 -46
  49. package/index.js +0 -483
  50. package/index.js.map +0 -1
  51. package/interface/assets.js +0 -16
  52. package/interface/runtimeInterface.js +0 -2
  53. package/interface/sceneInterface.js +0 -32
  54. package/sceneParser.js +0 -53
  55. package/scriptParser/argsParser.js +0 -70
  56. package/scriptParser/assetsScanner.js +0 -75
  57. package/scriptParser/commandParser.js +0 -60
  58. package/scriptParser/contentParser.js +0 -68
  59. package/scriptParser/scriptParser.js +0 -81
  60. package/scriptParser/subSceneScanner.js +0 -26
  61. package/test/test.js +0 -10
@@ -1,12 +1,12 @@
1
- /**
2
- * 内置资源类型的枚举
3
- */
4
- export declare enum fileType {
5
- background = 0,
6
- bgm = 1,
7
- figure = 2,
8
- scene = 3,
9
- tex = 4,
10
- vocal = 5,
11
- video = 6
12
- }
1
+ /**
2
+ * 内置资源类型的枚举
3
+ */
4
+ export declare enum fileType {
5
+ background = 0,
6
+ bgm = 1,
7
+ figure = 2,
8
+ scene = 3,
9
+ tex = 4,
10
+ vocal = 5,
11
+ video = 6
12
+ }
@@ -1,9 +1,9 @@
1
- /**
2
- * 子场景结束后回到父场景的入口
3
- * @interface sceneEntry
4
- */
5
- export interface sceneEntry {
6
- sceneName: string;
7
- sceneUrl: string;
8
- continueLine: number;
9
- }
1
+ /**
2
+ * 子场景结束后回到父场景的入口
3
+ * @interface sceneEntry
4
+ */
5
+ export interface sceneEntry {
6
+ sceneName: string;
7
+ sceneUrl: string;
8
+ continueLine: number;
9
+ }
@@ -1,91 +1,94 @@
1
- /**
2
- * 语句类型
3
- */
4
- import { sceneEntry } from "./runtimeInterface";
5
- import { fileType } from "./assets";
6
- export declare enum commandType {
7
- say = 0,
8
- changeBg = 1,
9
- changeFigure = 2,
10
- bgm = 3,
11
- video = 4,
12
- pixi = 5,
13
- pixiInit = 6,
14
- intro = 7,
15
- miniAvatar = 8,
16
- changeScene = 9,
17
- choose = 10,
18
- end = 11,
19
- setComplexAnimation = 12,
20
- setFilter = 13,
21
- label = 14,
22
- jumpLabel = 15,
23
- chooseLabel = 16,
24
- setVar = 17,
25
- if = 18,
26
- callScene = 19,
27
- showVars = 20,
28
- unlockCg = 21,
29
- unlockBgm = 22,
30
- filmMode = 23,
31
- setTextbox = 24,
32
- setAnimation = 25
33
- }
34
- /**
35
- * 单个参数接口
36
- * @interface arg
37
- */
38
- export interface arg {
39
- key: string;
40
- value: string | boolean | number;
41
- }
42
- /**
43
- * 资源接口
44
- * @interface IAsset
45
- */
46
- export interface IAsset {
47
- name: string;
48
- type: fileType;
49
- url: string;
50
- lineNumber: number;
51
- }
52
- /**
53
- * 单条语句接口
54
- * @interface ISentence
55
- */
56
- export interface ISentence {
57
- command: commandType;
58
- commandRaw: string;
59
- content: string;
60
- args: Array<arg>;
61
- sentenceAssets: Array<IAsset>;
62
- subScene: Array<string>;
63
- }
64
- /**
65
- * 场景接口
66
- * @interface IScene
67
- */
68
- export interface IScene {
69
- sceneName: string;
70
- sceneUrl: string;
71
- sentenceList: Array<ISentence>;
72
- assetsList: Array<IAsset>;
73
- subSceneList: Array<string>;
74
- }
75
- /**
76
- * 当前的场景数据
77
- * @interface ISceneData
78
- */
79
- export interface ISceneData {
80
- currentSentenceId: number;
81
- sceneStack: Array<sceneEntry>;
82
- currentScene: IScene;
83
- }
84
- /**
85
- * 处理后的命令接口
86
- * @interface parsedCommand
87
- */
88
- export interface parsedCommand {
89
- type: commandType;
90
- additionalArgs: Array<arg>;
91
- }
1
+ /**
2
+ * 语句类型
3
+ */
4
+ import { sceneEntry } from "./runtimeInterface";
5
+ import { fileType } from "./assets";
6
+ export declare enum commandType {
7
+ say = 0,
8
+ changeBg = 1,
9
+ changeFigure = 2,
10
+ bgm = 3,
11
+ video = 4,
12
+ pixi = 5,
13
+ pixiInit = 6,
14
+ intro = 7,
15
+ miniAvatar = 8,
16
+ changeScene = 9,
17
+ choose = 10,
18
+ end = 11,
19
+ setComplexAnimation = 12,
20
+ setFilter = 13,
21
+ label = 14,
22
+ jumpLabel = 15,
23
+ chooseLabel = 16,
24
+ setVar = 17,
25
+ if = 18,
26
+ callScene = 19,
27
+ showVars = 20,
28
+ unlockCg = 21,
29
+ unlockBgm = 22,
30
+ filmMode = 23,
31
+ setTextbox = 24,
32
+ setAnimation = 25,
33
+ playEffect = 26,
34
+ setTempAnimation = 27,
35
+ comment = 28
36
+ }
37
+ /**
38
+ * 单个参数接口
39
+ * @interface arg
40
+ */
41
+ export interface arg {
42
+ key: string;
43
+ value: string | boolean | number;
44
+ }
45
+ /**
46
+ * 资源接口
47
+ * @interface IAsset
48
+ */
49
+ export interface IAsset {
50
+ name: string;
51
+ type: fileType;
52
+ url: string;
53
+ lineNumber: number;
54
+ }
55
+ /**
56
+ * 单条语句接口
57
+ * @interface ISentence
58
+ */
59
+ export interface ISentence {
60
+ command: commandType;
61
+ commandRaw: string;
62
+ content: string;
63
+ args: Array<arg>;
64
+ sentenceAssets: Array<IAsset>;
65
+ subScene: Array<string>;
66
+ }
67
+ /**
68
+ * 场景接口
69
+ * @interface IScene
70
+ */
71
+ export interface IScene {
72
+ sceneName: string;
73
+ sceneUrl: string;
74
+ sentenceList: Array<ISentence>;
75
+ assetsList: Array<IAsset>;
76
+ subSceneList: Array<string>;
77
+ }
78
+ /**
79
+ * 当前的场景数据
80
+ * @interface ISceneData
81
+ */
82
+ export interface ISceneData {
83
+ currentSentenceId: number;
84
+ sceneStack: Array<sceneEntry>;
85
+ currentScene: IScene;
86
+ }
87
+ /**
88
+ * 处理后的命令接口
89
+ * @interface parsedCommand
90
+ */
91
+ export interface parsedCommand {
92
+ type: commandType;
93
+ additionalArgs: Array<arg>;
94
+ }
@@ -1,14 +1,14 @@
1
- import { IAsset, IScene } from "./interface/sceneInterface";
2
- import { fileType } from "./interface/assets";
3
- /**
4
- * 场景解析器
5
- * @param rawScene 原始场景
6
- * @param sceneName 场景名称
7
- * @param sceneUrl 场景url
8
- * @param assetsPrefetcher
9
- * @param assetSetter
10
- * @param ADD_NEXT_ARG_LIST
11
- * @param SCRIPT_CONFIG
12
- * @return {IScene} 解析后的场景
13
- */
14
- export declare const sceneParser: (rawScene: string, sceneName: string, sceneUrl: string, assetsPrefetcher: (assetList: Array<IAsset>) => void, assetSetter: (fileName: string, assetType: fileType) => string, ADD_NEXT_ARG_LIST: any, SCRIPT_CONFIG: any) => IScene;
1
+ import { IAsset, IScene } from "./interface/sceneInterface";
2
+ import { fileType } from "./interface/assets";
3
+ /**
4
+ * 场景解析器
5
+ * @param rawScene 原始场景
6
+ * @param sceneName 场景名称
7
+ * @param sceneUrl 场景url
8
+ * @param assetsPrefetcher
9
+ * @param assetSetter
10
+ * @param ADD_NEXT_ARG_LIST
11
+ * @param SCRIPT_CONFIG
12
+ * @return {IScene} 解析后的场景
13
+ */
14
+ export declare const sceneParser: (rawScene: string, sceneName: string, sceneUrl: string, assetsPrefetcher: (assetList: Array<IAsset>) => void, assetSetter: (fileName: string, assetType: fileType) => string, ADD_NEXT_ARG_LIST: any, SCRIPT_CONFIG: any) => IScene;
@@ -1,9 +1,9 @@
1
- import { arg } from "../interface/sceneInterface";
2
- import { fileType } from "../interface/assets";
3
- /**
4
- * 参数解析器
5
- * @param argsRaw 原始参数字符串
6
- * @param assetSetter
7
- * @return {Array<arg>} 解析后的参数列表
8
- */
9
- export declare function argsParser(argsRaw: string, assetSetter: (fileName: string, assetType: fileType) => string): Array<arg>;
1
+ import { arg } from "../interface/sceneInterface";
2
+ import { fileType } from "../interface/assets";
3
+ /**
4
+ * 参数解析器
5
+ * @param argsRaw 原始参数字符串
6
+ * @param assetSetter
7
+ * @return {Array<arg>} 解析后的参数列表
8
+ */
9
+ export declare function argsParser(argsRaw: string, assetSetter: (fileName: string, assetType: fileType) => string): Array<arg>;
@@ -1,9 +1,9 @@
1
- import { arg, commandType, IAsset } from '../interface/sceneInterface';
2
- /**
3
- * 根据语句类型、语句内容、参数列表,扫描该语句可能携带的资源
4
- * @param command 语句类型
5
- * @param content 语句内容
6
- * @param args 参数列表
7
- * @return {Array<IAsset>} 语句携带的参数列表
8
- */
9
- export declare const assetsScanner: (command: commandType, content: string, args: Array<arg>) => Array<IAsset>;
1
+ import { arg, commandType, IAsset } from '../interface/sceneInterface';
2
+ /**
3
+ * 根据语句类型、语句内容、参数列表,扫描该语句可能携带的资源
4
+ * @param command 语句类型
5
+ * @param content 语句内容
6
+ * @param args 参数列表
7
+ * @return {Array<IAsset>} 语句携带的参数列表
8
+ */
9
+ export declare const assetsScanner: (command: commandType, content: string, args: Array<arg>) => Array<IAsset>;
@@ -1,9 +1,9 @@
1
- import { parsedCommand } from "../interface/sceneInterface";
2
- /**
3
- * 处理命令
4
- * @param commandRaw
5
- * @param ADD_NEXT_ARG_LIST
6
- * @param SCRIPT_CONFIG
7
- * @return {parsedCommand} 处理后的命令
8
- */
9
- export declare const commandParser: (commandRaw: string, ADD_NEXT_ARG_LIST: any, SCRIPT_CONFIG: any) => parsedCommand;
1
+ import { parsedCommand } from "../interface/sceneInterface";
2
+ /**
3
+ * 处理命令
4
+ * @param commandRaw
5
+ * @param ADD_NEXT_ARG_LIST
6
+ * @param SCRIPT_CONFIG
7
+ * @return {parsedCommand} 处理后的命令
8
+ */
9
+ export declare const commandParser: (commandRaw: string, ADD_NEXT_ARG_LIST: any, SCRIPT_CONFIG: any) => parsedCommand;
@@ -1,9 +1,9 @@
1
- import { commandType } from "../interface/sceneInterface";
2
- /**
3
- * 解析语句内容的函数,主要作用是把文件名改为绝对地址或相对地址(根据使用情况而定)
4
- * @param contentRaw 原始语句内容
5
- * @param type 语句类型
6
- * @param assetSetter
7
- * @return {string} 解析后的语句内容
8
- */
9
- export declare const contentParser: (contentRaw: string, type: commandType, assetSetter: any) => any;
1
+ import { commandType } from "../interface/sceneInterface";
2
+ /**
3
+ * 解析语句内容的函数,主要作用是把文件名改为绝对地址或相对地址(根据使用情况而定)
4
+ * @param contentRaw 原始语句内容
5
+ * @param type 语句类型
6
+ * @param assetSetter
7
+ * @return {string} 解析后的语句内容
8
+ */
9
+ export declare const contentParser: (contentRaw: string, type: commandType, assetSetter: any) => any;
@@ -1,9 +1,9 @@
1
- import { ISentence } from "../interface/sceneInterface";
2
- /**
3
- * 语句解析器
4
- * @param sentenceRaw 原始语句
5
- * @param assetSetter
6
- * @param ADD_NEXT_ARG_LIST
7
- * @param SCRIPT_CONFIG
8
- */
9
- export declare const scriptParser: (sentenceRaw: string, assetSetter: any, ADD_NEXT_ARG_LIST: any, SCRIPT_CONFIG: any) => ISentence;
1
+ import { ISentence } from "../interface/sceneInterface";
2
+ /**
3
+ * 语句解析器
4
+ * @param sentenceRaw 原始语句
5
+ * @param assetSetter
6
+ * @param ADD_NEXT_ARG_LIST
7
+ * @param SCRIPT_CONFIG
8
+ */
9
+ export declare const scriptParser: (sentenceRaw: string, assetSetter: any, ADD_NEXT_ARG_LIST: any, SCRIPT_CONFIG: any) => ISentence;
@@ -1,7 +1,7 @@
1
- /**
2
- * 扫描子场景
3
- * @param content 语句内容
4
- * @return {Array<string>} 子场景列表
5
- */
6
- import { commandType } from '../interface/sceneInterface';
7
- export declare const subSceneScanner: (command: commandType, content: string) => Array<string>;
1
+ /**
2
+ * 扫描子场景
3
+ * @param content 语句内容
4
+ * @return {Array<string>} 子场景列表
5
+ */
6
+ import { commandType } from '../interface/sceneInterface';
7
+ export declare const subSceneScanner: (command: commandType, content: string) => Array<string>;
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "webgal-parser",
3
- "version": "4.3.11",
3
+ "version": "4.3.13",
4
4
  "description": "WebGAL script parser",
5
5
  "scripts": {
6
- "test": "node test/test.js",
6
+ "test": "vitest",
7
7
  "build": "rimraf -rf ./build && rollup --config"
8
8
  },
9
- "module": "./build/index.js",
10
- "main": "index.js",
9
+ "module": "./build/es/index.js",
10
+ "main": "./build/cjs/index.js",
11
11
  "author": "Mahiru <Mahiru_@outlook.com>",
12
12
  "license": "MPL-2.0",
13
13
  "dependencies": {
@@ -20,6 +20,7 @@
20
20
  "@rollup/plugin-node-resolve": "^15.0.1",
21
21
  "@rollup/plugin-typescript": "^9.0.2",
22
22
  "@types/lodash": "^4.14.189",
23
+ "@types/node": "^18.14.0",
23
24
  "rollup": "^3.3.0",
24
25
  "rollup-plugin-babel": "^4.4.0",
25
26
  "rollup-plugin-dts": "^5.0.0",
@@ -27,7 +28,8 @@
27
28
  "rollup-plugin-typescript2": "^0.34.1",
28
29
  "ts-node": "^10.9.1",
29
30
  "tslib": "^2.4.1",
30
- "typescript": "^4.9.3"
31
+ "typescript": "^4.9.3",
32
+ "vitest": "^0.28.5"
31
33
  },
32
34
  "type": "module"
33
35
  }
package/rollup.config.js CHANGED
@@ -1,32 +1,48 @@
1
- import typescript from 'rollup-plugin-typescript2';
1
+ import typescript from "rollup-plugin-typescript2";
2
+ import resolve from "@rollup/plugin-node-resolve";
3
+ import commonjs from "@rollup/plugin-commonjs";
2
4
 
3
5
  const mode = process.env.MODE;
4
- const isProd = mode === 'prod';
5
- import pkg from './package.json' assert { type: "json" };
6
+ const isProd = mode === "prod";
6
7
 
7
- export default {
8
- input: `index.ts`,
9
- output: [
10
- {
11
- file: pkg.main,
12
- exports: 'named',
13
- format: 'cjs',
14
- sourcemap: !isProd
15
- },
16
- {
17
- file: pkg.module,
18
- format: 'es',
19
- sourcemap: !isProd
20
- },
21
- {
22
- file: 'build/index.global.js',
23
- name: 'webgalparser',
24
- format: 'iife',
25
- sourcemap: !isProd
26
- },
27
- ],
28
- plugins: [typescript({
29
- useTsconfigDeclarationDir: true,
30
- tsconfigOverride: { compilerOptions: { sourceMap: !isProd } }
31
- })],
32
- };
8
+ export default [
9
+ {
10
+ input: `./src/index.ts`,
11
+ output:
12
+ {
13
+ file: "./build/es/index.js",
14
+ format: "es",
15
+ sourcemap: !isProd
16
+ },
17
+ plugins: [
18
+ resolve(), commonjs(), typescript({
19
+ useTsconfigDeclarationDir: true,
20
+ tsconfigOverride: {
21
+ compilerOptions: {
22
+ sourceMap: !isProd,
23
+ declarationDir: "build/es"
24
+ }, include: ["src"]
25
+ }
26
+ })]
27
+ }, {
28
+ input: `./src/index.ts`,
29
+ output: [
30
+ {
31
+ file: "./build/cjs/index.js",
32
+ exports: "named",
33
+ format: "cjs",
34
+ sourcemap: !isProd
35
+ },
36
+ ],
37
+ plugins: [
38
+ resolve(), commonjs(), typescript({
39
+ useTsconfigDeclarationDir: true,
40
+ tsconfigOverride: {
41
+ compilerOptions: {
42
+ sourceMap: !isProd,
43
+ declarationDir: "build/cjs"
44
+ }, include: ["src"]
45
+ }
46
+ })],
47
+ }
48
+ ];
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -31,7 +31,7 @@ export const scriptParser = (sentenceRaw: string, assetSetter: any, ADD_NEXT_ARG
31
31
  command: commandType.comment, // 语句类型
32
32
  commandRaw: "comment", // 命令原始内容,方便调试
33
33
  content: sentenceRaw.split(";")[1] ?? "", // 语句内容
34
- args: [], // 参数列表
34
+ args: [{ key: "next", value: true }], // 参数列表
35
35
  sentenceAssets: [], // 语句携带的资源列表
36
36
  subScene: [] // 语句携带的子场景
37
37
  };
@@ -1,12 +1,15 @@
1
- import { SceneParser } from "../index";
2
- import { ADD_NEXT_ARG_LIST, SCRIPT_CONFIG } from "../config/scriptConfig";
1
+ import SceneParser from "../src/index";
2
+ import { ADD_NEXT_ARG_LIST, SCRIPT_CONFIG } from "../src/config/scriptConfig";
3
+ import { expect, test } from "vitest";
4
+ import { commandType, ISentence } from "../src/interface/sceneInterface";
3
5
 
4
- const parser = new SceneParser((assetList) => {
5
- }, (fileName, assetType) => {
6
- return fileName;
7
- }, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG);
6
+ test("label", async () => {
7
+ const parser = new SceneParser((assetList) => {
8
+ }, (fileName, assetType) => {
9
+ return fileName;
10
+ }, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG);
8
11
 
9
- const result = parser.parse(`
12
+ const result = parser.parse(`
10
13
  ; 初始场景,以及特效演示
11
14
  changeBg:c4.jpg -next;
12
15
  unlockCg:c4.jpg -name=街前; 解锁部分CG
@@ -113,5 +116,15 @@ label:end;
113
116
  changeFigure:none -next;
114
117
  WebGAL:基础演出的展示已经结束。;
115
118
  `, "test", "/test.txt");
116
-
117
- console.log(result);
119
+ const expectSentenceItem: ISentence = {
120
+ command: commandType.label,
121
+ commandRaw: "label",
122
+ content: "end",
123
+ args: [
124
+ { key: "next", value: true }
125
+ ],
126
+ sentenceAssets: [],
127
+ subScene: []
128
+ };
129
+ expect(result.sentenceList).toContainEqual(expectSentenceItem);
130
+ });