Merge pull request #62584 from ahoppen/ahoppen/lint-swiftsyntax

[build] Verify that SwiftSyntax is correctly formatted

Author: ahoppen

utils/build-presets.ini

@@ -1815,6 +1815,7 @@ release
 assertions
 swiftsyntax
 swiftsyntax-verify-generated-files
+swiftsyntax-lint
 swiftformat
 skstresstester
 swiftevolve
@@ -1828,6 +1829,7 @@ assertions
 swiftsyntax
 sourcekit-lsp
 swiftsyntax-verify-generated-files
+swiftsyntax-lint
 swiftformat
 
 #===------------------------------------------------------------------------===#
@@ -1838,13 +1840,17 @@ swiftformat
 mixin-preset=mixin_swiftpm_package_macos_platform
 release
 assertions
+swiftsyntax
 swiftformat
+swiftsyntax-lint
 
 [preset: buildbot_swiftformat_linux]
 mixin-preset=mixin_swiftpm_package_linux_platform
 release
 assertions
+swiftsyntax
 swiftformat
+swiftsyntax-lint
 
 #===------------------------------------------------------------------------===#
 # Test Swift Stress Tester

utils/build_swift/build_swift/driver_arguments.py

@@ -709,6 +709,9 @@ def create_argument_parser():
            toggle_true('swiftsyntax_verify_generated_files'),
            help='set to verify that the generated files in the source tree '
                 'match the ones that would be generated from current main')
+    option('--swiftsyntax-lint',
+           toggle_true('swiftsyntax_lint'),
+           help='verify that swift-syntax Source code is formatted correctly')
     option(['--install-sourcekit-lsp'], toggle_true('install_sourcekitlsp'),
            help='install SourceKitLSP')
     option(['--install-swiftformat'], toggle_true('install_swiftformat'),

utils/build_swift/tests/expected_options.py

@@ -108,6 +108,7 @@
     'install_swift_driver': False,
     'install_swiftdocc': False,
     'swiftsyntax_verify_generated_files': False,
+    'swiftsyntax_lint': False,
     'install_playgroundsupport': False,
     'install_sourcekitlsp': False,
     'install_swiftformat': False,
@@ -594,6 +595,8 @@ class BuildScriptImplOption(_BaseOption):
     EnableOption('--install-swiftsyntax', dest='install_swiftsyntax'),
     EnableOption('--swiftsyntax-verify-generated-files',
                  dest='swiftsyntax_verify_generated_files'),
+    EnableOption('--swiftsyntax-lint',
+                 dest='swiftsyntax_lint'),
     EnableOption('--install-swiftpm', dest='install_swiftpm'),
     EnableOption('--install-swift-driver', dest='install_swift_driver'),
     EnableOption('--install-sourcekit-lsp', dest='install_sourcekitlsp'),

utils/swift_build_support/swift_build_support/products/swiftformat.py

@@ -50,19 +50,20 @@ def is_before_build_script_impl_product(cls):
     def is_swiftpm_unified_build_product(cls):
         return True
 
+    def configuration(self):
+        return 'release' if self.is_release() else 'debug'
+
     def run_build_script_helper(self, action, host_target, additional_params=[]):
         script_path = os.path.join(
             self.source_dir, 'build-script-helper.py')
 
         install_destdir = self.host_install_destdir(host_target)
 
-        configuration = 'release' if self.is_release() else 'debug'
-
         helper_cmd = [
             script_path,
             action,
             '--toolchain', self.install_toolchain_path(host_target),
-            '--configuration', configuration,
+            '--configuration', self.configuration(),
             '--build-path', self.build_dir,
             '--multiroot-data-file', MULTIROOT_DATA_FILE_PATH,
             # There might have been a Package.resolved created by other builds
@@ -84,6 +85,17 @@ def should_build(self, host_target):
 
     def build(self, host_target):
         self.run_build_script_helper('build', host_target)
+        if self.args.swiftsyntax_lint:
+            self.lint_swiftsyntax()
+
+    def lint_swiftsyntax(self):
+        linting_cmd = [
+            os.path.join(os.path.dirname(self.source_dir), 'swift-syntax', 'format.py'),
+            '--lint',
+            '--swift-format', os.path.join(self.build_dir, self.configuration(),
+                                           'swift-format'),
+        ]
+        shell.call(linting_cmd)
 
     def should_test(self, host_target):
         return self.args.test_swiftformat