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], commandInHtmlFormat: Option[CommandHTMLFormat], isVirtualDocumentSupported: Option[Boolean], openFilesOnRenameProvider: Option[Boolean], quickPickProvider: Option[Boolean], renameFileThreshold: Option[Int], slowTaskProvider: Option[Boolean], statusBarProvider: Option[String], treeViewProvider: Option[Boolean], testExplorerProvider: Option[Boolean], openNewWindowProvider: Option[Boolean], copyWorksheetOutputProvider: Option[Boolean], disableColorOutput: Option[Boolean]) extends Product with Serializable
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/didFocusTextDocumentcommand.- 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.
- isVirtualDocumentSupported
whether the client supports VirtualDocuments. For opening source jars in read-only
* https://code.visualstudio.com/api/extension-guides/virtual-documents- 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.
- testExplorerProvider
if the client implements the Test Explorer UI.
- openNewWindowProvider
if the client can open a new window after new project creation.
- copyWorksheetOutputProvider
if the client can execute server CopyWorksheet command and copy results to the local buffer.
- disableColorOutput
in the situation where your DAP client may not handle color codes in the output, you can enable this to strip them.
- Alphabetic
- By Inheritance
- InitializationOptions
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
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], commandInHtmlFormat: Option[CommandHTMLFormat], isVirtualDocumentSupported: Option[Boolean], openFilesOnRenameProvider: Option[Boolean], quickPickProvider: Option[Boolean], renameFileThreshold: Option[Int], slowTaskProvider: Option[Boolean], statusBarProvider: Option[String], treeViewProvider: Option[Boolean], testExplorerProvider: Option[Boolean], openNewWindowProvider: Option[Boolean], copyWorksheetOutputProvider: Option[Boolean], disableColorOutput: Option[Boolean])
- 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/didFocusTextDocumentcommand.- 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.
- isVirtualDocumentSupported
whether the client supports VirtualDocuments. For opening source jars in read-only
* https://code.visualstudio.com/api/extension-guides/virtual-documents- 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.
- testExplorerProvider
if the client implements the Test Explorer UI.
- openNewWindowProvider
if the client can open a new window after new project creation.
- copyWorksheetOutputProvider
if the client can execute server CopyWorksheet command and copy results to the local buffer.
- disableColorOutput
in the situation where your DAP client may not handle color codes in the output, you can enable this to strip them.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val commandInHtmlFormat: Option[CommandHTMLFormat]
- val compilerOptions: CompilerInitializationOptions
- val copyWorksheetOutputProvider: Option[Boolean]
- val debuggingProvider: Option[Boolean]
- val decorationProvider: Option[Boolean]
- val didFocusProvider: Option[Boolean]
- val disableColorOutput: Option[Boolean]
- def doctorFormat: Option[DoctorFormat]
- val doctorProvider: Option[String]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val executeClientCommandProvider: Option[Boolean]
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val globSyntax: Option[String]
- val icons: Option[String]
- val inlineDecorationProvider: Option[Boolean]
- val inputBoxProvider: Option[Boolean]
- val isExitOnShutdown: Option[Boolean]
- val isHttpEnabled: Option[Boolean]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val isVirtualDocumentSupported: Option[Boolean]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val openFilesOnRenameProvider: Option[Boolean]
- val openNewWindowProvider: Option[Boolean]
- val quickPickProvider: Option[Boolean]
- val renameFileThreshold: Option[Int]
- val slowTaskProvider: Option[Boolean]
- val statusBarProvider: Option[String]
- def statusBarState: Option[StatusBarState]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val testExplorerProvider: Option[Boolean]
- val treeViewProvider: Option[Boolean]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()