Packages

package metals

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. final class ActiveFiles extends AnyRef

    Keeps track of files that have been "recently active"

    Keeps track of files that have been "recently active"

    Used to ignore file watching events that follow right after textDocument/didSave events.

  2. trait AdjustLspData extends AnyRef
  3. case class AdjustedLspData(adjustPosition: (org.eclipse.lsp4j.Position) ⇒ org.eclipse.lsp4j.Position, filterOutLocations: (Location) ⇒ Boolean) extends AdjustLspData with Product with Serializable
  4. final case class AggregateSemanticdbs(underlying: List[Semanticdbs]) extends Semanticdbs with Product with Serializable

    Implements TextDocuments trait with a list of underlying implementations.

  5. final class BatchedFunction[A, B] extends (Seq[A]) ⇒ Future[B] with Pauseable

    Helper to batch multiple asynchronous requests and ensure only one request is active at a time.

  6. final class BloopServers extends AnyRef

    Establishes a connection with a bloop server using Bloop Launcher.

    Establishes a connection with a bloop server using Bloop Launcher.

    Connects to a running bloop server instance if it is installed on the user machine and starts a new one if it isn't. Alternatively user can use the coursier command to launch it:

    coursier launch ch.epfl.scala:bloopgun-core_2.12:{bloop-version} -- about

    Eventually, this class may be superseded by "BSP connection protocol": https://build-server-protocol.github.io/docs/server-discovery.html

  7. case class Buffers(map: TrieMap[io.AbsolutePath, String] = TrieMap.empty) extends Product with Serializable

    Manages in-memory text contents of unsaved files in the editor.

  8. class BuildServerConnection extends Cancelable

    An actively running and initialized BSP connection.

  9. class BuildServerInitializeException extends Exception
  10. final class BuildTargets extends AnyRef

    In-memory cache for looking up build server metadata.

  11. trait Cancelable extends AnyRef

    A copy of java.io.Closeable that is not auto closeable.

    A copy of java.io.Closeable that is not auto closeable.

    Gives us fine-grained control over when resources are cleaned up.

  12. case class CancelableFuture[T](future: Future[T], cancelable: Cancelable = Cancelable.empty) extends Cancelable with Product with Serializable
  13. class ChosenBuildServers extends AnyRef
  14. class ChosenBuildTool extends AnyRef
  15. class ClientConfiguration extends AnyRef

    This class provides a uniform way to know how the client is configured using a combination of server properties, clientExperimentalCapabilities and initializationOptions.

  16. final case class ClientExperimentalCapabilities(debuggingProvider: Option[Boolean], decorationProvider: Option[Boolean], didFocusProvider: Option[Boolean], doctorProvider: Option[String], executeClientCommandProvider: Option[Boolean], inputBoxProvider: Option[Boolean], isCommandInHtmlSupported: Option[Boolean], openFilesOnRenameProvider: Option[Boolean], quickPickProvider: Option[Boolean], slowTaskProvider: Option[Boolean], statusBarProvider: Option[String], treeViewProvider: Option[Boolean]) extends Product with Serializable

    While all these values can be set here, they are here only for compatablity with clients that were setting them this way.

    While all these values can be set here, they are here only for compatablity with clients that were setting them this way. From a client perspective it's preferable and recommended to use InitializationOptions instead. From a development perspective don't add something here unless it's truly a more "experimental" type feature.

  17. class ClosableOutputStream extends FilterOutputStream
  18. trait CodeAction extends AnyRef
  19. final class CodeActionProvider extends AnyRef
  20. final class CodeLensProvider extends AnyRef
  21. case class Command(id: String, title: String, description: String, arguments: String = "`null`") extends Product with Serializable
  22. final class Compilations extends AnyRef
  23. class CompilerPlugins extends AnyRef

    Responsible for disabling unsupported compiler plugins.

    Responsible for disabling unsupported compiler plugins.

    Metals only uses the presentation compiler for limited features - completions - hover - parameter hints Compiler plugins that don't affect those features can be disabled, for example WartRemover that only reports diagnostics. Diagnostics are already published from the build, where all compiler plugins are enabled by default.

    Some compiler plugins change the semantics of the Scala language. Metals officially only supports a hardcoded list of such compiler plugins: - kind-projector, introduces new syntax for anonymous type lambdas - better-monadic-for, changes for comprehension desugaring The IntelliJ Scala plugin has custom support for these plugins.

    Notably, macro-paradise-plugin id disabled because it does not work with the -Ymacro-expand:discard setting making completions always fail when inside an expanded tree.

    The process for adding support for other compiler plugins is the following, send a PR to Metals adding integration tests to demonstrate thee compiler plugin - needs to be enabled in order for completions/hover to function. Many plugins like WartRemover that only use the compiler report don't need to be enabled. - enabling the plugin does not break the presentation compiler in unexpected ways.

  24. class Compilers extends Cancelable

    Manages lifecycle for presentation compilers in all build targets.

    Manages lifecycle for presentation compilers in all build targets.

    We need a custom presentation compiler for each build target since build targets can have different classpaths and compiler settings.

  25. final class ConfiguredLanguageClient extends DelegatingLanguageClient

    Delegates requests/notifications to the underlying language client according to the user configuration.

    Delegates requests/notifications to the underlying language client according to the user configuration.

    This wrapper class manages differences in how editors interpret LSP endpoints slightly differently, especially the window/{logMessage,showMessage} notifications. For example, with vim-lsc the messages from window/logMessage are always visible in the UI while in VS Code the logs are hidden by default.

  26. sealed abstract class Confirmation extends AnyRef
  27. final case class DebugSession(name: String, uri: String) extends Product with Serializable
  28. case class DebugUnresolvedAttachRemoteParams(hostName: String, port: Int, buildTarget: String) extends Product with Serializable
  29. case class DebugUnresolvedMainClassParams(mainClass: String, buildTarget: String = null, args: java.util.List[String] = null, jvmOptions: java.util.List[String] = null, env: Map[String, String] = null, envFile: String = null) extends Product with Serializable
  30. case class DebugUnresolvedTestClassParams(testClass: String, buildTarget: String = null) extends Product with Serializable
  31. case class DefinitionDestination(snapshot: TextDocument, distance: TokenEditDistance, symbol: String, path: Option[io.AbsolutePath], uri: String) extends Product with Serializable
  32. final class DefinitionProvider extends AnyRef

    Implements goto definition that works even in code that doesn't parse.

    Implements goto definition that works even in code that doesn't parse.

    Uses token edit-distance to align identifiers in the current open buffer with symbol occurrences from the latest SemanticDB snapshot.

    The implementation logic for converting positions between the latest SemanticDB snapshot and current open buffer is quite hairy. We need to convert positions in both the "source" (where definition request is made) and the "destination" (location of the symbol definition). This requires using token edit distance twice:

    - source: dirty buffer -> snapshot - destination: snapshot -> dirty buffer

  33. case class DefinitionResult(locations: java.util.List[Location], symbol: String, definition: Option[io.AbsolutePath], semanticdb: Option[TextDocument]) extends Product with Serializable
  34. class DelegatingLanguageClient extends MetalsLanguageClient
  35. final class DependencySources extends AnyRef
  36. class DestinationProvider extends AnyRef
  37. final class Diagnostics extends AnyRef

    Converts diagnostics from the build server and Scalameta parser into LSP diagnostics.

    Converts diagnostics from the build server and Scalameta parser into LSP diagnostics.

    BSP diagnostics have different semantics from LSP diagnostics with regards to how they are published. BSP diagnostics can be accumulated when reset=false, meaning the client (Metals) is responsible for aggregating multiple build/publishDiagnostics notifications into a single textDocument/publishDiagnostics notification.

    Another challenge is to consolidate syntax errors on every keystroke with type errors on batch compile because positions get stale in batch compile errors as you type new syntax errors. To solve this problem we use token edit distance the same way we support goto definition in stale buffers.

  38. final class DismissedNotifications extends AnyRef
  39. final class Doctor extends AnyRef

    Helps the user figure out what is mis-configured in the build through the "Run doctor" command.

    Helps the user figure out what is mis-configured in the build through the "Run doctor" command.

    At the moment, the doctor only validates that SemanticDB is enabled for all projects.

  40. final case class DoctorMessage(title: String, recommendations: List[String]) extends Product with Serializable
  41. final case class DoctorResults(title: String, headerText: String, messages: Option[List[DoctorMessage]], targets: Option[List[DoctorTargetInfo]]) extends Product with Serializable
  42. final case class DoctorTargetInfo(name: String, scalaVersion: String, definitionStatus: String, completionsStatus: String, referencesStatus: String, recommenedFix: String) extends Product with Serializable
  43. final class DocumentHighlightProvider extends AnyRef
  44. final case class DocumentSymbolConfig(value: String) extends Product with Serializable
  45. final class Embedded extends Cancelable

    Wrapper around software that is embedded with Metals.

    Wrapper around software that is embedded with Metals.

    - sbt-launch.jar - mdoc

  46. class ExcludedPackagesHandler extends AnyRef

    This class handles packages that should be excluded from indexing causing them to not be recommended for completions, symbol searches, and code actions.

  47. final case class ExecuteClientCommandConfig(value: String) extends Product with Serializable
  48. final class FileSystemSemanticdbs extends Semanticdbs

    Reads SemanticDBs from disk that are produces by the semanticdb-scalac compiler plugin.

  49. final class FileWatcher extends Cancelable

    Handles file watching of interesting files in this build.

    Handles file watching of interesting files in this build.

    Tries to minimize file events by dynamically watching only relevant directories for the structure of the build. We don't use the LSP dynamic file watcher capability because

    1. the glob syntax is not defined in the LSP spec making it difficult to deliver a consistent file watching experience with all editor clients on all operating systems. 2. we may have a lot of file watching events and it's presumably less overhead to get the notifications directly from the OS instead of through the editor via LSP.

    Given we rely on file watching for critical functionality like Goto Definition and it's really difficult to reproduce/investigate file watching issues, I think it's best to have a single file watching solution that we have control over.

    This class does not watch for changes in *.sbt files in the workspace directory and in the project/. Those notifications are nice-to-have, but not critical. The library we are using https://github.com/gmethvin/directory-watcher only supports recursive directory meaning we would have to watch the workspace directory, resulting in a LOT of redundant file events. Editors are free to send workspace/didChangedWatchedFiles notifications for these directories.

  50. final class FormattingProvider extends Cancelable

    Implement text formatting using Scalafmt

  51. final class ForwardingMetalsBuildClient extends MetalsBuildClient with Cancelable

    A build client that forwards notifications from the build server to the language client.

  52. case class FutureCancelToken(f: Future[Boolean])(implicit ec: ExecutionContext) extends CancelToken with Product with Serializable

    A cancel token backed by a Scala future.

  53. final class HtmlBuilder extends AnyRef

    A string builder with helper methods for rendering HTML.

    A string builder with helper methods for rendering HTML.

    We don't use a library like Scalatags because we are trying to keep the number of external Scala dependencies low.

  54. abstract class Icons extends AnyRef
  55. case class ImportedBuild(workspaceBuildTargets: WorkspaceBuildTargetsResult, scalacOptions: ScalacOptionsResult, sources: SourcesResult, dependencySources: DependencySourcesResult) extends Product with Serializable

    Metadata that we import from the build tool via BSP.

  56. final case class InitializationOptions(compilerOptions: CompilerInitializationOptions, debuggingProvider: Option[Boolean], decorationProvider: Option[Boolean], inlineDecorationProvider: Option[Boolean], didFocusProvider: Option[Boolean], doctorProvider: Option[String], executeClientCommandProvider: Option[Boolean], globSyntax: Option[String], icons: Option[String], inputBoxProvider: Option[Boolean], isExitOnShutdown: Option[Boolean], isHttpEnabled: Option[Boolean], isCommandInHtmlSupported: Option[Boolean], openFilesOnRenameProvider: Option[Boolean], quickPickProvider: Option[Boolean], renameFileThreshold: Option[Int], slowTaskProvider: Option[Boolean], statusBarProvider: Option[String], treeViewProvider: Option[Boolean], openNewWindowProvider: Option[Boolean]) extends Product with Serializable

    This is the preferred way to configure Metals from the client.

    This is the preferred way to configure Metals from the client. Eventually this will be accumulated in the ClientConfiguration along with ClientExperimentalCapabilities and the InitialConfig. If the values aren't directly passed in here, we default everything to None to signify that the client didn't directly set the value. The defaults will then be handled by the ClientConfiguration so we don't need to worry about them here.

    compilerOptions

    configuration for the PresentationCompilerConfig.

    debuggingProvider

    if the client supports debugging.

    decorationProvider

    if the client implements the Metals Decoration Protocol.

    inlineDecorationProvider

    if the client implements the Metals Decoration Protocol and supports decorations to be shown inline and not only at the end of a line.

    didFocusProvider

    if the client implements the metals/didFocusTextDocument command.

    doctorProvider

    format that the client would like the Doctor to be returned in.

    executeClientCommandProvider

    if the client implements metals/executeClientCommand.

    globSyntax

    pattern used for DidChangeWatchedFilesRegistrationOptions.

    icons

    which icons will be used for messages.

    inputBoxProvider

    if the client implements metals/inputBox.

    isExitOnShutdown

    whether the client needs Metals to shut down manually on exit.

    isHttpEnabled

    whether the client needs Metals to start an HTTP client interface.

    openFilesOnRenameProvider

    whether or not the client supports opening files on rename.

    quickPickProvider

    if the client implements metals/quickPick.

    renameFileThreshold

    amount of files that should be opened during rename if client is a openFilesOnRenameProvider.

    slowTaskProvider

    if the client implements metals/slowTask.

    statusBarProvider

    if the client implements metals/status.

    treeViewProvider

    if the client implements the Metals Tree View Protocol.

    openNewWindowProvider

    if the client can open a new window after new project creation.

  57. final class InteractiveSemanticdbs extends Cancelable with Semanticdbs

    Produces SemanticDBs on-demand by using the presentation compiler.

    Produces SemanticDBs on-demand by using the presentation compiler.

    Only used to provide navigation inside external library sources, not used to compile workspace sources.

    Uses persistent storage to keep track of what external source file is associated with what build target (to determine classpath and compiler options).

  58. final class JarTopLevels extends AnyRef

    Handles caching of Jar Top Level Symbols in H2

    Handles caching of Jar Top Level Symbols in H2

    Wrapper around the indexed_jar and toplevel_symbol sql tables.

  59. trait MetalsBuildClient extends AnyRef

    A BSP client interface that uses lsp4j data structures where applicable.

    A BSP client interface that uses lsp4j data structures where applicable.

    Does not extend bsp4j BuildClient to avoid unnecessary converting between identical bsp/lsp data structures and also ignore unused endpoints like build/registerFileWatcher.

  60. trait MetalsBuildServer extends BuildServer with ScalaBuildServer
  61. final class MetalsHttpClient extends DelegatingLanguageClient

    Editor client that implement dialogue UIs like window/showMessageRequest.

    Editor client that implement dialogue UIs like window/showMessageRequest.

    Goals:

    - enable editor plugin authors access all functionality within Metals even if the editor plugin only supports a limited set of LSP endpoints.

    Non-goals:

    - Pretty UI, the interface only needs to be functional, not look nice. - Become permanent/primary interface for ordinary users. The end goal is to enable users to interact with Metals from their editor, not via a browser.

    The most popular LSP clients in editors like Vim currently have limited support so that endpoints like window/showMessageRequest are ignored, with no workaround for users to interact with the Metals language server. This http client allows users in those editors to trigger server commands and respond to UI dialogues through their browser instead.

  62. final class MetalsHttpServer extends Cancelable

    Http server

  63. case class MetalsInputBoxParams(value: String = null, prompt: String = null, placeholder: String = null, password: java.lang.Boolean = null, ignoreFocusOut: java.lang.Boolean = null, valueSelection: Array[Int] = null) extends Product with Serializable
  64. case class MetalsInputBoxResult(value: String = null, cancelled: java.lang.Boolean = null) extends Product with Serializable
  65. trait MetalsLanguageClient extends LanguageClient with TreeViewClient with DecorationClient
  66. class MetalsLanguageServer extends Cancelable
  67. case class MetalsOpenWindowParams(uri: String, openNewWindow: java.lang.Boolean) extends Product with Serializable
  68. case class MetalsQuickPickItem(id: String, label: String, description: String = null, detail: String = null, alwaysShow: java.lang.Boolean = null) extends Product with Serializable
  69. case class MetalsQuickPickParams(items: java.util.List[MetalsQuickPickItem], matchOnDescription: java.lang.Boolean = null, matchOnDetail: java.lang.Boolean = null, placeHolder: String = null, ignoreFocusOut: java.lang.Boolean = null) extends Product with Serializable
  70. case class MetalsQuickPickResult(itemId: String = null, cancelled: java.lang.Boolean = null) extends Product with Serializable
  71. final case class MetalsServerConfig(globSyntax: GlobSyntaxConfig = GlobSyntaxConfig.default, statusBar: StatusBarConfig = StatusBarConfig.default, slowTask: SlowTaskConfig = SlowTaskConfig.default, executeClientCommand: ExecuteClientCommandConfig = ExecuteClientCommandConfig.default, snippetAutoIndent: Boolean = ..., isExitOnShutdown: Boolean = ..., isHttpEnabled: Boolean = ..., isCommandInHtmlSupported: Boolean = ..., isInputBoxEnabled: Boolean = ..., isVerbose: Boolean = ..., isAutoServer: Boolean = ..., remoteTimeout: String = ..., openFilesOnRenames: Boolean = false, renameFileThreshold: Int = 300, askToReconnect: Boolean = ..., icons: Icons = ..., statistics: StatisticsConfig = StatisticsConfig.default, compilers: PresentationCompilerConfigImpl = CompilersConfig(), allowMultilineStringFormatting: Boolean = ..., bloopPort: Option[Int] = ...) extends Product with Serializable

    Configuration parameters for the Metals language server.

    Configuration parameters for the Metals language server. While these can be used to configure Metals, it's preferable that instead you configure Metals via InitializationOptions.

    globSyntax

    pattern used for DidChangeWatchedFilesRegistrationOptions.

    statusBar

    how to handle metals/status notifications.

    slowTask

    how to handle metals/slowTask requests.

    executeClientCommand

    whether client provides the ability to support the metals/executeClientCommand command.

    snippetAutoIndent

    if the client defaults to adding the identation of the reference line that the operation started on (relevant for multiline textEdits)

    isExitOnShutdown

    whether the client needs Metals to shut down manually on exit.

    isHttpEnabled

    whether to start the Metals HTTP client interface. This is needed for clients with limited support for UI dialogues that don't implement window/showMessageRequest yet.

    isInputBoxEnabled

    whether the client supports the metals/inputBox extension.

    isVerbose

    turn on verbose logging.

    isAutoServer

    whether or not AUTO_SERVER should be set for h2. * http://www.h2database.com/html/features.html#auto_mixed_mode

    remoteTimeout

    timeout period for retrieving references while using RemoteLanguageServer.

    openFilesOnRenames

    whether or not file should be opened when a rename occurs in an unopened file.

    renameFileThreshold

    amount of files that should be opened during a rename if the openFilesOnRenames is enabled.

    askToReconnect

    whether the user should be prompted to reconnect after a BuildServer connection is lost.

    icons

    what icon set to use for messages.

    statistics

    if all statistics in Metals should be enabled.

    compilers

    configuration for the PresentationCompilerConfig.

    allowMultilineStringFormatting

    whether or not multilineStringFormatting should be turned off. By default this is on, but Metals only supports a small subset of this, so it may be problematic for certain clients.

  72. case class MetalsSlowTaskParams(message: String, quietLogs: java.lang.Boolean = null, secondsElapsed: Integer = null) extends Product with Serializable
  73. case class MetalsSlowTaskResult(cancel: Boolean) extends Product with Serializable
  74. case class MetalsStatusParams(text: String, show: java.lang.Boolean = null, hide: java.lang.Boolean = null, tooltip: String = null, command: String = null) extends Product with Serializable

    Arguments for the metals/status notification.

    Arguments for the metals/status notification.

    text

    The text to display in the status bar.

    show

    if true, show the status bar.

    hide

    if true, hide the status bar.

    tooltip

    optional display this message when the user hovers over the status bar item.

    command

    optional command that the client should trigger when the user clicks on the status bar item.

  75. class MetalsSymbolSearch extends SymbolSearch

    Implementation of SymbolSearch that delegates to WorkspaceSymbolProvider and SymbolDocumentationIndexer.

  76. final class MutableCancelable extends Cancelable

    Open collection of cancelables that should cancel together

  77. final class MutableMd5Fingerprints extends Md5Fingerprints
  78. case class NonZeroExitCode(statusCode: Int) extends Exception with Product with Serializable
  79. abstract class NoopLanguageClient extends MetalsLanguageClient

    A language client that ignores all requests.

    A language client that ignores all requests.

    Used during shutdown procedure to ensure no status bar updates or log messages are published during shutdown.

  80. class PackageProvider extends AnyRef
  81. trait Pauseable extends AnyRef

    Interface for something that can be paused and unpaused, for example a stream of compile requests.

  82. class PopupChoiceReset extends AnyRef
  83. class PresentationCompilerClassLoader extends ClassLoader

    ClassLoader that is used to reflectively invoke presentation compiler APIs.

    ClassLoader that is used to reflectively invoke presentation compiler APIs.

    The presentation compiler APIs are compiled against exact Scala versions of the compiler while Metals only runs in a single Scala version. In order to communicate between Metals and the reflectively loaded compiler, this classloader shares a subset of Java classes that appear in method signatures of the PresentationCompiler class.

  84. abstract class ProgressTicks extends AnyRef
  85. class QuietInputStream extends FilterInputStream

    A delegate input stream that gracefully fails when the underlying stream is closed.

    A delegate input stream that gracefully fails when the underlying stream is closed.

    This class exists to suppress lsp4j logs like this:

      WARNING: Failed to send notification message.
    org.eclipse.lsp4j.jsonrpc.JsonRpcException: java.io.IOException: Stream Closed
     at org.eclipse.lsp4j.jsonrpc.json.StreamMessageConsumer.consume(StreamMessageConsumer.java:72)
     at org.eclipse.lsp4j.jsonrpc.Launcher$Builder.lambda$wrapMessageConsumer$0(Launcher.java:312)
     at or
  86. final class ReferenceProvider extends AnyRef
  87. case class ReferencesResult(symbol: String, locations: Seq[Location]) extends Product with Serializable
  88. case class ResolvedSymbolOccurrence(distance: TokenEditDistance, occurrence: Option[SymbolOccurrence]) extends Product with Serializable

    A symbol occurrence that appeared with the given edit distance

  89. case class ScalaTarget(info: BuildTarget, scalaInfo: ScalaBuildTarget, scalac: ScalacOptionsItem, autoImports: Option[Seq[String]], isSbt: Boolean) extends Product with Serializable
  90. case class ScalafixProvider(buffers: Buffers, userConfig: () ⇒ UserConfiguration, workspace: io.AbsolutePath, embedded: Embedded, statusBar: StatusBar, compilations: Compilations, icons: Icons, languageClient: MetalsLanguageClient, buildTargets: BuildTargets)(implicit ec: ExecutionContext) extends Product with Serializable
  91. class SemanticdbIndexer extends AnyRef
  92. final case class SlowTaskConfig(value: String) extends Product with Serializable
  93. case class SocketConnection(serverName: String, output: ClosableOutputStream, input: InputStream, cancelables: List[Cancelable], finishedPromise: Promise[Unit]) extends Product with Serializable
  94. class StacktraceAnalyzer extends AnyRef
  95. class StandaloneSymbolSearch extends SymbolSearch
  96. final case class StatisticsConfig(value: String) extends Product with Serializable
  97. final class StatusBar extends Cancelable

    Manages sending metals/status notifications to the editor client.

    Manages sending metals/status notifications to the editor client.

    Some design constraints and design decisions: - we should publish no more than status update per second so the user has time to read the notification. - there is only one active status bar notification at each time, in case there are multiple candidates we pick the item with higher priority. - it's acceptable that a low priority notification may never appear in the status bar. - long-running jobs like compilation or "import workspace" are active as long as the attached Future[_] is not completed.

  98. final case class StatusBarConfig(value: String) extends Product with Serializable
  99. final class Tables extends Cancelable
  100. class TaskProgress extends AnyRef

    Denotes how much of a task has been completed.

  101. trait Time extends AnyRef

    Wrapper around System.nanoTime and System.currentTimeMillis to allow easier testing.

  102. class Timer extends AnyRef
  103. final class TimerProvider extends AnyRef

    Helper class to provider functionality around timers.

  104. case class UserConfiguration(javaHome: Option[String] = None, sbtScript: Option[String] = None, gradleScript: Option[String] = None, mavenScript: Option[String] = None, millScript: Option[String] = None, scalafmtConfigPath: Option[io.AbsolutePath] = None, scalafixConfigPath: Option[io.AbsolutePath] = None, symbolPrefixes: Map[String, String] = ..., worksheetScreenWidth: Int = 120, worksheetCancelTimeout: Int = 4, bloopSbtAlreadyInstalled: Boolean = false, bloopVersion: Option[String] = None, ammoniteJvmProperties: Option[List[String]] = None, superMethodLensesEnabled: Boolean = false, showInferredType: Boolean = false, showImplicitArguments: Boolean = false, showImplicitConversionsAndClasses: Boolean = false, remoteLanguageServer: Option[String] = None, enableStripMarginOnTypeFormatting: Boolean = true, excludedPackages: Option[List[String]] = None) extends Product with Serializable

    Configuration that the user can override via workspace/didChangeConfiguration.

  105. case class UserConfigurationOption(key: String, default: String, example: String, title: String, description: String) extends Product with Serializable

    A setting that users can configure via LSP workspace/didChangeConfiguration.

    A setting that users can configure via LSP workspace/didChangeConfiguration.

    See also

    UserConfiguration.options for available options.

  106. final class Warnings extends AnyRef

    A helper to construct clear and actionable warning messages.

  107. case class WindowStateDidChangeParams(focused: java.lang.Boolean) extends Product with Serializable
  108. final class WorksheetDependencySources extends AnyRef
  109. class WorkspaceSearchVisitor extends SymbolSearchVisitor

    A symbol search visitor for workspace/symbol.

    A symbol search visitor for workspace/symbol.

    - workspace symbols are converted directly to l.SymbolInformation - classpath symbols are converted into "goto definition" requests, which creates files on disk, and then into l.SymbolInformation.

  110. final class WorkspaceSymbolProvider extends AnyRef

    Implements workspace/symbol for both workspace sources and dependency classpath.

  111. case class WorkspaceSymbolsIndex(bloom: StringBloomFilter, symbols: Seq[WorkspaceSymbolInformation]) extends Product with Serializable

    An index of symbols defined in workspace sources.

    An index of symbols defined in workspace sources.

    The path is stored as keys in WorkspaceSymbolProvider.

    bloom

    the Fuzzy.bloomFilterSymbolStrings index of all symbols.

    symbols

    the symbols defined in this source file.

