在前端开发中，GraphQL 非常的流行，而使用 GraphQL 时获取和管理配置信息是很常见的需求。@mac-/graphql-config-parser 是一个 npm 包，它可以帮助我们获取和管理 GraphQL 配置信息。在本文中，我们将介绍如何使用该包以及使用它的一些最佳实践。
环境要求和安装
@mac-/graphql-config-parser 包的使用要求 node.js 版本 >= 10.0.0。你可以在你的项目中通过 npm 或 yarn 安装该包：
npm install @mac-/graphql-config-parser
或
yarn add @mac-/graphql-config-parser
使用示例
首先，我们需要了解在一个 GraphQL 项目中，配置信息的结构。一个典型的配置文件可能如下所示：
-- -------------------- ---- -------
-
------------- -------------------
------------ -------------------------------
------------- -
---------- -
-------------------- -----------------------
-
-
-在这个配置文件中，我们定义了：
- schemaPath - GraphQL schema 文件的位置。
- documents - 包含 GraphQL query、mutation 和 subscription 文件的目录的路径。
- extensions.codegen.generatedFileName - 一个目标文件路径，在 schema 和 documents 的基础上生成对应的 TypeScript 类型定义文件。
接下来，我们将展示如何加载和解析上述的配置文件：
const { parseConfig } = require('@mac-/graphql-config-parser')
const { resolve } = require('path')
const config = parseConfig(resolve(__dirname, 'graphql.config.json'))我们可以使用 parseConfig 函数来解析此配置文件，解析后的配置信息将会作为该函数的返回值返回。需要注意的是，传入的配置文件路径必须是绝对路径，因此我们可以使用 resolve 函数将其转化为绝对路径。
得到配置信息后，我们可以访问该配置信息的各个字段来获取所需的配置信息：
console.log(config.schemaPath) // => "./schema.graphql" console.log(config.documents) // => ["./src/graphql/**/*.graphql"] console.log(config.extensions.codegen.generatedFileName) // => "./src/graphQlTypes.ts"
上述代码将会输出配置信息中几个关键字段的值。
除了加载和解析配置文件，@mac-/graphql-config-parser 还提供了一些函数可以帮助我们进行常用的操作，例如解析 GraphQL schema 文件、获取包含所有 query、mutation 和 subscription 的文档的字符串、将 GraphQL documents 转化为 GraphQL DocumentNode 等等：
-- -------------------- ---- -------
----- - ------ ---- ---------- - - --------------------------------------
----- ------ - -----------------------------
----- --------- - -----------------------
----- ------------- - ----
----- ------- -
---- -
----
-
-
-
----- --------------- - ----------------------------在上述代码中，我们使用 loadSchema 函数来解析 GraphQL schema 文件，使用 parse 函数来获取包含所有 query、mutation 和 subscription 的文档的字符串，并使用 gql 函数将 GraphQL documents 转化为 GraphQL DocumentNode。示例代码还包含从 DocumentNode 中提取定义的操作的方法。
最佳实践
在使用 @mac-/graphql-config-parser 时，以下是一些最佳实践：
使用 .env 文件中的变量来存储配置文件的路径
在很多项目中，配置文件的路径可能会常常改变。为了避免在每次更改配置文件路径时都要更改代码，我们可以使用 .env 中的变量来存储配置文件的路径：
GRAPHQL_CONFIG_PATH=graphql.config.json
此后，在你的代码中，你可以直接使用 process.env.GRAPHQL_CONFIG_PATH 来获取配置文件的路径。
将所有的 GraphQL Documents 转换为 DocumentNode
与代码直接操作字符串相比，将所有 GraphQL documents 转化为 DocumentNode 会更方便管理。因此，你可以使用 parse 函数将所有 GraphQL Documents 都转化为 DocumentNode。
const { parse } = require('@mac-/graphql-config-parser')
const documents = parse(config.documents)此后，在你的代码中，你可以直接使用 documents 数组来存储包含所有 GraphQL documents 的 DocumentNode 数组。
了解并使用提供的所有功能
除了加载和解析配置文件之外，@mac-/graphql-config-parser 还提供了一些函数可以帮助我们快速、便捷地进行常见的 GraphQL 相关操作。因此，你应当充分了解这些功能并加以利用。
总结
在本文中，我们介绍了 @mac-/graphql-config-parser 的使用方法，包括加载和解析配置文件、解析 GraphQL schema 文件、获取包含所有 query、mutation 和 subscription 的文档的字符串、将 GraphQL documents 转化为 GraphQL DocumentNode 等操作。我们还讨论了一些最佳实践，包括使用 .env 文件中的变量来存储配置文件的路径、将所有的 GraphQL Documents 转换为 DocumentNode、了解并使用提供的所有功能等等。希望这篇文章可以帮助你更好地使用 @mac-/graphql-config-parser ！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005534781e8991b448d0838