AutoHotkey v2 Language Support

中文版 README往下翻页

repositories:

Github

Gitee

AutoHotkey v2 Language support for VS Code, features realization based on v2 syntax analysis. Supports running on the Web, such as Chrome/Edge. https://vscode.dev or https://github.dev/github/dev

• Use in other editors
  • Vim and Neovim
  • Sublime Text4
• Use in Web browser
• Language Features
  • Rename Symbol
  • Diagnostics
  • IntelliSense
  • Signature
  • Document Symbol
  • Semantic Highlight
  • Tags
  • Document Color
  • Hover
  • Goto Definition
  • Find All References
  • CodeFormat
  • Custom folding
• Context Menu
  • Quick Help
  • Run Script
  • Run Selected Script
  • Compile Script
  • Debug Script
  • Generate Comment

Language Features

Rename Symbol

Rename variables and function names in the scope in batches.

Diagnostics

Simple syntax error diagnosis.

IntelliSense

Supports intelligent completion of variables, functions, parameters, class names, and method names within the scope (by simple type deduction), and supports the completion of include files and function libraries.

Signature

Support for intelligent prompts for function parameters.

Document Symbol

1. Displays class, method, function, variable, label, hotkey, hot string, block information in the left outline column.
2. press Ctrl + P, Input @symbol_name to retrieve and jump
3. You can comment a method with a semicolon or /* */ on the top line of a function, variable. Jsdoc-style annotations can mark variable types.

/**
 * @param {Array} a - a param
 * @return {Integer}
 */
fn(a*) {
  /** @type {Map} */
  d := Map()
  /**
   * @var {Map} e
   * @var {Object} f
   */
  e := Map(), f := {}
  /** @type {(a,b)=>Integer} */
  cb := (a, b) => a + b
  /** @type {ComObject<Excel.Sheet.12,Workbook>} */
  wb := ComObject('Excel.Sheet.12')
  return a[1] + a[2]
}
class abc {
  /** @prop {Map} p */
  p := dosomethingandreturnmap()
}

Semantic Highlight

Semantic highlighting is an addition to syntax highlighting, resolves symbols in the context of a project. The editor applies the highlighting from semantic tokens on top of the highlighting from grammars.

Tags

usage: Add ;;(default) or ; TODO to the comment code Tags.

Document Color

Compute and resolve colors inside a document to provide color picker in editor.

Hover

Supports hover prompts and comments for scoped variables, functions, global classes, and labels.
usage: Move the mouse over the symbol.

Goto Definition

1. Support for jumping to the declaration location of scoped variables, functions, global classes, and labels.
2. usage: Press ctrl Then move the mouse over to the code and click.

Find All References

See all the source code locations where a certain variable/function is being used.

CodeFormat

usage:

• Right-click the popup menu and click "Format document".
• Press Shift+Alt+F.
• Supports formatting code blocks when typing'}', formatting lines and indenting lines when typing'\ n'. (editor.formatOnType needs to be enabled)

Custom folding

Fold the part between ;#region tag and ;#endregion, ;{ and ;}

;#region tag
code
;#endregion

Context Menu

Quick Help

Open the help file and navigate to the keyword at the current cursor.

Run Script

Run the currently open script.

Run Selected Script

Run the code snippet at the cursor selection.

Compile Script

Compile the script to generate executable EXE files.

Debug Script

No additional configuration is required to start the installed Debug extensions, and support debugging with parameters.

Generate Comment

Generate JSDOC-style comments for a function or method.

Use in Web Browser

visit https://github.dev or https://vscode.dev in Chrome/Edge, and install thqby.vscode-autohotkey2-lsp

Use in other editors

1. Install Node.js.
2. Download vscode-autohotkey2-lsp server using command line, or download and unpack through vscode marketplace.

mkdir vscode-autohotkey2-lsp
cd vscode-autohotkey2-lsp
curl -L -o install.js https://raw.githubusercontent.com/thqby/vscode-autohotkey2-lsp/main/tools/install.js
node install.js

3. Set the LSP configuration of the editor that support LSP(Language Server Protocol), such as Sublime Text4, Vim, Neovim, Emacs, etc.

Sublime Text4

• Package Control: Install Package, and install Sublime LSP plug-in.
• Preferences: LSP Settings, add lsp configuration, language selector, and syntax highlighting. This is a simple example syntax highlighting, save the file in a similar path C:\Users\<USERNAME>\AppData\Roaming\Sublime Text\Packages\User\LSP-ahk2\AutoHotkey2.sublime-syntax.

