Dummy PR to review BSP migration changes

Contributor Documentation/BSP Extensions.md

@@ -0,0 +1,163 @@
+# BSP Extensions
+
+SourceKit-LSP extends the BSP protocol in the following ways.
+
+## `build/initialize`
+
+`InitializeBuildResultDataKind` can be `sourceKit`, in which case `InitializeBuildResultData` contains the following data.
+
+```ts
+export interface SourceKitInitializeBuildResponseData {
+  /** The directory to which the index store is written during compilation, ie. the path passed to `-index-store-path`
+   * for `swiftc` or `clang` invocations **/
+  indexStorePath?: string;
+
+  /** The path at which SourceKit-LSP can store its index database, aggregating data from `indexStorePath` */
+  indexDatabasePath?: string;
+
+  /** Whether the build server supports the `buildTarget/prepare` request */
+  supportsPreparation?: bool;
+}
+```
+
+## `buildTarget/didChange`
+
+`changes` can be `null` to indicate that all targets have changed.
+
+## `buildTarget/prepare`
+
+The prepare build target request is sent from the client to the server to prepare the given list of build targets for editor functionality.
+
+To do so, the build server should build Swift modules for all dependencies of this module so that all `import` statements in this module can be resolved.
+
+The server communicates during the initialize handshake whether this method is supported or not by setting `supportsPreparation` in `SourceKitInitializeBuildResponseData`.
+
+- method: `buildTarget/prepare`
+- params: `PrepareParams`
+
+```ts
+export interface PrepareParams {
+  /** A list of build targets to prepare. */
+  targets: BuildTargetIdentifier[];
+
+  /** A unique identifier generated by the client to identify this request.
+   * The server may include this id in triggered notifications or responses. **/
+  originId?: OriginId;
+}
+```
+
+## `builtTarget/sources`
+
+`SourceItemDataKind` can be `sourceKit` in which case `SourceItem.data` contains the following data.
+
+```ts
+export interface SourceKitSourceItemData {
+  /** The language of the source file. If `nil`, the language is inferred from the file extension. */
+  language? LanguageId;
+
+  /** Whether the file is a header file that is clearly associated with one target.
+   *
+   * For example header files in SwiftPM projects are always associated to one target and SwiftPM can provide build
+   * settings for that header file.
+   *
+   * In general, build systems don't need to list all header files in the `buildTarget/sources` request: Semantic
+   * functionality for header files is usually provided by finding a main file that includes the header file and
+   * inferring build settings from it. Listing header files in `buildTarget/sources` allows SourceKit-LSP to provide
+   * semantic functionality for header files if they haven't been included by any main file. **/
+  isHeader?: bool;
+}
+```
+
+## `textDocument/sourceKitOptions`
+
+The `TextDocumentSourceKitOptionsRequest` request is sent from the client to the server to query for the list of compiler options necessary to compile this file in the given target.
+
+The build settings are considered up-to-date and can be cached by SourceKit-LSP until a `buildTarget/didChange` is sent for the requested target.
+
+The request may return `nil` if it doesn't have any build settings for this file in the given target.
+
+- method: `textDocument/sourceKitOptions`
+- params: `TextDocumentSourceKitOptionsParams`
+- result: `TextDocumentSourceKitOptionsResult`
+
+```ts
+export interface TextDocumentSourceKitOptionsRequest {
+  /** The URI of the document to get options for */
+  textDocument: TextDocumentIdentifier;
+
+  /** The target for which the build setting should be returned.
+   *
+   * A source file might be part of multiple targets and might have different compiler arguments in those two targets,
+   * thus the target is necessary in this request. **/
+  target: BuildTargetIdentifier;
+
+  /** The language with which the document was opened in the editor. */
+  language: LanguageId;
+}
+
+export interface TextDocumentSourceKitOptionsResult {
+  /** The compiler options required for the requested file. */
+  compilerArguments: string[];
+
+  /** The working directory for the compile command. */
+  workingDirectory?: string;
+}
+```
+
+## `window/workDoneProgress/create`
+
+Request from the build server to SourceKit-LSP to create a work done progress.
+
+Definition is the same as in LSP.
+
+## `workspace/buildTargets`
+
+`BuildTargetTag` can have the following additional values
+
+```ts
+export interface BuildTargetTag {
+  // ...
+
+  /** This is a target of a dependency from the project the user opened, eg. a target that builds a SwiftPM dependency. */
+  export const Dependency = "dependency";
+
+  /** This target only exists to provide compiler arguments for SourceKit-LSP can't be built standalone.
+   *
+   * For example, a SwiftPM package manifest is in a non-buildable target. **/
+  export const NotBuildable = "not-buildable";
+}
+```
+
+`BuildTargetDataKind` can be `sourceKit` in which case `BuildTarget.data` contains the following data.
+
+
+```ts
+export interface SourceKitBuildTarget {
+  /** The toolchain that should be used to build this target. The URI should point to the directory that contains the
+   * `usr` directory. On macOS, this is typically a bundle ending in `.xctoolchain`. If the toolchain is installed to
+   * `/` on Linux, the toolchain URI would point to `/`.
+   *
+   * If no toolchain is given, SourceKit-LSP will pick a toolchain to use for this target. **/
+  toolchain?: URI;
+}
+```
+
+## `workspace/didChangeWatchedFiles`
+
+Notification sent from SourceKit-LSP to the build system to indicate that files within the project have been modified.
+
+Definition is the same as in LSP.
+
+## `workspace/waitForBuildSystemUpdates`
+
+This request is a no-op and doesn't have any effects.
+
+If the build system is currently updating the build graph, this request should return after those updates have finished processing.
+
+- method: `workspace/waitForBuildSystemUpdates`
+
+## `$/progress`
+
+Notification from the build server to SourceKit-LSP to update a work done progress created using `window/workDoneProgress/create`.
+
+Definition is the same as in LSP.

