Test Settings

[sandy081]

Test for #28538

• Windows - @dbaeumer
• OS X - @weinand
• Linux - @Lixire

Complexity: 4

No Workspace

• Settings are read and applied from Default / User settings. Make sure user settings override defaults.
• Update User settings and verify the update.
• Update settings using User actions like Toggling Sidebar Visibility and verify updates
• Write a simple extension and verify
  -- Settings are read and inspected (Default / User) correctly
  -- Settings can be update correctly. Writing into workspace context should fail.

Single root Workspace

• Settings are read and applied from Default / User / Workspace settings. Make sure workspace settings override user settings and default settings.
• Update User settings and Workspace settings and verify the updates.
• Update settings using User actions and verify updates
  -- Have files.associations setting in Workspace scope and try to update the file association using the language mode on the status bar. Verify workspace setting is updated.
• Write a simple extension and verify
  -- Settings are read and inspected (Default / User / Workspace) correctly
  -- Settings can be update correctly

Multi root Workspace

• Please go through the comment to know how Settings in multi-root workspace works

In brief, currently supported Folder scoped settings

editor.*
files.exclude
files.trimTrailingWhitespace
files.insertFinalNewLine
files.encoding
files.autoGuessEncoding
files.watcherExclude
search.exclude

Rest are Workspace scoped settings.

Source of Settings are

• Defaults come from Default settings
• User settings come from User settings file
• Workspace settings come from Settings file of first root folder excluding Folder scoped settings
• Folder settings come from Settings file of root folders excluding Workspace scoped settings.

Verify:

• Default setting is applied to all folders unless overridden
• User setting is applied to all folders unless overridden
• Workspace setting is applied to all folders unless overridden
• Folder settings are applied only to themseleves.
• Write a simple extension which is multi root aware
  • Copy vscode.proposed.d.ts into your extension.
  • Enable your extension to use proposed api by adding "enableProposedApi": true to package.json
  • Use the proposed API workspace.getConfiguration2()to read settings. Make sure you are able to get and inspect settings from different folders.
• Try to pass a resource belongs/ do not belongs to one of the root folders to the above API and verify getting and inspecting configuration.

NOTE: If the root folder does not have a .vscode folder and settings.json file under it, you have to manually create them so that you can add folder settings.

[sandy081]

@weinand Please use the following build for testing

https://az764295.vo.msecnd.net/insider/93b6aa7e167cba6d629df0eae51137303b54afc4/VSCode-darwin-insider.zip

Reason being, current insiders build does not has support for following. Where as the above build has.

• files.trimTrailingWhitespace
• files.insertFinalNewLine
• files.encoding
• files.autoGuessEncoding
• files.watcherExclude
• search.exclude