package
0.0.2
Repository: https://github.com/john-nguyen09/phpintel.git
Documentation: pkg.go.dev

# Functions

ComparePos returns -1, 0 or 1 indicating whether a is before, equal to or after b.
CompareRange compares 2 ranges.
No description provided by the author
No description provided by the author
No description provided by the author
IsInRange compare whether a position is within a range.
NewFileFS creates a FileFS instance.
NewLSPFS creates an URIFS instance from the connection.
No description provided by the author
PosFromString creates Position from string.
RangeFromString creates Range from string.
RangePointerFromString creates Range pointer from string.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

Abort defined: * Applying the workspace change is simply aborted if one of the changes provided * fails.
AfterDelay defined: * Automatic after a delay.
AlreadyListening defined: * The connection is already in listening mode.
Array is.
Boolean is.
Changed defined: * The file got changed.
Class is.
ClassCompletion is.
Closed defined: * The connection is closed.
ColorCompletion is.
Comment defined: * Folding range for a comment */.
Constant is.
ConstantCompletion is.
Constructor is.
ConstructorCompletion is.
ContentChange defined: * Signature help was triggered by the cursor moving or by the document content changing.
Create defined: * Supports creating new files and folders.
Created defined: * The file got created.
Delete defined: * Supports deleting existing files and folders.
Deleted defined: * The file got deleted.
Deprecated defined: * Deprecated or obsolete code.
Disposed defined: * The connection got disposed.
Empty defined: * Empty kind.
Enum is.
EnumCompletion is.
EnumMember is.
EnumMemberCompletion is.
Error defined: * An error message.
Event is.
EventCompletion is.
Field is.
FieldCompletion is.
File is.
FileCompletion is.
First is.
FocusOut defined: * When the editor lost focus.
FolderCompletion is.
Full defined: * Documents are synced by always sending the full content * of the document.
Function is.
FunctionCompletion is.
Imports defined: * Folding range for a imports or includes */.
Incremental defined: * Documents are synced by sending the full content on open.
Info defined: * An information message.
Interface is.
InterfaceCompletion is.
Invoked defined: * Completion was triggered by typing an identifier (24x7 code * complete), manual invocation (e.g Ctrl+Space) or via API.
JSON is.
Key is.
KeywordCompletion is.
Last is.
Listening is.
Log defined: * A log message.
Manual defined: * Manually triggered, e.g.
Markdown defined: * Markdown is supported as a content format */.
MessageReadError is.
MessageWriteError is.
Method is.
MethodCompletion is.
Module is.
ModuleCompletion is.
Namespace is.
New is.
None defined: * Documents should not be synced at all.
Null is.
Number is.
Object is.
Operator is.
OperatorCompletion is.
Package is.
PlainText defined: * Plain text is supported as a content format */.
PlainTextTextFormat defined: * The primary text to be inserted is treated as a plain string.
Property is.
PropertyCompletion is.
QuickFix defined: * Base kind for quickfix actions: 'quickfix' */.
Read defined: * Read-access of a symbol, like reading a variable.
Refactor defined: * Base kind for refactoring actions: 'refactor' */.
RefactorExtract defined: * Base kind for refactoring extraction actions: 'refactor.extract' * * Example extract actions: * * - Extract method * - Extract function * - Extract variable * - Extract interface from class * - ..
RefactorInline defined: * Base kind for refactoring inline actions: 'refactor.inline' * * Example inline actions: * * - Inline function * - Inline variable * - Inline constant * - ..
RefactorRewrite defined: * Base kind for refactoring rewrite actions: 'refactor.rewrite' * * Example rewrite actions: * * - Convert JavaScript function to class * - Add or remove parameter * - Encapsulate field * - Make method static * - Move method to base class * - ..
ReferenceCompletion is.
Region defined: * Folding range for a region (e.g.
Rename defined: * Supports renaming existing files and folders.
RequestCancelledError should be used when a request is cancelled early.
SeverityError defined: * Reports an error.
SeverityHint defined: * Reports a hint.
SeverityInformation defined: * Reports an information.
SeverityWarning defined: * Reports a warning.
SnippetCompletion is.
SnippetTextFormat defined: * The primary text to be inserted is treated as a snippet.
Source defined: * Base kind for source actions: `source` * * Source code actions apply to the entire file.
SourceOrganizeImports defined: * Base kind for an organize imports source action: `source.organizeImports` */.
String is.
Struct is.
StructCompletion is.
Text defined: * A textual occurrence.
TextCompletion is.
TextOnlyTransactional defined: * If the workspace edit contains only textual file changes they are executed transactional.
Transactional defined: * All operations are executed transactional.
TriggerCharacter defined: * Completion was triggered by a trigger character specified by * the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
TriggerForIncompleteCompletions defined: * Completion was re-triggered as current completion list is incomplete */.
TypeParameter is.
TypeParameterCompletion is.
Undo defined: * The client tries to undo the operations already executed.
UnitCompletion is.
UnknownProtocolVersion defined: * If the protocol version provided by the client can't be handled by the server.
Unnecessary defined: * Unused or unnecessary code.
ValueCompletion is.
Variable is.
VariableCompletion is.
Warning defined: * A warning message.
WatchChange defined: * Interested in change events */.
WatchCreate defined: * Interested in create events.
WatchDelete defined: * Interested in delete events */.
Write defined: * Write-access of a symbol, like writing to a variable.

# Structs

ApplyWorkspaceEditParams defined: * The parameters passed via a apply workspace edit request.
ApplyWorkspaceEditResponse defined: * A response returned from the apply workspace edit request.
ClientCapabilities is.
CodeAction defined: * A code action represents a change that can be performed in code, e.g.
CodeActionClientCapabilities defined: * The Client Capabilities of a [CodeActionRequest](#CodeActionRequest).
CodeActionContext defined: * Contains additional diagnostic information about the context in which * a [code action](#CodeActionProvider.provideCodeActions) is run.
CodeActionOptions defined: * Provider options for a [CodeActionRequest](#CodeActionRequest).
CodeActionParams defined: * The parameters of a [CodeActionRequest](#CodeActionRequest).
CodeActionRegistrationOptions defined: * Registration options for a [CodeActionRequest](#CodeActionRequest).
CodeLens defined: * A code lens represents a [command](#Command) that should be shown along with * source text, like the number of references, a way to run tests, etc.
CodeLensClientCapabilities defined: * The client capabilities of a [CodeLensRequest](#CodeLensRequest).
CodeLensOptions defined: * Code Lens provider options of a [CodeLensRequest](#CodeLensRequest).
CodeLensParams defined: * The parameters of a [CodeLensRequest](#CodeLensRequest).
CodeLensRegistrationOptions defined: * Registration options for a [CodeLensRequest](#CodeLensRequest).
Color defined: * Represents a color in RGBA space.
ColorInformation defined: * Represents a color range from a document.
ColorPresentation is.
ColorPresentationParams defined: * Parameters for a [ColorPresentationRequest](#ColorPresentationRequest).
Command defined: * Represents a reference to a command.
CompletionClientCapabilities defined: * Completion client capabilities */.
CompletionContext defined: * Contains additional information about the context in which a completion request is triggered.
CompletionItem defined: * A completion item represents a text snippet that is * proposed to complete text that is being typed.
CompletionList defined: * Represents a collection of [completion items](#CompletionItem) to be presented * in the editor.
CompletionOptions defined: * Completion options.
CompletionParams defined: * Completion parameters */.
CompletionRegistrationOptions defined: * Registration options for a [CompletionRequest](#CompletionRequest).
ConfigurationClientCapabilities is.
ConfigurationItem is.
ConfigurationParams defined: * The parameters of a configuration request.
ContentParams are params of xcontent request.
CreateFile defined: * Create file operation.
CreateFileOptions defined: * Options to create a file.
DeclarationClientCapabilities defined: * Since 3.14.0 */.
DeclarationOptions is.
DeclarationParams is.
DeclarationRegistrationOptions is.
DefinitionClientCapabilities defined: * Client Capabilities for a [DefinitionRequest](#DefinitionRequest).
DefinitionOptions defined: * Server Capabilities for a [DefinitionRequest](#DefinitionRequest).
DefinitionParams defined: * Parameters for a [DefinitionRequest](#DefinitionRequest).
DefinitionRegistrationOptions defined: * Registration options for a [DefinitionRequest](#DefinitionRequest).
DeleteFile defined: * Delete file operation */.
DeleteFileOptions defined: * Delete file options */.
Diagnostic defined: * Represents a diagnostic, such as a compiler error or warning.
DiagnosticRelatedInformation defined: * Represents a related message and source code location for a diagnostic.
DidChangeConfigurationClientCapabilities is.
DidChangeConfigurationParams defined: * The parameters of a change configuration notification.
DidChangeConfigurationRegistrationOptions is.
DidChangeTextDocumentParams defined: * The change text document notification's parameters.
DidChangeWatchedFilesClientCapabilities is.
DidChangeWatchedFilesParams defined: * The watched files change notification's parameters.
DidChangeWatchedFilesRegistrationOptions defined: * Describe options to be used when registered for text document change events.
DidChangeWorkspaceFoldersParams defined: * The parameters of a `workspace/didChangeWorkspaceFolders` notification.
DidCloseTextDocumentParams defined: * The parameters send in a close text document notification */.
DidOpenTextDocumentParams defined: * The parameters send in a open text document notification */.
DidSaveTextDocumentParams defined: * The parameters send in a save text document notification */.
DocumentColorClientCapabilities is.
DocumentColorOptions is.
DocumentColorParams defined: * Parameters for a [DocumentColorRequest](#DocumentColorRequest).
DocumentColorRegistrationOptions is.
DocumentFilter is a type* * A document filter denotes a document by different properties like * the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of * its resource, or a glob-pattern that is applied to the [path](#TextDocument.fileName).
DocumentFormattingClientCapabilities defined: * Client capabilities of a [DocumentFormattingRequest](#DocumentFormattingRequest).
DocumentFormattingOptions defined: * Provider options for a [DocumentFormattingRequest](#DocumentFormattingRequest).
DocumentFormattingParams defined: * The parameters of a [DocumentFormattingRequest](#DocumentFormattingRequest).
DocumentFormattingRegistrationOptions defined: * Registration options for a [DocumentFormattingRequest](#DocumentFormattingRequest).
DocumentHighlight defined: * A document highlight is a range inside a text document which deserves * special attention.
DocumentHighlightClientCapabilities defined: * Client Capabilities for a [DocumentHighlightRequest](#DocumentHighlightRequest).
DocumentHighlightOptions defined: * Provider options for a [DocumentHighlightRequest](#DocumentHighlightRequest).
DocumentHighlightParams defined: * Parameters for a [DocumentHighlightRequest](#DocumentHighlightRequest).
DocumentHighlightRegistrationOptions defined: * Registration options for a [DocumentHighlightRequest](#DocumentHighlightRequest).
DocumentLink defined: * A document link is a range in a text document that links to an internal or external resource, like another * text document or a web site.
DocumentLinkClientCapabilities defined: * The client capabilities of a [DocumentLinkRequest](#DocumentLinkRequest).
DocumentLinkOptions defined: * Provider options for a [DocumentLinkRequest](#DocumentLinkRequest).
DocumentLinkParams defined: * The parameters of a [DocumentLinkRequest](#DocumentLinkRequest).
DocumentLinkRegistrationOptions defined: * Registration options for a [DocumentLinkRequest](#DocumentLinkRequest).
DocumentOnTypeFormattingClientCapabilities defined: * Client capabilities of a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
DocumentOnTypeFormattingOptions defined: * Provider options for a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
DocumentOnTypeFormattingParams defined: * The parameters of a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
DocumentOnTypeFormattingRegistrationOptions defined: * Registration options for a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
DocumentRangeFormattingClientCapabilities defined: * Client capabilities of a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
DocumentRangeFormattingOptions defined: * Provider options for a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
DocumentRangeFormattingParams defined: * The parameters of a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
DocumentRangeFormattingRegistrationOptions defined: * Registration options for a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
DocumentSymbol defined: * Represents programming constructs like variables, classes, interfaces etc.
DocumentSymbolClientCapabilities defined: * Client Capabilities for a [DocumentSymbolRequest](#DocumentSymbolRequest).
DocumentSymbolOptions defined: * Provider options for a [DocumentSymbolRequest](#DocumentSymbolRequest).
DocumentSymbolParams defined: * Parameters for a [DocumentSymbolRequest](#DocumentSymbolRequest).
DocumentSymbolRegistrationOptions defined: * Registration options for a [DocumentSymbolRequest](#DocumentSymbolRequest).
ExecuteCommandClientCapabilities defined: * The client capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
ExecuteCommandOptions defined: * The server capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
ExecuteCommandParams defined: * The parameters of a [ExecuteCommandRequest](#ExecuteCommandRequest).
ExecuteCommandRegistrationOptions defined: * Registration options for a [ExecuteCommandRequest](#ExecuteCommandRequest).
FileEvent defined: * An event describing a file change.
FileFS uses file path.
FilesParams are params of xfiles request.
FileSystemWatcher is.
FoldingRange defined: * Represents a folding range.
FoldingRangeClientCapabilities is.
FoldingRangeOptions is.
FoldingRangeParams defined: * Parameters for a [FoldingRangeRequest](#FoldingRangeRequest).
FoldingRangeRegistrationOptions is.
FormattingOptions defined: * Value-object describing what options formatting should use.
Hover defined: * The result of a hover request.
HoverClientCapabilities is.
HoverOptions defined: * Hover options.
HoverParams defined: * Parameters for a [HoverRequest](#HoverRequest).
HoverRegistrationOptions defined: * Registration options for a [HoverRequest](#HoverRequest).
ImplementationClientCapabilities defined: * Since 3.6.0 */.
ImplementationOptions is.
ImplementationParams is.
ImplementationRegistrationOptions is.
InitializedParams is.
InitializeParams is.
InitializeResult defined: * The result returned from an initialize request.
InnerClientCapabilities defined: * Defines the capabilities provided by the client.
InnerInitializeParams defined: * The initialize parameters */.
InnerServerCapabilities defined: * Defines the capabilities provided by a language * server.
Location defined: * Represents a location inside a resource, such as a line * inside a text file.
LocationLink defined: * Represents the connection of two locations.
LogMessageParams defined: * The log message parameters.
LogTraceParams is.
MarkupContent defined: * A `MarkupContent` literal represents a string value which content is interpreted base on its * kind flag.
MessageActionItem is.
Types constructed to avoid structs as formal argument types.
ParameterInformation defined: * Represents a parameter of a callable-signature.
PartialResultParams is.
Position defined: * Position in a text document expressed as zero-based line and character offset.
PrepareRenameParams is.
ProgressParams is.
PublishDiagnosticsClientCapabilities defined: * The publish diagnostic client capabilities.
PublishDiagnosticsParams defined: * The publish diagnostic notification's parameters.
Range defined: * A range in a text document expressed as (zero-based) start and end positions.
ReferenceClientCapabilities defined: * Client Capabilities for a [ReferencesRequest](#ReferencesRequest).
ReferenceContext defined: * Value-object that contains additional information when * requesting references.
ReferenceOptions defined: * Reference options.
ReferenceParams defined: * Parameters for a [ReferencesRequest](#ReferencesRequest).
ReferenceRegistrationOptions defined: * Registration options for a [ReferencesRequest](#ReferencesRequest).
Registration defined: * General parameters to to register for an notification or to register a provider.
RegistrationParams is.
RenameClientCapabilities is.
RenameFile defined: * Rename file operation */.
RenameFileOptions defined: * Rename file options */.
RenameOptions defined: * Provider options for a [RenameRequest](#RenameRequest).
RenameParams defined: * The parameters of a [RenameRequest](#RenameRequest).
RenameRegistrationOptions defined: * Registration options for a [RenameRequest](#RenameRequest).
ResourceOperation is.
SaveOptions defined: * Save options.
SelectionRange defined: * A selection range represents a part of a selection hierarchy.
SelectionRangeClientCapabilities is.
SelectionRangeOptions is.
SelectionRangeParams defined: * A parameter literal used in selection range requests.
SelectionRangeRegistrationOptions is.
ServerCapabilities is.
SetTraceParams is.
ShowMessageParams defined: * The parameters of a notification message.
ShowMessageRequestParams is.
SignatureHelp defined: * Signature help represents the signature of something * callable.
SignatureHelpClientCapabilities defined: * Client Capabilities for a [SignatureHelpRequest](#SignatureHelpRequest).
SignatureHelpContext defined: * Additional information about the context in which a signature help request was triggered.
SignatureHelpOptions defined: * Server Capabilities for a [SignatureHelpRequest](#SignatureHelpRequest).
SignatureHelpParams defined: * Parameters for a [SignatureHelpRequest](#SignatureHelpRequest).
SignatureHelpRegistrationOptions defined: * Registration options for a [SignatureHelpRequest](#SignatureHelpRequest).
SignatureInformation defined: * Represents the signature of something callable.
StaticRegistrationOptions defined: * Static registration options to be returned in the initialize * request.
SymbolInformation defined: * Represents information about programming constructs like variables, classes, * interfaces etc.
TextDocument defined: * A simple text document.
TextDocumentChangeEvent defined: * Event to signal changes to a simple text document.
TextDocumentChangeRegistrationOptions defined: * Describe options to be used when registered for text document change events.
TextDocumentClientCapabilities defined: * Text document specific client capabilities.
TextDocumentContentChangeEvent defined: * An event describing a change to a text document.
TextDocumentEdit defined: * Describes textual changes on a text document.
TextDocumentIdentifier defined: * A literal to identify a text document in the client.
TextDocumentItem defined: * An item to transfer a text document from the client to the * server.
TextDocumentPositionParams defined: * A parameter literal used in requests to pass a text document and a position inside that * document.
TextDocumentRegistrationOptions defined: * General text document registration options.
TextDocumentSaveRegistrationOptions defined: * Save registration options.
TextDocumentSyncClientCapabilities is.
TextDocumentSyncOptions is.
TextDocumentWillSaveEvent is.
TextEdit defined: * A text edit applicable to a text document.
TextEditChange defined: * A change to capture text edits for existing resources.
Tracer is.
TypeDefinitionClientCapabilities defined: * Since 3.6.0 */.
TypeDefinitionOptions is.
TypeDefinitionParams is.
TypeDefinitionRegistrationOptions is.
Unregistration defined: * General parameters to unregister a request or notification.
UnregistrationParams is.
URIFS is a LSP file reader which relies on xcontentProvider and xfilesProvider client capabilities.
VersionedTextDocumentIdentifier defined: * An identifier to denote a specific version of a text document.
WillSaveTextDocumentParams defined: * The parameters send in a will save text document notification.
WorkDoneProgressOptions is.
WorkDoneProgressParams is.
WorkspaceClientCapabilities defined: * Workspace specific client capabilities.
WorkspaceEdit defined: * A workspace edit represents changes to many resources managed in the workspace.
WorkspaceEditClientCapabilities is.
WorkspaceFolder is.
WorkspaceFoldersChangeEvent defined: * The workspace folder change event.
WorkspaceFoldersClientCapabilities is.
WorkspaceFoldersInitializeParams is.
WorkspaceFoldersServerCapabilities is.
WorkspaceSymbolClientCapabilities defined: * Client capabilities for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
WorkspaceSymbolOptions defined: * Server capabilities for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
WorkspaceSymbolParams defined: * The parameters of a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
WorkspaceSymbolRegistrationOptions defined: * Registration options for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).

# Interfaces

No description provided by the author
FS is an interface for reading files.
ProgressToken is a type.
No description provided by the author

# Type aliases

CodeActionKind defines constants.
CompletionItemKind defines constants.
CompletionItemTag defines constants.
CompletionTriggerKind defines constants.
ConnectionErrors defines constants.
ConnectionState defines constants.
DeclarationLink is a type* * Information about where a symbol is declared.
DefinitionLink is a type* * Information about where a symbol is defined.
DiagnosticSeverity defines constants.
DiagnosticTag defines constants.
DocumentHighlightKind defines constants.
DocumentSelector is a type* * A document selector is the combination of one or many document filters.
DocumentURI is a type* * A tagging type for string properties that are actually URIs.
ErrorCodes defines constants.
FailureHandlingKind defines constants.
FileChangeType defines constants.
FoldingRangeKind defines constants.
InitializeError defines constants.
InsertTextFormat defines constants.
LSPMessageType is a type* * A LSP Log Entry.
MarkedString is a type* * MarkedString can be used to render human readable text.
MarkupKind defines constants.
MessageType defines constants.
ResourceOperationKind defines constants.
SignatureHelpTriggerKind defines constants.
SymbolKind defines constants.
TextDocumentSaveReason defines constants.
TextDocumentSyncKind defines constants.
Touch defines constants.
Trace defines constants.
TraceFormat defines constants.
TraceValues is a type.
WatchKind defines constants.