Skip to content

Latest commit

 

History

History
710 lines (604 loc) · 41.1 KB

_codearts_plugin_.md

File metadata and controls

710 lines (604 loc) · 41.1 KB
Raw

@codearts/plugin / "@codearts/plugin"

Namespace: "@codearts/plugin"

Copyright (C) 2020. Huawei Technologies Co., Ltd. All rights reserved. SPDX-License-Identifier: MIT

Table of contents

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Type Aliases

CharacterPair

Ƭ CharacterPair: [string, string]

A tuple of two characters, like a pair of opening and closing brackets.

Defined in

index.d.ts:5494

ConfigurationScope

Ƭ ConfigurationScope: Uri | TextDocument | WorkspaceFolder | { languageId: string ; uri?: Uri }

The configuration scope which can be a a 'resource' or a languageId or both or a 'TextDocument' or a 'WorkspaceFolder'

Defined in

index.d.ts:13176

DebugAdapterDescriptor

Ƭ DebugAdapterDescriptor: DebugAdapterExecutable | DebugAdapterServer | DebugAdapterNamedPipeServer | DebugAdapterInlineImplementation

Defined in

index.d.ts:15290

Declaration

Ƭ Declaration: Location | Location[] | LocationLink[]

The declaration of a symbol representation as one or many locations or location links.

Defined in

index.d.ts:2714

Definition

Ƭ Definition: Location | Location[]

The definition of a symbol represented as one or many locations. For most programming languages there is only one location at which a symbol is defined.

Defined in

index.d.ts:2653

DefinitionLink

Ƭ DefinitionLink: LocationLink

Information about where a symbol is defined.

Provides additional metadata over normal Location definitions, including the range of the defining symbol

Defined in

index.d.ts:2646

DocumentSelector

Ƭ DocumentSelector: DocumentFilter | string | ReadonlyArray<DocumentFilter | string>

A language selector is the combination of one or many language identifiers and language filters.

Note that a document selector that is just a language identifier selects all documents, even those that are not saved on disk. Only use such selectors when a feature works without further context, e.g. without the need to resolve related 'files'.

Example

let sel:DocumentSelector = { scheme: 'file', language: 'typescript' };

Defined in

index.d.ts:2200

GlobPattern

Ƭ GlobPattern: string | RelativePattern

A file glob pattern to match file paths against. This can either be a glob pattern string (like **​/*.{ts,js} or *.{ts,js}) or a relative pattern.

Glob patterns can have the following syntax:

  • * to match zero or more characters in a path segment
  • ? to match on one character in a path segment
  • ** to match any number of path segments, including none
  • {} to group conditions (e.g. **​/*.{ts,js} matches all TypeScript and JavaScript files)
  • [] to declare a range of characters to match in a path segment (e.g., example.[0-9] to match on example.0, example.1, …)
  • [!...] to negate a range of characters to match in a path segment (e.g., example.[!0-9] to match on example.a, example.b, but not example.0)

Note: a backslash (``) is not valid within a glob pattern. If you have an existing file path to match against, consider to use the relative pattern support that takes care of converting any backslash into slash. Otherwise, make sure to convert any backslash to slash when creating the glob pattern.

Defined in

index.d.ts:2144

InlineValue

Ƭ InlineValue: InlineValueText | InlineValueVariableLookup | InlineValueEvaluatableExpression

Inline value information can be provided by different means:

  • directly as a text value (class InlineValueText).
  • as a name to use for a variable lookup (class InlineValueVariableLookup)
  • as an evaluatable expression (class InlineValueEvaluatableExpression) The InlineValue types combines all inline value types into one type.

Defined in

index.d.ts:3007

MarkedString

Ƭ MarkedString: string | { language: string ; value: string }

MarkedString can be used to render human-readable text. It is either a markdown string or a code-block that provides a language and a code snippet. Note that markdown strings will be sanitized - that means html will be escaped.

Deprecated

This type is deprecated, please use MarkdownString instead.

Defined in

index.d.ts:2828

ProviderResult

Ƭ ProviderResult<T>: T | undefined | null | Thenable<T | undefined | null>

A provider result represents the values a provider, like the HoverProvider, may return. For once this is the actual result type T, like Hover, or a thenable that resolves to that type T. In addition, null and undefined can be returned - either directly or from a thenable.

The snippets below are all valid implementations of the HoverProvider:

let a: HoverProvider = {
	provideHover(doc, pos, token): ProviderResult<Hover> {
		return new Hover('Hello World');
	}
}

let b: HoverProvider = {
	provideHover(doc, pos, token): ProviderResult<Hover> {
		return new Promise(resolve => {
			resolve(new Hover('Hello World'));
	 	});
	}
}

let c: HoverProvider = {
	provideHover(doc, pos, token): ProviderResult<Hover> {
		return; // undefined
	}
}

Type parameters

Name
T

Defined in

index.d.ts:2232

ViewLocation

Ƭ ViewLocation: View | ViewContainer | "editor"

Location where Actions are registered.

Defined in

index.d.ts:9570

Variables

version

• Const version: string

The version of the editor.

Defined in

index.d.ts:19