WebStorm 2025.2 Help

内置 IDE 宏

WebStorm 提供多个内置 ,这些变量可用于为 外部工具运行配置 定义路径、选项及其他命令行参数。 支持宏的对话框字段旁会显示一个加号图标

添加 IDE 宏

宏的值取决于当前上下文。 例如,要插入包含当前文件的目录名称,请使用 $FileDirName$。 要插入该目录的完整路径,请使用 $FileDir$

描述

$WORKSPACE_DIR$

当前项目所属工作区的路径。 工作区是打开文件层级的根目录,且可以包含多个项目。

$PROJECT_DIR$

run.json 所在项目的根目录。 项目通常是用于开发和构建应用程序的一组文件,例如 Maven 或 Node.js 项目。

$USER_HOME$

用户主目录。

$FILE$

当前文件的绝对路径,包括扩展名。

$ClipboardContent$

系统剪贴板的当前内容。

$FileDir$

包含当前文件的目录的绝对路径。

$FileDirName$

包含当前文件的目录名称。

$FileDirPathFromParent(dir)$

相对于作为参数指定的父目录,当前文件所在目录的路径为 dir

Argument 1: /Users/jetbrains/myProjects/FileDirPathFromParent/ Argument 2: 1

$FileDirRelativeToSourcepath$

当前文件所在目录相对于 sourcepath 根目录的路径。

$FileEncoding$

当前文件的 编码

$FileExt$

当前文件的扩展名。

$FileName$

当前文件的名称(包括所有扩展名)。

$FileNameWithoutAllExtensions$

当前文件不带扩展名的名称。 当文件扩展名重复时,此选项非常有用。 它将移除所有点号及其后的内容。

例如,如果文件为 hello.txt.txt $FileNameWithoutAllExtensions$ 宏将返回 你好

$FileNameWithoutExtension$

文件不带扩展名的名称。 仅删除一个由点号和扩展名组成的部分。

例如,如果文件为 hello.txt.txt $FileNameWithoutExtension$ 宏将返回 hello.txt

$FileParentDir$

当前文件所在目录的父级目录名称。

$FilePath$

当前文件的绝对路径。

$FilePathRelativeToSourcepath$

当前文件相对于 sourcepath 根目录的路径。

$FilePrompt$

显示文件系统对话框以选择文件。

$LineNumber$

当前文件中插入符所处的行号。

$OSName$

以小写形式显示操作系统名称。

返回 System.getProperty("os.name") 的值,并截断到第一个空格字符。 因此,它不包含具体版本,只包含操作系统系列,如 windowsmaclinux

$Password$

显示指定密码的对话框。 类似于 $Prompt$ ,但输入内容为掩码形式。

可选择在冒号后添加提示文本,例如: $Password:API token$

$ProjectFileDir$

当前项目目录的绝对路径。

$ProjectName$

当前项目目录的名称。

$Projectpath$

当前项目的源路径。

$Prompt$

显示对话框以传递任意字符串。

可选择使用冒号分别添加提示文本和默认值,例如: $Prompt:Username:Alice$

$RemoteProjectFileDir$

远程服务器上项目目录的绝对路径。

$SelectedText$

编辑器中当前选中的文本。

$SelectionEndColumn$

选区结束位置所在的列号。

$SelectionEndLine$

选区结束位置所在的行号。

$SelectionStartColumn$

选区起始位置所在的列号。

$SelectionStartLine$

选区起始位置所在的行号。

$Sourcepath$

项目的完整 sourcepath。

$SourcepathEntry$

与当前文件相关的 sourcepath 条目。

$TempDir$

临时文件目录。

在 Windows 上,返回 %TEMP% 环境变量的值,如果未设置,则返回用户主目录下的 AppData\Local\Temp (由 System.getProperty("user.home") 返回)。

在其他操作系统中, $TempDir$ 返回 /tmp

$UnixSeparators(path)$

将路径作为参数,并将所有分隔符转换为正斜杠。

例如, $UnixSeparators(\foo\bar)$ 将返回 /foo/bar

项目外部资源路径

可以使用 路径变量 指向项目外部的资源。 添加已配置的路径变量方式与添加宏相同 —— 变量名称前后添加美元符号: $MY_VAR$

创建新的路径变量

  1. Ctrl+Alt+S 打开设置,然后选择 外观与行为 | 路径变量

  2. 点击 添加按钮 ,输入变量的名称和值,再点击 确定 以应用更改。

自定义宏

可通过使用 com.intellij.ide.macro.Macro 扩展点为插件定义自定义宏。 随后在 plugin.xml 中注册该宏:

<macro implementation="full.macro.class.Name"/>

有关可用扩展点的更多信息,请参阅 IntelliJ Platform 插件 SDK 文档

最后修改日期: 2025年 9月 26日