VbsTools: VBScript for VS Code

English | 简体中文

IntelliSense that understands COM objects, a debugger, a cscript-compatible script host and a code library for VBScript (.vbs).

Windows only. Type information comes from the COM type libraries registered on your machine, and scripts run in the bundled script host. Syntax highlighting works everywhere.

IntelliSense for COM objects

• Set fso = CreateObject("Scripting.FileSystemObject") → fso. lists its members; chains (fso.GetFolder(p).Files.), For Each, With, default members, script classes, function return types
• ProgID completion inside CreateObject("…"), parameter info, hover, parameter name hints
• Applications that run VBScript inside them (no registered type library): type definition files *.vbstypes.json. Built in: WinCC V7/V8 — "vbscript.environments": ["WinCC"] or ' @environment WinCC gives HMIRuntime.Tags("x").Read, Item. in event procedures, …; your own files anywhere in the workspace are checked against a schema while you edit them (format: see the user guide)
• Type annotations where inference cannot know the type: ' @type f As Scripting.File, ' @param ws As Excel.Worksheet and ' @returns Scripting.Folder above a procedure
• Included scripts: Include "lib\common.vbs" (an ExecuteGlobal helper) or ' @include lib\common.vbs — their procedures, classes and globals complete and are not reported as undefined; F12 and Ctrl+click open them

Checks and navigation

• Syntax errors as you type (checked by vbscript.dll itself — the script is never run), Option Explicit warnings, calls to procedures that do not exist, wrong argument counts, unknown classes after New, unused variables; quick fixes (Ctrl+.) such as Declare 'x' with Dim
• Outline, go to definition (F12), find all references (Shift+F12), rename (F2) — including members of script classes used as obj.Member — call hierarchy (Shift+Alt+H), N references above procedures
• Semantic highlighting, Format Document (Shift+Alt+F) with optional keyword case normalization, folding by blocks and by '#Region Name … '#End Region

Run and debug

• Run Script (Ctrl+F5, Shift+F5 stops): output in the VBScript panel, errors in the Problems panel; scripts that read WScript.StdIn run in a terminal. Run / Debug with Arguments… (Ctrl+Shift+F5) remembers the arguments per script. The status bar switches x64 / x86.
• Debug with F5 (no launch.json needed): breakpoints with conditions, hit counts and logpoints; step over / into / out; pause (also inside WScript.Sleep); call stack; variables (double-click to change a value); watch; hover; Debug Console with completion. "Runtime errors" and "Handled errors (On Error Resume Next)" in the Breakpoints view.
• Scripts run in the bundled VbsTools Script Host, compatible with cscript (messages, exit codes, WScript object, COM events through WScript.CreateObject(progId, "prefix_") / WScript.ConnectObject), or in cscript itself (vbscript.run.host).

Code Library

The VbsTools icon in the activity bar opens the Code Library:

• Samples — VbsEdit's sample collection when VbsEdit is installed (or vbscript.library.samplesFile), otherwise the samples of VbsTools Studio. Preview, insert at the cursor, start a new script, copy to My Snippets.
• My Snippets — your snippets, each with a shortcut you type to insert it (checked against keywords and the other snippets). Edit a snippet in an editor and save with Ctrl+S; rename, move to a folder, delete. Add to My Snippets… in the editor context menu saves the selection. Shared with VbsTools Studio.

Built-in snippets (fso, dict, fe, xl, wmi, …) complete as usual.

Settings you may want

.vbs opens as "Visual Basic"?

VS Code's built-in Visual Basic support also claims .vbs. If the language mode shows "Visual Basic", add to your settings:

"files.associations": { "*.vbs": "vbscript" }

File encodings

cscript and wscript read a .vbs file as UTF-16 LE (with BOM) or in the system ANSI code page — never as UTF-8, which is what VS Code saves by default. So:

• ANSI scripts (GBK, Shift JIS, Windows-1252, …) that VS Code would show garbled are reopened with the system code page (vbscript.encoding.ansi to choose another)
• a script with Chinese, Japanese or accented text saved as UTF-8 runs correctly in VbsTools Script Host but prints garbled text in cscript / wscript: a warning offers Save as UTF-16 LE (runs everywhere) or Save as ANSI; VBScript: Save with Encoding… does the same at any time

Documentation

VBScript: Open Documentation in the Command Palette opens the user guide (English, 简体中文): getting started, editing, running, debugging, type definition files, Code Library, settings and FAQ.

Feedback

Issues and suggestions: github.com/ZachShen99/VbsTools/issues.

简体中文

English | 简体中文

VBScript（.vbs）开发工具：能理解 COM 对象的智能提示、调试器、兼容 cscript 的脚本宿主和代码库。

仅支持 Windows。 类型信息来自本机注册的 COM 类型库，脚本在插件自带的脚本宿主中运行。语法高亮在任何系统上都可用。

