npm 包 graphql-tag-pluck 使用教程

什么是 graphql-tag-pluck?

graphql-tag-pluck 是一个 npm 包,用于提取 GraphQL 查询和变量定义,或者其它类型的 gql 标签模板字符串。它可以帮助前端开发者更方便地组织 GraphQL 代码,让代码更易于维护阅读。

如何安装 graphql-tag-pluck?

在终端窗口中,输入以下命令即可安装:

--- ------- ----------------- ----------

如何使用 graphql-tag-pluck?

1. 在 JavaScript 或 TypeScript 代码中使用

假设你有个 GraphQL 查询文件:

----- ------------ ---- -
  -------- ---- -
    --
    ----
    -----
    ---
  -
-

你需要在 JavaScript 或 TypeScript 代码中使用这个查询,可以使用如下代码:

------ - ------------- - ---- --------------------

----- -------- - -----------------------------
----- - ------ --------- - - ------------------------

------------------ -----------

上述代码将从 query.graphql 文件中提取出 queryvariables 变量,并将它们打印出来。

2. 在构建过程中使用

在构建过程中,可以使用 graphql-tag-pluck 提取代码中的 GraphQL 查询和变量,以将代码打包到最终的 JavaScript 或 TypeScript 文件中。

要使用 graphql-tag-pluck,你需要在 webpack.config.js 或者其它构建配置文件中,使用 graph-loaderinclude 配置如下:

-------------- - -
  -- ---
  ------- -
    ------ -
      -
        ----- -------------------
        -------- ---------------
        ---- -
          -
            ------- ---------------
            -------- -
              ------------ -
                -------- -- ----- -------------- ----------- ----- ---
              --
            --
          --
        --
      --
      -- ---
    --
  --
  -------- -
    ----------- ------- ------- ------ ------- ----------- --------
  --
--

这样,你就可以在项目中使用 gql 模板字符串,webpack 会自动提取并打包到最终的 JavaScript 或 TypeScript 文件中。

graphql-tag-pluck 的更多功能

1. 支持多种语言

graphql-tag-pluck 不仅支持 GraphQL 查询文件,还支持多种语言的 gql 标签,例如 TypeScript 和 Babel:

----- ----- - ----
  ----- ------------ ---- -
    -------- ---- -
      --
      ----
      -----
      ---
    -
  -
--
------ --- ---- --------------

----- ----- - ----
  ----- ------------ ---- -
    -------- ---- -
      --
      ----
      -----
      ---
    -
  -
--

2. 支持扫描多个文件

除了从单个 GraphQL 查询文件中提取查询和变量,graphql-tag-pluck 还支持从多个文件中一次性提取。

------ - -------------- - ---- --------------------

----- --------- - ------------------------------- -------------------------------
----- - ------ --------- - - --------------------------

------------------ -----------

3. 支持指定模块和标识符

如果你使用的 gql 模块和标识符与默认设置不同,可以传递 pluckConfig 参数来指定。

------ - ------------- - ---- --------------------

----- -------- - -----------------------------
----- - ------ --------- - - ----------------------- -
  ------------ -
    -------- -- ----- ------------------------ ----------- ------- ---
  --
---

------------------ -----------

总结

本文介绍了 npm 包 graphql-tag-pluck 的使用方法和更多功能。它可以帮助前端开发者更方便地组织 GraphQL 代码,让代码更易于维护阅读。如果你的项目使用了 GraphQL,不妨试试 graphql-tag-pluck,提高你的开发效率吧!

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/112116


