|
320 | 320 | "swift.path": {
|
321 | 321 | "type": "string",
|
322 | 322 | "default": "",
|
323 |
| - "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 | + "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`.", |
| 324 | + "scope": "machine-overridable" |
324 | 325 | },
|
325 | 326 | "swift.buildArguments": {
|
326 | 327 | "type": "array",
|
327 | 328 | "default": [],
|
328 | 329 | "items": {
|
329 | 330 | "type": "string"
|
330 | 331 | },
|
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 | + "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.", |
| 333 | + "scope": "machine-overridable" |
332 | 334 | },
|
333 | 335 | "swift.scriptSwiftLanguageVersion": {
|
334 | 336 | "type": "string",
|
|
354 | 356 | "items": {
|
355 | 357 | "type": "string"
|
356 | 358 | },
|
357 |
| - "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 | + "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.", |
| 360 | + "scope": "machine-overridable" |
358 | 361 | },
|
359 | 362 | "swift.additionalTestArguments": {
|
360 | 363 | "type": "array",
|
|
422 | 425 | "When merging diagnostics, give precedence to diagnostics from `swiftc`.",
|
423 | 426 | "When merging diagnostics, give precedence to diagnostics from `SourceKit`.",
|
424 | 427 | "Keep diagnostics from all providers."
|
425 |
| - ] |
| 428 | + ], |
| 429 | + "scope": "machine-overridable" |
426 | 430 | },
|
427 | 431 | "swift.diagnosticsStyle": {
|
428 | 432 | "type": "string",
|
|
437 | 441 | "Use whichever diagnostics style `swiftc` produces by default.",
|
438 | 442 | "Use the `llvm` diagnostic style. This allows the parsing of \"notes\".",
|
439 | 443 | "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."
|
440 |
| - ] |
| 444 | + ], |
| 445 | + "scope": "machine-overridable" |
441 | 446 | },
|
442 | 447 | "swift.backgroundCompilation": {
|
443 | 448 | "type": "boolean",
|
444 | 449 | "default": false,
|
445 |
| - "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 | + "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.", |
| 451 | + "scope": "machine-overridable" |
446 | 452 | },
|
447 | 453 | "swift.actionAfterBuildError": {
|
448 | 454 | "type": "string",
|
|
456 | 462 | "Focus on Problems View",
|
457 | 463 | "Focus on Build Task Terminal"
|
458 | 464 | ],
|
459 |
| - "markdownDescription": "Action after a Build task generates errors." |
| 465 | + "markdownDescription": "Action after a Build task generates errors.", |
| 466 | + "scope": "application" |
460 | 467 | },
|
461 | 468 | "swift.buildPath": {
|
462 | 469 | "type": "string",
|
463 | 470 | "default": "",
|
464 |
| - "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 | + "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.", |
| 472 | + "scope": "machine-overridable" |
465 | 473 | },
|
466 | 474 | "swift.disableSwiftPackageManagerIntegration": {
|
467 | 475 | "type": "boolean",
|
468 | 476 | "default": false,
|
469 |
| - "markdownDescription": "Disables automated Build Tasks, Package Dependency view, Launch configuration generation and TestExplorer." |
| 477 | + "markdownDescription": "Disables automated Build Tasks, Package Dependency view, Launch configuration generation and TestExplorer.", |
| 478 | + "scope": "machine-overridable" |
470 | 479 | },
|
471 | 480 | "swift.warnAboutSymlinkCreation": {
|
472 | 481 | "type": "boolean",
|
|
477 | 486 | "swift.enableTerminalEnvironment": {
|
478 | 487 | "type": "boolean",
|
479 | 488 | "default": true,
|
480 |
| - "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 | + "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`.", |
| 490 | + "scope": "application" |
481 | 491 | },
|
482 | 492 | "swift.pluginArguments": {
|
483 | 493 | "default": [],
|
|
560 | 570 | "items": {
|
561 | 571 | "type": "string"
|
562 | 572 | },
|
563 |
| - "default": [] |
| 573 | + "default": [], |
| 574 | + "scope": "machine-overridable" |
564 | 575 | }
|
565 | 576 | }
|
566 | 577 | },
|
|
594 | 605 | "Show the Swift build status in a status bar item provided by the Swift extension.",
|
595 | 606 | "Show the Swift build status in the \"Progress Message\" status bar item provided by VS Code.",
|
596 | 607 | "Show the Swift build status as a progress notification."
|
597 |
| - ] |
| 608 | + ], |
| 609 | + "scope": "application" |
598 | 610 | },
|
599 | 611 | "swift.showCreateSwiftProjectInWelcomePage": {
|
600 | 612 | "type": "boolean",
|
601 | 613 | "default": true,
|
602 |
| - "markdownDescription": "Controls whether or not the create new swift project button appears in the welcome page." |
| 614 | + "markdownDescription": "Controls whether or not the create new swift project button appears in the welcome page.", |
| 615 | + "scope": "application" |
603 | 616 | },
|
604 | 617 | "swift.openAfterCreateNewProject": {
|
605 | 618 | "type": "string",
|
|
616 | 629 | "Always prompt for action."
|
617 | 630 | ],
|
618 | 631 | "default": "prompt",
|
619 |
| - "markdownDescription": "Controls whether to open a swift project automatically after creating it." |
| 632 | + "markdownDescription": "Controls whether to open a swift project automatically after creating it.", |
| 633 | + "scope": "application" |
620 | 634 | }
|
621 | 635 | }
|
622 | 636 | },
|
|
658 | 672 | "cpp"
|
659 | 673 | ]
|
660 | 674 | },
|
661 |
| - "order": 3 |
| 675 | + "order": 3, |
| 676 | + "scope": "machine-overridable" |
662 | 677 | },
|
663 | 678 | "swift.sourcekit-lsp.backgroundIndexing": {
|
664 | 679 | "type": "string",
|
|
669 | 684 | ],
|
670 | 685 | "default": "auto",
|
671 | 686 | "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.",
|
672 |
| - "order": 4 |
| 687 | + "order": 4, |
| 688 | + "scope": "machine-overridable" |
673 | 689 | },
|
674 | 690 | "swift.sourcekit-lsp.trace.server": {
|
675 | 691 | "type": "string",
|
|
680 | 696 | "verbose"
|
681 | 697 | ],
|
682 | 698 | "markdownDescription": "Controls logging the communication between VS Code and the SourceKit-LSP language server. Logs can be viewed in Output > SourceKit Language Server.",
|
683 |
| - "order": 5 |
| 699 | + "order": 5, |
| 700 | + "scope": "machine-overridable" |
684 | 701 | },
|
685 | 702 | "swift.sourcekit-lsp.disable": {
|
686 | 703 | "type": "boolean",
|
687 | 704 | "default": false,
|
688 | 705 | "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.",
|
689 |
| - "order": 6 |
| 706 | + "order": 6, |
| 707 | + "scope": "machine-overridable" |
690 | 708 | },
|
691 | 709 | "sourcekit-lsp.inlayHints.enabled": {
|
692 | 710 | "type": "boolean",
|
|
760 | 778 | "Use the CodeLLDB extension's debug adapter."
|
761 | 779 | ],
|
762 | 780 | "markdownDescription": "Select which debug adapter to use to debug Swift executables.",
|
763 |
| - "order": 1 |
| 781 | + "order": 1, |
| 782 | + "scope": "machine-overridable" |
764 | 783 | },
|
765 | 784 | "swift.debugger.path": {
|
766 | 785 | "type": "string",
|
767 | 786 | "default": "",
|
768 | 787 | "markdownDescription": "Path to lldb debug adapter.",
|
769 |
| - "order": 2 |
| 788 | + "order": 2, |
| 789 | + "scope": "machine-overridable" |
770 | 790 | },
|
771 | 791 | "swift.debugger.setupCodeLLDB": {
|
772 | 792 | "type": "string",
|
|
784 | 804 | "Never automatically update CodeLLDB settings when they are incorrect."
|
785 | 805 | ],
|
786 | 806 | "markdownDescription": "Choose how CodeLLDB settings are updated when debugging Swift executables.",
|
787 |
| - "order": 3 |
| 807 | + "order": 3, |
| 808 | + "scope": "machine-overridable" |
788 | 809 | },
|
789 | 810 | "swift.debugger.useDebugAdapterFromToolchain": {
|
790 | 811 | "type": "boolean",
|
|
807 | 828 | },
|
808 | 829 | "default": {},
|
809 | 830 | "markdownDescription": "Additional environment variables to pass to swift operations (`swift build`, `swift resolve`, etc...).",
|
810 |
| - "order": 1 |
| 831 | + "order": 1, |
| 832 | + "scope": "machine-overridable" |
811 | 833 | },
|
812 | 834 | "swift.runtimePath": {
|
813 | 835 | "type": "string",
|
814 | 836 | "default": "",
|
815 | 837 | "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. ",
|
816 |
| - "order": 2 |
| 838 | + "order": 2, |
| 839 | + "scope": "machine-overridable" |
817 | 840 | },
|
818 | 841 | "swift.SDK": {
|
819 | 842 | "type": "string",
|
820 | 843 | "default": "",
|
821 | 844 | "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.",
|
822 |
| - "order": 3 |
| 845 | + "order": 3, |
| 846 | + "scope": "machine-overridable" |
823 | 847 | },
|
824 | 848 | "swift.swiftSDK": {
|
825 | 849 | "type": "string",
|
826 | 850 | "default": "",
|
827 |
| - "markdownDescription": "The [Swift SDK](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md) to compile against (`--swift-sdk` parameter)." |
| 851 | + "markdownDescription": "The [Swift SDK](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md) to compile against (`--swift-sdk` parameter).", |
| 852 | + "scope": "machine-overridable" |
828 | 853 | },
|
829 | 854 | "swift.disableSandox": {
|
830 | 855 | "type": "boolean",
|
831 | 856 | "default": false,
|
832 | 857 | "markdownDescription": "Disable sandboxing when running SwiftPM commands. In most cases you should keep the sandbox enabled and leave this setting set to `false`",
|
833 |
| - "order": 4 |
| 858 | + "order": 4, |
| 859 | + "scope": "machine-overridable" |
834 | 860 | },
|
835 | 861 | "swift.diagnostics": {
|
836 | 862 | "type": "boolean",
|
837 | 863 | "default": false,
|
838 | 864 | "markdownDescription": "Output additional diagnostics to the Swift Output View.",
|
839 |
| - "order": 100 |
| 865 | + "order": 100, |
| 866 | + "scope": "machine-overridable" |
840 | 867 | }
|
841 | 868 | }
|
842 | 869 | }
|
|
0 commit comments