@gravity-ui/websql-autocomplete

中文文档
13.16.1发布于 2026/11/03Apache-2.0TypeScriptESM + CJS近 30 天下载 9564

A library that provides autocompletion and errors highlighting for various database dialects

原始使用文档

WebSQL autocomplete

ci_badge npm_package_version_badge last_commit_badge license_badge

A tool that provides autocompletion for various sql dialects.

Autocomplete theory

In order to parse any language, you need a lexer (tokenizer) and a parser (ast builder)

Resources to research:

How everything works

  1. ANTLR4 grammar and lexer for different {dialect} are defined in src/autocomplete/databases/{dialect}/grammar directories.
  2. Actual parsers and lexers for different {dialect} are generated into src/autocomplete/databases/{dialect}/generated directories.
  3. Dialect specific code, which is required for the core logic to work, is put in src/autocomplete/databases/{dialect}/{dialect}-autocomplete.ts files.
  4. The core logic is inside src/autocomplete/shared/autocomplete.ts file. It uses dialect specific helpers to generate autocomplete suggestions based on current cursor position.

How to add a new dialect

  1. Add new dialect files to src/autocomplete/databases/{$dialect}
  2. Add new dialect to the typesVersions, exports variables in package.json
  3. Add new dialect to the databases array in build.js

Main scripts

  • npm run generate - Generate parsers and lexers (Java has to be installed on your system for this to work)
  • npm run test - Run tests

版本与发布记录

@gravity-ui/websql-autocomplete 共发布 57 个版本,首次发布于 2024/03/11;过去 12 个月发布了 4 个版本。

版本发布日期距今
13.16.1latest2026/11/0313 天前
13.16.02026/08/073 个月前
13.15.12026/07/164 个月前
13.15.02026/05/205 个月前
13.14.02025/11/061 年前
13.13.02025/11/061 年前

关于 @gravity-ui/websql-autocomplete 的常见问题

@gravity-ui/websql-autocomplete 是什么?

A library that provides autocompletion and errors highlighting for various database dialects

如何安装 @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 和提交记录判断。