persistgraphql 项目常见问题解决方案

persistgraphql 项目常见问题解决方案

persistgraphql A build tool for GraphQL projects. 项目地址: https://gitcode.com/gh_mirrors/pe/persistgraphql

项目基础介绍

persistgraphql 是一个用于 GraphQL 项目的构建工具，主要功能包括查询白名单和持久化查询。它通过扫描代码目录，提取 graphql 文件中的查询文档，并为这些查询分配 ID 值或哈希值，生成一个 JSON 文件，用于客户端和服务器之间的查询映射。该项目的主要编程语言是 JavaScript。

新手使用注意事项及解决方案

1. 安装问题

问题描述：新手在安装 persistgraphql 时可能会遇到依赖安装失败或版本不兼容的问题。

解决步骤：

• 检查 Node.js 版本：确保你的 Node.js 版本在 12.x 以上，建议使用 LTS 版本。
• 使用 npm 安装：在项目根目录下运行以下命令进行安装：

  npm install -g persistgraphql
  

• 解决依赖冲突：如果遇到依赖冲突，可以尝试删除 node_modules 目录并重新安装依赖：

  rm -rf node_modules
  npm install
  

2. 查询提取问题

问题描述：在提取 GraphQL 查询时，可能会遇到查询未被正确提取或提取结果为空的情况。

解决步骤：

• 检查文件路径：确保你指定的输入文件或目录路径是正确的。
• 使用 --add_typename 选项：如果你的客户端代码使用了 __typename 字段，确保在提取查询时添加 --add_typename 选项：

  persistgraphql src/ --add_typename
  

• 检查文件扩展名：如果你使用的是 TypeScript 或 JavaScript 文件，确保在命令中指定正确的扩展名：

  persistgraphql src/index.js --js --extension=js
  

3. 输出文件问题

问题描述：提取查询后，生成的输出文件可能不符合预期，或者文件路径错误。

解决步骤：

• 指定输出文件路径：在命令中明确指定输出文件的路径：

  persistgraphql src/ output.json
  

• 检查输出文件内容：确保生成的 JSON 文件内容正确，包含查询和对应的 ID 或哈希值。
• 处理文件路径问题：如果输出文件路径错误，检查当前工作目录，确保路径正确。

通过以上步骤，新手可以更好地理解和使用 persistgraphql 项目，解决常见的问题。

persistgraphql A build tool for GraphQL projects. 项目地址: https://gitcode.com/gh_mirrors/pe/persistgraphql