VSCode launch.json配置详细教程

  • Z时代
  • 2024-01-10
  • 分类：综合

vscode原文地址

以下为vscode 的node.js debugger 的 launch.json 配置详情:

启动配置必须设定请求类型，属性request ， 分为launch(启动) 和 attach(附加)两种 ,看下面例子：

{
 "version": "0.2.0",
 "configurations": [
  {
   ...
   "request": "launch", //请求类型为启动
  },
  {
  ...
   "request": "attach"， //请求类型为附加
  }
 ]
}

下面是launch 和 attach 类型共有的属性：

  • protocol 设置调试协议

  • auto 尝试自动检测目标运行时使用的协议

  • inspector 新的V8调试器协议，解决遗留版本的多数问题，node versions >= 6.3 and Electron versions >= 1.7.4.

  • legacy 原始的v8调试器协议，node versions < v8.0 and Electron versions < 1.7.4.

  • port调试使用的端口

  • address TCP/IP地址，用于远程调试

  • localRoot 远程调试时映射的本地地址

  • remoteRoot 远程调试时的远程目录地址

  • sourceMaps 默认为true

  • outFiles 当map文件不在js文件同目录时用于指定 sourceMaps的位置

  • restart 自动重启调试

  • timeout 配置自动附加的超时时间

  • stopOnEntry 自动断点到第一行代码处

  • smartStep 自动跳过未映射到源代码的代码

  • skipFiles :[]String,指定跳过单步调试的代码

 "skipFiles": [
 "${workspaceFolder}/node_modules/**/*.js", //跳过node_modules
 "${workspaceFolder}/lib/**/*.js",//跳过lib
 "<node_internals>/**/*.js"//跳过node核心模块
 ]

trace启用诊断输出

以下是特定于类型 launch(启动)的配置属性：

  • program 指定调试入口文件地址

  • args :[]String 传递给程序的参数,可在process.argv拿到

  • cwd 指定程序启动调试的目录 ,当vscode启动目录不是项目根目录，并且调试npm script时非常有用

  • runtimeExecutable 设置运行时可执行文件路径，默认是node

  • 可以是其他的执行程序，如npm、nodemon

  • runtimeArgs 传递给运行时可执行文件的参数,例如：

  {
   "type": "node",
   "request": "launch",
   "name": "npm launch app",
   "args":["a"],
   "runtimeExecutable": "npm",
   "runtimeArgs": [
    "run-script",
    "app",
    "b"
   ],
   "port": 6666
  }

打印参数可以发现 args 、runtimeArgs都会传给程序，但是runtimeArgs参数会紧跟可执行文件

  • runtimeVersion 设置运行时可执行程序的版本，如果使用nvm，可以切换node.js版本

  • env 添加额外的环境变量

  • envFile 文件加载环境变量

  • console 配置终端可以是外部终端或者内部集成终端，默认值internalConsole

  • outputCapture -如果设置为std，则进程stdout / stderr的输出将显示在调试控制台中，而不是侦听调试端口上的输出。这对于直接写入stdout / stderr流而不是使用console.*API的程序或日志库很有用。

  • autoAttachChildProcesses 跟踪调试对象的所有子过程，并自动附加到在调试模式下启动的子过程

以下是特定于类型 attach(附加)的配置属性：

  • processId 指定nodejs进程id,由于每次启动都会变，传入"${command:PickProcess}"

questions：

1. 如果使用了符号链接怎么调试？

传递参数:

{
 "runtimeArgs": ["--preserve-symlinks"]
}

如果主脚本也在符号链接路径里面，需要再传递一个参数"--preserve-symlinks-main"，支持的版本是 Node 10+.

2. 如何调试ECMAScript模块？

如果使用esm或传递--experimental-modules给Node.js以便使用ECMAScript模块，则可以传递这些选项通过runtimeArgs属性：

  • "runtimeArgs" : ["--experimental-modules"] -使用Node v8.5.0 +中的实验性ECMAScript模块支持

  • "runtimeArgs" : ["-r", "esm"] -使用esm ES模块加载器（请注意，["-r esm"]如果没有逗号，则无法使用）

总结

到此这篇关于VSCode launch.json配置详细教程的文章就介绍到这了,更多相关VSCode launch.json配置内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

以上是 VSCode launch.json配置详细教程 的全部内容， 来源链接： utcz.com/z/361264.html

回到顶部