猜你喜欢

  • npm包@pnpm/outdated使用教程

    npm 是 Node.js 的包管理工具,而 @pnpm/outdated 是一个 npm 包,用于检查已安装的依赖是否有新版本可用。 本文将给出具体的应用教程,包括安装、配置、使用和常见问题的解决方...

    5 年前
  • npm 包 @pnpm/logger 使用教程

    简介 @pnpm/logger 是一个 npm 包,它提供了一种灵活和可配置的日志记录工具。它能够帮助前端开发人员更好地管理和调试应用程序。在本文中,我们将介绍如何使用它以及如何将其应用于您自己的应用...

    5 年前
  • npm 包 @pnpm/default-resolver 使用教程

    什么是 @pnpm/default-resolver @pnpm/default-resolver 是一个 npm 包,它是一种用于解析模块名称的默认解析器。在前端开发中,我们需要经常引用各种模块,这...

    5 年前
  • npm 包 @pnpm/default-fetcher 使用教程

    近年来,随着前端技术的不断发展,npm 成为了前端开发必不可少的依赖管理工具。其中,@pnpm/default-fetcher 是一个非常实用的 npm 包,它可以自动化处理从 npm 源中安装软件包...

    5 年前
  • NPM 包 Elastic APM Node 使用教程

    什么是 Elastic APM? APM (Application Performance Monitoring) 是一种用于监测和分析应用程序性能的技术。 Elastic APM 是一个开源项目,为...

    5 年前
  • npm 包 @types/tar 使用教程

    在前端开发中,我们经常需要操作tar包,如打包、解包等。而在 TypeScript 项目中,使用Node.js的fs模块等时需要进行类型检查,这时就需要用到npm包@types/tar。

    5 年前
  • npm 包 @types/read 使用教程

    在前端开发中,我们经常需要使用第三方库来辅助开发。为了更好地使用这些库,我们通常需要在代码中进行类型注释,以提高代码的可读性和可维护性。而 @types/read 就是一个帮助我们实现类型注释的 np...

    5 年前
  • npm 包 @types/opn 使用教程

    在前端开发中,我们经常需要在浏览器中打开某个 URL 或者本地文件。而在 Node.js 环境下,我们还需要在命令行中启动应用程序或者打开某个文件夹。此时我们需要用到 opn 这个 npm 包来实现这...

    5 年前
  • npm 包 @types/node-static 使用教程

    在前端开发中,我们常常需要使用到静态文件服务器,比如开发 Web 应用、构建前端资源等。而 node-static 是一个常用的静态文件服务器插件。为了能够在 TypeScript 项目中使用该插件,...

    5 年前
  • npm 包 @types/retry 使用教程

    在进行 Web 开发时,避免出现错误是非常重要的。然而,即使代码被编写得很好和经过仔细测试,我们仍然会遇到网络和连接问题,例如连接丢失、超时和一些暂时的 5xx 错误等。

    5 年前
  • npm 包 @types/proper-lockfile 使用教程

    1. 前言 在前端开发中,常常会遇到多个进程/线程需要访问共享资源的情况,如多个 Node.js 实例同时读写同一个文件等。这时就需要使用文件锁(file lock)来确保数据的正确性和一致性。

    5 年前
  • npm 包 @types/flat 使用教程

    在前端开发中,经常需要处理复杂的 JSON 数据结构。而处理这些数据结构时,一个非常有用的工具就是 flat。flat 可以把多层嵌套的对象转换成一层对象,方便我们进行数据处理和操作。

    5 年前
  • `npm` 包 `@kubernetes/client-node` 使用教程

    前言 Kubernetes 是一个开源的容器编排平台,它以容器为基础提供了自动部署、弹性伸缩、负载均衡、容器健康管理等功能,是目前最流行的容器编排平台之一。为方便 JavaScript 开发者使用 K...

    5 年前
  • npm 包 anonymous-npm-registry-client 使用教程

    简介 anonymous-npm-registry-client 是一个 Node.js 的 npm 包,它提供了一个匿名的 NPM Registry 客户端,可以帮助我们在使用 NPM 进行包管理时...

    5 年前
  • npm 包 @types/tape 使用教程

    在前端开发过程中,我们经常需要写测试用例来确保代码的质量和正确性。而 Tape 是一款非常便捷的 JavaScript 测试框架,通过它能够轻松地编写测试用例并进行测试。

    5 年前
  • npm 包 @weahead/prettier-config 使用教程

    前言 在前端开发中,我们经常需要在多人协作时统一代码风格,以提高代码可读性和维护性。此时,一款好用的代码格式化工具便成为了必备工具。 Prettier 就是一款优秀的代码格式化工具,它可以自动地规范化...

    5 年前
  • npm 包 @weahead/markdownlint-config 使用教程

    #npm 包 @weahead/markdownlint-config 使用教程 在前端开发中,Markdown 格式已成为一种非常流行的文本格式。然而,由于 Markdown 语法比较灵活,容易出现...

    5 年前
  • npm 包 @weahead/lint-staged-config 使用教程

    随着前端开发的发展,代码质量成为越来越重要的话题。而 @weahead/lint-staged-config 是一个用于前端项目代码规范检查的 npm 包,它可以帮助我们在 git commit 前自...

    5 年前
  • npm 包 @weahead/husky-config 使用教程

    在前端开发的项目中,代码质量是非常重要的一环。而代码质量的保证离不开一些辅助工具和规范。其中,git hooks 是一个很好的选择,即可以在开发过程中绑定命令,帮助我们提高代码质量,让开发更加规范,同...

    5 年前
  • npm 包 @weahead/eslint-config-react 使用教程

    简介 在使用 React 编写应用程序时,ESLint 是一个必不可少的工具。它可以帮助我们检查代码中的潜在问题,规范代码风格,提高代码质量。@weahead/eslint-config-react ...

    5 年前

相关推荐

    暂无文章