dots.vscode.code-action-kind

Liking cljdoc? Tell your friends :D

ClojureScript only.

append
contains?
empty
intersects?
notebook
quick-fix
refactor
refactor-extract
refactor-inline
refactor-move
refactor-rewrite
source
source-fix-all
source-organize-imports
value

Kind of a code action.

Kinds are a hierarchical list of identifiers separated by ., e.g. "refactor.extract.function".

Code action kinds are used by the editor for UI elements such as the refactoring context menu. Users can also trigger code actions with a specific kind with the editor.action.codeAction command.

Kind of a code action.

Kinds are a hierarchical list of identifiers separated by `.`, e.g. `"refactor.extract.function"`.

Code action kinds are used by the editor for UI elements such as the refactoring context menu. Users
can also trigger code actions with a specific kind with the `editor.action.codeAction` command.

raw docstring

append^cljs

(append code-action-kind parts)

Create a new kind by appending a more specific selector to the current kind.

Does not modify the current kind.

Parameters:

parts: string

Returns: CodeActionKind

Create a new kind by appending a more specific selector to the current kind.

Does not modify the current kind.

**Parameters:**
- `parts`: `string`

**Returns:** `CodeActionKind`

source raw docstring

contains?^cljs

(contains? code-action-kind other)

Checks if other is a sub-kind of this CodeActionKind.

The kind "refactor.extract" for example contains "refactor.extract" and ``"refactor.extract.function", but not"unicorn.refactor.extract", or"refactor.extractAll"orrefactor`.

Parameters:

other: CodeActionKind - Kind to check.

Returns: boolean

Checks if `other` is a sub-kind of this `CodeActionKind`.

The kind `"refactor.extract"` for example contains `"refactor.extract"` and ``"refactor.extract.function"`,
but not `"unicorn.refactor.extract"`, or `"refactor.extractAll"` or `refactor`.

**Parameters:**
- `other`: `CodeActionKind` - Kind to check.

**Returns:** `boolean`

source raw docstring

empty^cljs

(empty code-action-kind)

Empty kind.

Returns: CodeActionKind

Empty kind.

**Returns:** `CodeActionKind`

source raw docstring

intersects?^cljs

(intersects? code-action-kind other)

Checks if this code action kind intersects other.

The kind "refactor.extract" for example intersects refactor, "refactor.extract" and "refactor.extract.function", but not "unicorn.refactor.extract", or "refactor.extractAll".

Parameters:

other: CodeActionKind - Kind to check.

Returns: boolean

Checks if this code action kind intersects `other`.

The kind `"refactor.extract"` for example intersects `refactor`, `"refactor.extract"` and `"refactor.extract.function"`,
but not `"unicorn.refactor.extract"`, or `"refactor.extractAll"`.

**Parameters:**
- `other`: `CodeActionKind` - Kind to check.

**Returns:** `boolean`

source raw docstring

notebook^cljs

(notebook code-action-kind)

Base kind for all code actions applying to the enitre notebook's scope. CodeActionKinds using this should always begin with notebook.

This requires that new CodeActions be created for it and contributed via extensions. Pre-existing kinds can not just have the new notebook. prefix added to them, as the functionality is unique to the full-notebook scope.

Notebook CodeActionKinds can be initialized as either of the following (both resulting in notebook.source.xyz):

const newKind = CodeActionKind.Notebook.append(CodeActionKind.Source.append('xyz').value)
const newKind = CodeActionKind.Notebook.append('source.xyz')

Example Kinds/Actions:

notebook.source.organizeImports (might move all imports to a new top cell)
notebook.source.normalizeVariableNames (might rename all variables to a standardized casing format)

Returns: CodeActionKind

Base kind for all code actions applying to the enitre notebook's scope. CodeActionKinds using
this should always begin with `notebook.`

This requires that new CodeActions be created for it and contributed via extensions.
Pre-existing kinds can not just have the new `notebook.` prefix added to them, as the functionality
is unique to the full-notebook scope.

Notebook CodeActionKinds can be initialized as either of the following (both resulting in `notebook.source.xyz`):
- `const newKind =  CodeActionKind.Notebook.append(CodeActionKind.Source.append('xyz').value)`
- `const newKind =  CodeActionKind.Notebook.append('source.xyz')`

