[build] Verify that SourceKit-LSP is correctly formatted

In sourcekit-lsp and swift-format, run swift-format on the sourcekit-lsp sources to make sure it’s correctly formatted.

Author: ahoppen

utils/build-presets.ini

@@ -1884,6 +1884,7 @@ assertions
 swiftsyntax
 swiftformat
 swiftsyntax-lint
+sourcekit-lsp-lint
 
 [preset: buildbot_swiftformat_linux]
 mixin-preset=mixin_swiftpm_package_linux_platform
@@ -1915,6 +1916,8 @@ mixin-preset=mixin_swiftpm_package_macos_platform
 release
 assertions
 sourcekit-lsp
+swiftformat
+sourcekit-lsp-lint
 
 [preset: buildbot_sourcekitlsp_linux,no_sanitize]
 mixin-preset=mixin_swiftpm_package_linux_platform

utils/build_swift/build_swift/driver_arguments.py

@@ -709,6 +709,9 @@ def create_argument_parser():
     option('--test-sourcekit-lsp-sanitize-all',
            toggle_true('test_sourcekitlsp_sanitize_all'),
            help='run sourcekit-lsp tests under all sanitizers')
+    option('--sourcekit-lsp-lint',
+           toggle_true('sourcekitlsp_lint'),
+           help='verify that sourcekit-lsp Source code is formatted correctly')
     option('--install-swiftsyntax', toggle_true('install_swiftsyntax'),
            help='install SwiftSyntax')
     option('--swiftsyntax-verify-generated-files',

utils/build_swift/tests/expected_options.py

@@ -104,6 +104,7 @@
     'test_indexstoredb_sanitize_all': False,
     'test_sourcekitlsp_sanitize_all': False,
     'build_sourcekitlsp': False,
+    'sourcekitlsp_lint': False,
     'install_llvm': False,
     'install_swiftpm': False,
     'install_swiftsyntax': False,
@@ -609,6 +610,8 @@ class BuildScriptImplOption(_BaseOption):
     EnableOption('--sourcekit-lsp', dest='build_sourcekitlsp'),
     EnableOption('--test-sourcekit-lsp-sanitize-all',
                  dest='test_sourcekitlsp_sanitize_all'),
+    EnableOption('--sourcekit-lsp-lint',
+                 dest='sourcekitlsp_lint'),
     EnableOption('--install-llvm', dest='install_llvm'),
     EnableOption('--install-swiftsyntax', dest='install_swiftsyntax'),
     EnableOption('--swiftsyntax-verify-generated-files',

utils/swift_build_support/swift_build_support/products/swiftformat.py

@@ -87,6 +87,8 @@ def build(self, host_target):
         self.run_build_script_helper('build', host_target)
         if self.args.swiftsyntax_lint:
             self.lint_swiftsyntax()
+        if self.args.sourcekitlsp_lint:
+            self.lint_sourcekitlsp()
 
     def lint_swiftsyntax(self):
         linting_cmd = [
@@ -97,6 +99,17 @@ def lint_swiftsyntax(self):
         ]
         shell.call(linting_cmd)
 
+    def lint_sourcekitlsp(self):
+        linting_cmd = [
+            os.path.join(self.build_dir, self.configuration(), 'swift-format'),
+            'lint',
+            '--parallel',
+            '--strict',
+            '--recursive',
+            os.path.join(os.path.dirname(self.source_dir), 'sourcekit-lsp'),
+        ]
+        shell.call(linting_cmd)
+
     def should_test(self, host_target):
         return self.args.test_swiftformat