@genesiscommunitysuccess/custom-elements-lsp

中文文档
5.0.3发布于 2024/02/14MITTypeScriptCommonJS近 30 天下载 3587

启用自定义元素标记模板中的 Intellisense 的脚本插件

中文使用文档
文档目录12 节
  1. 快速启动示例
  2. 演示文稿
  3. 插件设置和使用
  4. 示例配置
  5. FAST 语法
  6. 虚拟系统
  7. 纳米比亚
  8. 喷气管
  9. 高级使用
  10. 解决问题
  11. 捐款
  12. 许可证

这个 创世纪全球 社区成功倡议致力于开放资源选择技术,我们认为开放资源社区将从中受益.

NPM version License

自定义元素 LSP 插件

在您的工程中安装此 TypeScript 插件, 用 IntelliSense 处理增强您的 LSP 启用编辑器 网络组件自定义元素包括自动补全、对角和跳到定义.

编辑器完成情况诊断快速信息资讯
虚拟系统: 白色 检查 标记 :: 白色 检查 标记 :: 白色 检查 标记 :需要配置以使用本地 tsserver 实例 . 设置
维姆/尼奥维姆: 白色 检查 标记 :: 白色 检查 标记 :: 白色 检查 标记 :需要配置为TypeScript的LSP客户端. 设置
JetBrains (IntelliJ/Webstorm/etc.) (英语): havy minus 签名 :: 白色 检查 标记 :: x :JetBrains 接口 目前 仅作为LSP客户端获得部分支持. 设置

任何编辑器/IDE 配置为 LSP 客户端, 使用此插件安装到的 tsserver 实例 应 兼容.

快速启动示例

在您的项目中添加LSP需要不到5分钟. 跟着我们 设置行走视频试试我们的预设 示例项目,并看到 更改集 在示例项目中,需要启用LSP.

演示文稿

Custom Element Completion
显示更多实例
Attribute Completion Diagnostics Jump to Definition

还提供了快视信息,以及标准HTML元素的IntelliSense. 如前所述,您可以使用任何LSP所启用的编辑器,例如有LSP插件的Vim/NeoVim.

Custom Element in NeoVim
显示更多实例
Element IntelliSense in NeoVim Another Example

还有一个 辅助插件 用于在与 快速。 。 。 .

Example of custom element completion with property bindings and quicklook using FAST

跟着读取器 链接插件 如果需要,也可以设置.

插件设置和使用

这些指示是用于在您的应用程序中设置 LSP 。 如果你想建立 LSP 测试或贡献它,那么去 本节。 。 。 . 要使用此插件, 您有版本的打字符作为工程的一部分, 位于 node_modules。 。 。 .

  1. 在目标项目中安装此软件包作为 dev 依赖 .
npm i @genesiscommunitysuccess/custom-elements-lsp --save-dev
  1. 配置该插件 tsconfig.json。下面是示例形状,详细解释见下文.
{
  "compilerOptions": {
    "plugins": [
      {
        "name": "@genesiscommunitysuccess/custom-elements-lsp",
        "srcRouteFromTSServer": "configure this to set the relative path between your project route and your `tsserver.js`",
        "designSystemPrefix": "configure this to handle a library of components with a prefix",
        "parser": {
          "timeout": 2000,
          "src": "configure this to define the source code to parse",
          "dependencies": [
            "configure these globs to find manifest files from your dependencies",
            "and use the ! pattern to ignore manifests"
          ]
        },
        "plugins": ["set plugins here!"]
      }
    ]
  }
}

见 这里 举个例子.

  1. 你需要使用目标 ES2015 或后来在你的 tsconfig.json。 。 。 .

基础选项.

选项可选和默认解释
name虚假需要设置为 @genesiscommunitysuccess/custom-elements-lsp 以启用此插件.
srcRootFromTSServer真实( T)"../../../"(中文(简体) )srcRouteFromTSServer 是从 tsserver.js 可在您的节点模块中执行,可与您的目录一起执行 package.json 项目网根所在位置。 这很可能是 node_modules/typescript/lib/tsserver.js 因此我们使用 ../../..。 。 。 . 警报: 如果您使用带有工作空间的单列图案, 您必须说明 TypeScript 库在 node_modules 到父目录.
designSystemPrefix对 (不详)曾经与 %%prefix%% 处理作为设计系统一部分登记的组件。 见 这里。 。 。 .
plugins真实( T)[](中文(简体) )在 CEP 中可以添加一组可选插件,以加强其功能. 应用指定的插件顺序.

解析器选项 。 这些控制了源代码的分析,以理解自定义元素是否具有属性等语义. 这并不是控制LSP在模板中与html合作,以了解是否存在诊断问题,或是帮助完成建议.