COM 对象的智能提示

• Set fso = CreateObject("Scripting.FileSystemObject") 之后输入 fso. 会列出它的成员；支持链式调用 （fso.GetFolder(p).Files.）、For Each、With、默认成员、脚本中的类、函数返回值
• CreateObject("…") 中的 ProgID 补全、参数提示、悬停说明、参数名提示
• 在软件内部运行的脚本（没有注册类型库）：用类型描述文件 *.vbstypes.json 描述对象。内置 WinCC V7/V8： 设置 "vbscript.environments": ["WinCC"] 或在脚本中写 ' @environment WinCC，即可补全 HMIRuntime.Tags("x").Read、 事件过程中的 Item. 等；工作区中自己编写的类型描述文件自动生效，编辑时按 Schema 校验
• 类型注释：推断不出类型时，用 ' @type f As Scripting.File，或在过程上方写 ' @param ws As Excel.Worksheet、 ' @returns Scripting.Folder
• Include 文件：Include "lib\common.vbs"（使用 ExecuteGlobal 的辅助过程）或 ' @include lib\common.vbs—— 其中的过程、类和全局变量可以补全，不会报告为未定义；F12 和 Ctrl+单击可以打开

检查和导航

• 边输入边检查语法错误（由 vbscript.dll 检查，脚本不会被执行）、Option Explicit 下未声明的变量、调用不存在的过程、 参数个数错误、New 后未定义的类、未使用的变量；快速修复（Ctrl+.），例如"用 Dim 声明 'x'"
• 大纲、转到定义（F12）、查找所有引用（Shift+F12）、重命名（F2，包括 obj.Member 形式的脚本类成员）、 调用层次结构（Shift+Alt+H）、过程上方的引用计数
• 语义高亮、格式化文档（Shift+Alt+F，可统一关键字大小写）、按代码块和 '#Region 名称 … '#End Region 折叠

运行和调试

• 运行脚本（Ctrl+F5，Shift+F5 停止）：输出在 "VBScript" 面板，错误在"问题"面板；读取 WScript.StdIn 的脚本 在终端中运行。带参数运行 / 调试（Ctrl+Shift+F5）按脚本记住参数。状态栏切换 x64 / x86。
• 调试按 F5（不需要 launch.json）：条件断点、命中次数、日志点；单步跳过 / 进入 / 跳出；暂停（包括 WScript.Sleep 中）；调用堆栈；变量（双击修改值）；监视；悬停；带补全的调试控制台。断点视图中可选 "运行时错误"和"已处理的错误（On Error Resume Next）"。
• 脚本在自带的 VbsTools 脚本宿主中运行，与 cscript 兼容（消息、退出码、WScript 对象、通过 WScript.CreateObject(progId, "prefix_") / WScript.ConnectObject 连接的 COM 事件），也可以改用 cscript （vbscript.run.host）。

代码库

点击活动栏中的 VbsTools 图标打开代码库：

• 示例：安装了 VbsEdit 时显示 VbsEdit 的示例集（或用 vbscript.library.samplesFile 指定），否则显示 VbsTools Studio 的示例。可以预览、插入到光标处、以此新建脚本、复制到我的代码片段。
• 我的代码片段：自己的代码片段，每个都有快捷键，在脚本中输入即可插入（会检查是否与关键字和其他片段冲突）。 在编辑器中修改并按 Ctrl+S 保存；可以重命名、移动到文件夹、删除。编辑器右键菜单中的"添加到我的代码片段…" 可以保存选中的代码。与 VbsTools Studio 共用。

内置代码片段（fso、dict、fe、xl、wmi 等）照常可用。

常用设置

.vbs 被识别为 "Visual Basic"？

VS Code 自带的 Visual Basic 支持也会认领 .vbs。语言模式显示 "Visual Basic" 时，在设置中加入：

"files.associations": { "*.vbs": "vbscript" }

文件编码

cscript 和 wscript 只能按带 BOM 的 UTF-16 LE 或系统 ANSI 代码页读取 .vbs 文件，不认识 VS Code 默认保存的 UTF-8。因此：

• VS Code 会显示成乱码的 ANSI 脚本（GBK、Shift JIS 等）会按系统代码页重新打开（用 vbscript.encoding.ansi 指定其他代码页）
• 含中文、日文等字符的 UTF-8 脚本在 VbsTools 宿主中运行正常，但在 cscript / wscript 中会乱码：警告处可以选择 "另存为 UTF-16 LE"（任何系统都能运行）或"另存为 ANSI"；随时也可以执行 VBScript: 以指定编码保存…

使用说明

在命令面板中执行 VBScript: 打开说明文档，可以查看完整的使用说明（中文 / English）：快速上手、编辑、运行、调试、 类型描述文件、代码库、设置和常见问题。

反馈

问题和建议：github.com/ZachShen99/VbsTools/issues。