Documentation/Configuration File.md

@@ -30,6 +30,7 @@ The structure of the file is currently not guaranteed to be stable. Options may
   - `cCompilerFlags: string[]`: Extra arguments passed to the compiler for C files
   - `cxxCompilerFlags: string[]`: Extra arguments passed to the compiler for C++ files
   - `swiftCompilerFlags: string[]`: Extra arguments passed to the compiler for Swift files
+  - `sdk: string`: The SDK to use for fallback arguments. Default is to infer the SDK using `xcrun`.
 - `clangdOptions: string[]`: Extra command line arguments passed to `clangd` when launching it
 - `index`: Dictionary with the following keys, defining options related to indexing
     - `indexStorePath: string`: Directory in which a separate compilation stores the index store. By default, inferred from the build system.

Documentation/Environment Variables.md

@@ -17,3 +17,4 @@ The following environment variables can be used to control some behavior in Sour
 - `SKIP_LONG_TESTS`: Skip tests that typically take more than 1s to execute.
 - `SOURCEKITLSP_KEEP_TEST_SCRATCH_DIR`: Does not delete the temporary files created during test execution. Allows inspection of the test projects after the test finishes.
 - `SOURCEKIT_LSP_TEST_MODULE_CACHE`: Specifies where tests should store their shared module cache. Defaults to writing the module cache to a temporary directory. Intended so that CI systems can clean the module cache directory after running.
+- `SOURCEKIT_LSP_TEST_TIMEOUT`: Override the timeout duration for tests, in seconds.

Package.swift

@@ -252,9 +252,10 @@ let package = Package(
     .target(
       name: "SKSupport",
       dependencies: [
-        "CAtomics",
         "LanguageServerProtocol",
+        "LanguageServerProtocolJSONRPC",
         "SKLogging",
+        "SourceKitD",
         "SwiftExtensions",
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
@@ -377,6 +378,7 @@ let package = Package(
 
     .target(
       name: "SwiftExtensions",
+      dependencies: ["CAtomics"],
       exclude: ["CMakeLists.txt"]
     ),