Visual Studio Code 中的配置檔案
Visual Studio Code 有數百個設定、數千個擴充套件以及無數種調整 UI 佈局來自定義編輯器的方法。VS Code 配置檔案可讓你建立自定義設定集,並快速地在它們之間切換或與他人共享。本主題說明了如何使用配置檔案編輯器來建立、修改、匯出和匯入配置檔案。
訪問配置檔案編輯器
配置檔案編輯器使你能夠在一個地方建立和管理 VS Code 中的配置檔案。
你可以透過以下任一方式訪問配置檔案編輯器:
-
透過選單項 檔案 > 首選項 > 配置檔案
-
透過活動欄底部的管理齒輪按鈕。
建立配置檔案
VS Code 將你當前的配置視為預設配置檔案。當你修改設定、安裝擴充套件或透過移動檢視來更改 UI 佈局時,這些自定義項都會在預設配置檔案中被跟蹤。
要建立新的配置檔案,請開啟配置檔案編輯器並選擇新建配置檔案按鈕。這將開啟“新建配置檔案”表單,你可以在其中輸入配置檔名稱、選擇一個圖示,並配置新配置檔案中包含的內容。
你可以選擇透過從配置檔案模板或現有配置檔案中複製內容來建立新配置檔案,或者建立一個空配置檔案。空配置檔案不包含任何使用者自定義項,如設定、擴充套件、程式碼片段等。
你可以將新的配置檔案限制為僅包含一部分配置(設定、鍵盤快捷方式、MCP 伺服器、程式碼片段、任務和擴充套件),而其餘配置則使用預設配置檔案的。例如,你可以建立一個包含除鍵盤快捷方式外的所有配置的配置檔案,當此配置檔案啟用時,VS Code 將應用預設配置檔案的鍵盤快捷方式。
你可以在內容部分瀏覽你正在複製的模板或配置檔案的內容。每個部分旁邊都有一個開啟按鈕,你可以選擇它來檢視其內容。
透過選擇預覽按鈕,在建立新配置檔案之前進行預覽。這會開啟一個新的 VS Code 視窗,並應用了新的配置檔案。一旦你對預覽滿意,就可以選擇建立按鈕來建立新的配置檔案。
檢查當前配置檔案
你可以在 VS Code UI 的多個位置找到當前 VS Code 視窗正在使用的配置檔案:
-
在 VS Code 標題欄中
-
將滑鼠懸停在活動欄中的管理按鈕上時,會在懸停文字中顯示
如果你為配置檔案配置了一個圖示,該圖示將用作活動欄中的管理按鈕。請注意在下面的截圖中,“管理”按鈕現在有一個麥克風圖示,表示一個配置檔案處於活動狀態。
如果你沒有配置圖示,那麼管理齒輪按鈕會顯示一個帶有活動配置檔案前兩個字母的徽章,這樣你就可以快速檢查正在執行哪個配置檔案。
-
在配置檔案編輯器中
注意:如果你正在使用預設配置檔案,則不會顯示任何配置檔名稱。
配置配置檔案
你可以像更改任何 VS Code 配置一樣配置配置檔案。你可以安裝/解除安裝/停用擴充套件、更改設定以及調整編輯器的 UI 佈局(例如,移動和隱藏檢視)。當你應用這些更改時,它們將被儲存在你當前活動的配置檔案中。
資料夾和工作區關聯
當你建立或選擇一個配置檔案時,它會與當前的資料夾或工作區相關聯。每當你開啟該資料夾時,該工作區的配置檔案就會被啟用。如果你開啟另一個資料夾,配置檔案會更改為另一個資料夾的配置檔案(如果已設定)。
你可以在配置檔案編輯器的資料夾和工作區部分檢視與配置檔案關聯的資料夾列表。
管理配置檔案
切換配置檔案
你可以透過命令面板中的 配置檔案: 切換配置檔案 命令快速切換配置檔案,該命令會顯示一個包含你可用配置檔案的下拉列表。
你也可以在配置檔案編輯器中切換配置檔案,方法是選擇你想要切換到的配置檔案旁邊的在當前視窗使用此配置檔案按鈕。
編輯配置檔案
你可以在配置檔案編輯器中編輯現有配置檔案的名稱、圖示和其他配置。
刪除配置檔案
你可以從配置檔案編輯器中刪除配置檔案,方法是選擇要刪除的配置檔案的溢位操作中的刪除配置檔案按鈕。
你也可以透過刪除配置檔案命令來刪除配置檔案。刪除配置檔案下拉列表允許你選擇要刪除的配置檔案。
使用配置檔案開啟新視窗
你可以透過在配置檔案編輯器的配置檔案內容檢視中使用用於新視窗選項,來選擇開啟新 VS Code 視窗時使用的配置檔案。
你可以透過使用 檔案 > 使用配置檔案新建視窗 選單,並選擇你想要使用的配置檔案,來直接為特定配置檔案開啟一個新的 VS Code 視窗。
將設定應用於所有配置檔案
要將一個設定應用於你所有的配置檔案,請在設定編輯器中使用將設定應用於所有配置檔案操作。
在任何配置檔案中對此設定的更新也會應用於所有其他配置檔案。你可以隨時透過取消選中將設定應用於所有配置檔案操作來恢復此行為。
將擴充套件應用於所有配置檔案
要將一個擴充套件應用於你所有的配置檔案,請在擴充套件檢視中選擇將擴充套件應用於所有配置檔案操作。
這使得該擴充套件在你所有的配置檔案中都可用。你可以隨時透過取消選中將擴充套件應用於所有配置檔案操作來恢復此行為。
跨裝置同步配置檔案
你可以使用設定同步來在不同裝置間遷移你的配置檔案。啟用設定同步並在設定同步: 配置下拉選單中選中配置檔案後,你所有的配置檔案都將在已同步的裝置上可用。
注意:VS Code 不會從遠端視窗同步你的擴充套件,例如當你連線到 SSH、開發容器 (devcontainer) 或 WSL 時。
共享配置檔案
匯出
你可以透過使用要匯出的配置檔案的溢位操作中的匯出...按鈕來匯出配置檔案,以便儲存或與他人共享。
當你選擇匯出...時,系統會提示你輸入配置檔名稱,並詢問你是否要匯出到 GitHub gist 或你的本地檔案系統。
另存為 GitHub gist
將配置檔案儲存到 GitHub 後(系統會提示你登入 GitHub),一個對話方塊會給你複製連結的選項,以便與他人共享你的配置檔案 gist URL。該 URL 包含一個自動生成的 GUID,格式為 https://vscode.dev/editor/profile/github/{GUID}
。該 GitHub gist 被標記為私密,因此只有擁有連結的人才能看到該 gist。
如果你開啟該配置檔案 URL,它會開啟 VS Code for the Web,並開啟配置檔案編輯器,顯示匯入的配置檔案內容。如果你願意,可以取消選擇配置檔案的元素,並且如果你想在 VS Code for the Web 中繼續使用該配置檔案,你需要手動安裝擴充套件(透過下載雲按鈕)。
你還可以選擇在 Visual Studio Code 中匯入配置檔案,這會開啟 VS Code 桌面版,顯示配置檔案的內容和一個匯入配置檔案按鈕。
你可以在 https://gist.github.com/{username}
檢視你的 gists。在你的 GitHub gist 頁面上,你可以重新命名、刪除或複製 gist 的 GUID。
另存為本地檔案
如果你選擇將配置檔案儲存為本地檔案,一個儲存配置檔案對話方塊會讓你將檔案放在你的本地機器上。配置檔案被儲存在一個副檔名為 .code-profile
的檔案中。
匯入
你可以從配置檔案編輯器中匯入一個現有的配置檔案,方法是選擇新建配置檔案按鈕下拉操作中的匯入配置檔案...按鈕。
當你選擇匯入配置檔案...時,系統會透過一個匯入配置檔案對話方塊提示你輸入 GitHub gist 的 URL 或配置檔案的檔案位置。一旦你選擇了配置檔案,配置檔案建立表單就會開啟,並預先選擇了要匯入的配置檔案。你可以繼續修改配置檔案並選擇建立來匯入該配置檔案。
配置檔案的用途
配置檔案是自定義 VS Code 以更好地滿足你需求的好方法。在本節中,我們來看一些配置檔案的常見用例。
由於配置檔案是按工作區記憶的,因此它們是為特定程式語言自定義 VS Code 的好方法。例如,你可以建立一個 JavaScript 前端配置檔案,其中包含你在一個工作區中用於 JavaScript 開發的擴充套件、設定和自定義項,並擁有一個 Python 後端配置檔案,其中包含你在另一個工作區中用於 Python 開發的擴充套件、設定和自定義項。使用這種方法,你可以輕鬆地在工作區之間切換,並始終讓 VS Code 配置得當。
演示
在做演示時,你可以使用配置檔案為你的演示設定特定的配置。例如,你可以建立一個包含特定擴充套件集和設定(如縮放級別、字型大小和顏色主題)的配置檔案。這樣做,演示不會弄亂你正常的 VS Code 設定,並且你可以為演示期間更好的可見性自定義 VS Code。
教育
配置檔案可用於為學生自定義 VS Code,以便在課堂環境中簡化使用。配置檔案允許教育工作者快速與學生共享自定義的 VS Code 設定。例如,教育工作者可以建立一個包含計算機科學課程所需的特定擴充套件和設定的配置檔案,然後與學生共享該配置檔案。
報告 VS Code 問題
空配置檔案的一個用途是,當你想報告 VS Code 的問題時,可以重置你的編輯器。空配置檔案會停用所有擴充套件和已修改的設定,這樣你就可以快速檢視問題是由擴充套件、設定還是 VS Code 核心引起的。
配置檔案模板
VS Code 自帶一組預定義的配置檔案模板,你可以用它們來為你的特定工作流程自定義 VS Code。要基於模板建立新配置檔案,請在建立配置檔案流程中選擇一個配置檔案模板。
Python 配置檔案模板
Python 配置檔案是 Python 開發的一個很好的起點。它附帶了 Python 特定的程式碼片段,幷包含以下擴充套件:
- autoDocstring - 自動生成 Python 文件字串。
- 容器工具 - 建立、管理和除錯容器化應用程式。
- Even Better TOML - 為例如
pyproject.toml
檔案提供功能齊全的 TOML 支援。 - Python - IntelliSense、環境管理、除錯、重構。
- Python 環境 - 使用你偏好的環境管理器管理 Python 環境和包。
- 遠端開發擴充套件包 - 支援 SSH、WSL 和開發容器。
- Ruff - 集成了 Ruff Python linter 和格式化工具。
此配置檔案還設定了以下設定:
"python.analysis.autoImportCompletions": true,
"python.analysis.fixAll": ["source.unusedImports"],
"editor.defaultFormatter": "charliermarsh.ruff"
資料科學配置檔案模板
資料科學配置檔案是所有資料和 notebook 工作的一個很好的起點。它附帶了特定的程式碼片段,幷包含以下擴充套件:
- Data Wrangler - 用於表格資料集和 Excel/CSV/Parquet 檔案的資料檢視、清理和準備。
- GitHub Copilot - 你的 AI 結對程式設計師。
- Jupyter - 在 VS Code 中使用 Jupyter notebooks。
- Python - IntelliSense、環境管理、除錯、重構。
- 遠端開發擴充套件包 - 支援 SSH、WSL 和開發容器。
- Ruff - 集成了 Ruff Python linter 和格式化工具。
此配置檔案還設定了以下設定:
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.formatOnType": true,
"editor.formatOnSave": true
},
"editor.inlineSuggest.enabled": true,
"editor.lineHeight": 17,
"breadcrumbs.enabled": false,
"files.autoSave": "afterDelay",
"notebook.output.scrolling": true,
"jupyter.themeMatplotlibPlots": true,
"jupyter.widgetScriptSources": [
"unpkg.com",
"jsdelivr.com"
],
"files.exclude": {
"**/.csv": true,
"**/.parquet": true,
"**/.pkl": true,
"**/.xls": true
}
文件編寫者配置檔案模板
文件編寫者配置檔案是用於編寫文件的一個很好的輕量級設定。它包含以下擴充套件:
- Code Spell Checker - 原始碼的拼寫檢查器。
- Markdown Checkboxes - 為 VS Code 內建的 Markdown 預覽新增複選框支援。
- Markdown Emoji - 為 Markdown 預覽和 notebook Markdown 單元格新增表情符號語法支援。
- Markdown Footnotes - 為 Markdown 預覽新增 ^footnote 語法支援。
- Markdown Preview GitHub Styling - 在 Markdown 預覽中使用 GitHub 樣式。
- Markdown Preview Mermaid Support - Mermaid 圖表和流程圖。
- Markdown yaml Preamble - 將 YAML front matter 渲染為表格。
- markdownlint - Visual Studio Code 的 Markdown linting 和樣式檢查。
- Word Count - 在狀態列中檢視 Markdown 文件的字數。
- Read Time - 估算閱讀你的 Markdown 所需的時間。
此配置檔案還設定了以下設定:
"workbench.colorTheme": "Default Light Modern",
"editor.minimap.enabled": false,
"breadcrumbs.enabled": false,
"editor.glyphMargin": false,
"explorer.decorations.badges": false,
"explorer.decorations.colors": false,
"editor.fontLigatures": true,
"files.autoSave": "afterDelay",
"git.enableSmartCommit": true,
"window.commandCenter": true,
"editor.renderWhitespace": "none",
"workbench.editor.untitled.hint": "hidden",
"markdown.validate.enabled": true,
"markdown.updateLinksOnFileMove.enabled": "prompt",
"workbench.startupEditor": "none"
Node.js 配置檔案模板
Node.js 配置檔案是所有 Node.js 工作的一個很好的起點。它包含以下擴充套件:
- 容器工具 - 建立、管理和除錯容器化應用程式。
- Dev Containers - 在 Docker 容器內建立自定義開發環境。
- DotENV - 支援 dotenv 檔案語法。
- EditorConfig for VS Code - Visual Studio Code 的 EditorConfig 支援。
- ESLint - 將 ESLint JavaScript 整合到 VS Code 中。
- JavaScript (ES6) code snippets - ES6 語法的 JavaScript 程式碼片段。
- Jest - 使用 Facebook 的 jest 測試框架。
- Microsoft Edge Tools for VS Code - 在 VS Code 中使用 Microsoft Edge 工具。
- npm Intellisense - 在 import 語句中自動補全 npm 模組。
- Prettier - Code formatter - 使用 Prettier 的程式碼格式化工具。
- Rest Client - Visual Studio Code 的 REST 客戶端。
- YAML - YAML 語言支援,內建 Kubernetes 語法。
此配置檔案附帶以下設定:
"editor.formatOnPaste": true,
"git.autofetch": true,
"[markdown]": {
"editor.wordWrap": "on"
},
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[jsonc]": {
"editor.defaultFormatter": "vscode.json-language-features"
},
"[html]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
Angular 配置檔案模板
Angular 配置檔案是所有 Angular 工作的一個很好的起點。它包含以下擴充套件:
- Angular Language Service - 用於 Angular 模板的編輯器服務。
- Angular Schematics - 整合 Angular schematics(CLI 命令)。
- angular2-switcher - 在 angular2 專案中輕鬆導航到
typescript
|template
|style
。 - Dev Containers - 在 Docker 容器內建立自定義開發環境。
- EditorConfig for VS Code - Visual Studio Code 的 EditorConfig 支援。
- ESLint - 將 ESLint JavaScript 整合到 VS Code 中。
- JavaScript (ES6) code snippets - ES6 語法的 JavaScript 程式碼片段。
- Jest - 使用 Facebook 的 jest 測試框架。
- Material Icon Theme - Visual Studio Code 的 Material Design 圖示。
- Microsoft Edge Tools for VS Code - 在 VS Code 中使用 Microsoft Edge 工具。
- Playwright Test for VSCode - 在 Visual Studio Code 中執行 Playwright 測試。
- Prettier - Code formatter - 使用 Prettier 的程式碼格式化工具。
- Rest Client - Visual Studio Code 的 REST 客戶端。
- YAML - YAML 語言支援,內建 Kubernetes 語法。
此配置檔案設定了以下設定:
"editor.formatOnPaste": true,
"git.autofetch": true,
"[markdown]": {
"editor.wordWrap": "on"
},
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[jsonc]": {
"editor.defaultFormatter": "vscode.json-language-features"
},
"[html]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"workbench.iconTheme": "material-icon-theme"
Java 通用配置檔案模板
Java 通用配置檔案是所有 Java 工作的一個很好的起點。它自定義佈局以改善 Java 體驗,幷包含來自 Extension Pack for Java 的以下擴充套件:
- Debugger for Java - 一個輕量級的 Java 偵錯程式。
- IntelliCode - AI 輔助開發。
- IntelliCode API Usage Examples - 為超過 10 萬個不同的 API 提供程式碼示例。
- Language Support for Java(TM) by Red Hat - 基礎的 Java 語言支援、Linting、Intellisense、格式化、重構。
- Maven for Java - 管理 Maven 專案和構建。
- Project Manager for Java - 在 VS Code 中管理 Java 專案。
- Test Runner for Java - 執行和除錯 JUnit 或 TestNG 測試用例。
Java Spring 配置檔案模板
Java Spring 配置檔案是所有 Java 和 Spring 開發者的一個很好的起點。它建立在 Java 通用配置檔案的基礎上,並添加了來自 Spring Boot Extension Pack 的以下擴充套件:
- Spring Boot Dashboard - 在你執行的 Spring 應用程式中提供 Spring Boot 即時資料視覺化和觀察。
- Spring Boot Tools - 對 Spring Boot 檔案的豐富語言支援。
- Spring Initializr Java Support - 構建和生成 Spring Boot Java 專案。
此配置檔案設定了以下設定:
"[java]": {
"editor.defaultFormatter": "redhat.java"
},
"boot-java.rewrite.reconcile": true
命令列
你可以透過 --profile
命令列介面選項來啟動具有特定配置檔案的 VS Code。你在 --profile
引數後傳遞配置檔案的名稱,並使用該配置檔案開啟一個資料夾或工作區。下面的命令列使用 "Web Development" 配置檔案開啟 web-sample
資料夾:
code ~/projects/web-sample --profile "Web Development"
如果指定的配置檔案不存在,則會建立一個具有給定名稱的新空配置檔案。
常見問題
配置檔案儲存在哪裡?
配置檔案與你的使用者設定和鍵盤快捷方式類似,都儲存在你的使用者配置下。
- Windows
%APPDATA%\Code\User\profiles
- macOS
$HOME/Library/Application\ Support/Code/User/profiles
- Linux
$HOME/.config/Code/User/profiles
如果你正在使用 Insiders 版本,中間的資料夾名稱是 Code - Insiders
。
什麼是臨時配置檔案?
臨時配置檔案是一種不會在 VS Code 會話之間儲存的配置檔案。你可以透過命令面板中的配置檔案: 建立臨時配置檔案命令來建立臨時配置檔案。臨時配置檔案以空配置檔案的形式開始,並有一個自動生成的名稱(例如 Temp 1)。你可以修改配置檔案的設定和擴充套件,在你的 VS Code 會話期間使用該配置檔案,但一旦你關閉 VS Code,它就會被刪除。
如果你想嘗試新的配置或測試一個擴充套件而不修改你的預設或現有配置檔案,臨時配置檔案非常有用。重啟 VS Code 會為你的工作區重新啟用當前的配置檔案。
我可以從另一個配置檔案繼承設定嗎?
目前,無法從另一個配置檔案繼承設定,即覆蓋特定設定而保留來自另一個配置檔案的其餘設定。我們正在 vscode 倉庫中跟蹤此功能請求。
當你建立新配置檔案時,你可以選擇從另一個或預設配置檔案複製設定。這會在新配置檔案中建立設定的副本,但不會與你用作源的配置檔案保持連結。
如何從我的專案中移除配置檔案?
你可以將你的專案設定回預設配置檔案。如果你想移除所有配置檔案的工作區關聯,可以使用開發者: 重置工作區配置檔案關聯,這將把所有當前分配了配置檔案的本地資料夾設定回預設配置檔案。重置工作區配置檔案關聯不會刪除任何現有的配置檔案。
為什麼在匯出配置檔案時有些設定沒有被匯出?
在匯出配置檔案時,特定於機器的設定不會被包含在內,因為這些設定在另一臺機器上將不適用。例如,指向本地路徑的設定就不會被包含。
為什麼在建立新配置檔案時模板不可用?
配置檔案模板由 VS Code 外部託管,只有在你連線到網際網路時才能下載和應用模板。如果你發現配置檔案模板不可用,請務必檢查你的網際網路連線。