{
	"clients": {
		"lsp-ahk2": {
			"enabled": true,
			"command": [
				"node",
				"<VSCODE-AUTOHOTKEY2-LSP>/server/dist/server.js",
				"--stdio"
			], // Update the path of node.exe(maybe it's already in PATH, so you don't need to set it) and the folder of vscode-autohotkey2-lsp
			"selector": "source.ahk2",	// Same as scope in AutoHotkey2.sublime-syntax
			"schemes": ["file", "buffer", "res"],
			"initializationOptions": {
				"locale": "en-us", // or "zh-cn"
				"AutoLibInclude": "Disabled", // or "Local" or "User and Standard" or "All"
				"CommentTags": "^;;\\s*(?<tag>.+)",
				"CompleteFunctionParens": false,
				"Diagnostics": {
					"ClassStaticMemberCheck": true,
					"ParamsCheck": true
				},
				"ActionWhenV1IsDetected": "Continue",
				"FormatOptions": {
					"break_chained_methods": false,
					"ignore_comment": false,
					"indent_string": "\t",
					"keep_array_indentation": true,
					"max_preserve_newlines": 2,
					"brace_style": "One True Brace", // or "Allman" or "One True Brace Variant"
					"preserve_newlines": true,
					"space_after_double_colon": true,
					"space_before_conditional": true,
					"space_in_empty_paren": false,
					"space_in_other": true,
					"space_in_paren": false,
					"wrap_line_length": 0
				},
				"InterpreterPath": "C:/Program Files/AutoHotkey/v2/AutoHotkey.exe",
				"WorkingDirs": [],
				"SymbolFoldingFromOpenBrace": false
			}
		}
	},
	"semantic_highlighting": true
}

Vim and Neovim

• Download coc.nvim plugin or nvim-lspconfig.

cd $VIMRUNTIME\plugin
git clone --branch release https://github.com/neoclide/coc.nvim.git --depth=1

• Open (n)vim and enter the command :CocConfig to enter the coc.nvim configuration file to add configuration information.

{
	"languageserver": {
		"lsp-ahk2": {
			"module": "<VSCODE-AUTOHOTKEY2-LSP>/server/dist/server.js",
			"filetypes": ["autohotkey"],
			"args": ["--node-ipc"],
			"initializationOptions": {
				// Same as initializationOptions for Sublime Text4
			}
		}
	}
}

AutoHotkey v2语言支持

AutoHotkey v2 语言支持 for VS Code, 功能实现基于v2语法分析。 支持在Chrome/Edge等浏览器中使用 https://vscode.dev 或 https://github.dev/github/dev

• 在其他编辑器中使用
  • Vim和Neovim
  • Sublime Text 4
• 在Web浏览器中使用
• 语言特性
  • 重命名符号
  • 错误诊断
  • 智能感知
  • 智能提示
  • 大纲
  • 语义高亮
  • 代码标记
  • 颜色提示
  • 悬停提示
  • 转到定义
  • 查找所有引用
  • 代码格式化
  • 自定义折叠
• 上下文菜单
  • 快捷帮助
  • 运行脚本
  • 运行选定的脚本
  • 编译脚本
  • 调试脚本
  • 生成注释

语言特性

重命名符号

作用域范围内的变量、函数名批量重命名。

错误诊断

简单语法错误诊断。

智能感知

支持对作用域范围内的变量、函数、参数、类名、方法名智能补全(简单的类型推导)，支持对include文件和函数库补全。

智能提示

支持对函数、方法参数的智能提示。

大纲

1. 在左侧大纲栏目显示类、方法、函数、变量、标签、热键、热字串、区块信息
2. 按Ctrl + P, 输入@符号名检索并跳转
3. 您可以在函数、变量的上一行使用分号或/* */向方法添加注释, jsdoc样式的注释可以标记变量类型

/**
 * @param {Array} a - a param
 * @return {Integer}
 */
fn(a*) {
  /** @type {Map} */
  d := Map()
  /**
   * @var {Map} e
   * @var {Object} f
   */
  e := Map(), f := {}
  /** @type {(a,b)=>Integer} */
  cb := (a, b) => a + b
  /** @type {ComObject<Excel.Sheet.12,Workbook>} */
  wb := ComObject('Excel.Sheet.12')
  return a[1] + a[2]
}
class abc {
  /** @prop {Map} p */
  p := dosomethingandreturnmap()
}

语义高亮

语义高亮显示是语法高亮显示的补充，改进和改进语法中的语法突出显示。编辑器在来自语法的高亮显示之上应用来自语义标记的高亮显示。

代码标记

用法: 在注释代码块中添加;;(默认)或; TODO

颜色提示

计算并解析文档中的颜色，并提供颜色选择器更直观地修改颜色数据。

悬停提示

