Skip to content

Commit f7d02ac

Browse files
committed
Update settings docs
1 parent 5054301 commit f7d02ac

1 file changed

Lines changed: 42 additions & 8 deletions

File tree

_docs/settings.md

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Whether to show a notification the first few times an Analysis Server exception
4141
### dart.onlyAnalyzeProjectsWithOpenFiles
4242
**Default:** `false`.
4343
<br />
44-
Whether to ignore workspace folders and perform analysis based on the open files, as if no workspace was open at all. This allows opening large folders without causing them to be completely analyzed.
44+
Whether to ignore workspace folders and perform analysis based on the open files, as if no workspace was open at all. This allows opening very large folders without causing them to be fully analyzed but will result a lot of re-analysis as files are opened/closed. This is **not** recommended for small or medium sized workspaces, only very large workspaces where you are working in only a small part.
4545

4646
### dart.showExtensionRecommendations
4747
**Default:** `true`.
@@ -183,6 +183,11 @@ Whether to use code snippets from the Dart Analysis Server instead of those incl
183183
<br />
184184
Whether to include Dart and Flutter snippets in code completion.
185185

186+
### dart.inlayHints
187+
**Default:** `true`.
188+
<br />
189+
Whether to show Inlay Hints. When set to `true`, enables all inlay hints with default settings. When set to `false`, disables all inlay hints. Can also be an object to configure individual hint types. Requires Dart 3.10.
190+
186191
### dart.lspSnippetTextEdits
187192
**Default:** `true`.
188193
<br />
@@ -334,6 +339,16 @@ Sets the [Web renderer](https://flutter.dev/to/web-renderers) used for Flutter w
334339
- `html` - Always use the HTML renderer.
335340
- `auto` - Use Flutter's "auto" renderer option to pick the best renderer based on the users device.
336341

342+
### dart.flutterWidgetPreviewLocation
343+
**Options:** `"beside"` or `"sidebar"`.
344+
<br />
345+
**Default:** `"sidebar"`.
346+
<br />
347+
Where to display the Flutter Widget Preview.
348+
349+
- `beside` - Open the Flutter Widget Preview beside the active editor.
350+
- `sidebar` - Open the Flutter Widget Preview in the sidebar.
351+
337352
### dart.hotReloadOnSave
338353
**Options:** `"never"`, `"manual"`, `"manualIfDirty"`, `"all"` or `"allIfDirty"`.
339354
<br />
@@ -352,6 +367,11 @@ Whether to automatically send a Hot Reload request to Dart apps during a debug s
352367
<br />
353368
Whether to use the --offline switch for commands like `pub get` and **Flutter: New Project**.
354369

370+
### dart.useFlutterDev
371+
**Default:** `false`.
372+
<br />
373+
Whether to use `flutter-dev` instead of `flutter`. This is a script for developers of the `flutter` tool to run from source and will run more slowly than the compiled tool.
374+
355375
## Logging
356376

357377
### dart.maxCompletionItems
@@ -460,10 +480,15 @@ Whether to add your selected Dart/Flutter SDK path to the `PATH` environment var
460480
Whether to check you are using the latest version of the Dart SDK at startup.
461481

462482
### dart.mcpServer
463-
**Default:** `false`.
483+
**Default:** `true`.
464484
<br />
465485
Whether to register the Dart SDK's MCP server with VS Code. This only applies to Dart SDKs >= v3.9.0 which added the server.
466486

487+
### dart.mcpServerTools
488+
**Default:** `{run_tests: false}`.
489+
<br />
490+
A map of MCP tool names to booleans to enable/disable specific tools from the Dart MCP server. Tools set to `false` will be excluded (if supported). By default, tools that overlap with built-in VS Code functionality will be excluded.
491+
467492
### dart.sdkSwitchingTarget
468493
**Options:** `"workspace"` or `"global"`.
469494
<br />
@@ -481,6 +506,9 @@ Where to save SDK selections when using fast SDK switching from the language sta
481506
<br />
482507
Whether to consider files ending `_test.dart` that are outside of the test directory as tests. This should be enabled if you put tests inside the `lib` directory of your Flutter app so they will be run with `flutter test` and not `flutter run`.
483508

509+
### dart.coverageExcludePatterns
510+
An array of glob patterns to exclude from code coverage results. Paths matching any of these patterns will still be collected by the Dart VM but not be included in coverage reported to VS Code.
511+
484512
### dart.openTestView
485513
**Default:** `[testRunStart]`.
486514
<br />
@@ -508,7 +536,7 @@ Additional environment variables to be added to all Dart/Flutter processes spawn
508536
### dart.projectSearchDepth
509537
**Default:** `5`.
510538
<br />
511-
How many levels (including the workspace roots) down the workspace to search for Dart/Flutter projects. Increasing this number may help detect Flutter projects that are deeply nested in your workspace but slow down all operations that search for projects, including extension activation.
539+
How many levels (including the workspace roots) down the workspace to search for Dart/Flutter projects. Increasing this number may help detect Flutter projects that are deeply nested in your workspace but slow down all operations that search for projects, including extension activation (requires restart).
512540

513541
### dart.toolingDaemonAdditionalArgs
514542
Additional args to pass to the `dart tooling-daemon` command that runs as a background service (requires restart).
@@ -525,6 +553,11 @@ Whether to enable experimental (possibly unfinished or unstable) LSP handlers th
525553
<br />
526554
Whether to enable experimental (possibly unfinished or unstable) refactors on the lightbulb menu. This setting is intended for use by Dart Analysis Server developers or users that want to try out and provide feedback on in-progress refactors.
527555

556+
### dart.experimentalTestTracking
557+
**Default:** `false`.
558+
<br />
559+
Whether to enable experimental tracking of test locations. This may improve the experience when using packages like `pkg:test_reflective_loader` where tests are only discovered during test runs and not during coding.
560+
528561
### dart.normalizeFileCasing
529562
**Default:** `false`.
530563
<br />
@@ -578,11 +611,6 @@ Whether to enable analysis for AngularDart templates (requires the Angular analy
578611

579612
Whether to update DevTools if you are not using the latest version.
580613

581-
### dart.useLegacyDebugAdapters
582-
**LEGACY SETTING: Legacy debug adapters are not recommended since Dart v3.4.**
583-
584-
Whether to use the legacy debug adapters even if the new debug adapters are available in the current Dart/Flutter SDKs contain. Setting the value to `true` will force use of the legacay adapters. Setting to `false` will force use of the SDK adapters. Leaving as `null` will allow the extension to decide which debug adapters to use depending on the SDK version and rollout progress.
585-
586614
# Resource Scoped Settings
587615

588616
Resource scoped settings can be set in individual workspace folder settings and apply to resources within that workspace folder (for example each workspace folder could have its own `dart.lineLength`).
@@ -788,6 +816,12 @@ The path to a low-traffic log file for basic extension and editor issues. Use `$
788816
### dart.flutterDaemonLogFile
789817
The path to a log file for the `flutter daemon` service, which provides information about connected devices accessible from the status bar. Use `${workspaceName}` to insert the name of the current workspace in the file path. Use `~` to insert the user's home directory (the path should then use `/` separators even on Windows). Only the noted substitutions are supported, others will stay as-is. For more information on capturing these logs, see [Flutter Daemon Logging](/docs/logging/#flutter-daemon).
790818

819+
### dart.flutterWidgetPreviewLogFile
820+
The path to a log file for the `flutter widget-preview` service. Use `${workspaceName}` to insert the name of the current workspace in the file path. Use `~` to insert the user's home directory (the path should then use `/` separators even on Windows). Only the noted substitutions are supported, others will stay as-is.
821+
822+
### dart.mcpServerLogFile
823+
The path to a log file for the Dart SDK's MCP server. Use `${workspaceName}` to insert the name of the current workspace in the file path. Use `~` to insert the user's home directory (the path should then use `/` separators even on Windows). Only the noted substitutions are supported, others will stay as-is.
824+
791825
### dart.toolingDaemonLogFile
792826
The path to a log file for the `dart tooling-daemon` service, which coordinates between various Dart and Flutter tools and extensions. Use `${workspaceName}` to insert the name of the current workspace in the file path. Use `~` to insert the user's home directory (the path should then use `/` separators even on Windows). Only the noted substitutions are supported, others will stay as-is.
793827

0 commit comments

Comments
 (0)