wgsl-analyzer：WGSL着色语言的强大助手

wgsl-analyzer是一款专为WGSL着色语言设计的语言服务器插件，旨在提升开发者的编程体验。通过集成到您的开发环境中，wgsl-analyzer能够为您提供以下核心功能：

• 语法高亮：让您的代码更加清晰易读。
• 基本自动补全：加速您的代码编写过程。
• 类型检查：确保代码的正确性和健壮性。
• 跳转定义：快速定位到变量和函数的定义位置。
• 基本格式化：保持代码的整洁和一致性。

如果您有任何建议或发现bug，欢迎在我们的GitHub页面提出问题：https://github.com/wgsl-analyzer/wgsl-analyzer/issues。

配置指南

在您的vscode设置中，可以通过wgsl-analyzer部分进行以下配置：

自定义服务器路径

{
  "wgsl-analyzer.server.path": "~/.cargo/bin/wgsl-analyzer"
}

自定义导入

wgsl-analyzer支持类似于Bevy Engine的着色器预处理器的#import指令。您可以在wgsl-analyzer.customImports部分定义自定义导入片段。

如果您提供的URL包含http、https或file协议，该资源将被下载并使用。请注意，这会延长LSP的启动时间，如果您注意到显著的延迟（扩展程序会在启动超过一秒时发出警告），请考虑将网络资源替换为文件URL或内联文本。

{
  "wgsl-analyzer.customImports": {
    "bevy_pbr::mesh_bindings": "https://raw.githubusercontent.com/bevyengine/bevy/refs/tags/v0.15.2/crates/bevy_pbr/src/render/mesh_bindings.wgsl",
    "bevy_pbr::mesh_functions": "https://raw.githubusercontent.com/bevyengine/bevy/refs/tags/v0.15.2/crates/bevy_pbr/src/render/mesh_functions.wgsl"
  }
}

对于Bevy版本0.15.2的导入列表如下：

通过以下命令生成：

rg define_import_path -g '*.wgsl' --sort path | sd '^([^:]*):#define_import_path (.*)' ' "$2": "https://raw.githubusercontent.com/bevyengine/bevy/refs/tags/v0.15.2/$1",' >> ~/source/wgsl-analyzer/output.txt

在Bevy文件夹内执行。

{
  "wgsl-analyzer.customImports": {
    "bevy_core_pipeline::fullscreen_vertex_shader": "https://raw.githubusercontent.com/bevyengine/bevy/refs/tags/v0.15.2/crates/bevy_core_pipeline/src/fullscreen_vertex_shader/fullscreen.wgsl",
    "bevy_core_pipeline::oit": "https://raw.githubusercontent.com/bevyengine/bevy/refs/tags/v0.15.2/crates/bevy_core_pipeline/src/oit/oit_draw.wgsl",
    "bevy_core_pipeline::post_processing::chromatic_aberration": "https://raw.githubusercontent.com/bevyengine/bevy/refs/tags/v0.15.2/crates/bevy_core_pipeline/src/post_process/chromatic_aberration.wgsl",
    // ...（省略其他导入项）
    "bevy_ui::ui_vertex_output": "https://raw.githubusercontent.com/bevyengine/bevy/refs/tags/v0.15.2/crates/bevy_ui/src/render/ui_vertex_output.wgsl"
  }
}

为了更快的启动速度，您可以使用文件URL：

{
  "wgsl-analyzer.customImports": {
    "bevy_core_pipeline::fullscreen_vertex_shader": "file:///path/to/your/local/bevy/clone/crates/bevy_core_pipeline/src/fullscreen_vertex_shader/fullscreen.wgsl",
    "bevy_core_pipeline::oit": "file:///path/to/your/local/bevy/clone/crates/bevy_core_pipeline/src/oit/oit_draw.wgsl",
    "bevy_core_pipeline::post_processing::chromatic_aberration": "file:///path/to/your/local/bevy/clone/crates/bevy_core_pipeline/src/post_process/chromatic_aberration.wgsl",
    // ...（省略其他导入项）
    "bevy_ui::ui_vertex_output": "file:///path/to/your/local/bevy/clone/crates/bevy_ui/src/render/ui_vertex_output.wgsl"
  }
}

预处理器定义

wgsl-analyzer支持类似于Bevy Engine的着色器预处理器的#ifdef、#ifndef、#else、#endif指令。

{
  "wgsl-analyzer.preprocessor.shaderDefs": ["VERTEX_TANGENTS"]
}

诊断

wgsl-analyzer支持解析错误的诊断，并可选择性地（默认启用）支持类型错误和naga报告的验证错误。您还可以启用对naga解析错误的诊断。

{
  "wgsl-analyzer.diagnostics.typeErrors": true,
  "wgsl-analyzer.diagnostics.nagaParsing": false,
  "wgsl-analyzer.diagnostics.nagaValidation": true,
  "wgsl-analyzer.diagnostics.nagaVersion": "0.22" // 支持的版本之一或'main'
}

内联提示

wgsl-analyzer可以显示只读的虚拟文本片段，穿插在代码中，用于显示变量声明推断的类型或在调用点显示函数参数的名称。

{
  "wgsl-analyzer.inlayHints.enabled": true,
  "wgsl-analyzer.inlayHints.typeHints": true,
  "wgsl-analyzer.inlayHints.parameterHints": true,
  "wgsl-analyzer.inlayHints.structLayoutHints": false,
  "wgsl-analyzer.inlayHints.typeVerbosity": "compact"
}

typeVerbosity参数可以是full、compact或inner，分别对应于：

var x: ref = 0.0;
var x: ref = 0.0;
var x: f32 = 0.0;

更多信息，请参考WGSL规范中的“Load Rule”。

通过wgsl-analyzer，您可以更高效地编写和优化WGSL着色语言代码，提升开发效率。