Class DefaultCompletionService

Interface for a service providing shell auto-completion support.

Implements

CompletionService

Index

Constructors

Methods

formatCompletions generateCompletions getBootstrapScript getDefaultConfigPath parseCompletionContext setCommandRegistry validateShellEnvironment

Constructors

constructor

new DefaultCompletionService(): DefaultCompletionService

Returns DefaultCompletionService

Methods

formatCompletions

formatCompletions(
shellType: ShellType,
completions: readonly CompletionItem[],
): string
Parameters
- shellType: ShellType
- completions: readonly CompletionItem[]
Returns string
Implementation of CompletionService.formatCompletions
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/service/completion/DefaultCompletionService.ts:38

generateCompletions

generateCompletions(
    _shellType: ShellType,
    line: string,
    cursorPosition: number,
): Promise<readonly CompletionItem[]>
Parameters
- _shellType: ShellType
- line: string
- cursorPosition: number
Returns Promise<readonly CompletionItem[]>
Implementation of CompletionService.generateCompletions
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/service/completion/DefaultCompletionService.ts:49

getBootstrapScript

getBootstrapScript(
    shellType: ShellType,
    cliName: string,
    executablePath: string,
): string
Parameters
- shellType: ShellType
- cliName: string
- executablePath: string
Returns string
Implementation of CompletionService.getBootstrapScript
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/service/completion/DefaultCompletionService.ts:26

getDefaultConfigPath

getDefaultConfigPath(shellType: ShellType): string
Parameters
- shellType: ShellType
Returns string
Implementation of CompletionService.getDefaultConfigPath
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/service/completion/DefaultCompletionService.ts:30

parseCompletionContext

parseCompletionContext(
shell: ShellType,
args: readonly string[],
): { cursorPosition: number; line: string }
Parse the arguments passed by a shell's completion bootstrap script into the command line being completed and the cursor position within it.
Parameters
- shell: ShellType
- args: readonly string[]
  the arguments passed by the shell's bootstrap script.
Returns { cursorPosition: number; line: string }
the command line being completed and the cursor position within it.
Implementation of CompletionService.parseCompletionContext
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/service/completion/DefaultCompletionService.ts:42

setCommandRegistry

setCommandRegistry(registry: CommandRegistry): void
Parameters
- registry: CommandRegistry
Returns void
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/service/completion/DefaultCompletionService.ts:22

validateShellEnvironment

validateShellEnvironment(shellType: ShellType): Promise<boolean>
Parameters
- shellType: ShellType
Returns Promise<boolean>
Implementation of CompletionService.validateShellEnvironment
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/service/completion/DefaultCompletionService.ts:34

Class DefaultCompletionService

Implements

Index

Constructors

Methods

Constructors

constructor

Returns DefaultCompletionService

Methods

formatCompletions

Parameters

Returns string

generateCompletions

Parameters

Returns Promise<readonly CompletionItem[]>

getBootstrapScript

Parameters

Returns string

getDefaultConfigPath

Parameters

Returns string

parseCompletionContext

Parameters

Returns { cursorPosition: number; line: string }

setCommandRegistry

Parameters

Returns void

validateShellEnvironment

Parameters

Returns Promise<boolean>

Settings

On This Page