Example Kinds/Actions:
- `notebook.source.organizeImports` (might move all imports to a new top cell)
- `notebook.source.normalizeVariableNames` (might rename all variables to a standardized casing format)

**Returns:** `CodeActionKind`

source raw docstring

quick-fix^cljs

(quick-fix code-action-kind)

Base kind for quickfix actions: quickfix.

Quick fix actions address a problem in the code and are shown in the normal code action context menu.

Returns: CodeActionKind

Base kind for quickfix actions: `quickfix`.

Quick fix actions address a problem in the code and are shown in the normal code action context menu.

**Returns:** `CodeActionKind`

source raw docstring

refactor^cljs

(refactor code-action-kind)

Base kind for refactoring actions: refactor

Refactoring actions are shown in the refactoring context menu.

Returns: CodeActionKind

Base kind for refactoring actions: `refactor`

Refactoring actions are shown in the refactoring context menu.

**Returns:** `CodeActionKind`

source raw docstring

refactor-extract^cljs

(refactor-extract code-action-kind)

Base kind for refactoring extraction actions: refactor.extract

Example extract actions:

Extract method
Extract function
Extract variable
Extract interface from class
...

Returns: CodeActionKind

Base kind for refactoring extraction actions: `refactor.extract`

Example extract actions:

- Extract method
- Extract function
- Extract variable
- Extract interface from class
- ...

**Returns:** `CodeActionKind`

source raw docstring

refactor-inline^cljs

(refactor-inline code-action-kind)

Base kind for refactoring inline actions: refactor.inline

Example inline actions:

Inline function
Inline variable
Inline constant
...

Returns: CodeActionKind

Base kind for refactoring inline actions: `refactor.inline`

Example inline actions:

- Inline function
- Inline variable
- Inline constant
- ...

**Returns:** `CodeActionKind`

source raw docstring

refactor-move^cljs

(refactor-move code-action-kind)

Base kind for refactoring move actions: refactor.move

Example move actions:

Move a function to a new file
Move a property between classes
Move method to base class
...

Returns: CodeActionKind

Base kind for refactoring move actions: `refactor.move`

Example move actions:

- Move a function to a new file
- Move a property between classes
- Move method to base class
- ...

**Returns:** `CodeActionKind`

source raw docstring

refactor-rewrite^cljs

(refactor-rewrite code-action-kind)

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
...

Returns: CodeActionKind

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
- ...

**Returns:** `CodeActionKind`

source raw docstring

source^cljs

(source code-action-kind)

Base kind for source actions: source

Source code actions apply to the entire file. They must be explicitly requested and will not show in the normal lightbulb menu. Source actions can be run on save using editor.codeActionsOnSave and are also shown in the source context menu.

Returns: CodeActionKind

Base kind for source actions: `source`

Source code actions apply to the entire file. They must be explicitly requested and will not show in the
normal [lightbulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) menu. Source actions
can be run on save using `editor.codeActionsOnSave` and are also shown in the `source` context menu.

**Returns:** `CodeActionKind`

source raw docstring

source-fix-all^cljs

(source-fix-all code-action-kind)

Base kind for auto-fix source actions: source.fixAll.

Fix all actions automatically fix errors that have a clear fix that do not require user input. They should not suppress errors or perform unsafe fixes such as generating new types or classes.

Returns: CodeActionKind

Base kind for auto-fix source actions: `source.fixAll`.

Fix all actions automatically fix errors that have a clear fix that do not require user input.
They should not suppress errors or perform unsafe fixes such as generating new types or classes.

**Returns:** `CodeActionKind`

source raw docstring

source-organize-imports^cljs

(source-organize-imports code-action-kind)

Base kind for an organize imports source action: source.organizeImports.

Returns: CodeActionKind

Base kind for an organize imports source action: `source.organizeImports`.

**Returns:** `CodeActionKind`

source raw docstring

value^cljs

(value code-action-kind)

String value of the kind, e.g. "refactor.extract.function".

Returns: string

String value of the kind, e.g. `"refactor.extract.function"`.

**Returns:** `string`

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close