前言
Node.js 生态系统中最为广泛使用的工具之一是 npm 包。借助于 npm 包，我们可以轻松地将功能模块和组件集成到我们的应用程序中。generator-graql 就是一种可帮助我们在前端工程中生成 Graql 相关文件的 npm 包。在以下的使用教程中，我们将手把手地介绍如何使用 generator-graql，让你可以将其集成到任何前端项目中并把开发效率最大化。
安装 generator-graql
在开始之前，请确保您已经在您的计算机上安装了 Node.js 和 npm。如果您还没有安装它们，请到官方网站 https://nodejs.org/en/ 下载并安装 Node.js 和 npm。
生成器（generator）是一种类似于模板的工具集，它可以帮助我们根据指定的模板快速生成代码。generator-graql 就是一个可以生成 Graql 相关文件的生成器。我们需要使用 npm 命令来安装它。打开命令行工具并输入以下命令：
npm install -g yo generator-graql
该命令下载并安装 Yo 和 generator-graql。Yo 是一个生成器运行器，它用于管理各种不同类型的生成器。generator-graql 只是其中的一种生成器。
生成 Graql 文件
现在，我们已经安装了 generator-graql，我们来生成 Graql 文件。在以下的教程中，我们将以生成一个包含一个 Person 类型, 一个 software 关系和一个端口定义的 *.gql 文件为例。
yo graql
在命令行工具中输入以上命令，然后回答命令行的各种问题以便生成器能够生成您所需的文件。最终生成的代码如下：
-- -------------------- ---- -------
------
-------- --- -------
----- -----------
----- ------------ -
---- -------
------- ------
-
------ --- -------
--- -----
----- ------ -
---- ---------
-
---- --- -------
---------- --- ---------
------- ---------
------- -------
------------ --- ---------
------- ---------
------- ------------------ -- -------------------
------------------ --- -----
------ --- -----以上代码是一种示例，您可以使用它来在生成器的交互中选择相应的选项。生成的 *.gql 文件将会在运行命令的路径下创建。
将 Graql 文件集成到您的项目中
现在，您已经有了一个 .gql 文件，在您的项目中集成它是至关重要的。将 *.gql 文件添加到您的项目中并不那么困难。要这样做，请先创建一个 GraphQL Schema 类型的 JavaScript 模块，如以下示例：
import { gql } from '@apollo/client';
export const typeDefs = gql`
... // 这里是生成的 Graql 代码
`;然后，您需要将 typeDefs 导出，以便其他 TypeScript 或 JavaScript 模块可以访问它。将以下代码添加到您的主 JavaScript 模块中以导出此模块：
export { typeDefs } from './path/to/generated_gql_file.js';现在，您已经将 Graql 代码添加到了您的项目中！
结语
generator-graql 是一个强大的 npm 包，可以帮助您快速生成 Graql 文件，并将它们集成到您的项目中。我们希望这个使用教程对您在开发中有所帮助，并提高您的效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600566b181e8991b448e2f1d