选项可选和默认解释
src真实( T)"src/**/*.{js,ts}"(中文(简体) )当前工程中源文件的 glob 分析活性 .
timeout真实(2000年)运行源文件分析器之间的时间(以毫秒计) 。 LSP越低的时间越能适应源代码的变化,但使用的资源就越多.
dependencies真实( T)[](中文(简体) )找到一串花纹 custom-elements.json 从库依赖性到LSP使用。 图书馆将运出分析员无法解析的制作代码,因此图书馆需要运出生成的表 从分析器。一个可以用来加载所有文件的默认实例是 ["node_modules/**/custom-elements.json","!**/@custom-elements-manifest/**/*"] 它会在你的依赖性中找到所有表, 但忽略了来自麻醉剂依赖性的测试表.
fastEnable真( 残疾)启用 Microsoft FAST 本地组件解析 。 您需要启用该插件以完整功能

只有 src 文件被监视用于修改以更新分析器,如果您更新包含显示文件的依赖性,则您必须重新启动LSP,以便它意识到这些变化.

警报: 如果您使用带有工作空间的单列图案, 您必须说明 TypeScript 库在 node_modules 到父目录。 路径 src 财务报告和审定财务报表 dependencies 将相对于从打字符安装位置和 srcRouteFromTSServer 配置选项 .

示例配置

{
  "compilerOptions": {
    "plugins": [
      {
        "name": "@genesiscommunitysuccess/custom-elements-lsp",
        "srcRouteFromTSServer": "../../..",
        "designSystemPrefix": "example",
        "parser": {
          "fastEnable": true,
          "timeout": 2000,
          "dependencies": [
            "node_modules/example-lib/**/custom-elements.json",
            "!**/@custom-elements-manifest/**/*"
          ]
        },
        "plugins": ["@genesiscommunitysuccess/cep-fast-plugin"]
      }
    ]
  }
}

上述配置将设定如下:

  • 启用插件 .
  • 设定 example 作为设计系统,所以任何像那样的组件前缀都将是图案 example-X,例如 example-button。 。 。 .
  • 设置 FAST 插件 通过启用语法解析,以及插件本身在 plugins 阵列.
  • 使用源代码解析的默认路径, 查找所有显示 example-lib 依赖,而忽略从 @custom-elements-manifest 目录.

FAST 语法

目前支持增强 FAST 交接( 语法如 @event 模板定义)。 为此,您需要执行以下步骤:

  1. 通过设置 "fastEnable": true 解析选项 tsconfig.json。 。 。 .
  2. 安装 @genesiscommunitysuccess/cep-fast-plugin 用于您的软件包管理器项目 .
  3. 在您的第2步中添加软件包 plugins 在您主配置块中的阵列 tsconfig.json。请参看页上的例子.

虚拟系统

您只需要设置 VSCode 来使用您的本地打字符安装, 因为默认它会尝试使用它捆绑的打字符版本 .

  1. 创建目录 .vscode 在单体的根部。 内部创建一个名为 settings.json。然后填入以下内容:
{
  "typescript.tsdk": "node_modules/typescript/lib"
}

您可以在这个寄存器中看到一个实例 - ./example/.vscode/settings.json。 。 。 .

如果您已经拥有了该文件和目录, 因为您已经创建了自己的工程配置, 那么您可以简单地从 json 块将密钥/ 值对添加到您现有的配置 .

高级: 如果 npm 已挂起您的打字符安装, 请确保您为此配置的路径账户( 确保 typescript.tdsk 指向 lib 项目打字符安装目录).

  1. 在 monrepo 的根目录上启动 VSCode( 因此在文件夹结构中您将拥有) .vscode 目录来自根部的第1步)。 您可以通过 GUI 进行此操作, 或者在您的路径上安装 VSCode 您可以导航到根并运行 code .。 。 。 .

  2. 确保打开打字符文件,打开命令调色板(Ctrl/Cmd + Shift + P)并搜索 TypeScript: Select Typescript Version...

如果你看不到这个选项 那就确保你有一个 .ts 文件打开.

  1. 选择工作空间版本, 它应该有与第 1 步值设置的路径相匹配的路径 .

如果你没有看到这个选项,那么确保您已经打开了 VSCode 的项目 .vscode 目录来自根部的第1步.

  1. 就是这样! 请注意,在LSP装入后,你不会看到任何诊断信息,直到你交互并更改文件.

纳米比亚

如果您有 LSP 的打字机设置, 请使用工程的 TypeScript 直接工作 。 有许多不同的方式可以将NeoVim/Vim配置为LSP客户端,这种配置超出了这些指令的范围.

喷气管

本节涵盖所有JetBrainsIDE,如WebStorm和IntelliJ. 现 临时选举委员会只得到部分支持.

  • 全面诊断支持.
  • 部分完成支助,由IDE本身提供 没有 使用 CEP - 但因插件中所使用的显示文件而增强.
  • 不支持快视/快视, 因为 JetBrains 运行此关闭源头而不使用 tsserver 在它们的IDE中.

