inkjs多文件故事解决方案JsonFileHandler与PosixFileHandler处理INCLUDE完全指南【免费下载链接】inkjsA javascript port of inkles ink scripting language.项目地址: https://gitcode.com/gh_mirrors/in/inkjsinkjs 是 inkle 叙事语言 ink 的 JavaScript 移植版。编写多文件故事时INCLUDE语句能否正确找到被包含的 .ink 文件取决于你提供的文件处理器inkjs 提供 PosixFileHandler 与 JsonFileHandler 两种方案。本文带你快速掌握这两个处理器的用法与选型。为什么多文件故事需要文件处理器一个较大的 ink 故事通常会拆成主文件 章节文件通过 INCLUDE 语句合并例如 include.ink 就演示了嵌套引入子文件的方式INCLUDE includes/included_file.ink INCLUDE includes/included_file_2.ink This is the main file.编译时的内部流程由解析器驱动见 InkParser.ts解析器读到INCLUDE xxx.ink调用文件处理器的ResolveInkFilename把文件名解析为完整路径调用LoadInkFileContents读取文件内容并递归解析同时检测递归 INCLUDE发现重复引入会报错Recursive INCLUDE detected。这两个方法的契约定义在 IFileHandler.ts 中。inkjs 默认给的是 DefaultFileHandler——它不做任何解析一旦遇到 INCLUDE 就直接抛错提示你必须提供合适的 FileHandler。⚠️ 官方模板的 Node.js 示例正是这样处理多文件的inkjs-compiler.ts 用new PosixFileHandler(path.dirname(inputFile))把主文件所在目录设为根目录因此相对路径的 INCLUDE 都能命中。方案一PosixFileHandler 磁盘多文件方案Node.js 首选PosixFileHandler.ts 面向 Node.js 环境直接读写磁盘构造时传入rootPath根目录省略时默认为当前工作目录ResolveInkFilename用path.resolve(process.cwd(), rootPath, filename)拼出绝对路径LoadInkFileContents用fs.readFileSync(filename, utf-8)读取。最简用法const { Compiler } require(inkjs/full); const { PosixFileHandler } require(inkjs/full); const fileHandler new PosixFileHandler(/path/to/stories); const source fs.readFileSync(/path/to/stories/main.ink, utf-8); const options new CompilerOptions(main.ink, [], false, null, fileHandler); const story new Compiler(source, options).Compile(); 小提示把rootPath指向主文件所在目录最稳妥这样主文件里INCLUDE chapters/ch1.ink这类相对写法即可直接命中。方案二JsonFileHandler 内存映射方案浏览器/前端首选浏览器没有文件系统JsonFileHandler.ts 用一个Recordstring, string字典模拟文件树——键是文件名值是 .ink 源码文本const hierarchy { main.ink: INCLUDE chars.ink\n- scene_start, chars.ink: scene_start\n 你好世界 }; const fileHandler new JsonFileHandler(hierarchy); const options new CompilerOptions(main.ink, [], false, null, fileHandler);⚠️关键限制JsonFileHandler 的ResolveInkFilename只接受字典中已存在的键相对导入尚未实现遇到不存在的文件名会抛出Cannot locate ... Are you trying a relative import ?。所以所有 INCLUDE 里写的文件名都必须原样作为字典的键文件名含子目录如chapters/ch1.ink时键也要写成完整字符串与 INCLUDE 内容完全一致。一张表看懂两种处理器怎么选对比项PosixFileHandlerJsonFileHandler运行环境Node.js服务端/CLI浏览器、内存环境数据来源磁盘真实文件你传入的 文件内容字典路径解析自动拼绝对路径支持相对路径仅支持字典中完整键名典型场景命令行编译、CI 构建前端打包、Serverless 模板源码位置PosixFileHandler.tsJsonFileHandler.ts官方browser_serverless模板templates/browser_serverless/走的就是前端直接持有故事内容的路线与 JsonFileHandler 思路一致。常见问题速查清单报错 Cant resolve filename because no FileHandler was provided→ 忘了把 fileHandler 传给 CompilerOptions 的第五个参数报错 Cannot locate xxx.ink. Are you trying a relative import?→ JsonFileHandler 字典里缺少该键名报错 Recursive INCLUDE detected→ A 引入 B、B 又引入 A检查引入链找不到文件但路径看起来对→ PosixFileHandler 的 rootPath 不是主文件所在目录浏览器方案→ 换用 JsonFileHandler 或按 webpack 指南 把 .ink 作为 asset 内联后编译单文件。总结inkjs 的多文件故事支持把找文件的职责交给 IFileHandler 接口Node.js 环境交给PosixFileHandler读磁盘浏览器环境交给JsonFileHandler查字典。只要选对处理器、配好根目录或文件字典INCLUDE就能像 ink 原生一样顺畅工作把大故事拆成可维护的多文件结构。【免费下载链接】inkjsA javascript port of inkles ink scripting language.项目地址: https://gitcode.com/gh_mirrors/in/inkjs创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 inkjs多文件故事解决方案：JsonFileHandler与PosixFileHandler处理INCLUDE完全指南
inkjs多文件故事解决方案JsonFileHandler与PosixFileHandler处理INCLUDE完全指南【免费下载链接】inkjsA javascript port of inkles ink scripting language.项目地址: https://gitcode.com/gh_mirrors/in/inkjsinkjs 是 inkle 叙事语言 ink 的 JavaScript 移植版。编写多文件故事时INCLUDE语句能否正确找到被包含的 .ink 文件取决于你提供的文件处理器inkjs 提供 PosixFileHandler 与 JsonFileHandler 两种方案。本文带你快速掌握这两个处理器的用法与选型。为什么多文件故事需要文件处理器一个较大的 ink 故事通常会拆成主文件 章节文件通过 INCLUDE 语句合并例如 include.ink 就演示了嵌套引入子文件的方式INCLUDE includes/included_file.ink INCLUDE includes/included_file_2.ink This is the main file.编译时的内部流程由解析器驱动见 InkParser.ts解析器读到INCLUDE xxx.ink调用文件处理器的ResolveInkFilename把文件名解析为完整路径调用LoadInkFileContents读取文件内容并递归解析同时检测递归 INCLUDE发现重复引入会报错Recursive INCLUDE detected。这两个方法的契约定义在 IFileHandler.ts 中。inkjs 默认给的是 DefaultFileHandler——它不做任何解析一旦遇到 INCLUDE 就直接抛错提示你必须提供合适的 FileHandler。⚠️ 官方模板的 Node.js 示例正是这样处理多文件的inkjs-compiler.ts 用new PosixFileHandler(path.dirname(inputFile))把主文件所在目录设为根目录因此相对路径的 INCLUDE 都能命中。方案一PosixFileHandler 磁盘多文件方案Node.js 首选PosixFileHandler.ts 面向 Node.js 环境直接读写磁盘构造时传入rootPath根目录省略时默认为当前工作目录ResolveInkFilename用path.resolve(process.cwd(), rootPath, filename)拼出绝对路径LoadInkFileContents用fs.readFileSync(filename, utf-8)读取。最简用法const { Compiler } require(inkjs/full); const { PosixFileHandler } require(inkjs/full); const fileHandler new PosixFileHandler(/path/to/stories); const source fs.readFileSync(/path/to/stories/main.ink, utf-8); const options new CompilerOptions(main.ink, [], false, null, fileHandler); const story new Compiler(source, options).Compile(); 小提示把rootPath指向主文件所在目录最稳妥这样主文件里INCLUDE chapters/ch1.ink这类相对写法即可直接命中。方案二JsonFileHandler 内存映射方案浏览器/前端首选浏览器没有文件系统JsonFileHandler.ts 用一个Recordstring, string字典模拟文件树——键是文件名值是 .ink 源码文本const hierarchy { main.ink: INCLUDE chars.ink\n- scene_start, chars.ink: scene_start\n 你好世界 }; const fileHandler new JsonFileHandler(hierarchy); const options new CompilerOptions(main.ink, [], false, null, fileHandler);⚠️关键限制JsonFileHandler 的ResolveInkFilename只接受字典中已存在的键相对导入尚未实现遇到不存在的文件名会抛出Cannot locate ... Are you trying a relative import ?。所以所有 INCLUDE 里写的文件名都必须原样作为字典的键文件名含子目录如chapters/ch1.ink时键也要写成完整字符串与 INCLUDE 内容完全一致。一张表看懂两种处理器怎么选对比项PosixFileHandlerJsonFileHandler运行环境Node.js服务端/CLI浏览器、内存环境数据来源磁盘真实文件你传入的 文件内容字典路径解析自动拼绝对路径支持相对路径仅支持字典中完整键名典型场景命令行编译、CI 构建前端打包、Serverless 模板源码位置PosixFileHandler.tsJsonFileHandler.ts官方browser_serverless模板templates/browser_serverless/走的就是前端直接持有故事内容的路线与 JsonFileHandler 思路一致。常见问题速查清单报错 Cant resolve filename because no FileHandler was provided→ 忘了把 fileHandler 传给 CompilerOptions 的第五个参数报错 Cannot locate xxx.ink. Are you trying a relative import?→ JsonFileHandler 字典里缺少该键名报错 Recursive INCLUDE detected→ A 引入 B、B 又引入 A检查引入链找不到文件但路径看起来对→ PosixFileHandler 的 rootPath 不是主文件所在目录浏览器方案→ 换用 JsonFileHandler 或按 webpack 指南 把 .ink 作为 asset 内联后编译单文件。总结inkjs 的多文件故事支持把找文件的职责交给 IFileHandler 接口Node.js 环境交给PosixFileHandler读磁盘浏览器环境交给JsonFileHandler查字典。只要选对处理器、配好根目录或文件字典INCLUDE就能像 ink 原生一样顺畅工作把大故事拆成可维护的多文件结构。【免费下载链接】inkjsA javascript port of inkles ink scripting language.项目地址: https://gitcode.com/gh_mirrors/in/inkjs创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考