Replace newlines with spaces in property descriptions

Author: kateinoigakukun

Documentation/Configuration File.md

@@ -15,22 +15,16 @@ The structure of the file is currently not guaranteed to be stable. Options may
 
 `config.json` is a JSON file with the following structure. All keys are optional and unknown keys are ignored.
 - `swiftPM`: Options for SwiftPM workspaces.
-  - `configuration: "debug"|"release"`: The configuration to build the project for during background indexing
-    and the configuration whose build folder should be used for Swift
-    modules if background indexing is disabled.
-    Equivalent to SwiftPM's `--configuration` option.
-  - `scratchPath: string`: Build artifacts directory path. If nil, the build system may choose a default value.
-    This path can be specified as a relative path, which will be interpreted relative to the project root.
-    Equivalent to SwiftPM's `--scratch-path` option.
+  - `configuration: "debug"|"release"`: The configuration to build the project for during background indexing and the configuration whose build folder should be used for Swift modules if background indexing is disabled. Equivalent to SwiftPM's `--configuration` option.
+  - `scratchPath: string`: Build artifacts directory path. If nil, the build system may choose a default value. This path can be specified as a relative path, which will be interpreted relative to the project root. Equivalent to SwiftPM's `--scratch-path` option.
   - `swiftSDKsDirectory: string`: Equivalent to SwiftPM's `--swift-sdks-path` option.
   - `swiftSDK: string`: Equivalent to SwiftPM's `--swift-sdk` option.
   - `triple: string`: Equivalent to SwiftPM's `--triple` option.
   - `cCompilerFlags: string[]`: Extra arguments passed to the compiler for C files. Equivalent to SwiftPM's `-Xcc` option.
   - `cxxCompilerFlags: string[]`: Extra arguments passed to the compiler for C++ files. Equivalent to SwiftPM's `-Xcxx` option.
   - `swiftCompilerFlags: string[]`: Extra arguments passed to the compiler for Swift files. Equivalent to SwiftPM's `-Xswiftc` option.
   - `linkerFlags: string[]`: Extra arguments passed to the linker. Equivalent to SwiftPM's `-Xlinker` option.
-  - `disableSandbox: boolean`: Disables running subprocesses from SwiftPM in a sandbox. Equivalent to SwiftPM's `--disable-sandbox` option.
-    Useful when running `sourcekit-lsp` in a sandbox because nested sandboxes are not supported.
+  - `disableSandbox: boolean`: Disables running subprocesses from SwiftPM in a sandbox. Equivalent to SwiftPM's `--disable-sandbox` option. Useful when running `sourcekit-lsp` in a sandbox because nested sandboxes are not supported.
 - `compilationDatabase`: Dictionary with the following keys, defining options for workspaces with a compilation database.
   - `searchPaths: string[]`: Additional paths to search for a compilation database, relative to a workspace root.
 - `fallbackBuildSystem`: Dictionary with the following keys, defining options for files that aren't managed by any build system.
@@ -46,32 +40,16 @@ The structure of the file is currently not guaranteed to be stable. Options may
   - `indexPrefixMap: [string: string]`: Path remappings for remapping index data for local use.
   - `maxCoresPercentageToUseForBackgroundIndexing: number`: A hint indicating how many cores background indexing should use at most (value between 0 and 1). Background indexing is not required to honor this setting.
   - `updateIndexStoreTimeout: integer`: Number of seconds to wait for an update index store task to finish before killing it.
