Order: 2
Area: customization
TOCTitle: User and Workspace Settings
ContentId: FDA6D86C-FF24-49BC-A1EB-E3BA43130FA0
PageTitle: Visual Studio Code User and Workspace Settings
DateApproved: 4/14/2016

MetaDescription: How to modify Visual Studio Code User and Workspace Settings.

用户和工作区设置(User and Workspace Settings)

It’s easy to configure VS Code the way you want by editing the various setting files where you will find a great number of settings to play with.

很容易通过编辑各种设置文件来配置VS Code，你会发现许多有意思的设置。

VS Code provides two different scopes for settings:

VS Code 的设置分为两种作用域：

  • User these settings apply globally to any instance of VS Code you open

  • Workspace these settings are stored inside your workspace in a .vscode folder and only apply when the workspace is opened. Settings defined on this scope overwrite the user scope.

  • 用户设置 这些设置全局应用于您打开的任何VS Code 项目

  • 工作区设置 这些设置存储在工作区内的 .vscode 文件夹中，并且仅在打开的工作区适用。在此范围上定义的设置将覆盖用户范围的设置。

创建用户和工作区设置(Creating User and Workspace Settings)

The menu under File > Preferences provides entries to configure user and workspace settings. You are provided with a list of Default Settings. Copy any setting that you want to change to the related settings.json file.

文件>首选项 下的 菜单 提供用于配置用户和工作空间设置的选项。您将看到一个默认设置列表。将要更改的任何设置复制到相关的（右侧） settings.json 文件。

In the example below, we disabled line numbers in the editor and configured line wrapping to wrap automatically based on the size of the editor.

如下面的示例，我们在编辑器中禁用了 行号 ，并且配置换行为根据编辑器的大小自动换行。

Example Settings

Changes to settings are reloaded by VS Code after the modified settings.json file is saved.

保存修改的 settings.json 文件后，VS Code 将重新加载对设置的更改。

设置文件的位置(Settings File Locations)

Depending on your platform, the user settings file is located here:

根据您的操作系统，用户设置文件位于下面几处：

  • Windows %APPDATA%\Code\User\settings.json
  • Mac $HOME/Library/Application Support/Code/User/settings.json
  • Linux $HOME/.config/Code/User/settings.json

The workspace setting file is located under the .vscode folder in your project.

工作区设置文件位于项目中的 .vscode 文件夹下。

设置文件内容(Settings File Sections)

The settings.json file is divided into these sections:

settings.json 文件分为以下几个部分：

  • Editor Configuration - font, word wrapping, tab size, line numbers, indentation, …
  • Window Configuration - restore folders, zoom level, …
  • Files Configuration - excluded file filters, default encoding, trim trailing whitespace, …
  • File Explorer Configuration - encoding, WORKING FILES behavior, …
  • HTTP Configuration - proxy settings
  • Search Configuration - file exclude filters
  • Git Configuration - disable Git integration, auto fetch behavior
  • Telemetry Configuration - disable telemetry reporting, crash reporting
  • HTML Configuration - HTML format configuration
  • CSS Configuration - CSS linting configuration
  • JavaScript Configuration - Language specific settings
  • JSON Configuration - Schemas associated with certain JSON files
  • Markdown Preview Configuration - Add a custom CSS to the Markdown preview
  • Less Configuration - Control linting for Less
  • Sass Configuration - Control linting for Sass
  • TypeScript Configuration - Language specific settings
  • PHP Configuration - PHP linter configuration

默认设置(Default Settings)

Below is a copy of the default settings.json file.

下面是默认的 settings.json 文件的实例。

Tip: While in the settings.json file, press kb(workbench.action.gotoSymbol) to see an outline of all available settings and navigate through the file.

