npm 包 graphql-language-service-utils 使用教程-JavaScript中文网-JavaScript教程资源分享门户

GraphQL 是一种用于 API 的查询语言，提供了一种更高效、强类型、语法优雅的方式来查询和操作数据。GraphQL-language-service-utils 是一个 npm 包，它为 GraphQL 语言服务提供实用工具。

本文将详细介绍 GraphQL-language-service-utils 的使用方式，包括：

安装和依赖
工具 API
使用示例

安装和依赖

你可以使用 npm 安装 graphql-language-service-utils：

npm install graphql-language-service-utils

它的依赖包括：

graphql
lodash
path

在使用之前，你需要导入它的 API：

const { collectExecutableDefinitionDiagnositics, Position, parse, print } = require('graphql-language-service-utils')

我们将在下一部分中介绍这些 API。

工具 API

GraphQL-language-service-utils 提供了一系列实用工具，可以帮助你更有效率地编写 GraphQL 语言服务。接下来，我们将对主要的 API 进行详细介绍。

collectExecutableDefinitionDiagnositics

GraphQL 是一种静态类型语言，但仍有许多运行时错误需要处理。collectExecutableDefinitionDiagnositics 方法可以帮助你在解析和验证 GraphQL 文档时收集错误信息。它的 API 如下：

function collectExecutableDefinitionDiagnositics(
  source: string,
  withIgnored: boolean,
  config?: ?GraphQLConfig,
): ?Diagnostic[]

其中，参数意义如下：

source：GraphQL 文档字符串。
withIgnored：是否包含忽略的错误。
config：GraphQl 相关配置。

方法会返回一个包含 Diagnostic 对象的数组。Diagnostic 用于描述源代码中的警告和错误。它的类型定义如下：

type Diagnostic = {
  range: Range,
  severity?: number,
  message: string,
  code?: number | string,
  source?: string,
  relatedInformation?: Array<DiagnosticRelatedInformation>,
}

Position

Position 类型是定义源文件中位置的实用工具类型。Position 是一个简单的对行和列的引用，它的 API 如下：

type Position = {
  line: number, // 从 1 开始
  character: number, // 从 0 开始
}

parse

parse 方法可以将 GraphQL 文档字符串解析为 AST。它的 API 如下：

function parse(
  source: string,
): DocumentNode

其中，参数 source 为 GraphQL 文档字符串，方法返回的 DocumentNode 类型是 GraphQL 的抽象语法树。

print

print 方法可以将 GraphQL 的 AST 转换为文本格式。它的 API 如下：

function print(
  ast: ASTNode,
): string

其中，参数 ast 为 GraphQL 的抽象语法树，方法返回的是 GraphQL 文档字符串。

使用示例

接下来，我们将通过一个示例来演示如何使用 graphql-language-service-utils。本文不会详细介绍 GraphQL 的语法和概念，请先了解 GraphQL 的基本知识。

首先，我们需要一个 GraphQL 文档字符串，并导入 graphql-language-service-utils：

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

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

接下来，我们需要对这个 GraphQL 文档字符串进行解析，便于后续的处理。

const ast = parse(source)

在获取完 GraphQL AST 之后，我们可以用 collectExecutableDefinitionDiagnositics 方法收集错误信息：

const diagnostics = collectExecutableDefinitionDiagnositics(source, true)
console.log(diagnostics)

collectExecutableDefinitionDiagnositics 方法返回一个包含 Diagnostic 对象的数组，通过遍历这个数组，我们就可以轻松地获取错误信息。

我们还可以通过 print 方法将 AST 转换为 GraphQL 文档字符串：

const printed = print(ast)
console.log(printed)

最后，我们还可以使用 Position 类型来方便地引用源码中的行和列：

const position = new Position(1, 5)
console.log(position)

以上就是 graphql-language-service-utils 的主要 API，你可以根据你的实际需求来使用和自定义这些 API。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/5eeeb9457a6cc516fbab6e21