mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
eb304c4759
Background indexing probably won’t be the last experimental feature in sourcekit-lsp that we want to gate behind a feature flag. Instead of adding new parameters ad-hoc, introduce a general notion of experimental features.
80 lines
3.1 KiB
Swift
80 lines
3.1 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import Foundation
|
|
import LanguageServerProtocol
|
|
import SKCore
|
|
import SKSupport
|
|
import SemanticIndex
|
|
|
|
import struct TSCBasic.AbsolutePath
|
|
import struct TSCBasic.RelativePath
|
|
|
|
extension SourceKitLSPServer {
|
|
|
|
/// Configuration options for the SourceKitServer.
|
|
public struct Options: Sendable {
|
|
/// Additional compiler flags (e.g. `-Xswiftc` for SwiftPM projects) and other build-related
|
|
/// configuration.
|
|
public var buildSetup: BuildSetup
|
|
|
|
/// Additional arguments to pass to `clangd` on the command-line.
|
|
public var clangdOptions: [String]
|
|
|
|
/// Additional paths to search for a compilation database, relative to a workspace root.
|
|
public var compilationDatabaseSearchPaths: [RelativePath]
|
|
|
|
/// Additional options for the index.
|
|
public var indexOptions: IndexOptions
|
|
|
|
/// Options for code-completion.
|
|
public var completionOptions: SKCompletionOptions
|
|
|
|
/// Override the default directory where generated interfaces will be stored
|
|
public var generatedInterfacesPath: AbsolutePath
|
|
|
|
/// The time that `SwiftLanguageService` should wait after an edit before starting to compute diagnostics and
|
|
/// sending a `PublishDiagnosticsNotification`.
|
|
///
|
|
/// This is mostly intended for testing purposes so we don't need to wait the debouncing time to get a diagnostics
|
|
/// notification when running unit tests.
|
|
public var swiftPublishDiagnosticsDebounceDuration: TimeInterval
|
|
|
|
/// Experimental features that are enabled.
|
|
public var experimentalFeatures: [ExperimentalFeature]
|
|
|
|
public var indexTestHooks: IndexTestHooks
|
|
|
|
public init(
|
|
buildSetup: BuildSetup = .default,
|
|
clangdOptions: [String] = [],
|
|
compilationDatabaseSearchPaths: [RelativePath] = [],
|
|
indexOptions: IndexOptions = .init(),
|
|
completionOptions: SKCompletionOptions = .init(),
|
|
generatedInterfacesPath: AbsolutePath = defaultDirectoryForGeneratedInterfaces,
|
|
swiftPublishDiagnosticsDebounceDuration: TimeInterval = 2, /* 2s */
|
|
experimentalFeatures: [ExperimentalFeature] = [],
|
|
indexTestHooks: IndexTestHooks = IndexTestHooks()
|
|
) {
|
|
self.buildSetup = buildSetup
|
|
self.clangdOptions = clangdOptions
|
|
self.compilationDatabaseSearchPaths = compilationDatabaseSearchPaths
|
|
self.indexOptions = indexOptions
|
|
self.completionOptions = completionOptions
|
|
self.generatedInterfacesPath = generatedInterfacesPath
|
|
self.swiftPublishDiagnosticsDebounceDuration = swiftPublishDiagnosticsDebounceDuration
|
|
self.experimentalFeatures = experimentalFeatures
|
|
self.indexTestHooks = indexTestHooks
|
|
}
|
|
}
|
|
}
|