从零手写VSCODE 配置文件

VSCODE 配置文件书写详解一.task.json决定文件怎么编译,本质就是在指定的type下不断重复执行command和args构成的命令1.基本框架{version:2.0.0,//固定版本号tasks:[//任务数组,可以定义多个任务{//任务一},{//任务二}],inputs:[//可选,也就是可以不写这个,本文档暂时不涉及,这用于定义在任务中使用的输入变量{/*输入定义*/}]}task参数详解重要字段标黄的字段为必填选项label:任务的显示名称type:有两种类型,一种是shell,一种是nmp,(执行的任务类型,一般写shell,就是任务在shell中执行)​ “shell”:通过系统的shell 执行命令,cmd/powershell/bash/zsh​ “nmp”:专用于nmp脚本,此时command也不需要了,只需要scriptcommand:要执行的程序的名字(或路径),一般来说就是python,gcc,nmp,echo啥的args:传递给command的参数,注意输入时必须使用数组输入,而不要输入字符串eg. “args”:[…]​ 记得 command和args 是不可分离的,一个是可执行文件,另一个是传递参数​常见命令commandargs1.系统本身命令eg.输出文本echo[“hello”]创建目录mkdir[“dist”]删除文件del[“-rf”,“dist”]复制文件cp[“src/main.js”,“dist/”]改变目录,定位文件cd一般不单独在这里使用这个命令移动文件mv[“old.txt”, “new.txt”]列出目录ls/dir[“-l”]commandargs2.编译命令pythonpython/python3[“scripts.py”,“–vervbose”]Cgcc/g[“main.c”,“-o”,“main”]clangClang 编译器[test.c, -o, test]goGo 语言[run, main.go]或[build, -o, myapp]javaJava 运行[-cp, ., Main]dotnet.NET CLI[build, MyProject.csproj]常见补充命令:GCC:编译格式gcc[参数]源文件...[-o 输出文件]-o 文件 指定输出可执行文件名-g 生成调试信息-c 只编译不连接,生成.o文件​准确说,command就是要执行的命令,args就是要传递给command命令的参数args中间用逗号隔开参数的就是在终端中用空格隔开的参数eg.pip install numpy“command”:“pip”,“args”:[“install”,“numpy”]options:指定环境配置,比如工作目录,环境变量,shell等options:{cwd://当前工作目录,不指定的话默认项目根目录env:{//用于修改环境变量,会覆盖系统本身的同名变量PATH:,//添加PATHAPI_KEY:}shell:{//用于修改shell,仅在type选了shell时可用,例如想把Windows自带的改为bashexecutable://shell的路径args:[]}}group:任务分组, 会把任务分为“构建”“或者测试”,可以设置默认任务来利用快捷键运行通常可以忽略,因为group唯一的作用就是绑定快捷键,不使用快捷键完全没有用group:{kind:build,// 或 test、noneisDefault:true// 可选设为 true 表示该任务是默认构建/测试任务}说明:build任务和 CtrlShiftB 绑定,按下快捷键会运行类似gcc main.c -o app的指令test和 CtrlShiftT 绑定presentation:输出面板控制行为,可以定制个性化的东西,但有些选项十分必要一下是一个简要实例,包括了presentation的几个参数presentation:{reveal:always,// always(自动打开输出面板,默认) / silent (不打开但后台运行,比如一些不关心输出的任务可以用)/ never(不显示)panel:shared,// shared(所有任务公用一个终端,默认) / dedicated (每个人物单独分配)/ new(每次运行都建立一个新终端)clear:false,// 是否每次运行前清空输出showReuseMessage:true,focus:false// 运行后是否聚焦到输出面板(就是说运行程序之后光标自动放到输出面板上,适合要输入的任务)}problemMatcher:解析错误输出,作用是分析输出面板的错误信息,并帮助我们定位到具体错误位置problemMatcher:$gcc以上就是这个命令的常见格式常见参数:也就是识别的是什么工具的错误信息GCC/G$gccMSVCcl.exe$msCompileTypeScript 编译器$tscrunOptions:控制任务运行时的高级行为比如是否在重新运行任务时重新评估变量、是否在文件夹打开时自动运行等。(一般没用)detail:在“运行任务”的命令面板中为任务显示一行额外说明文字帮助你区分多个相似任务。(不会影响任务的执行)isBackground:作用是告诉vscode这个任务会一直运行不会自动结束默认情况下VS Code 认为任务执行完命令就会退出。如果你运行一个服务器它会一直挂在那里不退出VS Code 会误以为任务卡住了无法正常运行依赖它的其他任务比如调试可变参数变量含义示例值${workspaceFolder}当前打开的工作区根目录的路径/home/user/myproject${workspaceFolderBasename}工作区根目录的文件夹名不含路径myproject${file}当前在编辑器中打开的文件完整路径/home/user/myproject/src/main.py${fileWorkspaceFolder}当前文件所在的工作区根目录/home/user/myproject${relativeFile}当前文件相对于工作区根目录的路径src/main.py${relativeFileDirname}当前文件所在目录相对于工作区根目录的路径src${fileBasename}当前文件的基本名含扩展名main.py${fileBasenameNoExtension}当前文件的基本名不含扩展名main${fileDirname}当前文件所在的目录路径/home/user/myproject/src${fileExtname}当前文件的扩展名包含点.py${lineNumber}当前光标所在的行号在调试中常用10${selectedText}当前选中的文本def hello()${execPath}VS Code 可执行文件的路径/usr/bin/code${pathSeparator}系统的路径分隔符Windows 是\其他是//一个简单的用于GCC编译C语言文件的tasks.json{version:2.0.0,//这是固定的,所有任务都要写这行tasks:[{label:构建一个可执行.c 文件,//任务显示名称,可以随便写自己想看到的东西type:shell,// 任务类型command:gcc,//使用GCC编译args:[${file},-o,${fileBasenameNoExtension}],group:{kind:build,//任务分组isDefault:true},presentation:{reveal:always,panel:shared,clear:false,focus:false},problemMatcher:$gcc//解析错误输出}]}二.launch.json决定文件怎么执行,怎么调试可以通过preLaunchTash与tasks串联起来(这个命令就是在调试前自动执行构建任务)1.基本框架{version:0.2.0,// 固定版本号configurations:[// 调试配置数组可以定义多个{/* 配置1 */},{/* 配置2 */}],compounds:[]// 可选同时启动多个配置,本文不涉及这个参数}参数详解带绿色√或者黄色标注的为必填项namestring✅在调试下拉菜单中显示的名称typestring✅调试器类型如node、python、cppdbg、chromerequeststring✅launch启动新进程或attach附加到已有进程programstring多数需要要调试的可执行文件或脚本的路径argsarray❌传递给程序的命令行参数cwdstring❌当前工作目录默认${workspaceFolder}envobject❌环境变量preLaunchTaskstring❌调试前运行的任务对应tasks.json中的labelpostDebugTaskstring❌调试结束后运行的任务stopAtEntryboolean❌是否在程序入口处暂停默认 falseconsolestring❌控制台类型internalConsole、integratedTerminal、externalTerminalinternalConsoleOptionsstring❌neverOpen/openOnSessionStart等name:显示名称,作用类似tasks.json里的labeltype:选择调试器类型,以下是从网络搜集的常见值type 值对应的调试器/环境需要安装的扩展pythonPython 程序使用 debugpyPython (ms-python.python)cppdbgC/C 程序使用 GDB/LLDBC/C (ms-vscode.cpptools)nodeNode.js 程序内置无需额外安装chrome或pwa-chrome调试前端 JavaScript在 Chrome/Edge 中内置或 Debugger for Chromedotnet.NET Core / .NET 5 程序C# (ms-dotnettools.csharp)javaJava 程序Debugger for Java (vscjava.vscode-java-debug)goGo 程序Go (golang.go)rustRust 程序rust-analyzer自带调试支持或 CodeLLDBmsedge在 Edge 浏览器中调试内置firefox在 Firefox 中调试Debugger for Firefoxrequest:指定调试器如何链接程序,有两种取值 “launch”“attach”launch:直接启动程序,并加载调试器(比较常用),通常要配合prelaunchtask使用attach:用调试器连接一个已经启动的程序,并不负责启动program(一般是要写,但是当request选择了attach是可以忽略):指定要调试的文件路径,调试器会启动它并且附加调试器一般用预定义变量(见tasks,json部分附注的可变参量)给个例子program:${workspaceFolder}/main.exe,args, env, cwd:作用和tasks里一样,不同的是args传递给的是programpreLaunchTask:预启动任务,就是在调试之前先编译一个任务传入的值应该和tasks里的label的值一致console:决定被调试程序的输入和输出可选值internalConsole– VS Code 自带的“调试控制台”只显示输出不能输入比如无法使用scanf或input()integratedTerminal– VS Code 下方的集成终端支持输入推荐externalTerminal– 弹出一个单独的系统终端窗口支持输入但会切换窗口推荐使用中间那个stopAtEntry:是否在程序入口点自动暂停即停在main函数的第一行或脚本的第一行有两个布尔类型值,即true or falsetrue:调试启动后停止在入口false:程序运行到第一个断断点,没断点就一直运行postDebugTask:调试结束后运行的第一个任务(一般没用)给个例子,用于清理postDebugTask:Cleanup三.settings.json工作区配置各种插件配置字体,缩进,保存时格式化等操作,当团队协作时十分重要(但本人一般不喜欢配置这个,一般使用默认配置)本文略说如何创建?打开命令面板CtrlShiftP输入并选择Preferences: Open Workspace Settings (JSON)工作区设置或Preferences: Open User Settings (JSON)用户设置直接编辑保存。由于没写过,所以寻求DEEPSEEK写了两个常见的配置场景1Python 项目统一用 4 空格缩进保存时用 Black 格式化json{editor.tabSize:4,editor.insertSpaces:true,files.autoSave:afterDelay,[python]:{editor.formatOnSave:true,editor.defaultFormatter:ms-python.black-formatter},python.defaultInterpreterPath:${workspaceFolder}/.venv/bin/python,files.exclude:{**/__pycache__:true,**/.pytest_cache:true}}场景2C/C 项目MinGW 环境4 空格缩进json{editor.tabSize:4,editor.formatOnSave:false,files.associations:{*.h:c},C_Cpp.default.compilerPath:D:/J_tools/mingw64/bin/gcc.exe,C_Cpp.default.includePath:[${workspaceFolder}/**,D:/J_tools/mingw64/include],C_Cpp.default.cStandard:c11,C_Cpp.default.cppStandard:c17,files.exclude:{**/*.exe:true}}