# @gravity-ui/websql-autocomplete 中文文档

规范地址：https://npmcn.com/package/%40gravity-ui/websql-autocomplete/

版本：13\.16\.1
npm 元数据更新时间：2026-11-03T09:28:26.908Z
中文译文更新时间：2026-11-17T02:26:57.731Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gravity-ui/websql-autocomplete
原文对照：https://npmcn.com/package/%40gravity-ui/websql-autocomplete/?lang=original
项目主页：https://github.com/gravity-ui/websql-autocomplete#readme
源码仓库：https://github.com/gravity-ui/websql-autocomplete

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：17.4 MB，102 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.0
- 运行依赖：2 个
- 首次发布：2024-03-11T12:03:49.102Z
- 最新版本发布：2026-11-03T09:28:26.692Z
- 近 30 天下载量：9564（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：57（近 12 个月 4 个）

## 中文简介

为各种数据库方言提供自动补全和突出显示错误的库

## 安装

```sh
npm install @gravity-ui/websql-autocomplete
```

也可以使用：`pnpm add @gravity-ui/websql-autocomplete`、`yarn add @gravity-ui/websql-autocomplete`、`bun add @gravity-ui/websql-autocomplete`

## README

# WebSQL 自动完成

![ci\_badge](https://img.shields.io/github/actions/workflow/status/gravity-ui/websql-autocomplete/ci.yml) ![npm\_package\_version\_badge](https://img.shields.io/npm/v/@gravity-ui/websql-autocomplete) ![last\_commit\_badge](https://img.shields.io/github/last-commit/gravity-ui/websql-autocomplete) ![license\_badge](https://img.shields.io/github/license/gravity-ui/websql-autocomplete)

为各种 sql 方言提供自动补全的工具 .

# 自动完整理论

为了分析任何语言,你需要 [词典](https://en.wikipedia.org/wiki/Lexical_analysis) (指针)和a [解析器](https://en.wikipedia.org/wiki/Parsing#Parser) (建筑工人)

研究资源:

-   ANTLR大导师: [https://tomassetti.me/antlr-mega-tutorial/ 页面存档备份,存于互联网档案馆](https://tomassetti.me/antlr-mega-tutorial/)
-   以 ANTR4-c3 完成代码 : [https://tomassetti.me/code-complete- with-antlr4-c3/ 互联网档案馆的存檔,存档日期2013-12-12](https://tomassetti.me/code-completion-with-antlr4-c3/)

# 万事俱备

1.  不同语法和语法 `{dialect}` 定义在 `src/autocomplete/databases/{dialect}/grammar` 目录.
2.  不同的实际参数和出税人 `{dialect}` 生成为 `src/autocomplete/databases/{dialect}/generated` 目录.
3.  用于核心逻辑工作的 Dialect 特定代码被插入 `src/autocomplete/databases/{dialect}/{dialect}-autocomplete.ts` 文档.
4.  核心逻辑在内部 `src/autocomplete/shared/autocomplete.ts` 文档。 它利用方言特定帮助根据当前光标位置生成自动完成建议.

# 如何添加新方言

1.  添加新的方言文件到 [src/自动完成/数据库/{$dialect}](https://npmcn.com/package/%40gravity-ui/websql-autocomplete/src/autocomplete/databases)
2.  在方言中添加新方言 `typesVersions`, (中文(简体) ), `exports` 变量在 [软件包.json](https://npmcn.com/package/%40gravity-ui/websql-autocomplete/package.json)
3.  在方言中添加新方言 `databases` 阵列 [建设.js](https://npmcn.com/package/%40gravity-ui/websql-autocomplete/build.js)

# 主要脚本

-   `npm run generate` - 生成解析器和出税器(Java必须安装在您的系统中才能工作)
-   `npm run test` - 运行测试

## 常见问题

### @gravity-ui/websql-autocomplete 是什么？

为各种数据库方言提供自动补全和突出显示错误的库

### 如何安装 @gravity-ui/websql-autocomplete？

在项目目录运行 npm install @gravity-ui/websql-autocomplete，或使用 pnpm add / yarn add / bun add。

### @gravity-ui/websql-autocomplete 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @gravity-ui/websql-autocomplete 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @gravity-ui/websql-autocomplete 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=16\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @gravity-ui/websql-autocomplete 可以商用吗？

@gravity-ui/websql-autocomplete 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @gravity-ui/websql-autocomplete 的下载量有多少？

根据 npm 官方下载统计，@gravity-ui/websql-autocomplete 在 2026/10/17 – 2026/11/15 这 30 天内被下载 9,564 次，日均约 319 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gravity-ui/websql-autocomplete 还在维护吗？

最新版本 13\.16\.1 发布于 2026/11/03（13 天前）；至今共发布 57 个版本，其中过去 12 个月发布了 4 个；首次发布于 2024/03/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