提示： 在 settings.json 文件中，按 kb（workbench.action.gotoSymbol） 可查看所有可用设置的大纲，并浏览该文件。

  1. // Overwrite settings by placing them into your settings file.
  2. {
  4.     //-------- Editor configuration --------
  6.     // Controls the font family.
  7.     "editor.fontFamily": "",
  9.     // Controls the font size.
  10.     "editor.fontSize": 0,
  12.     // Controls the line height.
  13.     "editor.lineHeight": 0,
  15.     // Controls visibility of line numbers
  16.     "editor.lineNumbers": true,
  18.     // Controls visibility of the glyph margin
  19.     "editor.glyphMargin": false,
  21.     // Columns at which to show vertical rulers
  22.     "editor.rulers": [],
  24.     // Characters that will be used as word separators when doing word related navigations or operations
  25.     "editor.wordSeparators": "`~!@#$%^&*()-=+[{]}\\|;:'\",.<>/?",
  27.     // The number of spaces a tab is equal to.
  28.     "editor.tabSize": 4,
  30.     // Insert spaces when pressing Tab.
  31.     "editor.insertSpaces": true,
  33.     // When opening a file, `editor.tabSize` and `editor.insertSpaces` will be detected based on the file contents.
  34.     "editor.detectIndentation": true,
  36.     // Controls if selections have rounded corners
  37.     "editor.roundedSelection": true,
  39.     // Controls if the editor will scroll beyond the last line
  40.     "editor.scrollBeyondLastLine": true,
  42.     // Controls after how many characters the editor will wrap to the next line. Setting this to 0 turns on viewport width wrapping
  43.     "editor.wrappingColumn": 300,
  45.     // Controls the indentation of wrapped lines. Can be one of 'none', 'same' or 'indent'.
  46.     "editor.wrappingIndent": "same",
  48.     // A multiplier to be used on the `deltaX` and `deltaY` of mouse wheel scroll events
  49.     "editor.mouseWheelScrollSensitivity": 1,
  51.     // Controls if quick suggestions should show up or not while typing
  52.     "editor.quickSuggestions": true,
  54.     // Controls the delay in ms after which quick suggestions will show up
  55.     "editor.quickSuggestionsDelay": 10,
  57.     // Controls if the editor should automatically close brackets after opening them
  58.     "editor.autoClosingBrackets": true,
  60.     // Controls if the editor should automatically format the line after typing
  61.     "editor.formatOnType": false,
  63.     // Controls if suggestions should automatically show up when typing trigger characters
  64.     "editor.suggestOnTriggerCharacters": true,
  66.     // Controls if suggestions should be accepted 'Enter' - in addition to 'Tab'. Helps to avoid ambiguity between inserting new lines or accepting suggestions.
  67.     "editor.acceptSuggestionOnEnter": true,
  69.     // Controls whether the editor should highlight similar matches to the selection
  70.     "editor.selectionHighlight": true,
  72.     // Controls the number of decorations that can show up at the same position in the overview ruler
  73.     "editor.overviewRulerLanes": 3,
  75.     // Controls the cursor blinking animation, accepted values are 'blink', 'visible', and 'hidden'
  76.     "editor.cursorBlinking": "blink",
  78.     // Controls the cursor style, accepted values are 'block' and 'line'
  79.     "editor.cursorStyle": "line",
  81.     // Enables font ligatures
  82.     "editor.fontLigatures": false,
  84.     // Controls if the cursor should be hidden in the overview ruler.
  85.     "editor.hideCursorInOverviewRuler": false,
  87.     // Controls whether the editor should render whitespace characters
  88.     "editor.renderWhitespace": false,
  90.     // Controls if the editor shows reference information for the modes that support it
  91.     "editor.referenceInfos": true,
  93.     // Controls whether the editor has code folding enabled
  94.     "editor.folding": true,
  96.     // Controls if the diff editor shows the diff side by side or inline
  97.     "diffEditor.renderSideBySide": true,
  99.     // Controls if the diff editor shows changes in leading or trailing whitespace as diffs
  100.     "diffEditor.ignoreTrimWhitespace": true,
  103.     //-------- Window configuration --------
  105.     // When enabled, will open files in a new window instead of reusing an existing instance.
  106.     "window.openFilesInNewWindow": true,
  108.     // Controls how folders are being reopened after a restart. Select 'none' to never reopen a folder, 'one' to reopen the last folder you worked on or 'all' to reopen all folders of your last session.
  109.     "window.reopenFolders": "one",
  111.     // Adjust the zoom level of the window. The original size is 0 and each increment above (e.g. 1) or below (e.g. -1) represents zooming 20% larger or smaller. You can also enter decimals to adjust the zoom level with a finer granularity.
  112.     "window.zoomLevel": 0,
  115.     //-------- Files configuration --------
  117.     // Configure glob patterns for excluding files and folders.
  118.     "files.exclude": {
  119.         "**/.git": true,
  120.         "**/.DS_Store": true
  121.     },
  123.     // Configure file associations to languages (e.g. "*.extension": "html"). These have precedence over the default associations of the languages installed.
  124.     "files.associations": {},
  126.     // The default character set encoding to use when reading and writing files.
  127.     "files.encoding": "utf8",
  129.     // The default end of line character.
  130.     "files.eol": "\n",
  132.     // When enabled, will trim trailing whitespace when you save a file.
  133.     "files.trimTrailingWhitespace": false,
  135.     // Controls auto save of dirty files. Accepted values:  "off", "afterDelay", "onFocusChange". If set to "afterDelay" you can configure the delay in "files.autoSaveDelay".
  136.     "files.autoSave": "off",
  138.     // Controls the delay in ms after which a dirty file is saved automatically. Only applies when "files.autoSave" is set to "afterDelay"
  139.     "files.autoSaveDelay": 1000,
  141.     // Configure glob patterns of file paths to exclude from file watching. Changing this setting requires a restart. When you experience Code consuming lots of cpu time on startup, you can exclude large folders to reduce the initial load.
  142.     "files.watcherExclude": {
  143.         "**/.git/objects/**": true,
  144.         "**/node_modules/**": true
  145.     },
  148.     //-------- File Explorer configuration --------
  150.     // Maximum number of working files to show before scrollbars appear.
  151.     "explorer.workingFiles.maxVisible": 9,
  153.     // Controls if the height of the working files section should adapt dynamically to the number of elements or not.
  154.     "explorer.workingFiles.dynamicHeight": true,
  157.     //-------- HTTP configuration --------
  159.     // The proxy setting to use. If not set will be taken from the http_proxy and https_proxy environment variables
  160.     "http.proxy": "",
  162.     // Whether the proxy server certificate should be verified against the list of supplied CAs.
  163.     "http.proxyStrictSSL": true,
  166.     //-------- Update configuration --------
  168.     // Configure the update channel to receive updates from. Requires a restart after change.
  169.     "update.channel": "default",
  172.     //-------- Search configuration --------
  174.     // Configure glob patterns for excluding files and folders in searches. Inherits all glob patterns from the file.exclude setting.
  175.     "search.exclude": {
  176.         "**/node_modules": true,
  177.         "**/bower_components": true
  178.     },
  181.     //-------- Git configuration --------
  183.     // Is git enabled
  184.     "git.enabled": true,
  186.     // Path to the git executable
  187.     "git.path": null,
  189.     // Whether auto fetching is enabled.
  190.     "git.autofetch": true,
  193.     //-------- Telemetry configuration --------
  195.     // Enable usage data and errors to be sent to Microsoft.
  196.     "telemetry.enableTelemetry": true,
  199.     //-------- Markdown preview configuration --------
  201.     // A list of URLs or local paths to CSS style sheets to use from the markdown preview.
  202.     "markdown.styles": [],
  205.     //-------- JSON configuration --------
  207.     // Associate schemas to JSON files in the current project
  208.     "json.schemas": [],
  211.     //-------- HTML configuration --------
  213.     // Maximum amount of characters per line (0 = disable).
  214.     "html.format.wrapLineLength": 120,
  216.     // List of tags, comma separated, that shouldn't be reformatted. 'null' defaults to all inline tags.
  217.     "html.format.unformatted": null,
  219.     // Indent <head> and <body> sections.
  220.     "html.format.indentInnerHtml": false,
  222.     // Whether existing line breaks before elements should be preserved. Only works before elements, not inside tags or for text.
  223.     "html.format.preserveNewLines": true,
  225.     // Maximum number of line breaks to be preserved in one chunk. Use 'null' for unlimited.
  226.     "html.format.maxPreserveNewLines": null,
  228.     // Format and indent {{#foo}} and {{/foo}}.
  229.     "html.format.indentHandlebars": false,
  231.     // End with a newline.
  232.     "html.format.endWithNewline": false,
  234.     // List of tags, comma separated, that should have an extra newline before them. 'null' defaults to "head, body, /html".
  235.     "html.format.extraLiners": null,
  238.     //-------- Telemetry configuration --------
  240.     // Enable crash reports to be sent to Microsoft.
  241.     // This option requires restart to take effect.
  242.     "telemetry.enableCrashReporter": true,
  245.     //-------- CSS configuration --------
  247.     // Controls CSS validation and problem severities.
  249.     // Enables or disables all validations
  250.     "css.validate": true,
  252.     // When using a vendor-specific prefix make sure to also include all other vendor-specific properties
  253.     "css.lint.compatibleVendorPrefixes": "ignore",
  255.     // When using a vendor-specific prefix also include the standard property
  256.     "css.lint.vendorPrefix": "warning",
  258.     // Do not use duplicate style definitions
  259.     "css.lint.duplicateProperties": "ignore",
  261.     // Do not use empty rulesets
  262.     "css.lint.emptyRules": "warning",
  264.     // Import statements do not load in parallel
  265.     "css.lint.importStatement": "ignore",
  267.     // Do not use width or height when using padding or border
  268.     "css.lint.boxModel": "ignore",
  270.     // The universal selector (*) is known to be slow
  271.     "css.lint.universalSelector": "ignore",
  273.     // No unit for zero needed
  274.     "css.lint.zeroUnits": "ignore",
  276.     // @font-face rule must define 'src' and 'font-family' properties
  277.     "css.lint.fontFaceProperties": "warning",
  279.     // Hex colors must consist of three or six hex numbers
  280.     "css.lint.hexColorLength": "error",
  282.     // Invalid number of parameters
  283.     "css.lint.argumentsInColorFunction": "error",
  285.     // Unknown property.
  286.     "css.lint.unknownProperties": "warning",
  288.     // IE hacks are only necessary when supporting IE7 and older
  289.     "css.lint.ieHack": "ignore",
  291.     // Unknown vendor specific property.
  292.     "css.lint.unknownVendorSpecificProperties": "ignore",
  294.     // Property is ignored due to the display. E.g. with 'display: inline', the width, height, margin-top, margin-bottom, and float properties have no effect
  295.     "css.lint.propertyIgnoredDueToDisplay": "warning",
  297.     // Avoid using !important. It is an indication that the specificity of the entire CSS has gotten out of control and needs to be refactored.
  298.     "css.lint.important": "ignore",
  300.     // Avoid using 'float'. Floats lead to fragile CSS that is easy to break if one aspect of the layout changes.
  301.     "css.lint.float": "ignore",
  303.     // Selectors should not contain IDs because these rules are too tightly coupled with the HTML.
  304.     "css.lint.idSelector": "ignore",
  307.     //-------- LESS configuration --------
  309.     // Controls LESS validation and problem severities.
  311.     // Enables or disables all validations
  312.     "less.validate": true,
  314.     // When using a vendor-specific prefix make sure to also include all other vendor-specific properties
  315.     "less.lint.compatibleVendorPrefixes": "ignore",
  317.     // When using a vendor-specific prefix also include the standard property
  318.     "less.lint.vendorPrefix": "warning",
  320.     // Do not use duplicate style definitions
  321.     "less.lint.duplicateProperties": "ignore",
  323.     // Do not use empty rulesets
  324.     "less.lint.emptyRules": "warning",
  326.     // Import statements do not load in parallel
  327.     "less.lint.importStatement": "ignore",
  329.     // Do not use width or height when using padding or border
  330.     "less.lint.boxModel": "ignore",
  332.     // The universal selector (*) is known to be slow
  333.     "less.lint.universalSelector": "ignore",
  335.     // No unit for zero needed
  336.     "less.lint.zeroUnits": "ignore",
  338.     // @font-face rule must define 'src' and 'font-family' properties
  339.     "less.lint.fontFaceProperties": "warning",
  341.     // Hex colors must consist of three or six hex numbers
  342.     "less.lint.hexColorLength": "error",
  344.     // Invalid number of parameters
  345.     "less.lint.argumentsInColorFunction": "error",
  347.     // Unknown property.
  348.     "less.lint.unknownProperties": "warning",
  350.     // IE hacks are only necessary when supporting IE7 and older
  351.     "less.lint.ieHack": "ignore",
  353.     // Unknown vendor specific property.
  354.     "less.lint.unknownVendorSpecificProperties": "ignore",
  356.     // Property is ignored due to the display. E.g. with 'display: inline', the width, height, margin-top, margin-bottom, and float properties have no effect
  357.     "less.lint.propertyIgnoredDueToDisplay": "warning",
  359.     // Avoid using !important. It is an indication that the specificity of the entire CSS has gotten out of control and needs to be refactored.
  360.     "less.lint.important": "ignore",
  362.     // Avoid using 'float'. Floats lead to fragile CSS that is easy to break if one aspect of the layout changes.
  363.     "less.lint.float": "ignore",
  365.     // Selectors should not contain IDs because these rules are too tightly coupled with the HTML.
  366.     "less.lint.idSelector": "ignore",
  369.     //-------- Sass configuration --------
  371.     // Controls Sass validation and problem severities.
  373.     // Enables or disables all validations
  374.     "sass.validate": true,
  376.     // When using a vendor-specific prefix make sure to also include all other vendor-specific properties
  377.     "sass.lint.compatibleVendorPrefixes": "ignore",
  379.     // When using a vendor-specific prefix also include the standard property
  380.     "sass.lint.vendorPrefix": "warning",
  382.     // Do not use duplicate style definitions
  383.     "sass.lint.duplicateProperties": "ignore",
  385.     // Do not use empty rulesets
  386.     "sass.lint.emptyRules": "warning",
  388.     // Import statements do not load in parallel
  389.     "sass.lint.importStatement": "ignore",
  391.     // Do not use width or height when using padding or border
  392.     "sass.lint.boxModel": "ignore",
  394.     // The universal selector (*) is known to be slow
  395.     "sass.lint.universalSelector": "ignore",
  397.     // No unit for zero needed
  398.     "sass.lint.zeroUnits": "ignore",
  400.     // @font-face rule must define 'src' and 'font-family' properties
  401.     "sass.lint.fontFaceProperties": "warning",
  403.     // Hex colors must consist of three or six hex numbers
  404.     "sass.lint.hexColorLength": "error",
  406.     // Invalid number of parameters
  407.     "sass.lint.argumentsInColorFunction": "error",
  409.     // Unknown property.
  410.     "sass.lint.unknownProperties": "warning",
  412.     // IE hacks are only necessary when supporting IE7 and older
  413.     "sass.lint.ieHack": "ignore",
  415.     // Unknown vendor specific property.
  416.     "sass.lint.unknownVendorSpecificProperties": "ignore",
  418.     // Property is ignored due to the display. E.g. with 'display: inline', the width, height, margin-top, margin-bottom, and float properties have no effect
  419.     "sass.lint.propertyIgnoredDueToDisplay": "warning",
  421.     // Avoid using !important. It is an indication that the specificity of the entire CSS has gotten out of control and needs to be refactored.
  422.     "sass.lint.important": "ignore",
  424.     // Avoid using 'float'. Floats lead to fragile CSS that is easy to break if one aspect of the layout changes.
  425.     "sass.lint.float": "ignore",
  427.     // Selectors should not contain IDs because these rules are too tightly coupled with the HTML.
  428.     "sass.lint.idSelector": "ignore",
  431.     //-------- TypeScript configuration --------
  433.     // Specifies the folder path containing the tsserver and lib*.d.ts files to use.
  434.     "typescript.tsdk": null,
  436.     // Complete functions with their parameter signature.
  437.     "typescript.useCodeSnippetsOnMethodSuggest": false,
  439.     // Enable / disable TypeScript validation
  440.     "typescript.validate.enable": true,
  442.     // Defines space handling after a comma delimiter
  443.     "typescript.format.insertSpaceAfterCommaDelimiter": true,
  445.     //  Defines space handling after a semicolon in a for statement
  446.     "typescript.format.insertSpaceAfterSemicolonInForStatements": true,
  448.     // Defines space handling after a binary operator
  449.     "typescript.format.insertSpaceBeforeAndAfterBinaryOperators": true,
  451.     // Defines space handling after keywords in control flow statement
  452.     "typescript.format.insertSpaceAfterKeywordsInControlFlowStatements": true,
  454.     // Defines space handling after function keyword for anonymous functions
  455.     "typescript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions": true,
  457.     // Defines space handling after opening and before closing non empty parenthesis
  458.     "typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
  460.     // Defines space handling after opening and before closing non empty brackets
  461.     "typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
  463.     // Defines whether an open brace is put onto a new line for functions or not
  464.     "typescript.format.placeOpenBraceOnNewLineForFunctions": false,
  466.     // Defines whether an open brace is put onto a new line for control blocks or not
  467.     "typescript.format.placeOpenBraceOnNewLineForControlBlocks": false,
  469.     // Enable / disable JavaScript validation
  470.     "javascript.validate.enable": true,
  472.     // Defines space handling after a comma delimiter
  473.     "javascript.format.insertSpaceAfterCommaDelimiter": true,
  475.     //  Defines space handling after a semicolon in a for statement
  476.     "javascript.format.insertSpaceAfterSemicolonInForStatements": true,
  478.     // Defines space handling after a binary operator
  479.     "javascript.format.insertSpaceBeforeAndAfterBinaryOperators": true,
  481.     // Defines space handling after keywords in control flow statement
  482.     "javascript.format.insertSpaceAfterKeywordsInControlFlowStatements": true,
  484.     // Defines space handling after function keyword for anonymous functions
  485.     "javascript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions": true,
  487.     // Defines space handling after opening and before closing non empty parenthesis
  488.     "javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
  490.     // Defines space handling after opening and before closing non empty brackets
  491.     "javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
  493.     // Defines whether an open brace is put onto a new line for functions or not
  494.     "javascript.format.placeOpenBraceOnNewLineForFunctions": false,
  496.     // Defines whether an open brace is put onto a new line for control blocks or not
  497.     "javascript.format.placeOpenBraceOnNewLineForControlBlocks": false,
  500.     //-------- PHP Configuration options --------
  502.     // Whether php validation is enabled or not.
  503.     "php.validate.enable": true,
  505.     // Points to the php executable.
  506.     "php.validate.executablePath": null,
  508.     // Whether the linter is run on save or on type.
  509.     "php.validate.run": "onSave"
  511. }

Common Questions

Q: When does it make sense to use workspace settings?

A: If you’re using a workspace that needs custom settings but you don’t want to apply them to your other VS Code projects. A good example is language-specific linting rules.