Value Members

  1. object AdjustedLspData extends Serializable
  2. object BatchedFunction
  3. object BuildInfo extends Product with Serializable

    This object was generated by sbt-buildinfo.

  4. object BuildServerConnection
  5. object BuildTargets
  6. object CancelTokens

    Constructs an async CancelToken.

    Constructs an async CancelToken.

    The CancelChecker API in lsp4j is un-sufficient for our needs because we want to get a Future[Boolean] that completes to true when the user cancels a request, allowing us to abort expensive computation like typechecking as soon as possible. With CancelChecker, we need to explicitly call token.checkCancelled(), which is not possible inside the compiler.

  7. object Cancelable
  8. object CancelableFuture extends Serializable
  9. object ClientCommands

    Optional commands that metals expects the client to implement.

  10. object ClientConfiguration
  11. object ClientExperimentalCapabilities extends Serializable
  12. object ConcurrentHashSet

    Helper to construct a concurrent mutable set.

  13. object Configs
  14. object Confirmation
  15. object Debug

    Small utilities that are helpful for println debugging.

  16. object DefaultAdjustedData extends AdjustLspData
  17. object DefinitionResult extends Serializable
  18. object DidFocusResult extends Enumeration
  19. object Directories
  20. object DocumentSymbolConfig extends Serializable
  21. object Embedded
  22. object EmptyScalafmtReporter extends ScalafmtReporter

    A Scalafmt reporter that ignores all messages

  23. object ExecuteClientCommandConfig extends Serializable
  24. object FormattingProvider
  25. object FutureCancelToken extends Serializable
  26. object GlobalTrace

    Manages JSON-RPC tracing of incoming/outgoing messages via BSP and LSP.

  27. object Icons
  28. object ImportedBuild extends Serializable
  29. object InitializationOptions extends Serializable
  30. object JavaBinary
  31. object JdbcEnrichments
  32. object JsonParser
  33. object JvmOpts

    Support for the .jvmopts file loaded by the sbt launcher script as alternative to command line options.

  34. object JvmSignatures
  35. object LanguageClientLogger extends Writer

    Scribe logging handler that forwards logging messages to the LSP editor client.

  36. object Memory
  37. object Messages

    Constants for requests/dialogues via LSP window/showMessage and window/showMessageRequest.

  38. object MetalsEnrichments extends DecorateAsJava with DecorateAsScala with MtagsEnrichments

    One stop shop for all extension methods that are used in the metals build.

    One stop shop for all extension methods that are used in the metals build.

    Usage:

    import scala.meta.internal.metals.MetalsEnrichments._
    List(1).asJava
    Future(1).asJava
    // ...

    Includes the following converters from the standard library:

    import scala.compat.java8.FutureConverters._
    import scala.meta.internal.jdk.CollectionConverters._

    If this doesn't scale because we have too many unrelated extension methods then we can split this up, but for now it's really convenient to have to remember only one import.

  39. object MetalsHttpServer
  40. object MetalsLanguageServer
  41. object MetalsLogger
  42. object MetalsServerConfig extends Serializable
  43. object NoopLanguageClient extends NoopLanguageClient
  44. object Pauseable
  45. object PopupChoiceReset
  46. object ProgressTicks
  47. object ReferencesResult extends Serializable
  48. object SbtOpts

    Support for the .sbtopts file loaded by the sbt launcher script as alternative to command line options.

  49. object ScalaVersions
  50. object ScalacDiagnostic
  51. object ScalafixProvider extends Serializable
  52. object ServerCommands

    LSP commands supported by the Metals language server.

  53. object SlowTaskConfig extends Serializable
  54. object StacktraceAnalyzer
  55. object StandaloneSymbolSearch
  56. object StatisticsConfig extends Serializable
  57. object StatusBarConfig extends Serializable
  58. object StringCase
  59. object Synthetics

    Utilities to work with SemanticDB synthetics.

  60. object TaskProgress
  61. object ThreadPools
  62. object Time
  63. object Timer
  64. object Urls
  65. object UserConfiguration extends Serializable
  66. object WorkspaceSymbolProvider

Ungrouped