npm 包 relay-compiler-pr-1868 使用教程

阅读时长 4 分钟读完

前言

relay-compiler-pr-1868 是一个基于 Facebook 的 GraphQL 框架 Relay 的 npm 包,它可以使 Relay 在使用 babel-plugin-relay 编译 GraphQL 时更高效,同时也避免了 babel-plugin-relay 在进行无用编译时的性能降低和内存开销增加问题。

本篇文章将重点介绍使用 relay-compiler-pr-1868 的方法,以及如何进行相关配置,并通过示例代码来加深理解。

安装

在使用 relay-compiler-pr-1868 之前需要先安装依赖。

使用方法

relay-compiler-pr-1868 的使用非常简单,只需要在终端执行以下命令即可。

其中,--schema 为 GraphQL schema 的路径,--src 为 Relay 的源代码路径,--extensions 为需要编译的文件扩展名,--language 为编译语言,--exclude 为需要排除的文件路径。

配置方法

对于 Relay 的配置,relay-compiler-pr-1868 可以与 babel-plugin-relay 无缝衔接,只需要在 babelrc 文件中添加以下配置即可。

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

其中,schema 为 GraphQL schema 的路径,artifactDirectory 为编译后的代码路径,language 为编译语言,persistOutput 为编译结果的保存路径,codegenCommand 为编译命令,additionalSchemaLocations 和 additionalSchemas 为额外的 GraphQL schema 路径。exclude 则与前文中介绍的 exclude 相同,用于文件的排除。

这里需要注意的是,artifactDirectory 的值需要与 Relay 的配置文件 .env 中的字符串 REACT_APP_RELAY_GENERATED_FILES 进行对应。

示例代码

下面是一个使用 relay-compiler-pr-1868 的示例代码,可供参考。

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

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

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

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

总结

通过本文的介绍,相信大家已经对于 npm 包 relay-compiler-pr-1868 的使用方法及配置有了更加深入的了解。在实际项目中,使用 relay-compiler-pr-1868 可以在提高编译效率的同时,也可以避免一些性能和内存方面的问题。希望本文能够对大家有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005661981e8991b448e1f8f

纠错
反馈