支持对作用域范围内变量、函数、全局类、标签的悬停提示并显示相关备注。
用法: 移动鼠标到相关符号上。

转到定义

1. 支持跳转到作用域范围内变量、函数、全局类、标签的声明位置。
2. 用法: 按住 ctrl 然后移动鼠标到代码处点击。

查找所有引用

查看正在使用某个变量/函数的所有源代码位置。

代码格式化

用法:

• 右键弹出菜单然后点击 格式化文档。
• 或按 Shift+Alt+F。
• 支持在键入}时格式化代码块，在代码行结束处键入\n时格式化行并缩进。支持在代码区(非注释、字符串)输入中文标点时替换为英文标点。 (需要开启editor.format OnType)

自定义折叠

折叠;#region tag和;#endregion之间部分, ;{和;}之间部分

;#region tag
code
;#endregion

上下文菜单

快速帮助

打开帮助文件并导航到当前光标处的关键字。

运行脚本

运行当前打开的脚本。

运行选定的脚本

运行光标选择范围的代码片段。

编译脚本

编译脚本生成可执行的 EXE 文件。

调试脚本

无需额外配置即可启动已安装的调试扩展，支持带参数调试。

生成注释

为函数或方法生成 JSDOC 样式的注释文档。

在其他编辑器中使用

1. 安装Node.js。
2. 用命令行下载vscode-autohotkey2-lsp服务端, 或通过vscode marketplace下载并解包。

mkdir vscode-autohotkey2-lsp
cd vscode-autohotkey2-lsp
curl -L -o install.js https://raw.githubusercontent.com/thqby/vscode-autohotkey2-lsp/main/tools/install.js
node install.js

3. 设置支持LSP(语言服务器协议)的编辑器的LSP配置, 例如Sublime Text4, Vim, Neovim, Emacs, 等。

Sublime Text 4

• Package Control: Install Package, 安装Sublime LSP插件
• Preferences: LSP Settings, 增加lsp配置、语言选择器和语法高亮. 这是一个简单的语法高亮示例, 存放在类似路径下 C:\Users\<USERNAME>\AppData\Roaming\Sublime Text\Packages\User\LSP-ahk2\AutoHotkey2.sublime-syntax

{
	"clients": {
		"lsp-ahk2": {
			"enabled": true,
			"command": [
				"node",
				"<VSCODE-AUTOHOTKEY2-LSP>/server/dist/server.js",
				"--stdio"
			], // 更新node.exe的路径(可能已经在环境变量中，所以你不需要设置)和vscode-autohotkey2-lsp的文件夹
			"selector": "source.ahk2", // 与AutoHotkey2.sublime-syntax中的scope相同
			"schemes": ["file", "buffer", "res"],
			"initializationOptions": {
				"locale": "en-us", // or "zh-cn"
				"AutoLibInclude": "Disabled", // or "Local" or "User and Standard" or "All"
				"CommentTags": "^;;\\s*(?<tag>.+)",
				"CompleteFunctionParens": false,
				"Diagnostics": {
					"ClassStaticMemberCheck": true,
					"ParamsCheck": true
				},
				"ActionWhenV1IsDetected": "Continue",
				"FormatOptions": {
					"break_chained_methods": false,
					"ignore_comment": false,
					"indent_string": "\t",
					"keep_array_indentation": true,
					"max_preserve_newlines": 2,
					"brace_style": "One True Brace", // or "Allman" or "One True Brace Variant"
					"preserve_newlines": true,
					"space_after_double_colon": true,
					"space_before_conditional": true,
					"space_in_empty_paren": false,
					"space_in_other": true,
					"space_in_paren": false,
					"wrap_line_length": 0
				},
				"InterpreterPath": "C:/Program Files/AutoHotkey/v2/AutoHotkey.exe",
				"WorkingDirs": [],
				"SymbolFoldingFromOpenBrace": false
			}
		}
	},
	"semantic_highlighting": true
}

Vim和Neovim

• 下载coc.nvim插件或nvim-lspconfig。

cd $VIMRUNTIME\plugin
git clone --branch release https://github.com/neoclide/coc.nvim.git --depth=1

• 打开(n)vim, 输入命令 :CocConfig 进入coc.nvim配置文件增加配置信息。

{
	"languageserver": {
		"lsp-ahk2": {
			"module": "<VSCODE-AUTOHOTKEY2-LSP>/server/dist/server.js",
			"filetypes": ["autohotkey"],
			"args": ["--node-ipc"],
			"initializationOptions": {
				// Same as initializationOptions for Sublime Text4
			}
		}
	}
}

在Web浏览器中使用

在Chrome/Edge中打开 https://github.dev 或 https://vscode.dev, 然后安装thqby.vscode-autohotkey2-lsp。