Skip to content

Commit 8c9acee

Browse files
plemarquandplemarquand
committed
Properly scope all settings
Be more explicit about settings scopes, marking appropriate ones as `application` (user settings applied across all swift projects) and `machine-overridable` (for per-project settings).
1 parent a671524 commit 8c9acee

File tree

1 file changed

+54
-27
lines changed

1 file changed

+54
-27
lines changed

‎package.json

Lines changed: 54 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -319,15 +319,17 @@
319319
"swift.path": {
320320
"type": "string",
321321
"default": "",
322-
"markdownDescription": "Override the default path of the folder containing the Swift executables. The default is to look in the `PATH` environment variable. This path is also used to search for other executables used by the extension like `sourcekit-lsp` and `lldb`."
322+
"markdownDescription": "Override the default path of the folder containing the Swift executables. The default is to look in the `PATH` environment variable. This path is also used to search for other executables used by the extension like `sourcekit-lsp` and `lldb`.",
323+
"scope": "machine-overridable"
323324
},
324325
"swift.buildArguments": {
325326
"type": "array",
326327
"default": [],
327328
"items": {
328329
"type": "string"
329330
},
330-
"markdownDescription": "Additional arguments to pass to `swift build` and `swift test`. Keys and values should be provided as individual entries in the list. If you have created a copy of the build task in `tasks.json` then these build arguments will not be propagated to that task."
331+
"markdownDescription": "Additional arguments to pass to `swift build` and `swift test`. Keys and values should be provided as individual entries in the list. If you have created a copy of the build task in `tasks.json` then these build arguments will not be propagated to that task.",
332+
"scope": "machine-overridable"
331333
},
332334
"swift.scriptSwiftLanguageVersion": {
333335
"type": "string",
@@ -353,7 +355,8 @@
353355
"items": {
354356
"type": "string"
355357
},
356-
"markdownDescription": "Additional arguments to pass to swift commands that do package resolution, such as `swift package resolve`, `swift package update`, `swift build` and `swift test`. Keys and values should be provided as individual entries in the list."
358+
"markdownDescription": "Additional arguments to pass to swift commands that do package resolution, such as `swift package resolve`, `swift package update`, `swift build` and `swift test`. Keys and values should be provided as individual entries in the list.",
359+
"scope": "machine-overridable"
357360
},
358361
"swift.additionalTestArguments": {
359362
"type": "array",
@@ -421,7 +424,8 @@
421424
"When merging diagnostics, give precedence to diagnostics from `swiftc`.",
422425
"When merging diagnostics, give precedence to diagnostics from `SourceKit`.",
423426
"Keep diagnostics from all providers."
424-
]
427+
],
428+
"scope": "machine-overridable"
425429
},
426430
"swift.diagnosticsStyle": {
427431
"type": "string",
@@ -436,12 +440,14 @@
436440
"Use whichever diagnostics style `swiftc` produces by default.",
437441
"Use the `llvm` diagnostic style. This allows the parsing of \"notes\".",
438442
"Use the `swift` diagnostic style. This means that \"notes\" will not be parsed. This option has no effect in Swift versions prior to 5.10."
439-
]
443+
],
444+
"scope": "machine-overridable"
440445
},
441446
"swift.backgroundCompilation": {
442447
"type": "boolean",
443448
"default": false,
444-
"markdownDescription": "**Experimental**: Run `swift build` in the background whenever a file is saved. It is possible the background compilation will already be running when you attempt a compile yourself, so this is disabled by default."
449+
"markdownDescription": "**Experimental**: Run `swift build` in the background whenever a file is saved. It is possible the background compilation will already be running when you attempt a compile yourself, so this is disabled by default.",
450+
"scope": "machine-overridable"
445451
},
446452
"swift.actionAfterBuildError": {
447453
"type": "string",
@@ -455,17 +461,20 @@
455461
"Focus on Problems View",
456462
"Focus on Build Task Terminal"
457463
],
458-
"markdownDescription": "Action after a Build task generates errors."
464+
"markdownDescription": "Action after a Build task generates errors.",
465+
"scope": "application"
459466
},
460467
"swift.buildPath": {
461468
"type": "string",
462469
"default": "",
463-
"markdownDescription": "The path to a directory that will be used for build artifacts. This path will be added to all swift package manager commands that are executed by vscode-swift extension via `--scratch-path` option. When no value provided - nothing gets passed to swift package manager and it will use its default value of `.build` folder in the workspace.\n\nYou can use absolute path for directory or the relative path, which will use the workspace path as a base. Note that VS Code does not respect tildes (`~`) in paths which represents user home folder under *nix systems."
470+
"markdownDescription": "The path to a directory that will be used for build artifacts. This path will be added to all swift package manager commands that are executed by vscode-swift extension via `--scratch-path` option. When no value provided - nothing gets passed to swift package manager and it will use its default value of `.build` folder in the workspace.\n\nYou can use absolute path for directory or the relative path, which will use the workspace path as a base. Note that VS Code does not respect tildes (`~`) in paths which represents user home folder under *nix systems.",
471+
"scope": "machine-overridable"
464472
},
465473
"swift.disableSwiftPackageManagerIntegration": {
466474
"type": "boolean",
467475
"default": false,
468-
"markdownDescription": "Disables automated Build Tasks, Package Dependency view, Launch configuration generation and TestExplorer."
476+
"markdownDescription": "Disables automated Build Tasks, Package Dependency view, Launch configuration generation and TestExplorer.",
477+
"scope": "machine-overridable"
469478
},
470479
"swift.warnAboutSymlinkCreation": {
471480
"type": "boolean",
@@ -476,7 +485,8 @@
476485
"swift.enableTerminalEnvironment": {
477486
"type": "boolean",
478487
"default": true,
479-
"markdownDescription": "Controls whether or not the extension will contribute environment variables defined in `Swift: Environment Variables` to the integrated terminal. If this is set to `true` and a custom `Swift: Path` is also set then the swift path is appended to the terminal's `PATH`."
488+
"markdownDescription": "Controls whether or not the extension will contribute environment variables defined in `Swift: Environment Variables` to the integrated terminal. If this is set to `true` and a custom `Swift: Path` is also set then the swift path is appended to the terminal's `PATH`.",
489+
"scope": "application"
480490
},
481491
"swift.pluginArguments": {
482492
"default": [],
@@ -559,7 +569,8 @@
559569
"items": {
560570
"type": "string"
561571
},
562-
"default": []
572+
"default": [],
573+
"scope": "machine-overridable"
563574
}
564575
}
565576
},
@@ -592,12 +603,14 @@
592603
"Show the Swift build status in a status bar item provided by the Swift extension.",
593604
"Show the Swift build status in the \"Progress Message\" status bar item provided by VS Code.",
594605
"Show the Swift build status as a progress notification."
595-
]
606+
],
607+
"scope": "application"
596608
},
597609
"swift.showCreateSwiftProjectInWelcomePage": {
598610
"type": "boolean",
599611
"default": true,
600-
"markdownDescription": "Controls whether or not the create new swift project button appears in the welcome page."
612+
"markdownDescription": "Controls whether or not the create new swift project button appears in the welcome page.",
613+
"scope": "application"
601614
},
602615
"swift.openAfterCreateNewProject": {
603616
"type": "string",
@@ -614,7 +627,8 @@
614627
"Always prompt for action."
615628
],
616629
"default": "prompt",
617-
"markdownDescription": "Controls whether to open a swift project automatically after creating it."
630+
"markdownDescription": "Controls whether to open a swift project automatically after creating it.",
631+
"scope": "application"
618632
}
619633
}
620634
},
@@ -656,7 +670,8 @@
656670
"cpp"
657671
]
658672
},
659-
"order": 3
673+
"order": 3,
674+
"scope": "machine-overridable"
660675
},
661676
"swift.sourcekit-lsp.backgroundIndexing": {
662677
"type": "string",
@@ -667,7 +682,8 @@
667682
],
668683
"default": "auto",
669684
"markdownDescription": "Turns background indexing `on` or `off`. `auto` will enable background indexing if the Swift version is >= 6.1. This option has no effect in Swift versions prior to 6.0.",
670-
"order": 4
685+
"order": 4,
686+
"scope": "machine-overridable"
671687
},
672688
"swift.sourcekit-lsp.trace.server": {
673689
"type": "string",
@@ -678,13 +694,15 @@
678694
"verbose"
679695
],
680696
"markdownDescription": "Controls logging the communication between VS Code and the SourceKit-LSP language server. Logs can be viewed in Output > SourceKit Language Server.",
681-
"order": 5
697+
"order": 5,
698+
"scope": "machine-overridable"
682699
},
683700
"swift.sourcekit-lsp.disable": {
684701
"type": "boolean",
685702
"default": false,
686703
"markdownDescription": "Disable SourceKit-LSP. This will turn off features like code completion, error diagnostics and jump-to-definition. Features like swift-testing test discovery will not work correctly.",
687-
"order": 6
704+
"order": 6,
705+
"scope": "machine-overridable"
688706
},
689707
"sourcekit-lsp.inlayHints.enabled": {
690708
"type": "boolean",
@@ -758,13 +776,15 @@
758776
"Use the CodeLLDB extension's debug adapter."
759777
],
760778
"markdownDescription": "Select which debug adapter to use to debug Swift executables.",
761-
"order": 1
779+
"order": 1,
780+
"scope": "machine-overridable"
762781
},
763782
"swift.debugger.path": {
764783
"type": "string",
765784
"default": "",
766785
"markdownDescription": "Path to lldb debug adapter.",
767-
"order": 2
786+
"order": 2,
787+
"scope": "machine-overridable"
768788
},
769789
"swift.debugger.setupCodeLLDB": {
770790
"type": "string",
@@ -782,7 +802,8 @@
782802
"Never automatically update CodeLLDB settings when they are incorrect."
783803
],
784804
"markdownDescription": "Choose how CodeLLDB settings are updated when debugging Swift executables.",
785-
"order": 3
805+
"order": 3,
806+
"scope": "application"
786807
},
787808
"swift.debugger.useDebugAdapterFromToolchain": {
788809
"type": "boolean",
@@ -805,36 +826,42 @@
805826
},
806827
"default": {},
807828
"markdownDescription": "Additional environment variables to pass to swift operations (`swift build`, `swift resolve`, etc...).",
808-
"order": 1
829+
"order": 1,
830+
"scope": "machine-overridable"
809831
},
810832
"swift.runtimePath": {
811833
"type": "string",
812834
"default": "",
813835
"markdownDescription": "The path of the folder containing the Swift runtime libraries. This is of use when supporting non-standard SDK layouts on Windows. On Windows the runtime path is added to the `Path` environment variable. This is of less use on macOS and Linux but will be added to `DYLD_LIBRARY_PATH` and `LD_LIBRARY_PATH` environment variables respectively on each platform. ",
814-
"order": 2
836+
"order": 2,
837+
"scope": "machine-overridable"
815838
},
816839
"swift.SDK": {
817840
"type": "string",
818841
"default": "",
819842
"markdownDescription": "The path of the SDK to compile against (`--sdk` parameter). This is of use when supporting non-standard SDK layouts on Windows and using custom SDKs. The default SDK is determined by the environment on macOS and Windows.\n\nFor SwiftPM projects, prefer using `swift.swiftSDK` with a triple (such as `arm64-apple-ios`) or Swift SDK name instead.",
820-
"order": 3
843+
"order": 3,
844+
"scope": "machine-overridable"
821845
},
822846
"swift.swiftSDK": {
823847
"type": "string",
824848
"default": "",
825-
"markdownDescription": "The [Swift SDK](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md) to compile against (`--swift-sdk` parameter)."
849+
"markdownDescription": "The [Swift SDK](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md) to compile against (`--swift-sdk` parameter).",
850+
"scope": "machine-overridable"
826851
},
827852
"swift.disableSandox": {
828853
"type": "boolean",
829854
"default": false,
830855
"markdownDescription": "Disable sandboxing when running SwiftPM commands. In most cases you should keep the sandbox enabled and leave this setting set to `false`",
831-
"order": 4
856+
"order": 4,
857+
"scope": "machine-overridable"
832858
},
833859
"swift.diagnostics": {
834860
"type": "boolean",
835861
"default": false,
836862
"markdownDescription": "Output additional diagnostics to the Swift Output View.",
837-
"order": 100
863+
"order": 100,
864+
"scope": "machine-overridable"
838865
}
839866
}
840867
}

0 commit comments

Comments
 (0)