Search
Preparing search index...
The search index is not available
Theia TypeDoc
Options
All
Public
Public/Protected
All
Inherited
Menu
Theia TypeDoc
plugin-ext
TheiaPluginScanner
Class TheiaPluginScanner
Hierarchy
TheiaPluginScanner
TheiaPluginScannerElectron
Implements
PluginScanner
Index
Constructors
constructor
Properties
_api
Type
grammars
Reader
plugin
Uri
Factory
Accessors
api
Type
Methods
extract
Plugin
Views
Ids
extract
Valid
Auto
Closing
Pairs
extract
Valid
Surrounding
Pairs
get
Contribution
get
Dependencies
get
Lifecycle
get
Model
read
Colors
read
Command
read
Configuration
read
Custom
Editor
read
Custom
Editors
read
Debugger
read
Debuggers
read
File
Sync
read
Icon
Themes
read
Json
read
Keybinding
read
Language
read
Languages
read
Localization
read
Localizations
read
Menu
read
Menus
read
Snippets
read
Submenu
read
Submenus
read
Task
Definition
read
Terminals
read
Themes
read
Translation
read
View
read
View
Container
read
View
Welcome
read
Views
read
Views
Containers
read
Views
Welcome
resolve
Schema
Attributes
to
Plugin
Url
to
Schema
transform
Icon
Url
Constructors
constructor
new
Theia
Plugin
Scanner
(
)
:
TheiaPluginScanner
Returns
TheiaPluginScanner
Properties
Private
Readonly
_api
Type
_api
Type
:
string
= 'theiaPlugin'
Private
Readonly
grammars
Reader
grammars
Reader
:
GrammarsReader
Protected
Readonly
plugin
Uri
Factory
plugin
Uri
Factory
:
PluginUriFactory
Accessors
api
Type
get
apiType
(
)
:
string
Returns
string
Methods
Private
extract
Plugin
Views
Ids
extract
Plugin
Views
Ids
(
views
:
undefined
|
{}
)
:
string
[]
Parameters
views:
undefined
|
{}
Returns
string
[]
Private
extract
Valid
Auto
Closing
Pairs
extract
Valid
Auto
Closing
Pairs
(
langId
:
string
, configuration
:
PluginPackageLanguageContributionConfiguration
)
:
undefined
|
AutoClosingPairConditional
[]
Parameters
langId:
string
configuration:
PluginPackageLanguageContributionConfiguration
Returns
undefined
|
AutoClosingPairConditional
[]
Private
extract
Valid
Surrounding
Pairs
extract
Valid
Surrounding
Pairs
(
langId
:
string
, configuration
:
PluginPackageLanguageContributionConfiguration
)
:
undefined
|
AutoClosingPair
[]
Parameters
langId:
string
configuration:
PluginPackageLanguageContributionConfiguration
Returns
undefined
|
AutoClosingPair
[]
get
Contribution
get
Contribution
(
rawPlugin
:
PluginPackage
)
:
undefined
|
PluginContribution
Parameters
rawPlugin:
PluginPackage
Returns
undefined
|
PluginContribution
get
Dependencies
get
Dependencies
(
rawPlugin
:
PluginPackage
)
:
undefined
|
Map
<
string
,
string
>
Parameters
rawPlugin:
PluginPackage
Returns
undefined
|
Map
<
string
,
string
>
get
Lifecycle
get
Lifecycle
(
plugin
:
PluginPackage
)
:
PluginLifecycle
Parameters
plugin:
PluginPackage
Returns
PluginLifecycle
get
Model
get
Model
(
plugin
:
PluginPackage
)
:
PluginModel
Parameters
plugin:
PluginPackage
Returns
PluginModel
Protected
read
Colors
read
Colors
(
pck
:
PluginPackage
)
:
undefined
|
ColorDefinition
[]
Parameters
pck:
PluginPackage
Returns
undefined
|
ColorDefinition
[]
Protected
read
Command
read
Command
(
__namedParameters
:
PluginPackageCommand
, pck
:
PluginPackage
)
:
PluginCommand
Parameters
__namedParameters:
PluginPackageCommand
pck:
PluginPackage
Returns
PluginCommand
Private
read
Configuration
read
Configuration
(
rawConfiguration
:
RecursivePartial
<
PreferenceSchema
>
, pluginPath
:
string
)
:
undefined
|
PreferenceSchema
Parameters
rawConfiguration:
RecursivePartial
<
PreferenceSchema
>
pluginPath:
string
Returns
undefined
|
PreferenceSchema
Private
read
Custom
Editor
read
Custom
Editor
(
rawCustomEditor
:
PluginPackageCustomEditor
)
:
CustomEditor
Parameters
rawCustomEditor:
PluginPackageCustomEditor
Returns
CustomEditor
Private
read
Custom
Editors
read
Custom
Editors
(
rawCustomEditors
:
PluginPackageCustomEditor
[]
)
:
CustomEditor
[]
Parameters
rawCustomEditors:
PluginPackageCustomEditor
[]
Returns
CustomEditor
[]
Private
read
Debugger
read
Debugger
(
rawDebugger
:
PluginPackageDebuggersContribution
)
:
DebuggerContribution
Parameters
rawDebugger:
PluginPackageDebuggersContribution
Returns
DebuggerContribution
Private
read
Debuggers
read
Debuggers
(
rawDebuggers
:
PluginPackageDebuggersContribution
[]
)
:
DebuggerContribution
[]
Parameters
rawDebuggers:
PluginPackageDebuggersContribution
[]
Returns
DebuggerContribution
[]
Protected
read
File
Sync
read
File
Sync
(
filePath
:
string
)
:
string
Parameters
filePath:
string
Returns
string
Protected
read
Icon
Themes
read
Icon
Themes
(
pck
:
PluginPackage
)
:
undefined
|
IconThemeContribution
[]
Parameters
pck:
PluginPackage
Returns
undefined
|
IconThemeContribution
[]
Protected
read
Json
read
Json
<
T
>
(
filePath
:
string
)
:
undefined
|
T
Type Parameters
T
Parameters
filePath:
string
Returns
undefined
|
T
Private
read
Keybinding
read
Keybinding
(
rawKeybinding
:
PluginPackageKeybinding
)
:
Keybinding
Parameters
rawKeybinding:
PluginPackageKeybinding
Returns
Keybinding
Private
read
Language
read
Language
(
rawLang
:
PluginPackageLanguageContribution
, pluginPath
:
string
)
:
LanguageContribution
Parameters
rawLang:
PluginPackageLanguageContribution
pluginPath:
string
Returns
LanguageContribution
Private
read
Languages
read
Languages
(
rawLanguages
:
PluginPackageLanguageContribution
[]
, pluginPath
:
string
)
:
LanguageContribution
[]
Parameters
rawLanguages:
PluginPackageLanguageContribution
[]
pluginPath:
string
Returns
LanguageContribution
[]
Protected
read
Localization
read
Localization
(
__namedParameters
:
PluginPackageLocalization
, pluginPath
:
string
)
:
Localization
Parameters
__namedParameters:
PluginPackageLocalization
pluginPath:
string
Returns
Localization
Protected
read
Localizations
read
Localizations
(
pck
:
PluginPackage
)
:
undefined
|
Localization
[]
Parameters
pck:
PluginPackage
Returns
undefined
|
Localization
[]
Private
read
Menu
read
Menu
(
rawMenu
:
PluginPackageMenu
)
:
Menu
Parameters
rawMenu:
PluginPackageMenu
Returns
Menu
Private
read
Menus
read
Menus
(
rawMenus
:
PluginPackageMenu
[]
)
:
Menu
[]
Parameters
rawMenus:
PluginPackageMenu
[]
Returns
Menu
[]
Protected
read
Snippets
read
Snippets
(
pck
:
PluginPackage
)
:
undefined
|
SnippetContribution
[]
Parameters
pck:
PluginPackage
Returns
undefined
|
SnippetContribution
[]
Private
read
Submenu
read
Submenu
(
rawSubmenu
:
PluginPackageSubmenu
, plugin
:
PluginPackage
)
:
Submenu
Parameters
rawSubmenu:
PluginPackageSubmenu
plugin:
PluginPackage
Returns
Submenu
Private
read
Submenus
read
Submenus
(
rawSubmenus
:
PluginPackageSubmenu
[]
, plugin
:
PluginPackage
)
:
Submenu
[]
Parameters
rawSubmenus:
PluginPackageSubmenu
[]
plugin:
PluginPackage
Returns
Submenu
[]
Private
read
Task
Definition
read
Task
Definition
(
pluginName
:
string
, definitionContribution
:
PluginTaskDefinitionContribution
)
:
TaskDefinition
Parameters
pluginName:
string
definitionContribution:
PluginTaskDefinitionContribution
Returns
TaskDefinition
Protected
read
Terminals
read
Terminals
(
pck
:
PluginPackage
)
:
undefined
|
TerminalProfile
[]
Parameters
pck:
PluginPackage
Returns
undefined
|
TerminalProfile
[]
Protected
read
Themes
read
Themes
(
pck
:
PluginPackage
)
:
undefined
|
ThemeContribution
[]
Parameters
pck:
PluginPackage
Returns
undefined
|
ThemeContribution
[]
Protected
read
Translation
read
Translation
(
packageTranslation
:
PluginPackageTranslation
, pluginPath
:
string
)
:
Translation
Parameters
packageTranslation:
PluginPackageTranslation
pluginPath:
string
Returns
Translation
Private
read
View
read
View
(
rawView
:
PluginPackageView
)
:
View
Parameters
rawView:
PluginPackageView
Returns
View
Private
read
View
Container
read
View
Container
(
rawViewContainer
:
PluginPackageViewContainer
, pck
:
PluginPackage
)
:
ViewContainer
Parameters
rawViewContainer:
PluginPackageViewContainer
pck:
PluginPackage
Returns
ViewContainer
Private
read
View
Welcome
read
View
Welcome
(
rawViewWelcome
:
PluginPackageViewWelcome
, pluginViewsIds
:
string
[]
)
:
ViewWelcome
Parameters
rawViewWelcome:
PluginPackageViewWelcome
pluginViewsIds:
string
[]
Returns
ViewWelcome
Private
read
Views
read
Views
(
rawViews
:
PluginPackageView
[]
)
:
View
[]
Parameters
rawViews:
PluginPackageView
[]
Returns
View
[]
Private
read
Views
Containers
read
Views
Containers
(
rawViewsContainers
:
PluginPackageViewContainer
[]
, pck
:
PluginPackage
)
:
ViewContainer
[]
Parameters
rawViewsContainers:
PluginPackageViewContainer
[]
pck:
PluginPackage
Returns
ViewContainer
[]
Private
read
Views
Welcome
read
Views
Welcome
(
rawViewsWelcome
:
PluginPackageViewWelcome
[]
, rowViews
:
undefined
|
{}
)
:
ViewWelcome
[]
Parameters
rawViewsWelcome:
PluginPackageViewWelcome
[]
rowViews:
undefined
|
{}
Returns
ViewWelcome
[]
Protected
resolve
Schema
Attributes
resolve
Schema
Attributes
(
type
:
string
, configurationAttributes
:
{}
)
:
IJSONSchema
[]
Parameters
type:
string
configurationAttributes:
{}
[
request:
string
]:
IJSONSchema
Returns
IJSONSchema
[]
Protected
to
Plugin
Url
to
Plugin
Url
(
pck
:
PluginPackage
, relativePath
:
string
)
:
string
Parameters
pck:
PluginPackage
relativePath:
string
Returns
string
Protected
to
Schema
to
Schema
(
definition
:
PluginTaskDefinitionContribution
)
:
IJSONSchema
Parameters
definition:
PluginTaskDefinitionContribution
Returns
IJSONSchema
Protected
transform
Icon
Url
transform
Icon
Url
(
plugin
:
PluginPackage
, original
?:
IconUrl
)
:
undefined
|
{
iconUrl
?:
IconUrl
;
themeIcon
?:
string
}
Parameters
plugin:
PluginPackage
Optional
original:
IconUrl
Returns
undefined
|
{
iconUrl
?:
IconUrl
;
themeIcon
?:
string
}
Modules
bulk-
edit
callhierarchy
console
core
debug
editor
editor-
preview
electron
external-
terminal
file-
search
filesystem
getting-
started
git
keymaps
markers
memory-
inspector
messages
metrics
mini-
browser
monaco
navigator
outline-
view
output
plugin
plugin-
dev
plugin-
ext
Comments
Command
Arg
Comments
Context
Command
Arg
Comments
Edit
Command
Arg
Composite
Tree
View
Node
Connection
Closed
Error
Custom
Editor
Widget
Data
Transfer
Data
Transfer
Data
Transfer
Item
Data
Transfer
Item
Debug
Adapter
Executable
Debug
Adapter
Inline
Implementation
Debug
Adapter
Named
Pipe
Server
Debug
Adapter
Server
Decoration
Range
Behavior
Decoration
Render
Options
Document
Link
Inlay
Hint
Kind
Known
Commands
Notification
Main
Object
Identifier
Parameter
Information
Plugin
Contributions
Plugin
Icon
Path
Plugin
Identifiers
Plugin
Package
Plugin
Paths
Plugin
View
Registry
Plugin
View
Widget
Process
Terminate
Message
Process
Terminated
Message
Schemes
Scm
Command
Arg
Selection
Provider
Commands
Signature
Help
Signature
Information
Symbol
Kind
Symbol
Kind
Converter
Text
Document
Show
Options
Text
Editor
Selection
Change
Kind
Themable
Decoration
Attachment
Render
Options
Themable
Decoration
Render
Options
Theme
Icon
Timeline
Command
Arg
Tree
View
Item
Reference
Tree
View
Node
View
Column
Webview
External
Endpoint
Webview
Widget
Workspace
Text
Edit
Dto
plugin-
ext-
vscode
plugin-
metrics
preferences
preview
process
property-
view
scm
scm-
extra
search-
in-
workspace
secondary-
window
task
terminal
timeline
toolbar
typehierarchy
userstorage
variable-
resolver
vsx-
registry
workspace
Theia
Plugin
Scanner
constructor
_api
Type
grammars
Reader
plugin
Uri
Factory
api
Type
extract
Plugin
Views
Ids
extract
Valid
Auto
Closing
Pairs
extract
Valid
Surrounding
Pairs
get
Contribution
get
Dependencies
get
Lifecycle
get
Model
read
Colors
read
Command
read
Configuration
read
Custom
Editor
read
Custom
Editors
read
Debugger
read
Debuggers
read
File
Sync
read
Icon
Themes
read
Json
read
Keybinding
read
Language
read
Languages
read
Localization
read
Localizations
read
Menu
read
Menus
read
Snippets
read
Submenu
read
Submenus
read
Task
Definition
read
Terminals
read
Themes
read
Translation
read
View
read
View
Container
read
View
Welcome
read
Views
read
Views
Containers
read
Views
Welcome
resolve
Schema
Attributes
to
Plugin
Url
to
Schema
transform
Icon
Url