-- `logging`: Options related to logging, changing SourceKit-LSP’s logging behavior on non-Apple platforms.
-  On Apple platforms, logging is done through the [system log](Diagnose%20Bundle.md#Enable%20Extended%20Logging).
-  These options can only be set globally and not per workspace.
+- `logging`: Options related to logging, changing SourceKit-LSP’s logging behavior on non-Apple platforms. On Apple platforms, logging is done through the [system log](Diagnose%20Bundle.md#Enable%20Extended%20Logging). These options can only be set globally and not per workspace.
   - `level: "debug"|"info"|"default"|"error"|"fault"`: The level from which one onwards log messages should be written.
-  - `privacyLevel: "sensitive"|"private"|"public"`: Whether potentially sensitive information should be redacted.
-    Default is `public`, which redacts potentially sensitive information.
-  - `inputMirrorDirectory: string`: Write all input received by SourceKit-LSP on stdin to a file in this directory.
-    Useful to record and replay an entire SourceKit-LSP session.
+  - `privacyLevel: "sensitive"|"private"|"public"`: Whether potentially sensitive information should be redacted. Default is `public`, which redacts potentially sensitive information.
+  - `inputMirrorDirectory: string`: Write all input received by SourceKit-LSP on stdin to a file in this directory. Useful to record and replay an entire SourceKit-LSP session.
 - `defaultWorkspaceType: "buildServer"|"compilationDatabase"|"swiftPM"`: Default workspace type (buildserver|compdb|swiftpm). Overrides workspace type selection logic.
 - `generatedFilesPath: string`: Directory in which generated interfaces and macro expansions should be stored.
 - `backgroundIndexing: boolean`: Whether background indexing is enabled.
-- `backgroundPreparationMode: string`: Determines how background indexing should prepare a target. Possible values are:
-  - `build`: Build a target to prepare it.
-  - `noLazy`: Prepare a target without generating object files but do not do lazy type checking and function body skipping.
-  - `enabled`: Prepare a target without generating object files and the like.
-- `cancelTextDocumentRequestsOnEditAndClose: boolean`: Whether sending a `textDocument/didChange` or `textDocument/didClose` notification for a document should cancel
-  all pending requests for that document.
+- `backgroundPreparationMode: string`: Determines how background indexing should prepare a target. Possible values are: - `build`: Build a target to prepare it. - `noLazy`: Prepare a target without generating object files but do not do lazy type checking and function body skipping. - `enabled`: Prepare a target without generating object files and the like.
+- `cancelTextDocumentRequestsOnEditAndClose: boolean`: Whether sending a `textDocument/didChange` or `textDocument/didClose` notification for a document should cancel all pending requests for that document.
 - `experimentalFeatures: ("on-type-formatting")[]`: Experimental features that are enabled.
-- `swiftPublishDiagnosticsDebounceDuration: number`: The time that `SwiftLanguageService` should wait after an edit before starting to compute diagnostics and
-  sending a `PublishDiagnosticsNotification`.
-- `workDoneProgressDebounceDuration: number`: When a task is started that should be displayed to the client as a work done progress, how many milliseconds to
-  wait before actually starting the work done progress. This prevents flickering of the work done progress in the
-  client for short-lived index tasks which end within this duration.
-- `sourcekitdRequestTimeout: number`: The maximum duration that a sourcekitd request should be allowed to execute before being declared as timed out.
-  In general, editors should cancel requests that they are no longer interested in, but in case editors don't cancel
-  requests, this ensures that a long-running non-cancelled request is not blocking sourcekitd and thus most semantic
-  functionality.
-  In particular, VS Code does not cancel the semantic tokens request, which can cause a long-running AST build that
-  blocks sourcekitd.
+- `swiftPublishDiagnosticsDebounceDuration: number`: The time that `SwiftLanguageService` should wait after an edit before starting to compute diagnostics and sending a `PublishDiagnosticsNotification`.
+- `workDoneProgressDebounceDuration: number`: When a task is started that should be displayed to the client as a work done progress, how many milliseconds to wait before actually starting the work done progress. This prevents flickering of the work done progress in the client for short-lived index tasks which end within this duration.
+- `sourcekitdRequestTimeout: number`: The maximum duration that a sourcekitd request should be allowed to execute before being declared as timed out. In general, editors should cancel requests that they are no longer interested in, but in case editors don't cancel requests, this ensures that a long-running non-cancelled request is not blocking sourcekitd and thus most semantic functionality. In particular, VS Code does not cancel the semantic tokens request, which can cause a long-running AST build that blocks sourcekitd.

Utilities/ConfigSchemaGen/Sources/ConfigSchemaGen/OptionSchema.swift

@@ -176,27 +176,33 @@ struct OptionSchemaContext {
   }
 
   private static func extractDocComment(_ trivia: Trivia) -> String? {
-    let docContents = trivia.compactMap { piece in
+    var docLines = trivia.flatMap { piece in
       switch piece {
       case .docBlockComment(let text):
         // Remove `/**` and `*/`
         assert(text.hasPrefix("/**") && text.hasSuffix("*/"), "Unexpected doc block comment format: \(text)")
-        return String(text.dropFirst(3).dropLast(2))
+        return text.dropFirst(3).dropLast(2).split { $0.isNewline }
       case .docLineComment(let text):
         // Remove `///` and leading space
         assert(text.hasPrefix("///"), "Unexpected doc line comment format: \(text)")
-        var text = text.dropFirst(3)
-        while text.first?.isWhitespace == true {
-          text = text.dropFirst()
-        }
-        return String(text)
+        let text = text.dropFirst(3)
+        return [text]
       default:
-        return nil
+        return []
       }
     }
-    guard !docContents.isEmpty else {
+    guard !docLines.isEmpty else {
       return nil
     }
-    return docContents.joined(separator: "\n")
+    // Trim leading spaces for each line and skip empty lines
+    docLines = docLines.compactMap {
+      guard !$0.isEmpty else { return nil }
+      var trimmed = $0
+      while trimmed.first?.isWhitespace == true {
+        trimmed = trimmed.dropFirst()
+      }
+      return trimmed
+    }
+    return docLines.joined(separator: " ")
   }
 }