用你的JetBrains IDE中的LSP来操作.

  1. 以单列波根为项目启动 IDE.
  2. 从设置中打开首选项.
  3. 导航到 Typescript 设置 Languages & Frameworks 设置,并确保将打字符选项设置到 node_modules/typescript 您的电话 当地 工程,如图像所示。 这可能已经是默认了,在这种情况下你不需要做任何事情。 您还想要启用以下图像中启用的三个选项 .
  4. 就是这样! 请注意,在LSP装入后,你不会看到任何诊断信息,直到你交互并更改文件.

请注意菜单的位置和外观可能因IDEs和版本不同而不同.

高级使用

designSystemPrefix 用于指定如何处理定义但导出为元素注册函数的自定义元素,然后在具有特定前缀的设计系统上注册。 这方面的一个例子是: FAST 组件库。用魔法字符串导出这些 %%prefix%%- 在标签名称的开头, 然后 designSystemPrefix 将覆盖 %%prefix%%。 。 。 .

在这个寄存器的配置中,它设定为 example 因为我们使用 example 前缀按设置在 ./example/src/components.ts中的组件 ./example/src/components/button/ 目录.

解决问题

分析脚本

如果LSP的结果不是您所期望的(如不正确或缺失的信息),那么可能是因为源和依赖路径存在问题,而插件无法正确找到文件来解析.

您可以通过运行带有此插件的可执行脚本来生成该插件正在使用的显示文件的副本 custom-elements-analyze 命令.

  1. 在您中设置 npm 脚本 package.json 以执行命令。 例如:
{
  "scripts": {
    "lsp:analyze": "custom-elements-analyze --tsconfig=./src/tsconfig.json",
  },
}

脚本目前采用可选参数 :

  • --tsconfig - 要使用的 tsconfig.json 文件的路径 。 默认为 process.cwd()。 。 。 .
  • --fastEnable 从插件配置设置.

这个 package.json 文件系统中需要相同的位置 srcRouteFromTSServer 相对路径让你,如 设置区域。 。 。 .

  1. 运行您刚刚创建的 npm 脚本 npm run lsp:analyze。 。 。 .
  2. 检查 ce.json 以了解哪些组成部分有问题,或从清单中缺失.
  3. 如果有什么问题,你就可以改变光彩模式,从第1步重复到快乐.
  4. 一旦从脚本中收到正确的输出,您就可以更新您的 tsconfig.json 以在 LSP 插件中修复问题.
分析器脚本外加

如果您还在遇到问题, 您可以花时间核实调试解析器脚本是否正在获得与 CEP 本身相同的视图 .

  1. 填写 Setup Logging 区域 捐款 文档.
  2. 在您的 IDE 中运行 CEP 并检查日志, 以查找大致看起来像的行 Info 32 [14:43:25.686] [CE] Analyzing and updating manifest. Config: ...
  3. 运行分析脚本, 并看到相同的行像 [log] Analyzing and updating manifest. Config: ...
  4. 核实他们是一样的。 如果没有的话, 您的插件设置可能会出问题 .

捐款

感谢您有兴趣为自定义元素插件投稿 。 参见提交文件的准则(A/CN.9/WG.III/WP.III/WP.1和Corr.1)CONTRIBUTING.md)取于一心之根.

许可证

见 这里。 。 。 .

版本与发布记录

@genesiscommunitysuccess/custom-elements-lsp 共发布 26 个版本,首次发布于 2023/08/04;过去 12 个月发布了 0 个版本。

版本发布日期距今
5.0.3latest2024/02/142 年前
5.0.22023/12/202 年前
5.0.12023/12/202 年前
5.0.02023/12/132 年前
4.1.32023/12/122 年前
4.1.22023/12/122 年前

其他发布通道:prerelease → 2.1.1-prerelease.2。

关于 @genesiscommunitysuccess/custom-elements-lsp 的常见问题

@genesiscommunitysuccess/custom-elements-lsp 是什么?

启用自定义元素标记模板中的 Intellisense 的脚本插件

如何安装 @genesiscommunitysuccess/custom-elements-lsp?

在项目目录运行 npm install @genesiscommunitysuccess/custom-elements-lsp,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 custom-elements-analyze,可以用 npx custom-elements-analyze 直接运行。

@genesiscommunitysuccess/custom-elements-lsp 支持 TypeScript 吗?

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

@genesiscommunitysuccess/custom-elements-lsp 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@genesiscommunitysuccess/custom-elements-lsp 可以商用吗?

@genesiscommunitysuccess/custom-elements-lsp 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@genesiscommunitysuccess/custom-elements-lsp 的下载量有多少?

根据 npm 官方下载统计,@genesiscommunitysuccess/custom-elements-lsp 在 2026/10/16 – 2026/11/14 这 30 天内被下载 3,587 次,日均约 120 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@genesiscommunitysuccess/custom-elements-lsp 还在维护吗?

最新版本 5.0.3 发布于 2024/02/14(2 年前);至今共发布 26 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/08/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。