1
0
mirror of https://github.com/chylex/IntelliJ-IdeaVim.git synced 2025-10-14 19:12:01 +02:00

Compare commits

..

744 Commits

Author SHA1 Message Date
1d4a14defd Set plugin version to chylex-52 2025-10-08 05:36:15 +02:00
021a94d9bb Improve support for recording macros with code completion
Fixes wrong recorded inputs when code completion introduces an import.

Fixes wrong recorded inputs when completing a static member with a partial type name. Example: `WiE.A` -> `WindowEvent.ACTION_EVENT_MASK`
2025-10-08 05:36:01 +02:00
9f6bffcf7d Preserve visual mode after executing IDE action 2025-10-06 22:19:03 +02:00
80222af0bf Make g0/g^/g$ work with soft wraps 2025-10-06 22:19:03 +02:00
57ea1ecb69 Make gj/gk jump over soft wraps 2025-10-06 22:19:03 +02:00
3b65b55929 Make camelCase motions adjust based on direction of visual selection 2025-10-06 22:19:02 +02:00
097924e078 Make search highlights temporary 2025-10-06 22:19:02 +02:00
8d092693b9 Exit insert mode after refactoring 2025-10-06 22:19:02 +02:00
42780c052b Add action to run last macro in all opened files 2025-10-06 22:19:02 +02:00
bf5eb879f9 Stop macro execution after a failed search 2025-10-06 22:19:02 +02:00
51e9c9be1c Revert per-caret registers 2025-10-06 22:19:02 +02:00
f4137d2769 Apply scrolloff after executing native IDEA actions 2025-10-06 22:19:02 +02:00
9c9284a201 Stay on same line after reindenting 2025-10-06 22:19:02 +02:00
84c30d1afc Update search register when using f/t 2025-10-06 22:19:02 +02:00
0de4b4fdde Automatically add unambiguous imports after running a macro 2025-10-06 22:19:02 +02:00
1ccb75e6b8 Fix(VIM-3986): Exception when pasting register contents containing new line 2025-10-06 22:19:02 +02:00
6671642428 Fix(VIM-3179): Respect virtual space below editor (imperfectly) 2025-10-06 22:19:02 +02:00
6cef05bfbb Fix(VIM-3178): Workaround to support "Jump to Source" action mapping 2025-10-06 22:19:02 +02:00
e961dce249 Add support for count for visual and line motion surround 2025-10-06 22:19:00 +02:00
47937cb382 Fix vim-surround not working with multiple cursors
Fixes multiple cursors with vim-surround commands `cs, ds, S` (but not `ys`).
2025-10-06 22:18:55 +02:00
10552bef28 Fix(VIM-696): Restore visual mode after undo/redo, and disable incompatible actions 2025-10-05 01:25:09 +02:00
140fe1ec6c Respect count with <Action> mappings 2025-10-05 01:25:09 +02:00
ecb2416457 Change matchit plugin to use HTML patterns in unrecognized files 2025-10-05 01:25:09 +02:00
a8de488629 Reset insert mode when switching active editor 2025-10-05 01:25:09 +02:00
ba55ffe7e4 Remove notifications about configuration options 2025-10-05 01:25:09 +02:00
a6ba575ef9 Set custom plugin version 2025-10-05 01:25:08 +02:00
Alex Plate
bdc29c3eb4 Add support for count(), index(), min(), max(), and range() vimscript functions
Implements five new vimscript list functions:
- count(): counts occurrences of a value in a list/dict
- index(): finds first index of a value in a list
- min()/max(): finds minimum/maximum value in a list/dict
- range(): generates a list of numbers with optional stride

Includes error handling for edge cases like zero stride and invalid ranges.
2025-10-03 20:59:29 +03:00
Alex Plate
d46eb39635 Add support for repeat(), char2nr(), nr2char(), trim(), and reverse() vimscript functions
Implement five commonly used vimscript functions:

- repeat(expr, count): Repeats strings or lists multiple times
- char2nr(char): Converts character to Unicode code point
- nr2char(number): Converts code point to character
- trim(text, [mask], [dir]): Trims whitespace or custom characters
- reverse(object): Reverses lists in-place or returns reversed string

All functions include comprehensive test coverage and follow vim's
official behavior including edge cases.
2025-10-03 19:08:57 +03:00
Alex Plate
a6c71d90bb Fix(VIM-4050): Implement getline vim function 2025-10-03 18:41:34 +03:00
Alex Plate
62de460264 Execute the processor with a proper mode after closing the exEntryPanel
Now, the inputProcessor will be called after all closing is finished. This includes the mode that won't be CMD_LINE anymore, but the one that was used before entering CMD_LINE
2025-10-03 15:33:27 +03:00
Alex Plate
2d02327665 Rename method to get the panel
Kotlin has some hard incremental compilation issues when keeping the old name. No other reason for the rename
2025-10-03 15:32:53 +03:00
Alex Plate
91b5a705d4 Fix issues with null variables during swing initialization 2025-10-03 15:16:04 +03:00
Alex Plate
b7c3bc2875 Migrate ExOutputPanel from Java to Kotlin and update related references 2025-10-03 13:30:20 +03:00
Alex Plate
70922f5fc5 Rename .java to .kt 2025-10-03 13:30:19 +03:00
Alex Plate
13e4d0ce2b Migrate ExTextField from Java to Kotlin and update related references 2025-10-03 13:30:19 +03:00
Alex Plate
3990b6475e Rename .java to .kt 2025-10-03 13:30:19 +03:00
Alex Plate
63c65c8b93 Migrate ExEntryPanel from Java to Kotlin and update related references 2025-10-03 13:30:19 +03:00
Alex Plate
ba2ffa6955 Rename .java to .kt 2025-10-03 13:30:19 +03:00
Alex Plate
411b6eaf48 Refactor ExDocument: Migrate from Java to Kotlin 2025-10-03 13:30:18 +03:00
Alex Plate
b5ecb05382 Rename .java to .kt 2025-10-03 13:30:18 +03:00
IdeaVim Bot
a5e4b8515d Add magidc, magidc to contributors list 2025-10-03 09:01:54 +00:00
Alex Plate
330f24bf74 Update JUnit to version 6 and improve null safety in test utilities 2025-10-02 18:04:30 +03:00
Alex Plate
36dfce695a Fix the compatibility with the latest idea EAP 2025-10-02 17:55:55 +03:00
Matt Ellis
6defddd24c Extract variable expression assignment 2025-10-02 17:26:38 +03:00
Matt Ellis
a916b4de9c Rename Variable to VariableExpression 2025-10-02 17:26:38 +03:00
Matt Ellis
8a0bdfd18f Improve sublist expression compatibility 2025-10-02 17:26:38 +03:00
Matt Ellis
3eb0ac9207 Remove tests for indexed expressions 2025-10-02 17:26:38 +03:00
Matt Ellis
d71b99b8d5 Update SublistExpressionTest.kt 2025-10-02 17:26:38 +03:00
Matt Ellis
db8736dcf4 Extract sublist expression assignment 2025-10-02 17:26:38 +03:00
Matt Ellis
4c3cefc1e6 Add typename for reporting purposes 2025-10-02 17:26:38 +03:00
Matt Ellis
b11fc4895b Support assigning to negative index 2025-10-02 17:26:38 +03:00
Matt Ellis
b7ce946af3 Extract sublist expression assignment
Also allows whitespace inside indexed expression
2025-10-02 17:26:38 +03:00
Matt Ellis
5a45f6d945 Improve evaluating indexed expressions
Support negative indexes, float indexes, and indexing numbers
2025-10-02 17:26:38 +03:00
Matt Ellis
6622f15ea3 Allow dictionary to be indexed by Float 2025-10-02 17:26:38 +03:00
Matt Ellis
fd1fe51633 Extract indexed expression assignment 2025-10-02 17:26:38 +03:00
Matt Ellis
91459edf6c Rename OneElementSublistExpression 2025-10-02 17:26:38 +03:00
Matt Ellis
01d92acd40 Improve validation for concatenation 2025-10-02 17:26:38 +03:00
Matt Ellis
6d18288883 Fix validation for modulo operator 2025-10-02 17:26:38 +03:00
Matt Ellis
7ffca59450 Support double-dot concatenation assignment 2025-10-02 17:26:38 +03:00
Matt Ellis
61df4f342d Support Float in concatenation handler
Surprisingly Float is converted to String, and then concatenated. But this is only supported for the binary concatenation operator, not the compound assignment concatenation operator. This lead to improved validation and behaviour closer to Vim.
2025-10-02 17:26:38 +03:00
Matt Ellis
cb1c0298ff Improve exception handling in tests 2025-10-02 17:26:38 +03:00
Matt Ellis
56d5af6bc9 Allow assigning Float to Register 2025-10-02 17:26:38 +03:00
Matt Ellis
1dbe3e4aa1 Update RegisterExpression to assign value 2025-10-02 17:26:38 +03:00
Matt Ellis
7256731572 Rename Register to RegisterExpression 2025-10-02 17:26:38 +03:00
Matt Ellis
dc5b45a52d Update OptionExpression to match Vim behaviour 2025-10-02 17:26:38 +03:00
Matt Ellis
063317b0c9 Introduce LValueExpression, update OptionExpression 2025-10-02 17:26:38 +03:00
Matt Ellis
37b6768148 Rename LetCommand.variable to lvalue 2025-10-02 17:26:38 +03:00
Matt Ellis
5ce2887391 Extract and add tests for sublist expressions 2025-10-02 17:26:38 +03:00
Matt Ellis
4ab91150d6 Extract and add tests for indexed expressions 2025-10-02 17:26:38 +03:00
Matt Ellis
9ddd074916 Extract tests for let command with register lvalue 2025-10-02 17:26:38 +03:00
Matt Ellis
a321bb28c0 Extract tests for let command with option lvalue 2025-10-02 17:26:38 +03:00
Matt Ellis
8c9df332aa Add tests for let command with variable lvalue 2025-10-02 17:26:38 +03:00
Matt Ellis
356a748181 Add tests for let command operators 2025-10-02 17:26:38 +03:00
Matt Ellis
7fe01cd885 Add string() Vim function 2025-10-02 17:26:38 +03:00
Matt Ellis
68f0e162e2 Update out of date error message 2025-10-02 17:26:38 +03:00
Xinhe Wang
f25b9fd9bf Fix uppercase keys in NERDTree 2025-10-02 17:12:23 +03:00
Alex Plate
168fa309ae Add an instruction that an external plugin should be installed 2025-10-02 17:07:24 +03:00
Alex Plate
2c6638fe37 Introduce a common getChar implementation in the injector 2025-10-02 17:05:06 +03:00
magidc
3d2375e937 Update doc/IdeaVim Plugins.md
Thanks!

Co-authored-by: Thomas Gautvedt <thomas.gautvedt@gmail.com>
2025-10-02 17:04:55 +03:00
magidc
c8ea045ef9 Added plugins Vim-Dial and Vim-AnyObject to plugins document 2025-10-02 17:04:55 +03:00
dependabot[bot]
c2d7f40512 Bump org.mockito.kotlin:mockito-kotlin from 6.0.0 to 6.1.0
Bumps [org.mockito.kotlin:mockito-kotlin](https://github.com/mockito/mockito-kotlin) from 6.0.0 to 6.1.0.
- [Release notes](https://github.com/mockito/mockito-kotlin/releases)
- [Commits](https://github.com/mockito/mockito-kotlin/compare/v6.0.0...v6.1.0)

---
updated-dependencies:
- dependency-name: org.mockito.kotlin:mockito-kotlin
  dependency-version: 6.1.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-10-01 19:18:24 +03:00
dependabot[bot]
23191a221d Bump org.junit.jupiter:junit-jupiter from 5.13.4 to 6.0.0
Bumps [org.junit.jupiter:junit-jupiter](https://github.com/junit-team/junit-framework) from 5.13.4 to 6.0.0.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.4...r6.0.0)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter
  dependency-version: 6.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-10-01 18:41:44 +03:00
dependabot[bot]
ac4a55d245 Bump org.junit.vintage:junit-vintage-engine from 5.13.4 to 6.0.0
Bumps [org.junit.vintage:junit-vintage-engine](https://github.com/junit-team/junit-framework) from 5.13.4 to 6.0.0.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.4...r6.0.0)

---
updated-dependencies:
- dependency-name: org.junit.vintage:junit-vintage-engine
  dependency-version: 6.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-10-01 18:22:54 +03:00
dependabot[bot]
f834ef2ef3 Bump org.junit:junit-bom from 5.13.4 to 6.0.0
Bumps [org.junit:junit-bom](https://github.com/junit-team/junit-framework) from 5.13.4 to 6.0.0.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.4...r6.0.0)

---
updated-dependencies:
- dependency-name: org.junit:junit-bom
  dependency-version: 6.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-10-01 15:17:29 +00:00
dependabot[bot]
7ec1428915 Bump io.ktor:ktor-client-core from 3.2.3 to 3.3.0
Bumps [io.ktor:ktor-client-core](https://github.com/ktorio/ktor) from 3.2.3 to 3.3.0.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.2.3...3.3.0)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-core
  dependency-version: 3.3.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-17 18:17:33 +03:00
Matt Ellis
b6ffc7a357 Use injector instead of directly using helper 2025-09-16 16:33:40 +03:00
Matt Ellis
6f259f5207 Extract E474 error message 2025-09-16 16:33:40 +03:00
Matt Ellis
a9e503d13f Extract error messages from code 2025-09-16 16:33:40 +03:00
Matt Ellis
5297193649 Assert full error message, not partial
There's no good reason to only check a partial match. Make sure the entire string is correct.
2025-09-16 16:33:40 +03:00
Matt Ellis
4c84241d2a Remove unnecessary error text messages
Let the IDE do this from the code
2025-09-16 16:33:40 +03:00
Matt Ellis
612dfe321c Fix typo 2025-09-16 16:33:40 +03:00
Matt Ellis
c0f9f0bcbc Rename cryptic error messages to error codes 2025-09-16 16:33:40 +03:00
Matt Ellis
e7769e33d7 Remove or rename unnecessary messages 2025-09-16 16:33:40 +03:00
Matt Ellis
c725447c00 Refactor messages for ActionListCommand 2025-09-16 16:33:40 +03:00
Matt Ellis
920ac0546e Replace custom errors with error codes 2025-09-16 16:33:40 +03:00
Matt Ellis
c5e3c9ccf1 Rename messages to be more consistent 2025-09-16 16:33:40 +03:00
Matt Ellis
f8d5d049bc Simplify code to remove duplicate error message 2025-09-16 16:33:40 +03:00
Matt Ellis
5c45c62c5b Rename some error message identifiers 2025-09-16 16:33:40 +03:00
Matt Ellis
f1d0206c66 Refactor code to remove unnecessary messages
The code doesn't require nullable arguments, which removes null check error messages. Also removed some "not implemented" messages from resources. There's no need for them to be in resources, hopefully we'll implement them soon.
2025-09-16 16:33:40 +03:00
Matt Ellis
e00960ebbc Tidy up host message bundle 2025-09-16 16:33:40 +03:00
Matt Ellis
fd6fe37c8f Remove unnecessary Msg class
Using string identifiers means the IntelliJ resource tooling works better
2025-09-16 16:33:40 +03:00
Matt Ellis
76087fea93 Split host and engine bundles
This allows IntelliJ's property annotations to help in code
2025-09-16 16:33:40 +03:00
Matt Ellis
ec125c9c7e Restore API for external plugin compatibility 2025-09-12 12:56:58 +03:00
dependabot[bot]
4b69c9141d Bump org.jetbrains.kotlin:kotlin-stdlib from 2.2.10 to 2.2.20
Bumps [org.jetbrains.kotlin:kotlin-stdlib](https://github.com/JetBrains/kotlin) from 2.2.10 to 2.2.20.
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/master/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v2.2.10...v2.2.20)

---
updated-dependencies:
- dependency-name: org.jetbrains.kotlin:kotlin-stdlib
  dependency-version: 2.2.20
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-10 18:20:03 +03:00
dependabot[bot]
14aa0e7c93 Bump org.jetbrains.intellij.platform from 2.8.0 to 2.9.0
Bumps org.jetbrains.intellij.platform from 2.8.0 to 2.9.0.

---
updated-dependencies:
- dependency-name: org.jetbrains.intellij.platform
  dependency-version: 2.9.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-10 18:19:13 +03:00
Alex Plate
59459e5113 Introduce a hidden vimhints option to hide the new hints functionality 2025-09-10 14:58:46 +03:00
Alex Plate
54653d1d1b Specify ActionUpdateThread for ToggleHintsAction 2025-09-10 14:06:33 +03:00
Xinhe Wang
4e59af278b Avoid generating hints for another unfocused window 2025-09-10 11:36:04 +03:00
Matt Ellis
d4df794d3c Show message if no mapping found 2025-09-09 14:06:38 +03:00
Xinhe Wang
04273d005e Skip the tree nodes when generating hints to improve performance 2025-09-09 12:53:26 +03:00
Xinhe Wang
463a9e7ceb Generate hints for visible components whose parent is not visible 2025-09-09 12:53:26 +03:00
Xinhe Wang
aab1999782 Do not preserve previous hints if impossible 2025-09-09 12:53:26 +03:00
Xinhe Wang
733470f7b4 Allow repeated characters in hints 2025-09-09 12:53:26 +03:00
Matt Ellis
4c48b4cd42 Update comments and other PR feedback 2025-09-08 09:58:34 +03:00
Matt Ellis
aa46713d3d Move deprecated functions to bottom of class 2025-09-08 09:58:34 +03:00
Matt Ellis
aef0515183 Replace asDouble with a new toVimFloat function 2025-09-08 09:58:34 +03:00
Matt Ellis
b48f80ee7d Deprecate VimDataType.asString
Prefer `toVimString` to `asString`. It makes it more explicit that the caller requires a Vim String type, and must follow Vim's conversion rules, rather than simple requiring a string. It also prevents confusion with other string functions such as `toString`, `toOutputString`, `toInsertableString`.

The function is deprecated because it's in use by external plugins. There is no change in functionality.
2025-09-08 09:58:34 +03:00
Matt Ellis
fdda1f0eb6 Refactor VimInt.parseNumber 2025-09-08 09:58:34 +03:00
Matt Ellis
69fac0eff0 Deprecate VimDataType.asBoolean
The `asBoolean` method does not make it clear that only a Vim Number can be treated as a boolean and incorrectly allowed a Float to be converted.

If a caller needs a boolean value, it should be explicit that it must get a Number by calling `toVimNumber` and then using the new `booleanValue` accessor. This correctly allows conversion from a String, and other Vim datatypes will correctly raise an error.

The implementation of `VimString.toVimNumber` has been updated to match Vim behaviour, and the behaviour of the previously called `VimString.asDouble` by allowing trailing characters while converting a string to a number.

The `asBoolean` function is deprecated because it is used by external plugins.
2025-09-08 09:58:34 +03:00
Matt Ellis
9dd60cdb3b Introduce VimDataType.toOutputString
It's confusing to know the rules for converting between data types. This change introduces a semantically named method for getting a string representation that can be used in output and error messages.
2025-09-08 09:58:34 +03:00
Alex Plate
8aedadde5e [API] Use the new API for implementation of the ReplaceWithRegister 2025-09-05 17:54:25 +03:00
Alex Plate
763d4518eb Refactor: Replace deprecated fileSize property 2025-09-05 16:53:45 +03:00
Alex Plate
f5c1b11e4f [API] Rename Read to EditorAccessor 2025-09-05 16:51:06 +03:00
Xinhe Wang
0d38ac8d6f Allow focusing components with hints 2025-09-05 16:26:03 +03:00
Xinhe Wang
fd1f762bc2 Adjust the hint color to make it clearer 2025-09-05 16:26:03 +03:00
Xinhe Wang
cfdc3b7dc3 Display only hints prefixed by the currently entered letters 2025-09-05 16:26:03 +03:00
Xinhe Wang
eaaab34434 Bring clicked component highlighting back
The highlight will remain active for a fixed period of time.
2025-09-05 16:26:03 +03:00
Xinhe Wang
80f52d70c8 Encapsulate ShortcutDispatcher for use in NERDTree 2025-09-05 16:26:03 +03:00
Xinhe Wang
ff13845b57 Use custom key listener instead of ListPopup to select hints
As a result, the user no longer needs to press ENTER to action.

Note that component highlighting is temporarily removed.
2025-09-05 16:26:03 +03:00
Xinhe Wang
b349bb74db Encapsulate hints generation 2025-09-05 16:26:03 +03:00
Xinhe Wang
90cc7de761 Preserve previous hints if possible 2025-09-05 16:26:03 +03:00
Xinhe Wang
d674d33735 Basic hint generation (permutation) 2025-09-05 16:26:03 +03:00
Xinhe Wang
c4713ed89d Highlight the current selected component 2025-09-05 16:26:03 +03:00
Xinhe Wang
337fc91261 Traverse the accessible tree instead to support Skia components 2025-09-05 16:26:03 +03:00
Xinhe Wang
bd8dc5a74f Show a popup instead of a dialog to select the component 2025-09-05 16:26:03 +03:00
Xinhe Wang
9ae2bfea8d Select elements to click 2025-09-05 16:26:03 +03:00
Xinhe Wang
19ef7588f7 Create class Hint 2025-09-05 16:26:03 +03:00
Xinhe Wang
248111bd1c Change ToggleOptionAction to DumbAwareToggleAction 2025-09-05 16:26:03 +03:00
Xinhe Wang
76b0f13804 Use accessibleContext for checking clickable elements 2025-09-05 16:26:03 +03:00
Xinhe Wang
7ac9ce78ca Toggle hints with ToggleOptionAction
However, this does not work in Dumb Mode
2025-09-05 16:26:03 +03:00
Xinhe Wang
b304905b35 Simplify KeyStrokeTrie.getData by delegating to getTrieNode 2025-09-05 13:14:34 +03:00
Xinhe Wang
3d19696f3b Fix casting error in KeyStrokeTrie.getEntries
Return an empty sequence if the prefix node is not found in `KeyStrokeTrie`.
Passing a non-existent prefix previously would result in a casting error.
2025-09-05 13:14:34 +03:00
Matt Ellis
572c24ff31 Insert text from incsearch end offset 2025-09-05 12:37:45 +03:00
Matt Ellis
c4a43eef92 Support insert filename literally 2025-09-05 12:37:45 +03:00
Matt Ellis
c22992c16c Extract find filename at cursor to VimSearchHelper 2025-09-05 12:37:45 +03:00
Matt Ellis
01a612ad60 Add insert filename under caret action 2025-09-05 12:37:45 +03:00
Matt Ellis
606e5c6a9f Add 'isfname' option, not yet applied
Relates to VIM-4018
2025-09-05 12:37:45 +03:00
Matt Ellis
93ef18b32c Remove unnecessary JvmField annotations 2025-09-05 12:37:45 +03:00
Matt Ellis
fa4c62ebde Add insert big word at cursor literally action
Relates to VIM-2511
2025-09-05 12:37:45 +03:00
Matt Ellis
c5f6b2e336 Add insert big word at cursor command line action
Relates to VIM-2511
2025-09-05 12:37:45 +03:00
Matt Ellis
1e27220eaa Support insert word literally
Inserting a word and inserting it literally is the same operation. No need for another action

Fixes VIM-2511
2025-09-05 12:37:45 +03:00
Matt Ellis
b5484345f8 Add insert word under caret action for command line
Fixes VIM-2511
2025-09-05 12:37:45 +03:00
Matt Ellis
5d68ba26c2 Add insert current line literally action 2025-09-05 12:37:45 +03:00
Matt Ellis
5c8ca893e1 Insert current line by replaying keys 2025-09-05 12:37:45 +03:00
Matt Ellis
6aff6a07af Add insert current line in command line
Fixes VIM-2511
2025-09-05 12:37:45 +03:00
Matt Ellis
c580aaceed Add insert register literally action
Fixes VIM-2511
2025-09-05 12:37:45 +03:00
Matt Ellis
d204860a26 Remove write action from insert register action
Fixes VIM-3650
2025-09-05 12:37:45 +03:00
Matt Ellis
4bd4aefaca Add minor optimisation for simple register contents 2025-09-05 12:37:45 +03:00
Matt Ellis
161bb2b28b Insert register by replaying keys 2025-09-05 12:37:45 +03:00
Matt Ellis
4be143f4ff Fix move caret to previous big word to match Vim
The docs says it moves to the previous WORD, but in practice it moves to the previous whitespace character
2025-09-05 12:37:45 +03:00
Matt Ellis
4a86af9071 Fix move caret to next big word to match Vim
The docs says it moves to the next WORD, but in practice it moves to the next whitespace character
2025-09-05 12:37:45 +03:00
Matt Ellis
9a5339d8af Fix delete to use word instead of WORD 2025-09-05 12:37:45 +03:00
Matt Ellis
b70f15584f Remove obsolete comments 2025-09-05 12:37:45 +03:00
Matt Ellis
38928e82c8 Extract insert literal command line tests 2025-09-05 12:37:45 +03:00
Matt Ellis
aa5975485e Extract digraph command line tests 2025-09-05 12:37:45 +03:00
Matt Ellis
b6be329a08 Add tests for saving history when cancelling ex field 2025-09-05 12:37:45 +03:00
Matt Ellis
1a566b70d9 Add cmd history before executing
But save to register after executing. Matches Vim behaviour
2025-09-05 12:37:45 +03:00
Matt Ellis
b4eee5d45e Show indicator for current history entry 2025-09-05 12:37:45 +03:00
Matt Ellis
30dae9f4d9 Rename HistoryDownFilterAction and add tests 2025-09-05 12:37:45 +03:00
Matt Ellis
3ca51d0361 Rename HistoryDownAction and add tests 2025-09-05 12:37:45 +03:00
Matt Ellis
f282131414 Rename HistoryUpFilterAction and add tests 2025-09-05 12:37:45 +03:00
Matt Ellis
f5f14f308b Rename HistoryUpAction and add tests 2025-09-05 12:37:45 +03:00
Matt Ellis
6557169eec Remove unnecessary textExInput function 2025-09-05 12:37:45 +03:00
Matt Ellis
ed402d3b26 Extract ToggleOverstrikeActionTest
Vim calls this "overstrike". We'll update terminology to match.
2025-09-05 12:37:45 +03:00
Matt Ellis
44cb65859b Extract MoveCaretToPreviousBigWordAction 2025-09-05 12:37:45 +03:00
Matt Ellis
84eb131cea Extract MoveCaretToNextBigWordAction 2025-09-05 12:37:45 +03:00
Matt Ellis
9ce2c2ba3a Extract MoveCaretToLineEndActionTest 2025-09-05 12:37:45 +03:00
Matt Ellis
549d4a722f Extract MoveCaretToLineStartActionTest 2025-09-05 12:37:45 +03:00
Matt Ellis
667890cb4d Extract InsertRegisterActionTest 2025-09-05 12:37:45 +03:00
Matt Ellis
1ebaa34bda Extract DeleteToCaretActionTest 2025-09-05 12:37:45 +03:00
Matt Ellis
310d90466b Extract DeletePreviousWordActionTest 2025-09-05 12:37:45 +03:00
Matt Ellis
822052358e Extract DeletePreviousCharActionTest 2025-09-05 12:37:45 +03:00
Matt Ellis
d1eb1aeb4d Extract DeleteNextCharActionTest 2025-09-05 12:37:45 +03:00
Matt Ellis
8dd28cd257 Introduce CommandLineActionHandler base class 2025-09-05 12:37:45 +03:00
Matt Ellis
057259eba2 Move CommandKeyConsumer before CharArgumentConsumer 2025-09-05 12:37:45 +03:00
Matt Ellis
7f927ac62e Reorder register consumers 2025-09-05 12:37:45 +03:00
Matt Ellis
ecceab3fd6 Rename SelectRegisterConsumer 2025-09-05 12:37:45 +03:00
Matt Ellis
3e18fcd7f1 Rename StartSelectRegisterConsumer 2025-09-05 12:37:45 +03:00
Matt Ellis
747ffa1e7f Move CommandCountTest.kt 2025-09-05 12:37:45 +03:00
Matt Ellis
c3c581ceb6 Rename CommandConsumer to CommandKeyConsumer 2025-09-05 12:37:45 +03:00
Matt Ellis
abf7dc51bd Add doc comments for all key consumers 2025-09-05 12:37:45 +03:00
Matt Ellis
a0d3fd9eed Rename DeleteCommandConsumer to add Count 2025-09-05 12:37:45 +03:00
Matt Ellis
f53d93016d Make it a little easier to debug key consumers
Adding an `isApplicable` function allows avoiding stepping into irrelevant consumers
2025-09-05 12:37:45 +03:00
NaMinhyeok
ce6822fa82 Add repository condition to updateChangelog workflow
Signed-off-by: NaMinhyeok <nmh9097@gmail.com>
2025-09-05 11:51:48 +03:00
Alex Plate
e9bc665aaa Revert StatusBarWidgetsManager to be the project-level service 2025-09-05 10:43:25 +03:00
Alex Plate
0fd95c17cf Fix(VIM-4028): Disable new plugin registration because currently it causes an error and this should be properly reviewed 2025-09-05 10:38:30 +03:00
dependabot[bot]
faf7a44f7d Bump org.junit:junit-bom from 5.10.0 to 5.13.4
Bumps [org.junit:junit-bom](https://github.com/junit-team/junit-framework) from 5.10.0 to 5.13.4.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.10.0...r5.13.4)

---
updated-dependencies:
- dependency-name: org.junit:junit-bom
  dependency-version: 5.13.4
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-04 09:52:47 +03:00
dependabot[bot]
739336ca45 Bump org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm
Bumps [org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm](https://github.com/Kotlin/kotlinx.coroutines) from 1.8.1 to 1.10.2.
- [Release notes](https://github.com/Kotlin/kotlinx.coroutines/releases)
- [Changelog](https://github.com/Kotlin/kotlinx.coroutines/blob/master/CHANGES.md)
- [Commits](https://github.com/Kotlin/kotlinx.coroutines/compare/1.8.1...1.10.2)

---
updated-dependencies:
- dependency-name: org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm
  dependency-version: 1.10.2
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-04 09:52:39 +03:00
dependabot[bot]
759df9eb22 Bump org.jetbrains:annotations from 26.0.2 to 26.0.2-1
Bumps [org.jetbrains:annotations](https://github.com/JetBrains/java-annotations) from 26.0.2 to 26.0.2-1.
- [Release notes](https://github.com/JetBrains/java-annotations/releases)
- [Changelog](https://github.com/JetBrains/java-annotations/blob/master/CHANGELOG.md)
- [Commits](https://github.com/JetBrains/java-annotations/compare/26.0.2...26.0.2-1)

---
updated-dependencies:
- dependency-name: org.jetbrains:annotations
  dependency-version: 26.0.2-1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-04 09:36:07 +03:00
dependabot[bot]
6eefb1dd51 Bump org.jetbrains.intellij.platform from 2.7.2 to 2.8.0
Bumps org.jetbrains.intellij.platform from 2.7.2 to 2.8.0.

---
updated-dependencies:
- dependency-name: org.jetbrains.intellij.platform
  dependency-version: 2.8.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-04 05:19:17 +03:00
Xinhe Wang
7f107fcc21 Remove unused NerdTree ProjectViewListener from plugin configuration
The ProjectViewListener was already removed in 175bae51
2025-09-02 15:06:01 +01:00
Alex Plate
1c80863e12 Fix an issue that the application level service was called from the project level 2025-09-02 11:27:22 +03:00
Alex Plate
ec11c2ec70 Update status bar menu links with a sign that shows that this is an external link
Because of some encoding issues, I had to embed the string right in the code
2025-09-02 11:25:55 +03:00
Alex Plate
1e98fe2bed Add link to IdeaVim documentation in the status bar menu 2025-09-02 11:22:10 +03:00
Alex Plate
7558a9da39 Spellchecker is a separate plugin now and needs to be declared explicitly 2025-09-02 11:12:57 +03:00
Alex Plate
b47783090c Add new plugins for compatibility checks in TeamCity and plugin dependency validation. 2025-09-01 10:00:55 +03:00
IdeaVim Bot
b0361326b5 Add jetbrains-junie[bot] to contributors list 2025-08-30 09:01:45 +00:00
Alex Plate
1c6e9354fb Add instruction to examine commit content, not just messages
- Emphasize using git show to see full commit content
- Note that test files contain good examples for changelog
- Encourage looking at actual code changes for better understanding
- Help find specific command examples from tests
2025-08-30 11:57:20 +03:00
Alex Plate
2bc5daf2bf Add instruction to read PR comments for changelog guidance
- Emphasize reading PR comments from previous changelog updates
- Add gh command to view PR comments
- Note that review feedback may indicate what to avoid
- Help ensure special instructions from PR discussions are followed
2025-08-30 11:56:42 +03:00
Alex Plate
8e7beea33e Add note about reading only top portion of CHANGES.md
- Clarify that CHANGES.md is a large file
- Instruct to focus on [To Be Released] section and recent versions
- Avoid reading the entire file unnecessarily
2025-08-30 11:55:21 +03:00
Alex Plate
8b9e904623 Add dedicated section for updating changeNotes in build.gradle.kts
- Create separate section with detailed instructions for changeNotes
- Clarify that content should match CHANGES.md exactly (no summarizing)
- Provide HTML formatting guidelines and examples
- Emphasize not to create shorter or condensed versions
- Include example showing Markdown to HTML conversion
2025-08-30 11:19:59 +03:00
Alex Plate
ed14efc55c Add instruction to use PR titles as-is in changelog
- Specify that PR descriptions should be taken directly from PR titles
- Don't regenerate or rewrite PR descriptions
- Maintain author's original wording for PR entries
2025-08-30 11:11:40 +03:00
Alex Plate
deae5fea8e Add special rules for Merged PRs section in changelog
- Clarify that PRs have different inclusion criteria than Features/Fixes
- Note that internal changes and refactoring PRs should be included
- Emphasize acknowledging community contributions regardless of visibility
- Make clear that "user-visible only" rule doesn't apply to PRs section
2025-08-30 11:10:27 +03:00
Alex Plate
f5c5bd82ba Add another example of unclear changelog entry to avoid
- Add "Fixed inlay offset calculations" as bad example
- Show better alternative with specific user-visible case
- Reinforce that technical internal fixes should either have clear user impact or be omitted
2025-08-30 11:09:02 +03:00
Alex Plate
3b88a57478 Add guidance for clear, specific changelog entries
- Include bad example: "Fixed count validation in text objects" (too vague)
- Show better alternative: specific command that was fixed
- Emphasize: if unable to determine specific case, omit entry rather than be unclear
- Help ensure all changelog entries are meaningful to users
2025-08-30 11:07:13 +03:00
Alex Plate
00d08c3840 Add instructions to avoid duplication in changelog subsections
- Clarify that each change should appear in only ONE subsection
- Add note that features can also use YouTrack link format
- Emphasize no duplication between Features, Fixes, and other categories
- Update both Format Notes and Writing Style sections for clarity
2025-08-30 11:04:57 +03:00
Alex Plate
a5dd8cf8b1 Update PR title format for changelog updates
- Change PR title format to "Update changelog: <super short summary>"
- Add example showing how to summarize key changes in title
- Update both GitHub workflow and changelog instructions for consistency
2025-08-30 10:55:54 +03:00
Alex Plate
22b17e8cc5 Add instruction to include helpful documentation links in changelog
- Guide to search for and include official documentation links
- Add links to JetBrains features and Vim commands when relevant
- Include examples showing linked IntelliJ features (Next Edit Suggestion, multiple cursors)
- Help users find more information about mentioned features
2025-08-30 10:54:16 +03:00
Alex Plate
070b608687 Add guidance for including command examples in changelog
- Add instruction to include examples of commands/operations in changelog entries
- Update example entries to demonstrate including specific commands
- Show how to describe what now works for both fixes and features
- Help users understand how to use new features or what was fixed
2025-08-30 10:51:34 +03:00
Alex Plate
a72db2b5af Add user-focus emphasis to changelog instructions
- Clarify that internal code changes should not be logged
- Emphasize that changelog is for users, not developers
- Strengthen user-focused writing style guidelines
- Exclude refactoring, code cleanup, and internal architecture changes
2025-08-30 10:49:20 +03:00
Alex Plate
9f58c73d92 Refactor documentation structure and extract changelog instructions
- Simplified CLAUDE.md to avoid redundancy with other docs
- Created .claude/changelog-instructions.md with detailed changelog maintenance guide
- Updated GitHub Action to reference the new changelog instructions doc
- Added instructions for updating changeNotes in build.gradle.kts
- Added notes about excluding API module changes (experimental status)
- Added step to check previous changelog PRs for special instructions
2025-08-30 10:42:01 +03:00
Alex Plate
0b919b18b7 [API] Fix handling of empty strings in list option functions
The append, prepend, and remove functions now correctly handle empty
option values. When an option is empty (""), we use an empty list
instead of splitting the empty string which would result in [""].

This fixes test failures in OptionScopeTest for operations on empty options.
2025-08-29 19:00:37 +03:00
Alex Plate
9aff700a58 Add GitHub Action for automated changelog maintenance using Claude
This workflow runs daily at 5 AM UTC (or manually) and uses Claude to:
- Review commits and update CHANGES.md with meaningful changes
- Maintain the exact format used before the changelog gap
- Include YouTrack links for fixes (format: [VIM-XXXX](url))
- Reference merged PRs (excluding dependabot and Claude PRs)
- Handle the historical gap between versions 2.9.0 and 2.28.0
- Create PRs only when there are actual changes to document

Claude has access to git, GitHub CLI, and can fetch from YouTrack,
GitHub, and JetBrains plugin pages to gather accurate information.
2025-08-29 18:32:17 +03:00
Alex Plate
12fe8671d3 Add GitHub Action to automatically update IntelliJ version configurations
This workflow runs three times a year (August 15, April 30, December 1)
and uses Claude to check if new IntelliJ versions need to be added to
TeamCity test configurations. Claude will automatically create a PR if
a new version is needed.

The workflow can also be triggered manually for testing.
2025-08-29 18:11:27 +03:00
Alex Plate
fc2cea471b Add TeamCity configuration for IntelliJ 2025.2
Added test configuration for IntelliJ 2025.2 to run alongside 2025.1.
This ensures compatibility testing with the upcoming IDE version.
2025-08-29 18:11:27 +03:00
Alex Plate
9499716b18 [API] Simplify list option handling in OptionScope 2025-08-29 18:11:27 +03:00
Alex Plate
c66a212781 [API] Add experimental API warning to all plugin documentation
Added prominent warning notice to all Plugin API documentation files:
- Plugin-API-reference.md
- Plugin-API-introduction.md
- Plugin-API-quick-start-guide.md
- Plugin-API-tutorial-replace-with-register.md

The warning clearly states that the API is experimental and not
recommended for production use, with potential breaking changes.
2025-08-29 18:11:26 +03:00
Alex Plate
0099ea9073 [API] Update Plugin API Reference documentation for OptionScope
- Document that option() function now returns a value
- Add comprehensive documentation for list option methods (append, prepend, remove)
- Add utility methods documentation (toggle, split)
- Include practical usage examples and common use cases
- Update method signatures to reflect non-nullable returns
- Add Vim command equivalents for better understanding
2025-08-29 18:11:26 +03:00
Alex Plate
de809b528b [API] Turn OptionScopeImpl into an object 2025-08-29 18:11:26 +03:00
Alex Plate
c6adc48e81 [API] Make option() function return a value
This allows users to easily retrieve values from option scope:
val x = option { get<Int>("history") }

- Changed option() signature from Unit to generic T return type
- Updated VimApiImpl implementation to return the lambda result
- Added test demonstrating the new return value capability
2025-08-29 18:11:26 +03:00
Alex Plate
955ccc8151 [API] Make getOptionValue return type non-nullable
The implementation always returns a value or throws an exception,
so the return type should be non-nullable to reflect this behavior.
Updated extension functions to remove unnecessary null checks.
2025-08-29 18:11:26 +03:00
Alex Plate
907495df4d [API] Refactor OptionScope from abstract class to interface
- Convert OptionScope from abstract class to interface
- Extract inline functions with reified types as extension functions
- Make getOptionValue() and setOption() public interface methods
- Remove internal modifier layer functions
- Update OptionScopeImpl to implement new interface
- Add documentation recommending extension function usage
- Update test imports to use new extension functions
2025-08-29 18:11:25 +03:00
Alex Plate
2b276d316f [API] Add append(), prepend(), and remove() extension functions for list options
- append(): adds values to end of comma-separated list (like Vim's +=)
- prepend(): adds values to beginning of list (like Vim's ^=)
- remove(): removes values from list (like Vim's -=)
- All functions prevent duplicate values from being added
- Comprehensive test coverage for all scenarios
2025-08-29 18:11:25 +03:00
Alex Plate
4f1982d6bd [API] Add toggle() function to OptionScope for boolean options
Adds a simple toggle() function that flips boolean option values.
Works with both full option names and abbreviations.

Example usage:
  toggle("ignorecase")  // true → false, false → true
  toggle("ic")          // works with abbreviations
2025-08-29 18:11:25 +03:00
Alex Plate
a235648672 [API] Add split() extension function to OptionScope for comma-separated values
Adds a concise String.split() extension function within OptionScope that splits
comma-separated option values into lists. This simplifies working with list-type
options like 'virtualedit', 'whichwrap', etc.

Example usage:
  val values = get<String>("virtualedit")?.split() ?: emptyList()
  // "block,all" → ["block", "all"]
2025-08-29 18:11:25 +03:00
Alex Plate
85d5da4ab6 [API] Add comprehensive tests for OptionScope API
Added extensive test coverage for the OptionScope API including:
- String list options with various formats (single, multiple, empty values)
- Error handling for invalid values, empty names, and type mismatches
- Boundary conditions for integer options
- Boolean/integer type conversions
- Global vs local option scoping
- Option abbreviations
- Edge cases like trailing/leading commas and very long strings
2025-08-29 18:11:24 +03:00
Xinhe Wang
511da14b83 Support disabling extended NERDTree without restarting 2025-08-29 17:53:46 +03:00
Xinhe Wang
636fe0a76f Make extended NERDTree a separate VimExtension 2025-08-29 17:53:46 +03:00
Xinhe Wang
2b5342a935 Add support for ActivateNode in NERDTree Everywhere 2025-08-29 17:53:46 +03:00
Xinhe Wang
758aaf276a Extend NERDTree support to Tree components other than Project 2025-08-29 17:53:46 +03:00
jetbrains-junie[bot]
022dc9698b feat(junie): added .devcontainer.json 2025-08-29 16:53:20 +03:00
jetbrains-junie[bot]
6c3a9f214b feat(junie): added .junie workflow 2025-08-29 16:52:06 +03:00
Alex Plate
df82794f4f Fixed a missing | 2025-08-29 14:31:44 +03:00
Alex Plate
2d378327e7 Fix tests after bringing back the old ReplaceWithRegister 2025-08-29 14:00:24 +03:00
Alex Plate
0e37295988 Ignore some test for neovim 2025-08-29 13:55:27 +03:00
Alex Plate
0d342ea6c3 Disable the new ReplaceWithRegister test as it's flaky 2025-08-29 13:45:06 +03:00
Alex Plate
e343da03a1 Bring back the old implementation of the replace with register
The new implementation is now named ReplaceWithRegisterNew
2025-08-29 13:44:26 +03:00
Alex Plãte
a009766a1a "Claude Code Review workflow" 2025-08-29 12:05:24 +03:00
Alex Plãte
d40061f9a4 "Claude PR Assistant workflow" 2025-08-29 12:05:24 +03:00
Alex Plate
476389b9c3 Bring back actualText to keep the compatibility with an external plugin 2025-08-29 11:48:26 +03:00
Alex Plate
7e71676656 [API] The write lock should be taken on EDT 2025-08-29 11:45:22 +03:00
Alex Plate
6a149a8ba4 [API] Add an experimental status on the API 2025-08-29 11:45:22 +03:00
Xinhe Wang
b593d079c4 Correct the behavior of NERDTree-P to jump to the root node
It cannot be guaranteed that the tree has a single visible root.
2025-08-26 14:04:15 +01:00
Xinhe Wang
cfbb77f1db Fix(VIM-3981): make :set noNERDTree work
Please note that the ex-commands will still not be unregistered
2025-08-26 14:04:15 +01:00
Xinhe Wang
c6fc1046ee Extract helper functions in NerdTree.Util to the global scope
This is necessary because I would like to use `registerMappings` in
the constructor of `NerdDispatcher` where we have no access to
private methods of `NerdTree`.

Also, `callAction` is moved into `nerdtree.Mappings.Action` and
duplicated `addCommand` is removed.
2025-08-26 14:04:15 +01:00
Xinhe Wang
007d636310 Clear NERDTree's KeyStroke buffer after <ESC> is pressed
The user may have pressed `g` accidentally and wish to perform an
operation which is not prefix by `g`.

This gives the user a way to clear the keys entered previously and
matches Vim's behavior.
2025-08-26 14:04:15 +01:00
Xinhe Wang
8d2d3a21a3 Move update from NerdDispatcher to its abstract class
To make it reusable in the incoming extended NERDTree.

Note that this commit itself does not change any behavior.
2025-08-26 14:04:15 +01:00
Xinhe Wang
175bae51a1 Initiate SpeedSearch right after / is pressed in NERDTree
What we can benefit from this approach:

- User perspective

  The SpeedSearch input will pop up immediately to indicate that
  `/` has been pressed, and search text can then be entered to
  filter the tree nodes.

- Codebase perspective

  The `waitForSearch` property can be removed from the Dispatcher
  objects, and we can get rid of `ToolWindowManagerListener` and
  the concurrency issue in it. This keeps code simple and readable.

  In my previous attempt to preserve the `waitForSearch` prop, the
  Dispatcher object had to be passed to each action impl as an
  argument.
2025-08-26 14:04:15 +01:00
Alex Plate
186db70a22 [API] Specify and cleanup the error handling in the option scope
1) ExException is wrapped with the IllegalArgumentException. We cannot use the raw ExException as it's not defined in the API module. So, if any client will have an access only to the API module, they won't be able to handle this kind of the exception.

2) getOption throws IllegalArgumentException if the type classifier is null. I don't know when this might happen, but this looks more like a plugin developer error. Also, this allows to distinguish the wrong option name vs this type of problem

3) In setOption and getOption throw an exception if there is no such option. This clearly explains what is wrong with this call.

Note: there was a question of using exceptions vs some return values, even like `Result`. The decision falls into the using of exceptions as using the wrong arguments in the plugin is a programming error from the user point of view.
This means, if there is a plugin that checks some option that in reality doesn't exist, it's not a fail of the end user and the end user cannot do anything about that.
Also, using the `Result` will force the plugin developer to handle all possible failure branches, what is quite unnecessary when accessing a well-defined option.
2025-08-22 17:52:51 +03:00
Alex Plate
04d9282fb2 Change OutputPanelScopeImpl to be an object 2025-08-22 16:30:51 +03:00
Alex Plate
6f54a30bc3 Fix(VIM-4004): Add support for f13-f24 keys 2025-08-22 16:09:43 +03:00
Matt Ellis
1a7b54d0a9 Avoid importing unnecessary helper function 2025-08-22 15:26:26 +03:00
Matt Ellis
4cc3bd2b9f Use return value of Escape action
If none of the IDE Escape handlers do anything, we get Vim's lovely beep
2025-08-22 15:26:26 +03:00
Matt Ellis
f0a104a131 Reset caret shape on Escape
Provides a way to reset and resync the caret shape by hitting Escape, even if we don't change mode
2025-08-22 15:26:26 +03:00
Matt Ellis
ef66a15faf Reuse existing colour when changing caret
Maintains the colour set by Next Edit Suggestions when changing mode

Fixes VIM-4010. Fixes VIM-3455
2025-08-22 15:26:26 +03:00
Matt Ellis
d8a79cb12f Use Vim actions to insert Tab
Previously, we would drop out of VimShortcutKeyAction when hitting Tab in Insert mode. This allowed Emmet to work because ExpandLiveTemplateByTabAction (one of the many actions registered for Tab) would have a chance to handle it.

Now we let Tab actions try to handle the key before Vim does, so we can let Vim handle Tab. In Insert mode, Vim now inserts the tab (or equivalent spaces) by invoking the "EditorTab" action, which is the same as the TabAction handler in the list of actions. Because Vim does this, we can now easily repeat inserting Tab without workarounds, remap `<Tab>` and `<S-Tab>` and Vim will update scroll locations after inserting the text.

Fixes VIM-2331. Fixes JetBrains/ideavim#938. Fixes JetBrains/ideavim#280
2025-08-22 15:26:26 +03:00
Matt Ellis
74a04dd235 Do not expand Live Templates in Normal mode 2025-08-22 15:26:26 +03:00
Matt Ellis
2aaf9badd5 Order IDE actions for Tab before Vim actions
Fixes VIM-4010
2025-08-22 15:26:26 +03:00
Matt Ellis
0950585e13 Fix initialising non-default colorcolumn option
Fixes VIM-3984
2025-08-22 15:25:55 +03:00
Matt Ellis
d850052f20 Fix count accepted as valid in text object
Fixes VIM-3960
2025-08-22 14:17:33 +03:00
Xinhe Wang
629a0f7aab Indicate error when an unrecognized key sequence is entered in NERDTree 2025-08-22 14:16:31 +03:00
Matt Ellis
cb74ff6af2 Fix normalising visual column
Would previously normalise against the entire buffer line length rather than just the current visual line length. For short lines, this would not include inlays, and would therefore position the caret wrong when moving up/down at end of line. For long, wrapped lines, this just plain wouldn't work.

Fixes VIM-3997
2025-08-22 14:15:44 +03:00
Matt Ellis
c9ebc1c4ae Fix calculation of visual column with inlays
Was assuming caret was always on a text character visual column, but could be on an inlay.

Fixes VIM-4007
2025-08-22 14:15:44 +03:00
Alex Plate
a0a3f3f3b1 Fix an exception during the renaming: there was a read action missing 2025-08-22 11:22:38 +03:00
Alex Plate
aa539e76eb Rename RWLockLabel to VimLockLabel and other annotations
Also, clarify their usage
2025-08-22 11:22:38 +03:00
dependabot[bot]
4ab42db6a9 Bump org.jetbrains.kotlin:kotlin-stdlib from 2.2.0 to 2.2.10
Bumps [org.jetbrains.kotlin:kotlin-stdlib](https://github.com/JetBrains/kotlin) from 2.2.0 to 2.2.10.
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/master/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v2.2.0...v2.2.10)

---
updated-dependencies:
- dependency-name: org.jetbrains.kotlin:kotlin-stdlib
  dependency-version: 2.2.10
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-20 18:50:38 +03:00
dependabot[bot]
fbb8abe386 Bump org.jetbrains.intellij.platform from 2.7.1 to 2.7.2
Bumps org.jetbrains.intellij.platform from 2.7.1 to 2.7.2.

---
updated-dependencies:
- dependency-name: org.jetbrains.intellij.platform
  dependency-version: 2.7.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-20 18:48:42 +03:00
IdeaVim Bot
8e5d4b156c Add Na Minhyeok to contributors list 2025-08-20 09:01:54 +00:00
Alex Plate
55dd27db33 Update the contribution guide to avoid the confusion
By feedback https://github.com/JetBrains/ideavim/pull/1271#issuecomment-3203657519
2025-08-20 09:37:06 +03:00
Alex Plate
2136836877 Merge all configuration files into a single plugin.xml
The way we split plugin.xml was outdated. Also, it started to show errors in highlighting, even there were no errors.
It's better to keep everything in a single file
2025-08-20 09:18:16 +03:00
NaMinhyeok
ca676ca973 Fix Gradle build deprecation warnings and improve type safety
- Replace deprecated java.net.URL and HttpURLConnection with Ktor HttpClient in slackNotification task
- Fix deprecated intellijPlatform API calls:
  - create(ideaType, ideaVersion, useInstaller) → create(ideaType, ideaVersion) { this.useInstaller = useInstaller }
  - verifyPlugin → pluginVerification
- Add explicit Task type parameters to all tasks.register() calls to resolve Kotlin type inference warnings

Signed-off-by: NaMinhyeok <nmh9097@gmail.com>
2025-08-19 16:59:06 +03:00
dependabot[bot]
82d3420570 Bump org.jetbrains.changelog from 2.3.0 to 2.4.0
Bumps org.jetbrains.changelog from 2.3.0 to 2.4.0.

---
updated-dependencies:
- dependency-name: org.jetbrains.changelog
  dependency-version: 2.4.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-13 19:33:32 +03:00
dependabot[bot]
060135737d Bump org.jetbrains.intellij.platform from 2.6.0 to 2.7.1
Bumps org.jetbrains.intellij.platform from 2.6.0 to 2.7.1.

---
updated-dependencies:
- dependency-name: org.jetbrains.intellij.platform
  dependency-version: 2.7.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-13 19:16:19 +03:00
Alex Plate
63e482408d Fix compilation issues 2025-08-08 18:28:52 +03:00
Alex Plate
ddb4c5ec81 Comment out listeners scope. It does require an accurate and proper review and design 2025-08-08 18:07:59 +03:00
Alex Plate
22e6ba3b3c Refactor DigraphScopeImpl to be an object and simplify digraph method logic 2025-08-08 18:04:09 +03:00
Alex Plate
e2a089fbeb Remove function to clearing all custom digraphs
This function is not provided by vim and by using it from the plugins we may drop the digraphs created by other plugins.
It'd be better to provide a just remove function. However, let's skip it for now. Also, maybe we should use an approach with the owners
2025-08-08 18:00:30 +03:00
Alex Plate
5cfed9929e Refresh documentation for MappingScope 2025-08-08 17:43:00 +03:00
Alex Plate
e85c006321 Remove isRepeatable parameter from key mapping methods
First of all, this is a property of the plugin, not the mapping. Secondly, all plugins should support repeat.
2025-08-08 17:11:10 +03:00
Alex Plate
1db8d01961 Add detailed documentation for label usage in key mapping methods
Documented the role of `label` in providing intermediate mappings, allowing users to override default plugin mappings with custom configurations.
2025-08-08 16:23:37 +03:00
Alex Plate
9c9cd1b2a0 Bring back the function to set the mode, but in experimental status now 2025-08-08 14:28:01 +03:00
Alex Plate
fb6a97f586 Remove redundant return statement in CommandLineScope 2025-08-08 12:44:30 +03:00
Alex Plate
87f5a6fab3 Remove stub classes
This solution was initially questionable. For a long time it produced nothing but more work on implementing the stubs.
2025-08-08 12:44:30 +03:00
Alex Plate
9d92ae9449 Remove the suspend from functions under the read or write actions
The suspending operations must not be performed under the read or write actions as this will lead to performance issues or freezes.

Also, the current implementation of launching coroutine under the write action is simply incorrect. The coroutine will escape the write action into another thread.
2025-08-08 12:44:30 +03:00
Alex Plate
492bd62166 Rename VimScope to VimApi and move it into a different package
`VimApi` would be a better entry point name. Also, the API term is clearer than the scope.
2025-08-08 12:44:30 +03:00
Alex Plate
a0c213b90d Refactor Mode in API to be a simple enum
The current representation of Mode with `returnTo` is quite complicated and we're not even sure it'll remain like that.
At the same time, `mode()` function in Vim has quite a reach specification and there is a small chance it'll be changed. With this approach, we use values from Vim, yet in a form of enum.
2025-08-08 12:44:30 +03:00
Alex Plate
fee75001f6 Do not allow to change the mode from the API
The details why we don't want this for now are logged in the code
2025-08-08 12:44:29 +03:00
Alex Plate
df3fb1a8a3 Convert VimScope into the interface 2025-08-08 12:44:29 +03:00
Alex Plate
057f4eee5d The ReadImpl does not inherit the VimScopeImpl
`ReadImpl` didn't use anything from `VimScopeImpl`. This would make sense if `Read` inherited `VimScope`, but it doesn't.
Also, we'll always be able to bring back the dependency if we figure out it's necessary.
2025-08-08 12:44:29 +03:00
Alex Plate
e2b20bb04d Reformat API module 2025-08-08 12:44:29 +03:00
Alex Plate
add8023155 Rename @VimPluginDsl to @VimApiDsl
The API is a more correct term, despite the fact that the API will be mostly used from the plugins.
2025-08-08 12:44:29 +03:00
Alex Plate
88e77d1bea Add API module to the gradle config 2025-08-08 12:44:29 +03:00
Matt Ellis
e6ed15c772 Fix command line missing due to empty colour
Fixes VIM-3993
2025-08-08 11:57:12 +03:00
dependabot[bot]
0867dbd420 Bump org.junit.jupiter:junit-jupiter from 5.13.3 to 5.13.4
Bumps [org.junit.jupiter:junit-jupiter](https://github.com/junit-team/junit-framework) from 5.13.3 to 5.13.4.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.3...r5.13.4)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter
  dependency-version: 5.13.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-06 18:27:06 +03:00
Mia Vucinic
3cb5308193 fix failing tests 2025-08-01 16:16:29 +03:00
Mia Vucinic
093769ee7c add file lock to ensure exclusive access 2025-08-01 16:16:29 +03:00
Mia Vucinic
fd58a61685 remove ReplaceWithRegister options from tests
- since enabling and disabling extensions is no longer done using options, options in tests can be removed
2025-08-01 16:16:28 +03:00
Mia Vucinic
562ae63805 fix ReplaceWithRegister test
- remove unnecessary new lines in tests
2025-08-01 16:16:28 +03:00
Mia Vucinic
04603ae61f add new extensions API handling in test 2025-08-01 16:16:27 +03:00
Mia Vucinic
807dff45a9 add a new ReplaceWithRegister plugin implementation 2025-08-01 16:16:27 +03:00
Mia Vucinic
a25b88327e implement PlugDisable command 2025-08-01 16:16:27 +03:00
Mia Vucinic
fbb2351ec2 implement PlugEnable command 2025-08-01 16:16:26 +03:00
Mia Vucinic
621969faec implement a new way for registering extensions 2025-08-01 16:16:26 +03:00
Mia Vucinic
26e33c088c implement ksp for extensions processing 2025-08-01 16:16:26 +03:00
Mia Vucinic
efdd0b9910 Add docs for the new Plugin API 2025-08-01 15:44:06 +03:00
Alex Plãte
38fba69c33 Merge pull request #1246 from JetBrains/thin-api-first-draft
API for writing plugins
2025-08-01 15:43:46 +03:00
dependabot[bot]
4764ffbbf5 Bump org.jetbrains.changelog from 2.2.1 to 2.3.0
Bumps org.jetbrains.changelog from 2.2.1 to 2.3.0.

---
updated-dependencies:
- dependency-name: org.jetbrains.changelog
  dependency-version: 2.3.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-30 18:52:03 +03:00
dependabot[bot]
2d9d000417 Bump com.squareup.okhttp3:okhttp from 4.12.0 to 5.0.0
Bumps [com.squareup.okhttp3:okhttp](https://github.com/square/okhttp) from 4.12.0 to 5.0.0.
- [Changelog](https://github.com/square/okhttp/blob/master/CHANGELOG.md)
- [Commits](https://github.com/square/okhttp/compare/parent-4.12.0...parent-5.0.0)

---
updated-dependencies:
- dependency-name: com.squareup.okhttp3:okhttp
  dependency-version: 5.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-30 18:50:43 +03:00
dependabot[bot]
2dfaff802d Bump io.ktor:ktor-client-auth from 3.2.2 to 3.2.3
Bumps [io.ktor:ktor-client-auth](https://github.com/ktorio/ktor) from 3.2.2 to 3.2.3.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.2.2...3.2.3)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-auth
  dependency-version: 3.2.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-30 18:50:35 +03:00
Mia Vucinic
06e34d6005 add a default value for isBigWord in getNextWordStartOffset and getNextWordEndOffset 2025-07-29 16:27:03 +02:00
Mia Vucinic
8ae792e74e add return value to with and withPrimaryCaret 2025-07-29 16:23:12 +02:00
Mia Vucinic
15660a9f3d make functions in output panel scope non suspend 2025-07-29 16:10:15 +02:00
Xinhe Wang
64033078b2 Use vimLogger instead in NerdTree 2025-07-29 10:43:43 +03:00
Xinhe Wang
ddff706ac8 Avoid NERDTree getting stuck by an invalid key sequence
This is not a complete fix, but a temporary measure to prevent it
from stopping responding.
2025-07-29 10:43:43 +03:00
Xinhe Wang
2e55cc1af8 Fix(VIM-3437): correct the behavior of NERDTree-X 2025-07-29 10:43:43 +03:00
Xinhe Wang
33f04869bf Fix(VIM-3985): correct the behavior of NERDTree-x 2025-07-29 10:43:43 +03:00
Xinhe Wang
aeaceca76e Extract navigation-related NERDTree actions to make them reusable
Code is simplified in this commit but the actual behavior remains unchanged
2025-07-29 10:43:43 +03:00
Xinhe Wang
e587161169 Refactor NerdAction
Removing `project` parameter from NerdAction.Code.action makes it
possible to extend NERDTree support to all tree components other
than the Project tool window.
2025-07-29 10:43:43 +03:00
Xinhe Wang
b3fd205148 Extract dispatcher logic from NerdTree into AbstractDispatcher 2025-07-29 10:43:43 +03:00
Xinhe Wang
4558c3f5c8 Encapsulate KeyStrokeTrie in extension.nerdtree.Mappings
This avoids external manipulation of the KeyStroke set, resulting
in data inconsistency.
2025-07-29 10:43:43 +03:00
Xinhe Wang
962abda86b Convert NerdDispatcher to a light service
Since there's no need to expose the dispatcher, we can safely
convert it to a light service as suggested by DevKit.

See https://plugins.jetbrains.com/docs/intellij/plugin-services.html#light-services
2025-07-29 10:43:43 +03:00
Matt Ellis
7d9fa418ce Support :k{mark} without separating whitespace
Fixes VIM-3915
2025-07-28 12:21:46 +03:00
Matt Ellis
68e9538ac5 Remove unnecessary special case handling of subst
This was added before the grammar made whitespace optional between command and argument
2025-07-28 12:21:46 +03:00
Mia Vucinic
72accdd186 remove exception throwing from getFocusedEditor function 2025-07-28 10:26:51 +02:00
Mia Vucinic
4282a58719 fix doc comments for count parameter 2025-07-28 10:21:40 +02:00
Mia Vucinic
f74552ef19 fix replaceText when editor is empty 2025-07-28 10:07:17 +02:00
Mia Vucinic
a4e9e70df7 add test for inserting empty text and fix coerceIn function 2025-07-28 07:32:29 +02:00
Mia Vucinic
3c32c8bbe7 rename VimHighlightingServiceImpl to IjVimHighlightingService and VimPluginServiceImpl to IjVimPluginService 2025-07-28 07:32:29 +02:00
Mia Vucinic
265e2e14e7 move thin api services from the extension package to the thinapi package 2025-07-28 07:32:29 +02:00
Mia Vucinic
55b44aab53 implement add caret and remove caret functions 2025-07-28 07:32:18 +02:00
Alex Plate
e13deb48cc Fix: Respect isIdeaVimDisabledHere flag in OctopusHandler 2025-07-25 13:13:29 +03:00
Matt Ellis
8ab7122e65 Fix issues with new islands theme
Stops the new frame background showing in the output panel, and returns the coloured background for the mode status bar widget.
2025-07-25 09:54:53 +03:00
Mia Vucinic
c95421518e fix path handling for jump and marks 2025-07-24 17:13:41 +02:00
Mia Vucinic
a45b642d1e fix exceptions 2025-07-24 09:26:16 +02:00
Mia Vucinic
9d09f824df fix executeNormalWithoutMapping function 2025-07-24 08:16:23 +02:00
Mia Vucinic
5d731ff818 fix editor size 2025-07-24 08:15:47 +02:00
Mia Vucinic
5f4cd75898 remove unnecessary getNextWordStartOffset function from VimScope 2025-07-24 08:15:09 +02:00
Mia Vucinic
9443f16551 remove unused variable and some comments 2025-07-24 08:00:00 +02:00
Mia Vucinic
6abee14079 have CaretTransaction extend Read 2025-07-24 07:56:23 +02:00
dependabot[bot]
e0c7f05c1e Bump org.junit.jupiter:junit-jupiter-api from 5.13.3 to 5.13.4
Bumps [org.junit.jupiter:junit-jupiter-api](https://github.com/junit-team/junit-framework) from 5.13.3 to 5.13.4.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.3...r5.13.4)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-api
  dependency-version: 5.13.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-23 18:32:42 +03:00
dependabot[bot]
f474d44d27 Bump org.junit.vintage:junit-vintage-engine from 5.13.2 to 5.13.4
Bumps [org.junit.vintage:junit-vintage-engine](https://github.com/junit-team/junit-framework) from 5.13.2 to 5.13.4.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.2...r5.13.4)

---
updated-dependencies:
- dependency-name: org.junit.vintage:junit-vintage-engine
  dependency-version: 5.13.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-23 18:32:32 +03:00
Mia Vucinic
d5e64a8f28 split read into Read and ReadScope
- We want to be able to execute functions defined on read scope under write lock as well, which means we want to have transaction extend read. However, due to conflicting names for caret scope builders (forEachCaret, withPrimaryCaret etc.) it was necessary to split it into two scopes:
1) Read - contains only functions available under read lock
2) ReadScope - contains both caret scope builders and functions defined on Read
2025-07-23 12:01:28 +02:00
Mia Vucinic
256fe515b0 add resetting for mocks in tests 2025-07-22 15:31:11 +02:00
Mia Vucinic
e7ec16e8f1 remove variable locking 2025-07-22 13:46:04 +02:00
Mia Vucinic
74e213af1d remove methods from caret transaction 2025-07-22 13:42:13 +02:00
Mia Vucinic
246e6e4444 remove onRemove method from listener 2025-07-22 13:41:18 +02:00
Mia Vucinic
0b8a72de95 return VimHighlightedYankTest.kt to previous state 2025-07-22 13:33:48 +02:00
Mia Vucinic
359769733c return VimListenerManager.kt to previous state 2025-07-22 13:33:12 +02:00
Mia Vucinic
8bf60bcb68 add lines to VimExtension and VimExtensionRegistrar.kt 2025-07-22 13:30:53 +02:00
Mia Vucinic
2aa5230aa7 fix docs 2025-07-22 13:29:41 +02:00
Mia Vucinic
ceaa74854f add docs 2025-07-22 13:17:04 +02:00
Mia Vucinic
96734867e5 revert VimExtension to previous state 2025-07-22 12:52:11 +02:00
Mia Vucinic
cc9a39fa6d revert VimExtensionRegistrar to previous state 2025-07-22 12:50:49 +02:00
Mia Vucinic
4d680465fb delete vim plugin base 2025-07-22 12:48:14 +02:00
Mia Vucinic
02a9d284b3 repackage files 2025-07-22 12:47:00 +02:00
Mia Vucinic
fd5e84eddc add docs 2025-07-22 12:39:10 +02:00
Mia Vucinic
f5cf751a0a move files to appropriate packages 2025-07-22 12:31:53 +02:00
Mia Vucinic
6f4bd936f9 update docs 2025-07-22 12:12:39 +02:00
Mia Vucinic
657f7f5f9c fix modal input tests after rebasing 2025-07-22 08:22:45 +02:00
Mia Vucinic
b3561c8b1e revert "attempt to have extensions disabled when the ideavim plugin is turned off"
This reverts commit cfc3b827ea327eedb15d3e9d48c26228db67b153.
2025-07-21 21:06:39 +02:00
Mia Vucinic
38a4512b00 revert "convert VimExtension file to Kotlin"
This reverts commit 58c84a7d3af3fc3a3c597949e059d86784825697.
2025-07-21 21:06:39 +02:00
Mia Vucinic
b96498a564 revert "make init function in VimExtension suspend"
This reverts commit 87dba1e2951d22b8a62d5c45e9ea20720dbacec2.
2025-07-21 21:06:39 +02:00
Mia Vucinic
85c3a78fb4 revert "make init function in VimPluginBase suspend"
This reverts commit 9d0d941adab09b03b7c2287a5e8ffd3fa4626dd4.
2025-07-21 21:06:39 +02:00
Mia Vucinic
62c816c80e refactor insert and replace text in caret transaction impl 2025-07-21 21:06:39 +02:00
Mia Vucinic
1b1d5815f4 fix validating offsets for replace text 2025-07-21 21:06:39 +02:00
Mia Vucinic
34af17d18e rename caretAfterInsertedText to caret at end 2025-07-21 21:06:39 +02:00
Mia Vucinic
67fa38d999 add caret transaction test 2025-07-21 21:06:39 +02:00
Mia Vucinic
891b6316eb add a replace text blockwise function 2025-07-21 21:06:39 +02:00
Mia Vucinic
b00274699d add option scope test 2025-07-21 21:06:39 +02:00
Mia Vucinic
cff4f75feb add modal input test 2025-07-21 21:06:39 +02:00
Mia Vucinic
9e6fb85325 add test for digraph scope 2025-07-21 21:06:39 +02:00
Mia Vucinic
f23e190849 delete on global option change listener 2025-07-21 21:06:39 +02:00
Mia Vucinic
5d525b0f38 add transaction test 2025-07-21 21:06:39 +02:00
Mia Vucinic
8e0f854f70 add read test 2025-07-21 21:06:39 +02:00
Mia Vucinic
36c2f797a9 add tests for search functions in VimScope 2025-07-21 21:06:39 +02:00
Mia Vucinic
98b19b2396 add variable tests 2025-07-21 21:06:39 +02:00
Mia Vucinic
f9f4c6b17c add modes test 2025-07-21 21:06:39 +02:00
Mia Vucinic
8642f4afe9 remove suspend from some functions 2025-07-21 21:06:39 +02:00
Mia Vucinic
560689399b wrap body of export operator function in command 2025-07-21 21:06:39 +02:00
Mia Vucinic
758809f7d5 make some functions not suspend 2025-07-21 21:06:39 +02:00
Mia Vucinic
cd1a7adc9e make listeners work with coroutines 2025-07-21 21:06:39 +02:00
Mia Vucinic
979ef3fa1c make api use coroutines 2025-07-21 21:06:39 +02:00
Mia Vucinic
6aebedfbc0 add a coroutines library to the vim-engine module 2025-07-21 21:06:39 +02:00
Mia Vucinic
9ca46bf150 add coroutines library to api module 2025-07-21 21:06:39 +02:00
Mia Vucinic
91ab26406b make jetbrains annotation compileOnly in api module 2025-07-21 21:06:39 +02:00
Mia Vucinic
5b1595886b make init function in VimPluginBase suspend 2025-07-21 21:06:39 +02:00
Mia Vucinic
0fc4a4b476 make init function in VimExtension suspend 2025-07-21 21:06:39 +02:00
Mia Vucinic
5b7c25b0f5 convert VimExtension file to Kotlin 2025-07-21 21:06:39 +02:00
Mia Vucinic
eb39fb546c implement a proper getFocusedEditor function 2025-07-21 21:06:39 +02:00
Mia Vucinic
74a2fe39d7 remove unnecessary test setup from highlighted yank test 2025-07-21 21:06:39 +02:00
Mia Vucinic
dbe9deec1c add forEachEditor function 2025-07-21 21:06:39 +02:00
Mia Vucinic
c4bb7e4145 fix replace with register plugin to work in visual block mode 2025-07-21 21:06:39 +02:00
Mia Vucinic
72af6fc313 add functions from VimDigraphGroup 2025-07-21 21:06:39 +02:00
Mia Vucinic
dba11ab1c3 implement path 2025-07-21 21:06:39 +02:00
Mia Vucinic
101d94e12a fix when some search functions return out-of-bounds offset 2025-07-21 21:06:39 +02:00
Mia Vucinic
9a79cdc3ab add functions from vim search helper 2025-07-21 21:06:39 +02:00
Mia Vucinic
dd1c5412ed introduce read and transaction scope for command line 2025-07-21 21:06:39 +02:00
Mia Vucinic
6cb4e2946f delete unnecessary functions from command line scope 2025-07-21 21:06:39 +02:00
Mia Vucinic
641fd42ecf rename getOptionValue to get and resetOptionToDefault to reset 2025-07-21 21:06:39 +02:00
Mia Vucinic
ee64316676 introduce option scope 2025-07-21 21:06:39 +02:00
Mia Vucinic
ea415d4c4f decouple some functions in vim search helper from the caret 2025-07-21 21:06:39 +02:00
Mia Vucinic
6eb71cb95e add functions for saveFile and closeFile in VimScope 2025-07-21 21:06:39 +02:00
Mia Vucinic
86c225616e add initial vim storage service implementation 2025-07-21 21:06:39 +02:00
Mia Vucinic
30190b43fc rename isVariableLocked to islocked 2025-07-21 21:06:39 +02:00
Mia Vucinic
bffa752855 rename parse variable value to convert to kotlin type 2025-07-21 21:06:39 +02:00
Mia Vucinic
4e97be5319 add test for convertToVimDataType function 2025-07-21 21:06:39 +02:00
Mia Vucinic
b0c5d8f658 add setVariable and lockvar/unlockvar functions 2025-07-21 21:06:39 +02:00
Mia Vucinic
c6176f1ac8 add initial command line implementation 2025-07-21 21:06:39 +02:00
Mia Vucinic
af1246bf9a add findNext and findPrevious methods to VimRegexpService 2025-07-21 21:06:39 +02:00
Mia Vucinic
af9fe9e44e add with primary caret method 2025-07-21 21:06:39 +02:00
Mia Vucinic
c1d6a5574b add contract on editor scope 2025-07-21 21:06:39 +02:00
Mia Vucinic
b7f69c8c28 add command function 2025-07-21 21:06:39 +02:00
Mia Vucinic
61b515260c rename repeat until to repeat while 2025-07-21 21:06:38 +02:00
Mia Vucinic
65c845fc78 fix updating modal input label 2025-07-21 21:06:38 +02:00
Mia Vucinic
d774505801 add update label function to modal input 2025-07-21 21:06:38 +02:00
Mia Vucinic
11e2c00fd8 add modal input implementation 2025-07-21 21:06:38 +02:00
Mia Vucinic
17e261a9e8 add output panel functions 2025-07-21 21:06:38 +02:00
Mia Vucinic
b3dd404aa2 add vimscript executor functions 2025-07-21 21:06:38 +02:00
Mia Vucinic
fdb677dde1 add vim window group functions 2025-07-21 21:06:38 +02:00
Mia Vucinic
74e40ccff8 add vim scroll group functions 2025-07-21 21:06:38 +02:00
Mia Vucinic
008a143284 add vim regexp service functions 2025-07-21 21:06:38 +02:00
Mia Vucinic
124f4345ee add tab service functions 2025-07-21 21:06:38 +02:00
Mia Vucinic
a70fc85ca0 add jump service implementation 2025-07-21 21:06:38 +02:00
Mia Vucinic
bed26eecdc convert some mark functions to fields 2025-07-21 21:06:38 +02:00
Mia Vucinic
d655ba2ece remove unnecessary functions for recording macros 2025-07-21 21:06:38 +02:00
Mia Vucinic
b201e9a85c remove unnecessary functions from the options api 2025-07-21 21:06:38 +02:00
Mia Vucinic
f503ba5c77 convert fromRgba function to constructor 2025-07-21 21:06:38 +02:00
Mia Vucinic
23db1c7069 delete old test 2025-07-21 21:06:38 +02:00
Mia Vucinic
6c403f6288 move path to separate file 2025-07-21 21:06:38 +02:00
Mia Vucinic
3632511ea2 add documentation and range annotation to mark class 2025-07-21 21:06:38 +02:00
Mia Vucinic
fa0162f8d4 add jetbrains annotations dependency 2025-07-21 21:06:38 +02:00
Mia Vucinic
12819261d3 add initial marks api 2025-07-21 21:06:38 +02:00
Mia Vucinic
1dadbe77b7 add additional mappings 2025-07-21 21:06:38 +02:00
Mia Vucinic
d633686e75 add initial options api 2025-07-21 21:06:38 +02:00
Mia Vucinic
3508006f0f add register-related operations and properties from VimInjector to CaretRead interface and implementation 2025-07-21 21:06:38 +02:00
Mia Vucinic
d262ce58d5 add more functions and properties into the color class and move parse rgba color to the highlighted yank extension 2025-07-21 21:06:38 +02:00
Mia Vucinic
ba78d9d518 rename addHighlighter, removeHighlighter, HighlighterId to addHighlight, removeHighlight and HighlightId 2025-07-21 21:06:38 +02:00
Mia Vucinic
38c53ea91e rename visualSelectionMarks to selectionMarks 2025-07-21 21:06:38 +02:00
Mia Vucinic
71f8c4af1e introduce simple range and block range 2025-07-21 21:06:38 +02:00
Mia Vucinic
884ab72fc6 rename fileSize to text length 2025-07-21 21:06:38 +02:00
Mia Vucinic
d9f196af41 hide one getVariable function with @PublishedApi annotation 2025-07-21 21:06:38 +02:00
Mia Vucinic
b148ed62eb remove getSelectionTypeForCurrentMode function since it is not used anymore 2025-07-21 21:06:38 +02:00
Mia Vucinic
7e78e27d6c introduce Line class 2025-07-21 21:06:38 +02:00
Mia Vucinic
76dd95b62a fix implementation for selection and visual selection marks 2025-07-21 21:06:38 +02:00
Mia Vucinic
504c98ab11 refactor vim scope 2025-07-21 21:06:38 +02:00
Mia Vucinic
d09af15eb2 refactor transaction interface 2025-07-21 21:06:38 +02:00
Mia Vucinic
cca73409bb refactor read interface 2025-07-21 21:06:38 +02:00
Mia Vucinic
71599ff01c rename highlighter to highlighter id 2025-07-21 21:06:38 +02:00
Mia Vucinic
2ec01d636b rename onPlugin listeners and delete onReplaceCharChange listener 2025-07-21 21:06:38 +02:00
Mia Vucinic
494da27353 make forEachCaret use sorted carets by default 2025-07-21 21:06:38 +02:00
Mia Vucinic
f51d4af762 change functions to fields in caret read and change signatures of the text functions, update ReplaceWithRegister new api implementaion 2025-07-21 21:06:38 +02:00
Mia Vucinic
dd9c1fdbdc get rid of register type 2025-07-21 21:06:38 +02:00
Mia Vucinic
3475171d49 Revert commits that remove VimBehaviourDiffers annotation and new lines in the replace with register plugin tests 2025-07-21 21:06:38 +02:00
Mia Vucinic
8a505fd807 fix replace with register extension implementation 2025-07-21 21:06:38 +02:00
Mia Vucinic
0f9e8d3ad5 get rid of unnecessary text manipulation options in transaction functions, change tests and delete previous (incomplete) implementation of these functions 2025-07-21 21:06:38 +02:00
Mia Vucinic
aecf4a8b87 attempt to have extensions disabled when the ideavim plugin is turned off 2025-07-21 21:06:38 +02:00
Mia Vucinic
9b91b16d88 move test for parseVariableValue function to service package and rename it
- since the parseVariableValue function was moved to variable service, tests for it are moved to a different file and package
2025-07-21 21:06:38 +02:00
Mia Vucinic
5a645f044d move parseVariableValue to variable service 2025-07-21 21:06:38 +02:00
Mia Vucinic
9eb7bb48d0 put exception messages in the properties file 2025-07-21 21:06:38 +02:00
Mia Vucinic
1c33a4e651 modify getNullableVariableValue to work when editor, context or vimContext is not available 2025-07-21 21:06:38 +02:00
Mia Vucinic
fdb3b8814a add initial implementation for changing modes 2025-07-21 21:06:38 +02:00
Mia Vucinic
6248b7a879 move getFocusedEditor to editor group and delete editor service 2025-07-21 21:06:38 +02:00
Mia Vucinic
c2203afebc fix transaction and getVariable tests 2025-07-21 21:06:38 +02:00
Mia Vucinic
260b4d62d6 add implementation for highlighted yank plugin 2025-07-21 21:06:38 +02:00
Mia Vucinic
5ad55ad891 have mapping owner and listener owner passed as parameters in all scopes where necessary 2025-07-21 21:06:38 +02:00
Mia Vucinic
3b2785fc94 have dispose method called when the ideavim plugin is disabled and init when enabled 2025-07-21 21:06:38 +02:00
Mia Vucinic
bdaf0e2389 remove unnecessary options 2025-07-21 21:06:38 +02:00
Mia Vucinic
91fdc91f69 add proper implementation for put data functions 2025-07-21 21:06:38 +02:00
Mia Vucinic
764a45c99a fix get variable test 2025-07-21 21:06:38 +02:00
Mia Vucinic
abbc46a3ed add a mapping owner to vim scope 2025-07-21 21:06:38 +02:00
Mia Vucinic
98f8226246 add listener scope implementation 2025-07-21 21:06:38 +02:00
Mia Vucinic
d2f73a6102 add a listener owner to all listeners 2025-07-21 21:06:38 +02:00
Mia Vucinic
267313a2e0 get rid of editor as a constructor parameter in scopes 2025-07-21 21:06:38 +02:00
Mia Vucinic
55d2371574 add editor service 2025-07-21 21:06:38 +02:00
Mia Vucinic
3a63ed596f add implementation with templates for getVariable function 2025-07-21 21:06:38 +02:00
Mia Vucinic
a5f379a943 add VimPlugin dsl annotation on editor scope 2025-07-21 21:06:38 +02:00
Mia Vucinic
24a0322b5a add more functions to the read 2025-07-21 21:06:38 +02:00
Mia Vucinic
1a968f7721 move update caret to caret transaction 2025-07-21 21:06:38 +02:00
Mia Vucinic
02a8a84728 rename editor to vimEditor 2025-07-21 21:06:38 +02:00
Mia Vucinic
6a896664ed introduce editor scope 2025-07-21 21:06:38 +02:00
Mia Vucinic
4d01f286f5 introduce caret scope 2025-07-21 21:06:38 +02:00
Mia Vucinic
9ab97106d7 make isRepeatable false by default 2025-07-21 21:06:38 +02:00
Mia Vucinic
f1cb9247d1 add mapping scope 2025-07-21 21:06:38 +02:00
Mia Vucinic
e946e74840 merge two mappings into one 2025-07-21 21:06:38 +02:00
Mia Vucinic
4db3e91d6a huge refactoring
- In the `api` module:
  - remove dependency on `vim-engine` module due to circular dependencies
  - move implementations of scopes to the `vim-engine`
  - add VimPluginDsl annotation to interfaces
  - make VimScope abstract class
  - remove ScopeBuilders file and move scope builders to the VimScope abstract class
 - In the `vim-engine` module:
  - add dependency on `api` module
  - add implementation of scopes
  - in VimInjector add new field - pluginService (reason for that is because functions from VimExtensionFacade are not available in the VimEngine)
2025-07-21 21:06:30 +02:00
Mia Vucinic
cf95ea1fc9 add a proper implementation for getVariableInt 2025-07-21 21:05:43 +02:00
Mia Vucinic
20fe881597 move scopes to packages 2025-07-21 21:05:43 +02:00
Mia Vucinic
617eee6237 hide instances of editor, context and VimPluginApi from the user 2025-07-21 21:05:43 +02:00
Mia Vucinic
86b9238e5f have functions in VimPluginApi take editor and context as parameters instead of scopes 2025-07-21 21:05:43 +02:00
Mia Vucinic
4583b65a3e remove VimInitPluginScope 2025-07-21 21:05:43 +02:00
Mia Vucinic
a283ee02ab rename VimPluginScope to VimScope 2025-07-21 21:05:43 +02:00
Mia Vucinic
5ca3af6643 remove VimBehaviorDiffers annotation from tests where that is no longer the case 2025-07-21 21:05:43 +02:00
Mia Vucinic
08d0bcd6ec fix tests to match vim behavior 2025-07-21 21:05:43 +02:00
Mia Vucinic
8ea9b29e5e first api draft 2025-07-21 21:05:43 +02:00
Matt Ellis
7d44c87873 Move ex prompt character out of API
The prompt character is now implemented as a custom view, only in the UI, and not inserted directly into the text. This simplifies management of the text (and removes/fixes an exception due to manually handling prompt offset), and also allows highlighting of the prompt character.
2025-07-21 18:43:28 +03:00
Matt Ellis
b67c3d7bab Add extra logging details
Randomly hit this condition, but don't know how
2025-07-21 18:43:28 +03:00
Matt Ellis
261b910845 Add tests for rendering control characters 2025-07-21 18:43:28 +03:00
Matt Ellis
ac15372901 Use actualText instead of visibleText 2025-07-21 18:43:28 +03:00
Matt Ellis
2a603a681c Simplify implementation of VimInputInterceptor 2025-07-21 18:43:28 +03:00
Matt Ellis
a208ad7598 Remove unnecessary ex cmdline without shortcuts
We don't need a secondary UI element hierarchy without shortcuts because the shortcuts are no longer handled by the UI, but by the key handler. This secondary instance was used by modal input, and this is also managed by the key handler, consuming key strokes first if a modal input prompt is active
2025-07-21 18:43:28 +03:00
Matt Ellis
dde287073e Only create modal input panel when needed 2025-07-21 18:43:28 +03:00
Matt Ellis
0e07f0c78e Show special keys in a different colour
Mimics Vim's `SpecialKey` highlight. Currently uses IntelliJ's "Whitespaces" colour, which seems like the best fit.
2025-07-21 18:43:28 +03:00
Matt Ellis
c0f412547f Maintain narrow caret width for non-printable chars 2025-07-21 18:43:28 +03:00
Matt Ellis
ddf1612d11 Fix scrolling issues editing long command lines
Instead of replacing the whole string, which will reset scroll position, delete or insert the required text/offsets, and let the text field manage scroll position
2025-07-21 18:43:28 +03:00
Matt Ellis
bf32c5d5b5 Render control characters in ex cmdline 2025-07-21 18:43:28 +03:00
Matt Ellis
6e6cd722d4 Support insertion of control chars in command line
Fixes VIM-3907, fixes VIM-239
2025-07-21 18:43:28 +03:00
Matt Ellis
356b4ed8c4 Remove unnecessary mouse listener 2025-07-21 18:43:28 +03:00
Matt Ellis
84a3d0457d Simplify and document keymap handling
All key handling is done with the Vim pipeline, so make sure we don't have any Swing key bindings registered. This is quite confusing, so document what's going on
2025-07-21 18:43:28 +03:00
Matt Ellis
d4f4f7661c Remove unnecessary action registration
We don't have any custom actions, so there's nothing to register
2025-07-21 18:43:28 +03:00
Matt Ellis
0e9c3d9d87 Replace constants with enum 2025-07-21 18:43:28 +03:00
Matt Ellis
654b95147b Simplify command line keystroke dispatching
Pass the keystroke to the key handler directly rather than relying on the superclass to call a default action handler that would do the dispatching
2025-07-21 18:43:28 +03:00
Matt Ellis
a2fb8acd47 Remove obsolete ExShortcutKeyAction
All CMD_LINE actions are registered the same as other Vim commands, which means all shortcuts are already registered with the IDE's action system. The existing VimShortcutKeyAction class will dispatch shortcuts to the key handler, where they will be handled as real CMD_LINE actions.
2025-07-21 18:43:28 +03:00
Matt Ellis
b284deb1b7 Extract some state and accessors out of text field
Encapsulate text field a little better
2025-07-21 18:43:28 +03:00
Matt Ellis
56e6ecca89 Update history command and add tests 2025-07-21 18:43:28 +03:00
Matt Ellis
055a3bc910 Remove deprecated and unused history related code 2025-07-21 18:43:28 +03:00
Matt Ellis
e2b50809ac Fix warning of renamed parameter 2025-07-21 18:43:28 +03:00
Matt Ellis
40ff54c47f Remove non-Vim key bindings from ex command line
Shift+Insert and Alt+V for paste. These are non-standard, not documented and can be added with `cmap` if required
2025-07-21 18:43:28 +03:00
Matt Ellis
1638bc304d Improve input method highlighting in ex field 2025-07-21 18:43:28 +03:00
Alex Plate
f12b0b04f6 Fix the contribution name of Jakub 2025-07-18 16:06:45 +03:00
Alex Plate
ea4fc85e5b Add a new plugin for the verification 2025-07-18 16:04:00 +03:00
Alex Plate
4af8fc1868 Update TC configuration to run only needed tests 2025-07-18 16:04:00 +03:00
Alex Plate
1482ac0335 Fix(VIM-3970): Get rid of VimStandalonePluginUpdateChecker 2025-07-18 16:03:59 +03:00
IdeaVim Bot
79168b00f3 Add zuberol to contributors list 2025-07-18 09:03:36 +00:00
zuberol
07990847c6 Merge pull request #1223 from JetBrains/feat/VIM-3791-nerdtree-gg-G-jumps
Feat(VIM-3791): support for "G" and "gg" motions inside the NERDtree
2025-07-17 11:44:07 +02:00
dependabot[bot]
8c40e19c44 Bump org.mockito.kotlin:mockito-kotlin from 5.4.0 to 6.0.0
Bumps [org.mockito.kotlin:mockito-kotlin](https://github.com/mockito/mockito-kotlin) from 5.4.0 to 6.0.0.
- [Release notes](https://github.com/mockito/mockito-kotlin/releases)
- [Commits](https://github.com/mockito/mockito-kotlin/compare/5.4.0...v6.0.0)

---
updated-dependencies:
- dependency-name: org.mockito.kotlin:mockito-kotlin
  dependency-version: 6.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-16 19:15:13 +03:00
dependabot[bot]
371769c508 Bump io.ktor:ktor-client-cio from 3.2.1 to 3.2.2
Bumps [io.ktor:ktor-client-cio](https://github.com/ktorio/ktor) from 3.2.1 to 3.2.2.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.2.1...3.2.2)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-cio
  dependency-version: 3.2.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-16 19:14:55 +03:00
dependabot[bot]
7ee34d0b27 Bump io.ktor:ktor-client-cio from 3.2.0 to 3.2.1
Bumps [io.ktor:ktor-client-cio](https://github.com/ktorio/ktor) from 3.2.0 to 3.2.1.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.2.0...3.2.1)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-cio
  dependency-version: 3.2.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-09 18:57:15 +03:00
dependabot[bot]
d1ec7d617d Bump org.junit.jupiter:junit-jupiter-engine from 5.13.2 to 5.13.3
Bumps [org.junit.jupiter:junit-jupiter-engine](https://github.com/junit-team/junit-framework) from 5.13.2 to 5.13.3.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.2...r5.13.3)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-engine
  dependency-version: 5.13.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-09 18:56:55 +03:00
dependabot[bot]
898fd0537d Bump org.junit.jupiter:junit-jupiter from 5.13.2 to 5.13.3
Bumps [org.junit.jupiter:junit-jupiter](https://github.com/junit-team/junit-framework) from 5.13.2 to 5.13.3.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.2...r5.13.3)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter
  dependency-version: 5.13.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-09 18:56:22 +03:00
Xinhe Wang
353603b546 Fix(VIM-3266): Set FileSaveCloseAction to OTHER_SELF_SYNCHRONIZED 2025-07-07 10:55:53 +03:00
Xinhe Wang
2f7f0dcacb Fix(VIM-3044): correct the behavior of I in (linewise) Visual mode
For visual selections spanning multiple lines, keep caret position
if it's on the first line. Otherwise move the caret to the start of
the first selected line.
2025-07-07 10:55:30 +03:00
Xinhe Wang
af9023af4b Rename insertBeforeCursor and insertAfterCursor helpers
The terminology used in IntelliJ is "caret".
2025-07-07 10:55:30 +03:00
Xinhe Wang
c393c902b2 Fix(VIM-2375): do not save file with ZQ
ZQ is defined to `Quit without checking for changes (same as ":q!").`
2025-07-04 14:26:56 +03:00
Xinhe Wang
c355cb7ed7 Make VimChangeGroup::changeCaseMotion not accept non-Motion argument
Error is logged if `ChangeCaseMotion` actions receive non-`Motion` args
2025-07-03 17:25:38 +03:00
Xinhe Wang
0803a1c195 Fix(VIM-2413): correct the range of line-wise case change commands
The start of the range is the leftmost non-whitespace character
OR the current position, whichever is closer to the left.
2025-07-03 17:25:38 +03:00
Xinhe Wang
5208412b46 Refine Argument.Motion::isLineWiseMotion and VimMotionGroupBase::getMotionRange
This does not change any actual behavior.
2025-07-03 17:25:38 +03:00
IdeaVim Bot
78c463cf7b Add Xinhe Wang to contributors list 2025-07-03 09:02:01 +00:00
dependabot[bot]
8f5a44bf44 Bump org.junit.vintage:junit-vintage-engine from 5.13.1 to 5.13.2
Bumps [org.junit.vintage:junit-vintage-engine](https://github.com/junit-team/junit-framework) from 5.13.1 to 5.13.2.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.1...r5.13.2)

---
updated-dependencies:
- dependency-name: org.junit.vintage:junit-vintage-engine
  dependency-version: 5.13.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-02 19:19:55 +03:00
Xinhe Wang
2377408028 Fix(VIM-2142): support gU and gu in VISUAL mode
Note that this implementation assumes that the 'gU' / 'gu' command in
visual mode is equivalent to 'U' / 'u'. While 'v_gU' and 'v_gu' are not
explicitly documented in Vim help, we treat these commands as identical
based on observed behavior, without examining Vim's source code.
2025-07-02 18:56:29 +03:00
Alex Plate
246425b1fb Mark IdeaVim as a plugin that supports vim configuration
In this way, we'll be able to actively promote IdeaVim as a suggested plugin in the IDE.

GO-17806
2025-06-27 19:43:08 +03:00
Jakub
4eadfc1fba feat: support for "G" and "gg" motions inside the NERDtree 2025-06-27 13:51:44 +02:00
dependabot[bot]
d3c945cd6d Bump org.junit.jupiter:junit-jupiter-api from 5.13.1 to 5.13.2
Bumps [org.junit.jupiter:junit-jupiter-api](https://github.com/junit-team/junit-framework) from 5.13.1 to 5.13.2.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.1...r5.13.2)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-api
  dependency-version: 5.13.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-25 19:35:31 +03:00
dependabot[bot]
2ac46129ac Bump org.junit.jupiter:junit-jupiter-params from 5.13.1 to 5.13.2
Bumps [org.junit.jupiter:junit-jupiter-params](https://github.com/junit-team/junit-framework) from 5.13.1 to 5.13.2.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.1...r5.13.2)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-params
  dependency-version: 5.13.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-25 19:14:44 +03:00
dependabot[bot]
c8d40be1ce Bump org.junit.jupiter:junit-jupiter from 5.13.1 to 5.13.2
Bumps [org.junit.jupiter:junit-jupiter](https://github.com/junit-team/junit-framework) from 5.13.1 to 5.13.2.
- [Release notes](https://github.com/junit-team/junit-framework/releases)
- [Commits](https://github.com/junit-team/junit-framework/compare/r5.13.1...r5.13.2)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter
  dependency-version: 5.13.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-25 19:14:31 +03:00
dependabot[bot]
97159a33fe Bump org.jetbrains.kotlin:kotlin-stdlib from 2.1.21 to 2.2.0
Bumps [org.jetbrains.kotlin:kotlin-stdlib](https://github.com/JetBrains/kotlin) from 2.1.21 to 2.2.0.
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/master/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v2.1.21...v2.2.0)

---
updated-dependencies:
- dependency-name: org.jetbrains.kotlin:kotlin-stdlib
  dependency-version: 2.2.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-25 19:13:44 +03:00
Alex Plate
861d585102 Also, specify new task names in build scripts 2025-06-25 18:43:01 +03:00
Alex Plate
126925b4eb Fix long running and property tests
Because of some changes, if we define the test using `testIde` registering, they're not executed properly and don't work.
Now, we don't exclude these tests from the main test execution, so they have to be excluded explicitly
2025-06-25 18:33:50 +03:00
Alex Plate
9302c0a057 Use intellij.spellchecker module for 2025.2+ builds of IJ 2025-06-25 17:35:46 +03:00
Alex Plate
ddea72f803 Update kotlin version to 2.2.0
This is required to support IJ 2025.2 platform, which uses 2.2.0 for compilation.
2025-06-25 17:23:54 +03:00
Alex Plate
e991aa922c Try to increase timeout for UI tests for Rider 2025-06-24 17:24:56 +03:00
dependabot[bot]
5ffaa7b084 Bump org.junit.jupiter:junit-jupiter-api from 5.13.0 to 5.13.1
Bumps [org.junit.jupiter:junit-jupiter-api](https://github.com/junit-team/junit5) from 5.13.0 to 5.13.1.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.13.0...r5.13.1)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-api
  dependency-version: 5.13.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-18 19:10:53 +03:00
dependabot[bot]
0d4183129d Bump org.eclipse.jgit:org.eclipse.jgit.ssh.apache
Bumps [org.eclipse.jgit:org.eclipse.jgit.ssh.apache](https://github.com/eclipse-jgit/jgit) from 7.2.1.202505142326-r to 7.3.0.202506031305-r.
- [Commits](https://github.com/eclipse-jgit/jgit/compare/v7.2.1.202505142326-r...v7.3.0.202506031305-r)

---
updated-dependencies:
- dependency-name: org.eclipse.jgit:org.eclipse.jgit.ssh.apache
  dependency-version: 7.3.0.202506031305-r
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-18 19:10:13 +03:00
dependabot[bot]
8a7fbac389 Bump org.junit.jupiter:junit-jupiter-params from 5.13.0 to 5.13.1
Bumps [org.junit.jupiter:junit-jupiter-params](https://github.com/junit-team/junit5) from 5.13.0 to 5.13.1.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.13.0...r5.13.1)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-params
  dependency-version: 5.13.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-18 18:53:18 +03:00
dependabot[bot]
dbab006f83 Bump io.ktor:ktor-client-content-negotiation from 3.1.3 to 3.2.0
Bumps [io.ktor:ktor-client-content-negotiation](https://github.com/ktorio/ktor) from 3.1.3 to 3.2.0.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.1.3...3.2.0)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-content-negotiation
  dependency-version: 3.2.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-18 18:52:47 +03:00
dependabot[bot]
3149de7b73 Bump org.junit.vintage:junit-vintage-engine from 5.13.0 to 5.13.1
Bumps [org.junit.vintage:junit-vintage-engine](https://github.com/junit-team/junit5) from 5.13.0 to 5.13.1.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.13.0...r5.13.1)

---
updated-dependencies:
- dependency-name: org.junit.vintage:junit-vintage-engine
  dependency-version: 5.13.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-11 18:30:27 +03:00
dependabot[bot]
28a71f0e09 Bump com.google.devtools.ksp:symbol-processing-api
Bumps [com.google.devtools.ksp:symbol-processing-api](https://github.com/google/ksp) from 2.1.21-2.0.1 to 2.1.21-2.0.2.
- [Release notes](https://github.com/google/ksp/releases)
- [Commits](https://github.com/google/ksp/compare/2.1.21-2.0.1...2.1.21-2.0.2)

---
updated-dependencies:
- dependency-name: com.google.devtools.ksp:symbol-processing-api
  dependency-version: 2.1.21-2.0.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-11 18:30:20 +03:00
dependabot[bot]
fc7d4e614b Bump org.junit.jupiter:junit-jupiter from 5.13.0 to 5.13.1
Bumps [org.junit.jupiter:junit-jupiter](https://github.com/junit-team/junit5) from 5.13.0 to 5.13.1.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.13.0...r5.13.1)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter
  dependency-version: 5.13.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-11 18:30:12 +03:00
dependabot[bot]
5b1aade876 Bump org.junit.jupiter:junit-jupiter-engine from 5.13.0 to 5.13.1
Bumps [org.junit.jupiter:junit-jupiter-engine](https://github.com/junit-team/junit5) from 5.13.0 to 5.13.1.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.13.0...r5.13.1)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-engine
  dependency-version: 5.13.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-11 18:29:52 +03:00
IdeaVim Bot
ef2d87ff6b Add Thomas Canava to contributors list 2025-06-07 09:02:03 +00:00
Alex Plate
75cd79312c Which-Key plugin don't use VimShortcutKeyAction anymore, so we can hide it
The change was here: 2a1191a260
2025-06-06 17:02:35 +03:00
Thomas Canava
b868e0cb81 test: Update tests to match new keys 2025-06-06 15:34:44 +03:00
Thomas Canava
30c972ee1e fix: Vim macro not working with arrows 2025-06-06 15:34:44 +03:00
761f6f5fb9 Implement pumvisible() function 2025-06-06 15:21:26 +03:00
Matt Ellis
1e3738314a Add support for := to print line number
Fixes VIM-3921
2025-06-06 15:15:13 +03:00
dependabot[bot]
f47388175b Bump org.junit.jupiter:junit-jupiter-api from 5.12.2 to 5.13.0
Bumps [org.junit.jupiter:junit-jupiter-api](https://github.com/junit-team/junit5) from 5.12.2 to 5.13.0.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.2...r5.13.0)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-api
  dependency-version: 5.13.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-04 19:40:36 +03:00
dependabot[bot]
779de5e29c Bump org.junit.jupiter:junit-jupiter-params from 5.12.2 to 5.13.0
Bumps [org.junit.jupiter:junit-jupiter-params](https://github.com/junit-team/junit5) from 5.12.2 to 5.13.0.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.2...r5.13.0)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-params
  dependency-version: 5.13.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-04 19:23:51 +03:00
dependabot[bot]
1f0cca17cf Bump org.junit.jupiter:junit-jupiter from 5.12.2 to 5.13.0
Bumps [org.junit.jupiter:junit-jupiter](https://github.com/junit-team/junit5) from 5.12.2 to 5.13.0.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.2...r5.13.0)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter
  dependency-version: 5.13.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-04 19:06:42 +03:00
dependabot[bot]
d09592824c Bump org.junit.jupiter:junit-jupiter-engine from 5.12.2 to 5.13.0
Bumps [org.junit.jupiter:junit-jupiter-engine](https://github.com/junit-team/junit5) from 5.12.2 to 5.13.0.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.2...r5.13.0)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-engine
  dependency-version: 5.13.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-04 19:06:27 +03:00
dependabot[bot]
725d60a56e Bump org.junit.vintage:junit-vintage-engine from 5.12.2 to 5.13.0
Bumps [org.junit.vintage:junit-vintage-engine](https://github.com/junit-team/junit5) from 5.12.2 to 5.13.0.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.2...r5.13.0)

---
updated-dependencies:
- dependency-name: org.junit.vintage:junit-vintage-engine
  dependency-version: 5.13.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-04 19:06:01 +03:00
Alex Plate
77a106f9c6 Throw ProcessCanceledException instead of silently ignoring it in VimTypedActionHandler
This is a requirement from the platform
2025-05-30 19:41:41 +03:00
Alex Plate
1f66bdf5ed Refactor tests in ChangeActionTest.kt for better readability by reformatting doTest calls and improving code style consistency. 2025-05-30 15:12:43 +03:00
Alex Plate
7c4cfe44ae Remove unused MutableBoolean data class from KeyHandler 2025-05-30 14:20:25 +03:00
Alex Plate
b58c1a42d2 Remove unused mappingCompleted parameter from handleKey methods
This updates method signatures and removes the redundant parameter throughout the codebase. Adds a deprecated overload for backward compatibility.
2025-05-30 14:16:40 +03:00
Alex Plate
02fab15aa9 Add tests that verify the behaviour with oldundo flag 2025-05-28 16:45:06 +03:00
Alex Plate
6c9d85cce0 Add a big number of undo tests for macros
This is a part of work for VIM-3935. Since we'll have to change the `CommandProcessor` execution, this may affect the "undo" command behavior. To ensure the stability, we add undo tests before making a refactoring.
2025-05-28 12:40:56 +03:00
Alex Plate
360080e8c0 Enable some disabled tests 2025-05-28 12:14:08 +03:00
Alex Plate
e41831798e Add a big number of undo tests for ex commands
This is a part of work for VIM-3935. Since we'll have to change the `CommandProcessor` execution, this may affect the "undo" command behavior. To ensure the stability, we add undo tests before making a refactoring.
2025-05-28 11:48:38 +03:00
Alex Plate
c93c9e539c Add a big number of undo tests
This is a part of work for VIM-3935. Since we'll have to change the `CommandProcessor` execution, this may affect the "undo" command behavior. To ensure the stability, we add undo tests before making a refactoring.
2025-05-28 09:46:05 +03:00
Alex Plate
149e3f92ae Update .gitignore to exclude local Claude settings file 2025-05-28 09:40:53 +03:00
Alex Plate
233bad0070 Turn off TeamCity emulation when running tests locally
IJ platform runs additional project leak checks when it detects teamcity run. It was quite complicated to understand why tests were failing on TC, but not locally, so I decided to enable TeamCity emulation to have these checks locally.

However, it turned out that in addition to that, an IJ platform also collects CPU statistics on TeamCity, which may take around a minute. This dramatically affects the performance of local execution. So, this property is turned off.
2025-05-28 09:38:54 +03:00
Alex Plate
b44308c9ef Remove skipping of command execution if it happens not on the EDT
This requirement was a fix for VIM-318 introduced in ac654d70fa.
However, now we always run IdeaVim on EDT. Also, this check prevents the migration of IdeaVim to the background thread: VIM-3935
2025-05-27 18:30:16 +03:00
Alex Plate
8c612afed6 VIM-3929: Re-enable IdeaVim in diff editors 2025-05-27 13:07:43 +03:00
Alex Plate
2c057e937a Fix(VIM-3929): IdeaVim is disabled in non-file based editors of IDE
This change should fix issues in Rider evaluate window and other places.

However, we may face small issues as IdeaVim will be disabled in more places than it used to be. However, this approach looks safer as before that we were disabling some random keys
2025-05-23 19:34:17 +03:00
Alex Plate
2548008116 Add missing switches to EDT during test 2025-05-23 17:14:26 +03:00
Alex Plate
c43eb1212e Bring back CommandState to fix the compatibility with the external plugins 2025-05-23 16:53:01 +03:00
Alex Plate
4c11399b43 Bring the compatibility with the latest EAP version
Removed a single test on JSON. There are always problems with the json plugin in IJ. In 2025.2 EAP it was unbundled.
2025-05-23 16:48:37 +03:00
Alex Plate
18f3ba6fe1 Rethrow ProcessCancelledException 2025-05-23 16:22:04 +03:00
Alex Plate
2435136734 Remove vimscript roadmap file 2025-05-23 16:00:37 +03:00
Alex Plate
4d2a7df6b4 Cleanup readme file 2025-05-23 13:19:46 +03:00
dependabot[bot]
b04e90e93c Bump org.jetbrains.intellij.platform from 2.5.0 to 2.6.0
Bumps org.jetbrains.intellij.platform from 2.5.0 to 2.6.0.

---
updated-dependencies:
- dependency-name: org.jetbrains.intellij.platform
  dependency-version: 2.6.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-21 19:02:43 +03:00
dependabot[bot]
4c88359f46 Bump org.eclipse.jgit:org.eclipse.jgit.ssh.apache
Bumps [org.eclipse.jgit:org.eclipse.jgit.ssh.apache](https://github.com/eclipse-jgit/jgit) from 7.2.0.202503040940-r to 7.2.1.202505142326-r.
- [Commits](https://github.com/eclipse-jgit/jgit/compare/v7.2.0.202503040940-r...v7.2.1.202505142326-r)

---
updated-dependencies:
- dependency-name: org.eclipse.jgit:org.eclipse.jgit.ssh.apache
  dependency-version: 7.2.1.202505142326-r
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-21 19:02:23 +03:00
Alex Plate
8e136bf769 Update list of supported IDEs 2025-05-21 12:31:29 +03:00
Alex Plate
be73e662bd Change wording to JetBrains IDEs on the readme
This is a new proper name for the ide family
2025-05-21 12:30:46 +03:00
dependabot[bot]
ee70ecd92e Bump com.google.devtools.ksp:symbol-processing-api
Bumps [com.google.devtools.ksp:symbol-processing-api](https://github.com/google/ksp) from 2.1.20-2.0.1 to 2.1.21-2.0.1.
- [Release notes](https://github.com/google/ksp/releases)
- [Commits](https://github.com/google/ksp/compare/2.1.20-2.0.1...2.1.21-2.0.1)

---
updated-dependencies:
- dependency-name: com.google.devtools.ksp:symbol-processing-api
  dependency-version: 2.1.21-2.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-14 18:28:17 +03:00
dependabot[bot]
f3cf3f03b1 Bump org.jetbrains.kotlin:kotlin-stdlib from 2.1.20 to 2.1.21
Bumps [org.jetbrains.kotlin:kotlin-stdlib](https://github.com/JetBrains/kotlin) from 2.1.20 to 2.1.21.
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/master/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v2.1.20...v2.1.21)

---
updated-dependencies:
- dependency-name: org.jetbrains.kotlin:kotlin-stdlib
  dependency-version: 2.1.21
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-14 18:28:01 +03:00
dependabot[bot]
4c46d734cc Bump io.ktor:ktor-client-core from 3.1.2 to 3.1.3
Bumps [io.ktor:ktor-client-core](https://github.com/ktorio/ktor) from 3.1.2 to 3.1.3.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.1.2...3.1.3)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-core
  dependency-version: 3.1.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-14 18:27:52 +03:00
Alex Plate
e932fe2059 Add com.ugarosa.idea.edgemotion as a dependant plugin 2025-05-14 12:02:06 +03:00
Alex Plate
d3f248d2f9 Refactor reset to avoid service initialization during the dispose 2025-05-09 19:04:10 +02:00
Alex Plate
f623c1eef9 Fix(VIM-3784): Integrate a notification that will warn new GoLand users that they use IdeaVim 2025-05-09 18:39:17 +02:00
Alex Plate
f03734e235 Fix(VIM-3786): Disable IdeaVim in the AI assistant 2025-05-09 16:31:44 +02:00
Alex Plate
85acdc2e24 Fix(VIM-3881): Execute undo/redo directly for the remote dev scenarios 2025-05-09 16:20:27 +02:00
Alex Plate
afa70e20e1 Correct the rider test 2025-05-09 15:27:43 +02:00
Alex Plate
73f3d328c5 Try to wait longer till Rider will start 2025-05-09 13:51:40 +02:00
Alex Plate
df3224b02d Start Rider with printing the logs to the output 2025-05-09 13:34:51 +02:00
Alex Plate
0e56a4e86e Remove background Rider start to see the problem when loading 2025-05-09 13:32:22 +02:00
Alex Plate
66ce949cc5 Do not use installer for Rider tests 2025-05-09 13:00:50 +02:00
Alex Plate
ab635972cc Remove a lot of deprecated methods in IdeaVim 2025-05-09 12:58:47 +02:00
Alex Plate
7fbf321cbd Do not use installer for Rider tests 2025-05-09 12:17:13 +02:00
Alex Plate
d4c24fcc7f Remove the outdated file with implemented vimscript functions 2025-05-09 12:17:12 +02:00
Matt Ellis
fd5af31247 Report cannot track intention action
If an alt+enter intention is invoked from Search Everywhere, IdeaVim's Track Action ID shows "Cannot detect action ID" instead of explaining that there is no action ID.

Relates to VIM-2541
2025-05-09 12:11:11 +02:00
Matt Ellis
df74b75570 Stop switching fragment editors to Insert mode
Fixes VIM-1217
2025-05-09 12:10:10 +02:00
Vladimir Parfinenko
c74163e917 Fix case settings in replacement string, VIM-3510
^VIM-3510 fixed
2025-05-09 12:08:01 +02:00
Vladimir Parfinenko
d38b2885ba Fix missing backreferences in replacement string, VIM-3895
^VIM-3895 fixed
2025-05-09 12:08:01 +02:00
Vladimir Parfinenko
61666d1cfd Always print float numbers using period as a decimal separator, VIM-3894
^VIM-3894 fixed
2025-05-09 12:02:56 +02:00
Alex Plate
35ddb21fe0 Fix the deprecated method use 2025-05-09 11:09:11 +02:00
Alex Plate
ccdd708907 Get rid of the old way of action execution 2025-05-08 18:22:40 +02:00
Alex Plate
73e61e0955 Get rid of hacks for Rider regarding esc and enter 2025-05-08 17:49:15 +02:00
Alex Plate
c3fa093d32 Upgrade the code to use the 2025.1 functions 2025-05-08 17:47:35 +02:00
Alex Plate
a94d509441 Remove other code deprecations 2025-05-08 17:33:41 +02:00
Alex Plate
12fd5bc79a Remove deprecated functions 2025-05-08 17:20:58 +02:00
Alex Plate
235368c449 Remove old comments regarding vim-engine extraction 2025-05-08 17:20:00 +02:00
Alex Plate
57ecd25640 Refactor MacKeyRepeat.kt in order to remove the deprecated methods use 2025-05-08 17:18:17 +02:00
Alex Plate
09d37ebd38 Convert MacKeyRepeat to kotlin 2025-05-08 17:11:39 +02:00
Alex Plate
81bc3f1f1b Rename .java to .kt 2025-05-08 17:11:39 +02:00
Alex Plate
9e3058dace Code cleanup: remove some deprecations from the source code 2025-05-08 17:04:25 +02:00
Alex Plate
6819d4f96c Add Mia Vucinic to the contributors list 2025-05-08 13:41:11 +02:00
IdeaVim Bot
222e1471b4 Add vumi19 to contributors list 2025-05-08 09:01:43 +00:00
M. V
35b9eaae3e VIM-2263 Add a not-null assertion operator to getRegister function to since assertions won't be executed if register does not exist 2025-05-07 18:54:26 +02:00
M. V
4eee1d3192 VIM-2263 Add additional tests that check the content of the registers 2025-05-07 18:54:26 +02:00
M. V
3c2e2bfb68 VIM-3771 Add a smile command with python ascii art 2025-05-07 18:54:12 +02:00
M. V
3f75b6db6d VIM-3771 Add a smile command with java ascii art 2025-05-07 18:54:12 +02:00
M. V
5fd318bf88 VIM-3771 Add a smile command with kotlin and default ascii art 2025-05-07 18:54:12 +02:00
M. V
6d34c70a9d VIM-3771 Rename VirtualFile.kt to VimVirtualFile.kt and add a new property extension 2025-05-07 18:54:12 +02:00
dependabot[bot]
3ffe8b68f7 Bump io.ktor:ktor-serialization-kotlinx-json from 3.1.2 to 3.1.3
Bumps [io.ktor:ktor-serialization-kotlinx-json](https://github.com/ktorio/ktor) from 3.1.2 to 3.1.3.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.1.2...3.1.3)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-serialization-kotlinx-json
  dependency-version: 3.1.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-07 18:30:51 +02:00
dependabot[bot]
d09fc538f7 Bump io.ktor:ktor-client-cio from 3.1.2 to 3.1.3
Bumps [io.ktor:ktor-client-cio](https://github.com/ktorio/ktor) from 3.1.2 to 3.1.3.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.1.2...3.1.3)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-cio
  dependency-version: 3.1.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-07 18:30:20 +02:00
dependabot[bot]
8d4d6b0f27 Bump io.ktor:ktor-client-content-negotiation from 3.1.2 to 3.1.3
Bumps [io.ktor:ktor-client-content-negotiation](https://github.com/ktorio/ktor) from 3.1.2 to 3.1.3.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.1.2...3.1.3)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-content-negotiation
  dependency-version: 3.1.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-07 18:13:19 +02:00
dependabot[bot]
f9f5f039db Bump com.google.devtools.ksp:symbol-processing-api
Bumps [com.google.devtools.ksp:symbol-processing-api](https://github.com/google/ksp) from 2.1.20-2.0.0 to 2.1.20-2.0.1.
- [Release notes](https://github.com/google/ksp/releases)
- [Commits](https://github.com/google/ksp/compare/2.1.20-2.0.0...2.1.20-2.0.1)

---
updated-dependencies:
- dependency-name: com.google.devtools.ksp:symbol-processing-api
  dependency-version: 2.1.20-2.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-07 17:57:47 +02:00
dependabot[bot]
cacb63a525 Bump io.ktor:ktor-client-auth from 3.1.2 to 3.1.3
Bumps [io.ktor:ktor-client-auth](https://github.com/ktorio/ktor) from 3.1.2 to 3.1.3.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.1.2...3.1.3)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-auth
  dependency-version: 3.1.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-07 17:56:32 +02:00
Alex Plate
518eac1476 Fix the authors update script 2025-05-06 14:28:59 +02:00
IdeaVim Bot
ad18667520 Add Ivan Yarkov to contributors list 2025-05-06 09:01:46 +00:00
Alex Plate
5bf2b51c5d Add a comment about the change 2025-05-05 17:00:33 +02:00
Ivan.Yarkov
5959fc2824 RIDER-123506 don't insert line break on enter in insert mode for Rider 2025-05-05 16:59:57 +02:00
Alex Plate
a9f9ae3727 Fix(VIM-3786): Make a workaround to fix shift-enter in AI chat 2025-04-29 19:36:05 +03:00
Alex Plate
8bfcd13c33 Fix(VIM-3882): Register the VimShortcutAction to the editor component instead of its wrapper
It turned out the editor.getComponent returns not the editorComponent, but the parent of the component. This caused no problems until the AI plugin started to register enter/esc on the editor component directly. Since an editor component is more specific than the component with vim actions, the vim shortcuts were suppressed.

In this change, we start to register shortcuts on the editor component directly, allowing them to properly work on the same level as AI shortcuts. This is also the level where the shortcuts are supposed to be registered.
2025-04-28 17:55:18 +03:00
Alex Plate
2cd5c9db72 Add Lejia Chen to the Authors list
Lejia was providing exceptional support for the IdeaVim project for two-plus years starting from 2023.
2025-04-28 11:45:15 +03:00
Matt Ellis
70d662fe28 Remove obsolete internal options 2025-04-22 15:48:19 +03:00
Alex Plate
2f33d41713 Update the minimal version of IJ to 251 2025-04-22 08:56:07 +03:00
Alex Plate
8247392dc3 Fix some compilation warnings 2025-04-16 22:12:36 +03:00
Alex Plate
c8504e1138 Fix warning about synchronization on primitive 2025-04-16 21:35:01 +03:00
Alex Plate
443e50b55f Add tests for case changing
Mostly to highlight that commands in format `gugu` and `gUgU` don't work for the moment
2025-04-16 19:44:38 +03:00
Alex Plate
1891216182 Fix(VIM-3878): Support ROT13 command g? 2025-04-16 19:44:38 +03:00
dependabot[bot]
515f0ca568 Bump org.junit.jupiter:junit-jupiter-params from 5.12.1 to 5.12.2
Bumps [org.junit.jupiter:junit-jupiter-params](https://github.com/junit-team/junit5) from 5.12.1 to 5.12.2.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.1...r5.12.2)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-params
  dependency-version: 5.12.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-16 19:41:45 +03:00
dependabot[bot]
2be0228c35 Bump org.junit.jupiter:junit-jupiter-api from 5.12.1 to 5.12.2
Bumps [org.junit.jupiter:junit-jupiter-api](https://github.com/junit-team/junit5) from 5.12.1 to 5.12.2.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.1...r5.12.2)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-api
  dependency-version: 5.12.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-16 19:25:31 +03:00
dependabot[bot]
cf554e9ae2 Bump org.junit.vintage:junit-vintage-engine from 5.12.1 to 5.12.2
Bumps [org.junit.vintage:junit-vintage-engine](https://github.com/junit-team/junit5) from 5.12.1 to 5.12.2.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.1...r5.12.2)

---
updated-dependencies:
- dependency-name: org.junit.vintage:junit-vintage-engine
  dependency-version: 5.12.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-16 19:10:22 +03:00
dependabot[bot]
251cc638db Bump org.junit.jupiter:junit-jupiter from 5.12.1 to 5.12.2
Bumps [org.junit.jupiter:junit-jupiter](https://github.com/junit-team/junit5) from 5.12.1 to 5.12.2.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.1...r5.12.2)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter
  dependency-version: 5.12.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-16 19:10:13 +03:00
dependabot[bot]
5700738c61 Bump org.junit.jupiter:junit-jupiter-engine from 5.12.1 to 5.12.2
Bumps [org.junit.jupiter:junit-jupiter-engine](https://github.com/junit-team/junit5) from 5.12.1 to 5.12.2.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.1...r5.12.2)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-engine
  dependency-version: 5.12.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-16 19:09:53 +03:00
Alex Plate
916afd31b2 Fix(VIM-3870): Add missing write actions 2025-04-16 18:54:22 +03:00
Alex Plate
5d2852420a Remove the duplication method for existing the select mode 2025-04-15 09:20:00 +03:00
Matt Ellis
a5efa5f9f2 Rename SAVE_VISUAL to SAVE_SELECTION
IdeaVim will still leave Visual mode, but the IDE's selection remains.
2025-04-10 19:32:29 +03:00
Matt Ellis
e86503798a Remove special case handling for Plug mapping
While it might not make sense to replay an incorrect `<Plug>` or `<Action>` mapping as characters where they are likely to cause unexpected behaviour as Normal commands, this is standard Vim behaviour (at least for `<Plug>`).

Note that `<Plug>` (and `<Action>`) is a special key code that cannot be typed. In Insert mode, Vim expands it to the text "<Plug>".
2025-04-10 19:32:29 +03:00
Matt Ellis
0b6ac4a9f4 Rename variable and add comments 2025-04-10 19:32:29 +03:00
Matt Ellis
2a6f7cc907 Remove unused mappingComplete parameter
Also makes all KeyConsumers internal
2025-04-10 19:32:29 +03:00
Matt Ellis
9b4f114d61 Refactor MappingProcessor
Extract single implementation for replaying unhandled keys and update to match the longest mapping that fits in the unhandled keys.
2025-04-10 19:32:29 +03:00
Matt Ellis
3155556832 Reformat and update comments for MappingProcessor
Minor refactorings, should be no changes in logic
2025-04-10 19:32:29 +03:00
Matt Ellis
07190f38c9 Fix :normal command with multi-letter mapping 2025-04-10 19:32:29 +03:00
Matt Ellis
db116faa32 Fix handling of modes in NormalCommand
All commands are called in Normal, so there is no need to check mode at execution time. The SAVE_VISUAL flag is perhaps poorly named, as it still change to Normal mode, but will save the current selection for commands that need (usually because they interact with IDE features). The `:normal` command does not need the current selection.
2025-04-10 19:32:29 +03:00
Matt Ellis
58496fa1a1 Uncomment NormalCommandTest.kt 2025-04-10 19:32:29 +03:00
dependabot[bot]
0bd12af1f4 Bump com.google.devtools.ksp:symbol-processing-api
Bumps [com.google.devtools.ksp:symbol-processing-api](https://github.com/google/ksp) from 2.1.20-1.0.32 to 2.1.20-2.0.0.
- [Release notes](https://github.com/google/ksp/releases)
- [Commits](https://github.com/google/ksp/compare/2.1.20-1.0.32...2.1.20-2.0.0)

---
updated-dependencies:
- dependency-name: com.google.devtools.ksp:symbol-processing-api
  dependency-version: 2.1.20-2.0.0
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-09 18:44:36 +03:00
dependabot[bot]
9f6d697e30 Bump io.ktor:ktor-client-cio from 3.1.1 to 3.1.2
Bumps [io.ktor:ktor-client-cio](https://github.com/ktorio/ktor) from 3.1.1 to 3.1.2.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.1.1...3.1.2)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-cio
  dependency-version: 3.1.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-09 18:44:10 +03:00
IdeaVim Bot
8ed283f7ae Add Max Siryk to contributors list 2025-04-07 09:02:16 +00:00
erotourtes
5a3d35f216 fix: typo & consistency 2025-04-07 10:47:41 +03:00
Alex Plate
13850f059d Add a new plugin to the compatibility check 2025-04-04 18:43:03 +03:00
Alex Plate
3ddc75f5f0 Remove the call for the instrumentationTools as it's deprecated 2025-04-04 18:39:28 +03:00
Alex Plate
6c71698aae Do not use the installer for some of the tests because currently it doesn't work on the installer with the new gradle plugin
It's unclear if this is a bug in the gradle plugin or misconfiguration
2025-04-04 18:38:29 +03:00
dependabot[bot]
664895941d Bump io.ktor:ktor-serialization-kotlinx-json from 3.1.1 to 3.1.2
Bumps [io.ktor:ktor-serialization-kotlinx-json](https://github.com/ktorio/ktor) from 3.1.1 to 3.1.2.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.1.1...3.1.2)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-serialization-kotlinx-json
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-02 18:45:35 +03:00
dependabot[bot]
c758ac16ec Bump io.ktor:ktor-client-core from 3.1.1 to 3.1.2
Bumps [io.ktor:ktor-client-core](https://github.com/ktorio/ktor) from 3.1.1 to 3.1.2.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.1.1...3.1.2)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-02 18:31:12 +03:00
dependabot[bot]
4c2b3b8011 Bump io.ktor:ktor-client-auth from 3.1.1 to 3.1.2
Bumps [io.ktor:ktor-client-auth](https://github.com/ktorio/ktor) from 3.1.1 to 3.1.2.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.1.1...3.1.2)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-auth
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-02 18:31:03 +03:00
dependabot[bot]
ee1c4914d4 Bump io.ktor:ktor-client-content-negotiation from 3.1.1 to 3.1.2
Bumps [io.ktor:ktor-client-content-negotiation](https://github.com/ktorio/ktor) from 3.1.1 to 3.1.2.
- [Release notes](https://github.com/ktorio/ktor/releases)
- [Changelog](https://github.com/ktorio/ktor/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ktorio/ktor/compare/3.1.1...3.1.2)

---
updated-dependencies:
- dependency-name: io.ktor:ktor-client-content-negotiation
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-02 18:16:18 +03:00
dependabot[bot]
a5f225394f Bump com.google.devtools.ksp:symbol-processing-api
Bumps [com.google.devtools.ksp:symbol-processing-api](https://github.com/google/ksp) from 2.1.20-1.0.31 to 2.1.20-1.0.32.
- [Release notes](https://github.com/google/ksp/releases)
- [Commits](https://github.com/google/ksp/compare/2.1.20-1.0.31...2.1.20-1.0.32)

---
updated-dependencies:
- dependency-name: com.google.devtools.ksp:symbol-processing-api
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-02 18:16:01 +03:00
Alex Plate
8af848cef6 Fix(VIM-3861): Fix the debug action execution 2025-03-31 12:33:18 +03:00
IdeaVim Bot
4c1d91cc37 Add Peter Hoburg to contributors list 2025-03-29 09:01:47 +00:00
Alex Plate
deca256e1c Add clear conditions for property tests 2025-03-28 19:23:47 +02:00
Matt Ellis
6d3bde3ad5 Fix incorrect implementation of DoesNotMatchHandler 2025-03-28 19:07:06 +02:00
Matt Ellis
3b2b863c88 Update truthy expressions 2025-03-28 19:07:06 +02:00
Matt Ellis
a7e1c08589 Simplify unary arithmetic operators 2025-03-28 19:07:06 +02:00
Matt Ellis
5aa5e82d59 Rename some operator handlers 2025-03-28 19:07:06 +02:00
Matt Ellis
0db9ad505b Remove unnecessary singleton classes 2025-03-28 19:07:06 +02:00
Matt Ellis
147eb99745 Simplify case sensitive binary operators 2025-03-28 19:07:06 +02:00
Matt Ellis
bb73bdfb4a Simplify case sensitive comparisons 2025-03-28 19:07:06 +02:00
Matt Ellis
9ab1044880 Migrate various string operators to toVimString
Make it explicit they only work with String values
2025-03-28 19:07:06 +02:00
Matt Ellis
e2cc9c648f Introduce toVimString to match toVimNumber 2025-03-28 19:07:06 +02:00
Matt Ellis
a322525c2a Be more explicit with is and isnot implementation 2025-03-28 19:07:06 +02:00
Matt Ellis
51ea947ccb Move comparison operator data rules to base class 2025-03-28 19:07:06 +02:00
Matt Ellis
f6810798ef Move binary operator conversion rules to base class 2025-03-28 19:07:06 +02:00
Matt Ellis
2fee525998 Refactor logical operators 2025-03-28 19:07:06 +02:00
Matt Ellis
9e3ab12451 Combine logical handlers into same file 2025-03-28 19:07:06 +02:00
Matt Ellis
5f8d552e8a Extract error message 2025-03-28 19:07:06 +02:00
Matt Ellis
4e847f8ef4 Merge arithmetic operators to same file 2025-03-28 19:07:06 +02:00
Matt Ellis
d5901fc2c9 Merge case-sensitive handlers to same file 2025-03-28 19:07:06 +02:00
Matt Ellis
3621b91321 Make operator handlers internal 2025-03-28 19:07:06 +02:00
Alex Plate
acbf1d7bd4 Update gradle wrapper 2025-03-28 19:05:55 +02:00
CCCC-L
f079edfb25 Modify CommentaryTextObject test case 2025-03-28 18:45:42 +02:00
CCCC-L
440cab1674 CommentaryTextObject no longer contains spaces to be consistent with neovim 2025-03-28 18:45:42 +02:00
Alex Plate
9322e3b81b Update intellij gradle plugin 2025-03-28 18:40:26 +02:00
Matt Ellis
021db84a21 Expand ~ to home directory in XDG_CONFIG_HOME
Addresses VIM-3844, VIM-2001
2025-03-28 18:18:32 +02:00
Matt Ellis
e232cb3ceb Support 32-bit Unicode codepoints in digraphs
Fixes VIM-3842
2025-03-28 18:13:14 +02:00
Peter Hoburg
174757cdb2 Removed summary from Mini.ai on the README.md 2025-03-28 18:00:26 +02:00
Peter Hoburg
ef0883bc0d finished adding summaries. 2025-03-28 18:00:26 +02:00
Peter Hoburg
0b4ad07b32 Moved more details around,
added more About sections.
2025-03-28 18:00:26 +02:00
Peter Hoburg
3d1a426566 Added back in a missing </details> tag. 2025-03-28 18:00:26 +02:00
Peter Hoburg
6f4eb838c3 Started alphabetizing and adding About: sections to the IdeaVim Plugins.md 2025-03-28 18:00:26 +02:00
Peter Hoburg
bc38ddc0f8 Alphabetized the IdeaVim Plugins section of the main README.md 2025-03-28 18:00:26 +02:00
Matt Ellis
a33b3980ab Fix unhandled key stroke after surround operation
Fixes VIM-3841
2025-03-28 17:51:14 +02:00
Matt Ellis
7917c83cb5 Add extra tests for line() function behaviour
It's not obvious that line('v') will return the opposite end of the current selection. Add some tests to highlight this.

Relates to VIM-3838
2025-03-28 17:23:41 +02:00
Matt Ellis
42229b285b Fix typo 2025-03-28 17:23:41 +02:00
Matt Ellis
421c3bbfb8 Support <C-U> in commandToKeys 2025-03-28 17:23:41 +02:00
Matt Ellis
dbd097a91a Fix caret position after :move command
Fixes VIM-3837
2025-03-28 17:23:41 +02:00
Alex Plate
30f019aa18 Fix enter for Clion Nova 2025-03-28 15:35:33 +02:00
Alex Plate
543d8dbb13 Fix(VIM-3856): Disable new way of action execution for CLion 2025-03-28 14:05:53 +02:00
Alex Plate
2800b2d5fc Fix(VIM-3857): Fix pasting for the client 2025-03-28 13:45:13 +02:00
Alex Plate
cd27ce8004 Fix(VIM-3852): Fix incorrect cast while checking the shortcuts 2025-03-28 13:27:59 +02:00
Alex Plate
6f3cf43bae Make a few tests for Rider
This should cover VIM-3826 issues
2025-03-27 17:34:24 +02:00
Alex Plate
b043296cde Fix(VIM-3826): Fix action execution in Rider 243 and older versions
It still doesn't work fine when executing in format `:action ReformatCode` in 243, but with 251 format updates from Rider, it should be fine.
2025-03-27 17:20:23 +02:00
Alex Plate
9beca20037 Click Activate during testing 2025-03-27 15:17:14 +02:00
Alex Plate
b882d60416 Trying to make Rider UI tests alive 2025-03-27 15:05:38 +02:00
Alex Plate
7144d73488 Mute a slow operation related to VIM-3648 2025-03-27 14:12:55 +02:00
dependabot[bot]
ae71075134 Bump org.jetbrains.kotlin:kotlin-stdlib from 2.1.10 to 2.1.20
Bumps [org.jetbrains.kotlin:kotlin-stdlib](https://github.com/JetBrains/kotlin) from 2.1.10 to 2.1.20.
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/master/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v2.1.10...v2.1.20)

---
updated-dependencies:
- dependency-name: org.jetbrains.kotlin:kotlin-stdlib
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-26 17:43:25 +02:00
dependabot[bot]
a5d4bf1a57 Bump org.eclipse.jgit:org.eclipse.jgit.ssh.apache
Bumps [org.eclipse.jgit:org.eclipse.jgit.ssh.apache](https://github.com/eclipse-jgit/jgit) from 7.1.0.202411261347-r to 7.2.0.202503040940-r.
- [Commits](https://github.com/eclipse-jgit/jgit/compare/v7.1.0.202411261347-r...v7.2.0.202503040940-r)

---
updated-dependencies:
- dependency-name: org.eclipse.jgit:org.eclipse.jgit.ssh.apache
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-26 17:41:33 +02:00
dependabot[bot]
3b8a830622 Bump org.junit.jupiter:junit-jupiter-api from 5.12.0 to 5.12.1
Bumps [org.junit.jupiter:junit-jupiter-api](https://github.com/junit-team/junit5) from 5.12.0 to 5.12.1.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.0...r5.12.1)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-api
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-26 17:41:17 +02:00
dependabot[bot]
71adcef1bf Bump com.google.devtools.ksp:symbol-processing-api
Bumps [com.google.devtools.ksp:symbol-processing-api](https://github.com/google/ksp) from 2.1.10-1.0.29 to 2.1.20-1.0.31.
- [Release notes](https://github.com/google/ksp/releases)
- [Commits](https://github.com/google/ksp/compare/2.1.10-1.0.29...2.1.20-1.0.31)

---
updated-dependencies:
- dependency-name: com.google.devtools.ksp:symbol-processing-api
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-26 17:40:41 +02:00
dependabot[bot]
d4d0212b04 Bump org.junit.jupiter:junit-jupiter-params from 5.12.0 to 5.12.1
Bumps [org.junit.jupiter:junit-jupiter-params](https://github.com/junit-team/junit5) from 5.12.0 to 5.12.1.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.0...r5.12.1)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-params
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-19 18:51:22 +03:00
dependabot[bot]
4b3bba6a98 Bump org.junit.vintage:junit-vintage-engine from 5.12.0 to 5.12.1
Bumps [org.junit.vintage:junit-vintage-engine](https://github.com/junit-team/junit5) from 5.12.0 to 5.12.1.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.0...r5.12.1)

---
updated-dependencies:
- dependency-name: org.junit.vintage:junit-vintage-engine
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-19 18:34:51 +03:00
dependabot[bot]
13edc1294c Bump org.junit.jupiter:junit-jupiter from 5.12.0 to 5.12.1
Bumps [org.junit.jupiter:junit-jupiter](https://github.com/junit-team/junit5) from 5.12.0 to 5.12.1.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.0...r5.12.1)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-19 18:34:22 +03:00
dependabot[bot]
f5269a56d6 Bump org.junit.jupiter:junit-jupiter-engine from 5.12.0 to 5.12.1
Bumps [org.junit.jupiter:junit-jupiter-engine](https://github.com/junit-team/junit5) from 5.12.0 to 5.12.1.
- [Release notes](https://github.com/junit-team/junit5/releases)
- [Commits](https://github.com/junit-team/junit5/compare/r5.12.0...r5.12.1)

---
updated-dependencies:
- dependency-name: org.junit.jupiter:junit-jupiter-engine
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-19 18:34:13 +03:00
768 changed files with 41279 additions and 11132 deletions

View File

@@ -0,0 +1,220 @@
# Changelog Maintenance Instructions
## Historical Context
- The changelog was actively maintained until version 2.9.0
- There's a gap from 2.10.0 through 2.27.0 where changelog wasn't maintained
- We're resuming changelog maintenance from version 2.28.0 onwards
- Between 2.9.0 and 2.28.0, include this note: **"Changelog was not maintained for versions 2.10.0 through 2.27.0"**
## Changelog Structure
### [To Be Released] Section
- All unreleased changes from master branch go here
- When a release is made, this section becomes the new version section
- Create a new empty `[To Be Released]` section after each release
### Version Entry Format
```
## 2.28.0, 2024-MM-DD
### Features:
* Feature description without ticket number
* `CommandName` action can be used... | [VIM-XXXX](https://youtrack.jetbrains.com/issue/VIM-XXXX)
### Fixes:
* [VIM-XXXX](https://youtrack.jetbrains.com/issue/VIM-XXXX) Bug fix description
### Changes:
* Other changes
```
## How to Gather Information
### 1. Check Current State
- Read CHANGES.md to find the last documented version
- **Important**: Only read the top portion of CHANGES.md (it's a large file)
- Focus on the `[To Be Released]` section and recent versions
- Note the date of the last entry
### 2. Find Releases
- Use `git tag --list --sort=-version:refname` to see all version tags
- Tags like `2.27.0`, `2.27.1` indicate releases
- Note: Patch releases (x.x.1, x.x.2) might be on separate branches
- Release dates available at: https://plugins.jetbrains.com/plugin/164-ideavim/versions
### 3. Review Changes
```bash
# Get commits since last documented version
git log --oneline --since="YYYY-MM-DD" --first-parent master
# Get merged PRs
gh pr list --state merged --limit 100 --json number,title,author,mergedAt
# Check specific release commits
git log --oneline <previous-tag>..<new-tag>
```
**Important**: Don't just read commit messages - examine the actual changes:
- Use `git show <commit-hash>` to see the full commit content
- Look at modified test files to find specific examples of fixed commands
- Check the actual code changes to understand what was really fixed or added
- Tests often contain the best examples for changelog entries (e.g., exact commands that now work)
### 4. What to Include
- **Features**: New functionality with [VIM-XXXX] ticket numbers if available
- **Bug Fixes**: Fixed issues with [VIM-XXXX] ticket references
- **Breaking Changes**: Any backwards-incompatible changes
- **Deprecations**: Features marked for future removal
- **Merged PRs**: Reference significant PRs like "Implement vim-surround (#123)"
- Note: PRs have their own inclusion rules - see "Merged PRs Special Rules" section below
### 5. What to Exclude
- Dependabot PRs (author: dependabot[bot])
- Claude-generated PRs (check PR author/title)
- Internal refactoring with no user impact
- Documentation-only changes (unless significant)
- Test-only changes
- **API module changes** (while in experimental status) - Do not log changes to the `api` module as it's currently experimental
- Note: This exclusion should be removed once the API status is no longer experimental
- **Internal code changes** - Do not log coding changes that users cannot see or experience
- Refactoring, code cleanup, internal architecture changes
- Performance optimizations (unless they fix a noticeable user issue)
- Remember: The changelog is for users, not developers
## Writing Style
- **Be concise**: One line per change when possible
- **User-focused**: Describe what changed from user's perspective
- Write for end users, not developers
- Focus on visible behavior changes, new commands, fixed issues users experience
- Avoid technical implementation details
- **Include examples** when helpful:
- For fixes: Show the command/operation that now works correctly
- For features: Demonstrate the new commands or functionality
- Good example: "Fixed `ci"` command in empty strings" or "Added support for `gn` text object"
- Bad examples (too vague, unclear what was broken):
- "Fixed count validation in text objects"
- "Fixed inlay offset calculations"
- Better: Specify the actual case - "Fixed `3daw` deleting wrong number of words" or "Fixed cursor position with inlay hints in `f` motion"
- **If you can't determine the specific case from tests/code, omit the entry rather than leave it unclear**
- **Add helpful links** for context:
- When mentioning IntelliJ features, search for official JetBrains documentation or blog posts
- When referencing Vim commands, link to Vim documentation if helpful
- Example: "Added support for [Next Edit Suggestion](https://blog.jetbrains.com/ai/2025/08/introducing-next-edit-suggestions-in-jetbrains-ai-assistant/)"
- Use web search to find the most relevant official sources
- **Include references**: Add [VIM-XXXX] for YouTrack tickets, (#XXX) for PRs
- **Group logically**: Features, Fixes, Changes, Merged PRs
- **No duplication**: Each change appears in exactly ONE subsection - don't repeat items across categories
- **Use consistent tense**: Past tense for completed work
## Examples of Good Entries
```
### Features:
* Added support for `gn` text object - select next match with `gn`, change with `cgn`
* Implemented `:tabmove` command - use `:tabmove +1` or `:tabmove -1` to reorder tabs
* Support for `z=` to show spelling suggestions
* Added integration with [Next Edit Suggestion](https://blog.jetbrains.com/ai/2025/08/introducing-next-edit-suggestions-in-jetbrains-ai-assistant/) feature
* Support for [multiple cursors](https://www.jetbrains.com/help/idea/multicursor.html) in visual mode
### Fixes:
* [VIM-3456](https://youtrack.jetbrains.com/issue/VIM-3456) Fixed cursor position after undo in visual mode
* [VIM-3458](https://youtrack.jetbrains.com/issue/VIM-3458) Fixed `ci"` command now works correctly in empty strings
* [VIM-3260](https://youtrack.jetbrains.com/issue/VIM-3260) Fixed `G` command at file end with count
* [VIM-3180](https://youtrack.jetbrains.com/issue/VIM-3180) Fixed `vib` and `viB` selection in nested blocks
### Merged PRs:
* [805](https://github.com/JetBrains/ideavim/pull/805) by [chylex](https://github.com/chylex): VIM-3238 Fix recording a macro that replays another macro
```
## IMPORTANT Format Notes
### For Fixes:
Always put the ticket link FIRST, then the description:
```
* [VIM-XXXX](https://youtrack.jetbrains.com/issue/VIM-XXXX) Description of what was fixed
```
### For Features:
- Without ticket: Just the description
- With ticket: Can use either format:
- Description with pipe: `* Feature description | [VIM-XXXX](https://youtrack.jetbrains.com/issue/VIM-XXXX)`
- Link first (like fixes): `* [VIM-XXXX](https://youtrack.jetbrains.com/issue/VIM-XXXX) Feature description`
### Avoid Duplication:
- **Each change should appear in only ONE subsection**
- If a feature is listed in Features, don't repeat it in Fixes
- If a bug fix is in Fixes, don't list it again elsewhere
- Choose the most appropriate category for each change
### Merged PRs Special Rules:
- **Different criteria than other sections**: The exclusion rules for Features/Fixes don't apply here
- **Include PRs from external contributors** even if they're internal changes or refactoring
- **List significant community contributions** regardless of whether they're user-visible
- **Format**: PR number, author, and brief description
- **Use PR title as-is**: Take the description directly from the PR title, don't regenerate or rewrite it
- **Purpose**: Acknowledge community contributions and provide PR tracking
- The "user-visible only" rule does NOT apply to this section
## Process
1. Read the current CHANGES.md (only the top portion - focus on `[To Be Released]` and recent versions)
2. Check previous changelog PRs from GitHub:
- Review the last few changelog update PRs (use `gh pr list --search "Update changelog" --state all --limit 5`)
- **Read the PR comments**: Use `gh pr view <PR_NUMBER> --comments` to check for specific instructions
- Look for any comments or instructions about what NOT to log this time
- Previous PRs may contain specific exclusions or special handling instructions
- Pay attention to review feedback that might indicate what to avoid in future updates
3. Check git tags for any undocumented releases
4. Review commits and PRs since last entry
5. Group changes by release or under [To Be Released]
6. Update CHANGES.md maintaining existing format
7. Update the `changeNotes` section in `build.gradle.kts` (see detailed instructions below)
8. Create a PR only if there are changes to document:
- Title format: "Update changelog: <super short summary>"
- Example: "Update changelog: Add gn text object, fix visual mode issues"
- Body: Brief summary of what was added
## Updating changeNotes in build.gradle.kts
The `changeNotes` section in `build.gradle.kts` displays on the JetBrains Marketplace plugin page. Follow these rules:
### Content Requirements
- **Match CHANGES.md exactly**: Use the same content from the `[To Be Released]` section
- **Don't create a shorter version**: Include all entries as they appear in CHANGES.md
- **Keep the same level of detail**: Don't summarize or condense
### HTML Formatting
Convert Markdown to HTML format:
- Headers: `### Features:``<b>Features:</b>`
- Line breaks: Use `<br>` between items
- Links: Convert markdown links to HTML `<a href="">` tags
- Bullet points: Use `•` or keep `*` with proper spacing
- Code blocks: Use `<code>` tags for commands like `<code>gn</code>`
### Special Notes
- **IMPORTANT**: Keep any existing information about the reward program in changeNotes
- This content appears in the plugin description on JetBrains Marketplace
### Example Conversion
Markdown in CHANGES.md:
```
### Features:
* Added support for `gn` text object
* [VIM-3456](https://youtrack.jetbrains.com/issue/VIM-3456) Fixed cursor position
```
HTML in changeNotes:
```html
<b>Features:</b><br>
• Added support for <code>gn</code> text object<br>
<a href="https://youtrack.jetbrains.com/issue/VIM-3456">VIM-3456</a> Fixed cursor position<br>
```
## Important Notes
- **Don't create a PR if changelog is already up to date**
- **Preserve existing format and structure**
- **Maintain chronological order (newest first)**
- **Keep the historical gap note between 2.9.0 and 2.28.0**

View File

@@ -0,0 +1,12 @@
{
"name": "Java",
"image": "mcr.microsoft.com/devcontainers/java:1-21",
"features": {
"ghcr.io/devcontainers/features/java:1": {
"version": "none",
"installMaven": "true",
"mavenVersion": "3.8.6",
"installGradle": "true"
}
}
}

View File

@@ -0,0 +1,54 @@
name: Claude Code Review
on:
pull_request:
types: [opened, synchronize]
# Optional: Only run on specific file changes
# paths:
# - "src/**/*.ts"
# - "src/**/*.tsx"
# - "src/**/*.js"
# - "src/**/*.jsx"
jobs:
claude-review:
# Optional: Filter by PR author
# if: |
# github.event.pull_request.user.login == 'external-contributor' ||
# github.event.pull_request.user.login == 'new-developer' ||
# github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR'
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: read
issues: read
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 1
- name: Run Claude Code Review
id: claude-review
uses: anthropics/claude-code-action@v1
with:
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
prompt: |
Please review this pull request and provide feedback on:
- Code quality and best practices
- Potential bugs or issues
- Performance considerations
- Security concerns
- Test coverage
Use the repository's CLAUDE.md for guidance on style and conventions. Be constructive and helpful in your feedback.
Use `gh pr comment` with your Bash tool to leave your review as a comment on the PR.
# See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
# or https://docs.anthropic.com/en/docs/claude-code/sdk#command-line for available options
claude_args: '--allowed-tools "Bash(gh issue view:*),Bash(gh search:*),Bash(gh issue list:*),Bash(gh pr comment:*),Bash(gh pr diff:*),Bash(gh pr view:*),Bash(gh pr list:*)"'

50
.github/workflows/claude.yml vendored Normal file
View File

@@ -0,0 +1,50 @@
name: Claude Code
on:
issue_comment:
types: [created]
pull_request_review_comment:
types: [created]
issues:
types: [opened, assigned]
pull_request_review:
types: [submitted]
jobs:
claude:
if: |
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
(github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
(github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: read
issues: read
id-token: write
actions: read # Required for Claude to read CI results on PRs
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 1
- name: Run Claude Code
id: claude
uses: anthropics/claude-code-action@v1
with:
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
# This is an optional setting that allows Claude to read CI results on PRs
additional_permissions: |
actions: read
# Optional: Give a custom prompt to Claude. If this is not specified, Claude will perform the instructions specified in the comment that tagged it.
# prompt: 'Update the pull request description to include a summary of changes.'
# Optional: Add claude_args to customize behavior and configuration
# See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
# or https://docs.anthropic.com/en/docs/claude-code/sdk#command-line for available options
# claude_args: '--model claude-opus-4-1-20250805 --allowed-tools Bash(gh pr:*)'

21
.github/workflows/junie.yml vendored Normal file
View File

@@ -0,0 +1,21 @@
name: Junie
run-name: Junie run ${{ inputs.run_id }}
permissions:
contents: write
on:
workflow_dispatch:
inputs:
run_id:
description: "id of workflow process"
required: true
workflow_params:
description: "stringified params"
required: true
jobs:
call-workflow-passing-data:
uses: jetbrains-junie/junie-workflows/.github/workflows/ej-issue.yml@main
with:
workflow_params: ${{ inputs.workflow_params }}

View File

@@ -28,10 +28,12 @@ jobs:
uses: jtalk/url-health-check-action@v3
with:
url: http://127.0.0.1:8082
max-attempts: 20
max-attempts: 100
retry-delay: 10s
- name: Tests
run: gradle :tests:ui-rd-tests:testUi
env:
RIDER_LICENSE: ${{ secrets.RIDER_LICENSE }}
- name: Move video
if: always()
run: mv tests/ui-rd-tests/video build/reports

View File

@@ -0,0 +1,45 @@
name: Update Changelog with Claude
on:
schedule:
# Run every day at 5 AM UTC
- cron: '0 5 * * *'
workflow_dispatch: # Allow manual trigger
jobs:
update-changelog:
runs-on: ubuntu-latest
if: github.repository == 'JetBrains/ideavim'
permissions:
contents: write
pull-requests: write
id-token: write
issues: read
actions: read
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0 # Need full history to analyze commits and tags
- name: Run Claude Code to Update Changelog
uses: anthropics/claude-code-action@v1
with:
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
prompt: |
## Task: Update the CHANGES.md Changelog File
You need to review the latest commits and maintain the changelog file (CHANGES.md) with meaningful changes.
Please follow the detailed changelog maintenance instructions in `.claude/changelog-instructions.md`.
If you find changes that need documenting, update CHANGES.md and create a pull request with:
- Title: "Update changelog: <super short summary>"
Example: "Update changelog: Add gn text object, fix visual mode issues"
- Body: Brief summary of what was added
# Allow Claude to use git, GitHub CLI, and web access for checking releases and tickets
claude_args: '--allowed-tools "Read,Edit,Bash(git:*),Bash(gh:*),WebSearch,WebFetch(domain:plugins.jetbrains.com),WebFetch(domain:youtrack.jetbrains.com),WebFetch(domain:github.com)"'

View File

@@ -0,0 +1,47 @@
name: Update IntelliJ Version Configurations
on:
schedule:
# Run three times a year: August 15, April 30, December 1
# Times are in UTC
- cron: '0 10 15 8 *' # August 15 at 10:00 UTC
- cron: '0 10 30 4 *' # April 30 at 10:00 UTC
- cron: '0 10 1 12 *' # December 1 at 10:00 UTC
workflow_dispatch: # Allow manual trigger for testing
jobs:
update-intellij-versions:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 1
- name: Run Claude Code
uses: anthropics/claude-code-action@v1
with:
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
prompt: |
Look at the file `.teamcity/_Self/Project.kt` and check what IntelliJ versions are currently being tested (look for TestingBuildType configurations).
Based on the current date and existing versions, determine if a new IntelliJ version should be added.
IntelliJ releases new versions approximately 3 times per year:
- Spring release (x.1) - around March/April
- Summer release (x.2) - around July/August
- Fall release (x.3) - around November/December
If a new version should be added:
1. Add the new TestingBuildType configuration in chronological order
2. Create a pull request with your changes
The configuration file is located at: `.teamcity/_Self/Project.kt`
Look for the section with comment `// Active tests`
Only add a new version if it doesn't already exist and if it makes sense based on the release schedule.

5
.gitignore vendored
View File

@@ -3,6 +3,7 @@
/.intellijPlatform/
/.idea/
!/.idea/dictionaries/project.xml
!/.idea/scopes
!/.idea/copyright
!/.idea/icon.png
@@ -32,4 +33,6 @@ vim-engine/src/main/java/com/maddyhome/idea/vim/regexp/parser/generated
# Created by github automation
settings.xml
.kotlin
.kotlin
.claude/settings.local.json

7
.idea/dictionaries/project.xml generated Normal file
View File

@@ -0,0 +1,7 @@
<component name="ProjectDictionaryState">
<dictionary name="project">
<words>
<w>overstrike</w>
</words>
</dictionary>
</component>

1
.idea/gradle.xml generated
View File

@@ -9,6 +9,7 @@
<set>
<option value="$PROJECT_DIR$" />
<option value="$PROJECT_DIR$/annotation-processors" />
<option value="$PROJECT_DIR$/api" />
<option value="$PROJECT_DIR$/scripts" />
<option value="$PROJECT_DIR$/tests" />
<option value="$PROJECT_DIR$/tests/java-tests" />

View File

@@ -5,7 +5,7 @@
<option name="executionName" />
<option name="externalProjectPath" value="$PROJECT_DIR$" />
<option name="externalSystemIdString" value="GRADLE" />
<option name="scriptParameters" value="" />
<option name="scriptParameters" value="-x :tests:property-tests:test -x :tests:long-running-tests:test" />
<option name="taskDescriptions">
<list />
</option>
@@ -19,6 +19,7 @@
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
<DebugAllEnabled>false</DebugAllEnabled>
<RunAsTest>false</RunAsTest>
<method v="2" />
</configuration>
</component>

View File

@@ -5,11 +5,11 @@ object Constants {
const val EAP_CHANNEL = "eap"
const val DEV_CHANNEL = "Dev"
const val NVIM_TESTS = "2024.3.3"
const val PROPERTY_TESTS = "2024.3.3"
const val LONG_RUNNING_TESTS = "2024.3.3"
const val RELEASE = "2024.3.3"
const val NVIM_TESTS = "2025.1"
const val PROPERTY_TESTS = "2025.1"
const val LONG_RUNNING_TESTS = "2025.1"
const val RELEASE = "2025.1"
const val RELEASE_DEV = "2024.3.3"
const val RELEASE_EAP = "2024.3.3"
const val RELEASE_DEV = "2025.1"
const val RELEASE_EAP = "2025.1"
}

View File

@@ -23,8 +23,9 @@ object Project : Project({
vcsRoot(ReleasesVcsRoot)
// Active tests
buildType(TestingBuildType("Latest EAP", "<default>", version = "LATEST-EAP-SNAPSHOT"))
buildType(TestingBuildType("2024.3.3", "<default>"))
buildType(TestingBuildType("Latest EAP", version = "LATEST-EAP-SNAPSHOT"))
buildType(TestingBuildType("2025.1"))
buildType(TestingBuildType("2025.2"))
buildType(TestingBuildType("Latest EAP With Xorg", "<default>", version = "LATEST-EAP-SNAPSHOT"))
buildType(PropertyBased)

View File

@@ -43,6 +43,12 @@ object Compatibility : IdeaVimBuildType({
java -jar verifier1/verifier-cli-dev-all-2.jar check-plugin '${'$'}com.julienphalip.ideavim.peekaboo' [latest-IU] -team-city
java -jar verifier1/verifier-cli-dev-all-2.jar check-plugin '${'$'}com.julienphalip.ideavim.switch' [latest-IU] -team-city
java -jar verifier1/verifier-cli-dev-all-2.jar check-plugin '${'$'}com.julienphalip.ideavim.functiontextobj' [latest-IU] -team-city
java -jar verifier1/verifier-cli-dev-all-2.jar check-plugin '${'$'}com.miksuki.HighlightCursor' [latest-IU] -team-city
java -jar verifier1/verifier-cli-dev-all-2.jar check-plugin '${'$'}com.ugarosa.idea.edgemotion' [latest-IU] -team-city
java -jar verifier1/verifier-cli-dev-all-2.jar check-plugin '${'$'}cn.mumukehao.plugin' [latest-IU] -team-city
java -jar verifier1/verifier-cli-dev-all-2.jar check-plugin '${'$'}com.magidc.ideavim.dial' [latest-IU] -team-city
java -jar verifier1/verifier-cli-dev-all-2.jar check-plugin '${'$'}dev.ghostflyby.ideavim.toggleIME' [latest-IU] -team-city
java -jar verifier1/verifier-cli-dev-all-2.jar check-plugin '${'$'}com.magidc.ideavim.anyObject' [latest-IU] -team-city
""".trimIndent()
}
}

View File

@@ -25,7 +25,7 @@ object LongRunning : IdeaVimBuildType({
steps {
gradle {
tasks = "clean :tests:long-running-tests:testLongRunning"
tasks = "clean :tests:long-running-tests:test"
buildFile = ""
enableStacktrace = true
jdkHome = "/usr/lib/jvm/java-21-amazon-corretto"

View File

@@ -39,7 +39,7 @@ object Nvim : IdeaVimBuildType({
""".trimIndent()
}
gradle {
tasks = "clean test -Dnvim"
tasks = "clean test -x :tests:property-tests:test -x :tests:long-running-tests:test -Dnvim"
buildFile = ""
enableStacktrace = true
jdkHome = "/usr/lib/jvm/java-21-amazon-corretto"

View File

@@ -24,7 +24,8 @@ object PropertyBased : IdeaVimBuildType({
steps {
gradle {
tasks = "clean :tests:property-tests:testPropertyBased"
clearConditions()
tasks = "clean :tests:property-tests:test"
buildFile = ""
enableStacktrace = true
jdkHome = "/usr/lib/jvm/java-21-amazon-corretto"

View File

@@ -115,7 +115,7 @@ sealed class ReleasePlugin(private val releaseType: String) : IdeaVimBuildType({
}
script {
name = "Run tests"
scriptContent = "./gradlew test"
scriptContent = "./gradlew test -x :tests:property-tests:test -x :tests:long-running-tests:test"
}
gradle {
name = "Publish release"

View File

@@ -12,7 +12,7 @@ import jetbrains.buildServer.configs.kotlin.v2019_2.triggers.vcs
open class TestingBuildType(
private val testName: String,
private val branch: String,
private val branch: String = "<default>",
private val version: String = testName,
private val javaVersion: String? = null,
private val javaPlugin: Boolean = true,
@@ -40,7 +40,7 @@ open class TestingBuildType(
steps {
gradle {
clearConditions()
tasks = "clean test"
tasks = "clean test -x :tests:property-tests:test -x :tests:long-running-tests:test"
buildFile = ""
enableStacktrace = true
jdkHome = "/usr/lib/jvm/java-21-amazon-corretto"

View File

@@ -15,7 +15,7 @@ object GitHub : Project({
name = "Pull Requests checks"
description = "Automatic checking of GitHub Pull Requests"
buildType(GithubBuildType("clean test", "Tests"))
buildType(GithubBuildType("clean test -x :tests:property-tests:test -x :tests:long-running-tests:test", "Tests"))
})
class GithubBuildType(command: String, desc: String) : IdeaVimBuildType({

View File

@@ -26,6 +26,13 @@ Previous maintainers:
&nbsp;
Andrey Vlasovskikh
Previous support members:
* [![icon][mail]](mailto:lejia.chen@jetbrains.com)
[![icon][github-off]](#)
&nbsp;
Lejia Chen
Contributors:
* [![icon][mail]](mailto:yole@jetbrains.com)
@@ -587,6 +594,50 @@ Contributors:
[![icon][github]](https://github.com/Iliya-usov)
&nbsp;
Ilya Usov
* [![icon][mail]](mailto:peterHoburg@users.noreply.github.com)
[![icon][github]](https://github.com/peterHoburg)
&nbsp;
Peter Hoburg
* [![icon][mail]](mailto:erotourtes@gmail.com)
[![icon][github]](https://github.com/erotourtes)
&nbsp;
Max Siryk
* [![icon][mail]](mailto:ivan.yarkov@jetbrains.com)
[![icon][github]](https://github.com/MToolMakerJB)
&nbsp;
Ivan Yarkov
* [![icon][mail]](mailto:mia.vucinic@jetbrains.com)
[![icon][github]](https://github.com/vumi19)
&nbsp;
Mia Vucinic
* [![icon][mail]](mailto:canava.thomas@gmail.com)
[![icon][github]](https://github.com/Malandril)
&nbsp;
Thomas Canava
* [![icon][mail]](mailto:xinhe.wang@jetbrains.com)
[![icon][github]](https://github.com/wxh06)
&nbsp;
Xinhe Wang
* [![icon][mail]](mailto:zuber.kuba@gmail.com)
[![icon][github]](https://github.com/zuberol)
&nbsp;
Jakub Zuber
* [![icon][mail]](mailto:nmh9097@gmail.com)
[![icon][github]](https://github.com/NaMinhyeok)
&nbsp;
Na Minhyeok
* [![icon][mail]](mailto:201638009+jetbrains-junie[bot]@users.noreply.github.com)
[![icon][github]](https://github.com/apps/jetbrains-junie)
&nbsp;
jetbrains-junie[bot]
* [![icon][mail]](mailto:4416693+magidc@users.noreply.github.com)
[![icon][github]](https://github.com/magidc)
&nbsp;
magidc
* [![icon][mail]](mailto:ricardo.rodcas@gmail.com)
[![icon][github]](https://github.com/magidc)
&nbsp;
magidc
Previous contributors:

22
CLAUDE.md Normal file
View File

@@ -0,0 +1,22 @@
# CLAUDE.md
Guidance for Claude Code when working with IdeaVim.
## Quick Reference
Essential commands:
- `./gradlew runIde` - Start dev IntelliJ with IdeaVim
- `./gradlew test -x :tests:property-tests:test -x :tests:long-running-tests:test` - Run standard tests
See CONTRIBUTING.md for architecture details and complete command list.
## IdeaVim-Specific Notes
- Property tests can be flaky - verify if failures relate to your changes
- Use `<Action>` in mappings, not `:action`
- Config file: `~/.ideavimrc` (XDG supported)
- Goal: Match Vim functionality and architecture
## Additional Documentation
- Changelog maintenance: See `.claude/changelog-instructions.md`

View File

@@ -65,7 +65,7 @@ We've prepared some useful configurations for you:
And here are useful gradle commands:
* `./gradlew runIde` — start the dev version of IntelliJ IDEA with IdeaVim installed.
* `./gradlew test` — run tests.
* `./gradlew test -x :tests:property-tests:test -x :tests:long-running-tests:test` — run tests.
* `./gradlew buildPlugin` — build the plugin. The result will be located in `build/distributions`. This file can be
installed by using `Settings | Plugin | >Gear Icon< | Install Plugin from Disk...`. You can stay with your personal build
for a few days or send it to a friend for testing.
@@ -78,8 +78,8 @@ for a few days or send it to a friend for testing.
- Read the javadoc for the `@VimBehaviorDiffers` annotation in the source code and fix the corresponding functionality.
- Implement one of the requested [#vim plugin](https://youtrack.jetbrains.com/issues/VIM?q=%23Unresolved%20tag:%20%7Bvim%20plugin%7D%20sort%20by:%20votes%20)s.
> :small_orange_diamond: Selected an issue to work on? Leave a comment in a YouTrack ticket or create a draft PR
> to indicate that you've started working on it so that you might get additional guidance and feedback from the maintainers.
> :small_orange_diamond: You may leave a comment in the YouTrack ticket or open a draft PR if youd like early feedback
> or want to let maintainers know youve started working on an issue. Otherwise, simply open a PR.
## Where to start in the codebase

View File

@@ -29,8 +29,8 @@ IdeaVim is a Vim engine for JetBrains IDEs.
#### Compatibility
IntelliJ IDEA, PyCharm, CLion, PhpStorm, WebStorm, RubyMine, DataGrip, GoLand, Rider, Cursive,
Android Studio and other IntelliJ platform based IDEs.
IntelliJ IDEA, PyCharm, GoLand, CLion, PhpStorm, WebStorm, RubyMine, DataGrip, DataSpell, Rider, Cursive,
Android Studio, and other [JetBrains IDEs](https://www.jetbrains.com/ides/).
Setup
------------
@@ -89,29 +89,12 @@ Here are some examples of supported vim features and commands:
* Full Vim regexps for search and search/replace
* Vim web help
* `~/.ideavimrc` configuration file
[IdeaVim plugins](https://github.com/JetBrains/ideavim/wiki/IdeaVim-Plugins):
* vim-easymotion
* NERDTree
* vim-surround
* vim-multiple-cursors
* vim-commentary
* argtextobj.vim
* vim-textobj-entire
* ReplaceWithRegister
* vim-exchange
* vim-highlightedyank
* vim-paragraph-motion
* vim-indent-object
* match.it
etc
* Vim script
* IdeaVim plugins
See also:
* [Top feature requests and bugs](https://youtrack.jetbrains.com/issues/VIM?q=%23Unresolved+sort+by%3A+votes)
* [Vimscript support roadmap](vimscript-info/VIMSCRIPT_ROADMAP.md)
* [List of supported in-build functions](vimscript-info/FUNCTIONS_INFO.MD)
Files
-----
@@ -265,8 +248,7 @@ IdeaVim can execute custom scripts that are written with Vim Script.
At the moment we support all language features, but not all of the built-in functions and options are supported.
Additionally, you may be interested in the
[Vim Script Discussion](https://github.com/JetBrains/ideavim/discussions/357) or
[Vim Script Roadmap](https://github.com/JetBrains/ideavim/blob/master/vimscript-info/VIMSCRIPT_ROADMAP.md).
[Vim Script Discussion](https://github.com/JetBrains/ideavim/discussions/357).
### IDE specific options

View File

@@ -8,7 +8,7 @@
plugins {
kotlin("jvm")
kotlin("plugin.serialization") version "2.0.21"
kotlin("plugin.serialization") version "2.2.0"
}
val kotlinxSerializationVersion: String by project
@@ -21,10 +21,11 @@ repositories {
}
dependencies {
compileOnly("com.google.devtools.ksp:symbol-processing-api:2.1.10-1.0.29")
compileOnly("com.google.devtools.ksp:symbol-processing-api:2.1.21-2.0.2")
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json-jvm:$kotlinxSerializationVersion") {
// kotlin stdlib is provided by IJ, so there is no need to include it into the distribution
exclude("org.jetbrains.kotlin", "kotlin-stdlib")
exclude("org.jetbrains.kotlin", "kotlin-stdlib-common")
}
api(project(":api"))
}

View File

@@ -31,12 +31,15 @@ class CommandOrMotionProcessor(private val environment: SymbolProcessorEnvironme
private val json = Json { prettyPrint = true }
override fun process(resolver: Resolver): List<KSAnnotated> {
val commandsFile = environment.options["commands_file"]
if (commandsFile == null) return emptyList()
resolver.getAllFiles().forEach { it.accept(visitor, Unit) }
val generatedDirPath = Path(environment.options["generated_directory"]!!)
Files.createDirectories(generatedDirPath)
val filePath = generatedDirPath.resolve(environment.options["commands_file"]!!)
val filePath = generatedDirPath.resolve(commandsFile)
val sortedCommands = commands.sortedWith(compareBy({ it.keys }, { it.`class` }))
val fileContent = json.encodeToString(sortedCommands)
filePath.writeText(fileContent)

View File

@@ -31,12 +31,15 @@ class ExCommandProcessor(private val environment: SymbolProcessorEnvironment): S
private val json = Json { prettyPrint = true }
override fun process(resolver: Resolver): List<KSAnnotated> {
val exCommandsFile = environment.options["ex_commands_file"]
if (exCommandsFile == null) return emptyList()
resolver.getAllFiles().forEach { it.accept(visitor, Unit) }
val generatedDirPath = Path(environment.options["generated_directory"]!!)
Files.createDirectories(generatedDirPath)
val filePath = generatedDirPath.resolve(environment.options["ex_commands_file"]!!)
val filePath = generatedDirPath.resolve(exCommandsFile)
val sortedCommandToClass = commandToClass.toList().sortedWith(compareBy({ it.first }, { it.second })).toMap()
val fileContent = json.encodeToString(sortedCommandToClass)
filePath.writeText(fileContent)

View File

@@ -0,0 +1,78 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.processors
import com.google.devtools.ksp.KspExperimental
import com.google.devtools.ksp.getAnnotationsByType
import com.google.devtools.ksp.processing.Resolver
import com.google.devtools.ksp.processing.SymbolProcessor
import com.google.devtools.ksp.processing.SymbolProcessorEnvironment
import com.google.devtools.ksp.symbol.KSAnnotated
import com.google.devtools.ksp.symbol.KSClassDeclaration
import com.google.devtools.ksp.symbol.KSFile
import com.google.devtools.ksp.symbol.KSFunctionDeclaration
import com.google.devtools.ksp.symbol.KSVisitorVoid
import com.intellij.vim.api.VimPlugin
import kotlinx.serialization.encodeToString
import kotlinx.serialization.json.Json
import java.nio.file.Files
import kotlin.io.path.Path
import kotlin.io.path.writeText
// Used for processing VimPlugin annotations
class ExtensionsProcessor(private val environment: SymbolProcessorEnvironment) : SymbolProcessor {
private val visitor = ExtensionsVisitor()
private val declaredExtensions = mutableListOf<KspExtensionBean>()
private val json = Json { prettyPrint = true }
override fun process(resolver: Resolver): List<KSAnnotated> {
val extensionsFile = environment.options["extensions_file"]
if (extensionsFile == null) return emptyList()
resolver.getAllFiles().forEach { it.accept(visitor, Unit) }
val generatedDirPath = Path(environment.options["generated_directory"]!!)
Files.createDirectories(generatedDirPath)
val filePath = generatedDirPath.resolve(environment.options["extensions_file"]!!)
val sortedExtensions = declaredExtensions.toList().sortedWith(compareBy { it.extensionName })
val fileContent = json.encodeToString(sortedExtensions)
filePath.writeText(fileContent)
return emptyList()
}
private inner class ExtensionsVisitor : KSVisitorVoid() {
@OptIn(KspExperimental::class)
override fun visitFunctionDeclaration(function: KSFunctionDeclaration, data: Unit) {
val pluginAnnotation = function.getAnnotationsByType(VimPlugin::class).firstOrNull() ?: return
val pluginName = pluginAnnotation.name
val functionPath = function.simpleName.asString()
// Extensions are not declared as part of class, however, when Kotlin code is decompiled to Java,
// function `fun init()` in a file File.kt, will be a static method in a class FileKt since Java
// does not support top-level functions. Then, it can be loaded with class loader.
val surroundingFileName = function.containingFile?.fileName?.removeSuffix(".kt") ?: return
val packageName = function.packageName.asString()
val className = "$packageName.${surroundingFileName}Kt"
val kspExtensionBean = KspExtensionBean(pluginName, functionPath, className)
declaredExtensions.add(kspExtensionBean)
}
override fun visitFile(file: KSFile, data: Unit) {
file.declarations.forEach { it.accept(this, Unit) }
}
}
}

View File

@@ -0,0 +1,14 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.processors
import kotlinx.serialization.Serializable
@Serializable
data class KspExtensionBean(val extensionName: String, val functionName: String, val className: String)

View File

@@ -31,12 +31,15 @@ class VimscriptFunctionProcessor(private val environment: SymbolProcessorEnviron
private val json = Json { prettyPrint = true }
override fun process(resolver: Resolver): List<KSAnnotated> {
val vimscriptFunctionsFile = environment.options["vimscript_functions_file"]
if (vimscriptFunctionsFile == null) return emptyList()
resolver.getAllFiles().forEach { it.accept(visitor, Unit) }
val generatedDirPath = Path(environment.options["generated_directory"]!!)
Files.createDirectories(generatedDirPath)
val filePath = generatedDirPath.resolve(environment.options["vimscript_functions_file"]!!)
val filePath = generatedDirPath.resolve(vimscriptFunctionsFile)
val sortedNameToClass = nameToClass.toList().sortedWith(compareBy({ it.first }, { it.second })).toMap()
val fileContent = json.encodeToString(sortedNameToClass)
filePath.writeText(fileContent)

View File

@@ -0,0 +1,20 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.providers
import com.google.devtools.ksp.processing.SymbolProcessor
import com.google.devtools.ksp.processing.SymbolProcessorEnvironment
import com.google.devtools.ksp.processing.SymbolProcessorProvider
import com.intellij.vim.processors.ExtensionsProcessor
class ExtensionsProcessorProvider: SymbolProcessorProvider {
override fun create(environment: SymbolProcessorEnvironment): SymbolProcessor {
return ExtensionsProcessor(environment)
}
}

View File

@@ -1,3 +1,4 @@
com.intellij.vim.providers.CommandOrMotionProcessorProvider
com.intellij.vim.providers.ExCommandProcessorProvider
com.intellij.vim.providers.VimscriptFunctionProcessorProvider
com.intellij.vim.providers.ExtensionsProcessorProvider

29
api/build.gradle.kts Normal file
View File

@@ -0,0 +1,29 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
plugins {
kotlin("jvm")
}
val kotlinVersion: String by project
repositories {
mavenCentral()
}
dependencies {
testImplementation(platform("org.junit:junit-bom:6.0.0"))
testImplementation("org.junit.jupiter:junit-jupiter")
compileOnly("org.jetbrains.kotlin:kotlin-stdlib:$kotlinVersion")
compileOnly("org.jetbrains:annotations:26.0.2-1")
compileOnly("org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.10.2")
}
tasks.test {
useJUnitPlatform()
}

View File

@@ -0,0 +1,545 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api
import com.intellij.vim.api.models.Mode
import com.intellij.vim.api.models.Path
import com.intellij.vim.api.scopes.DigraphScope
import com.intellij.vim.api.scopes.MappingScope
import com.intellij.vim.api.scopes.ModalInput
import com.intellij.vim.api.scopes.OptionScope
import com.intellij.vim.api.scopes.OutputPanelScope
import com.intellij.vim.api.scopes.VimApiDsl
import com.intellij.vim.api.scopes.commandline.CommandLineScope
import com.intellij.vim.api.scopes.editor.EditorScope
import org.jetbrains.annotations.ApiStatus
import kotlin.reflect.KType
import kotlin.reflect.typeOf
/**
* Entry point of the Vim API
*
* The API is currently in experimental status and not suggested to be used.
*/
@ApiStatus.Experimental
@VimApiDsl
interface VimApi {
/**
* Represents the current mode in Vim.
*
* Example usage:
*
* **Getting the Current Mode**
* ```kotlin
* val currentMode = mode
* println("Current Vim Mode: $currentMode")
* ```
*
* The set of mode is currently an experimental operation as the contracts of it are getting polished.
* We suggest currently not using it.
*/
@set:ApiStatus.Experimental
var mode: Mode
/**
* Retrieves a variable of the specified type and name.
* Use the extension function `getVariable<String>("name")`
*/
fun <T : Any> getVariable(name: String, type: KType): T?
/**
* Sets a variable with the specified name and value.
* Use the extension function `setVariable<String>("name", 1)`
*
* In Vim, this is equivalent to `let varname = value`.
*/
fun setVariable(name: String, value: Any, type: KType)
/**
* Exports a function that can be used as an operator function in Vim.
*
* In Vim, operator functions are used with the `g@` operator to create custom operators.
*
* Example usage:
* ```kotlin
* exportOperatorFunction("MyOperator") {
* editor {
* // Perform operations on the selected text
* true // Return success
* }
* }
* ```
*
* @param name The name to register the function under
* @param function The function to execute when the operator is invoked
*/
fun exportOperatorFunction(name: String, function: suspend VimApi.() -> Boolean)
/**
* Sets the current operator function to use with the `g@` operator.
*
* In Vim, this is equivalent to setting the 'operatorfunc' option.
*
* @param name The name of the previously exported operator function
*/
fun setOperatorFunction(name: String)
/**
* Executes normal mode commands as if they were typed.
*
* In Vim, this is equivalent to the `:normal` command.
*
* Example usage:
* ```kotlin
* normal("gg") // Go to the first line
* normal("dw") // Delete word
* ```
*
* @param command The normal mode command string to execute
*/
fun normal(command: String)
/**
* Executes a block of code in the context of the currently focused editor.
*
* Example usage:
* ```kotlin
* editor {
* read {
* // executed under read lock
* }
* }
* ```
*
* @param block The code block to execute within editor scope
* @return The result of the block execution
*/
fun <T> editor(block: EditorScope.() -> T): T
/**
* Executes a block of code for each editor.
*
* This function allows performing operations on all available editors.
*
* Example usage:
* ```kotlin
* forEachEditor {
* // Perform some operation on each editor
* }
* ```
*
* @param block The code block to execute for each editor
* @return A list containing the results of executing the block on each editor
*/
fun <T> forEachEditor(block: EditorScope.() -> T): List<T>
/**
* Provides access to key mapping functionality.
*
* Example usage:
* ```kotlin
* mappings {
* nmap("jk", "<Esc>")
* }
* ```
*
* @param block The code block to execute within the mapping scope
*/
fun mappings(block: MappingScope.() -> Unit)
// /**
// * Provides access to event listener functionality.
// *
// * Example usage:
// * ```kotlin
// * listeners {
// * // Register a listener for mode changes
// * onModeChange { oldMode ->
// * println("Mode changed from $oldMode")
// * }
// * }
// * ```
// *
// * @param block The code block to execute within the listeners scope
// */
// fun listeners(block: ListenersScope.() -> Unit)
/**
* Provides access to Vim's output panel functionality.
*
* Example usage:
* ```kotlin
* outputPanel {
* // Print a message to the output panel
* setText("Hello from IdeaVim plugin!")
* }
* ```
*
* @param block The code block to execute within the output panel scope
*/
fun outputPanel(block: OutputPanelScope.() -> Unit)
/**
* Provides access to modal input functionality.
*
* Example usage:
* ```kotlin
* modalInput()
* .inputChar(label) { char ->
* // get char that user entered
* }
* ```
*
* @return A ModalInput instance that can be used to request user input
*/
fun modalInput(): ModalInput
/**
* Provides access to Vim's command line functionality.
*
* Example usage:
* ```kotlin
* commandLine {
* // get current command line text
* read {
* // executed under read lock
* text
* }
* }
* ```
*
* @param block The code block to execute with command line scope
*/
fun commandLine(block: CommandLineScope.() -> Unit)
/**
* Provides access to Vim's options functionality.
*
* Example usage:
* ```kotlin
* // Get option value
* val history = option { get<Int>("history") }
*
* // Set option value and return result
* val wasSet = option {
* set("number", true)
* true
* }
*
* // Multiple operations
* option {
* set("ignorecase", true)
* append("virtualedit", "block")
* }
* ```
*
* @param block The code block to execute within the option scope
* @return The result of the block execution
*/
fun <T> option(block: OptionScope.() -> T): T
/**
* Provides access to Vim's digraph functionality.
*
* Example usage:
* ```kotlin
* digraph {
* // Add a new digraph
* add("a:", 'ä')
* }
* ```
*
* @param block The code block to execute within the digraph scope
*/
fun digraph(block: DigraphScope.() -> Unit)
/**
* Gets the number of tabs in the current window.
*/
val tabCount: Int
/**
* The index of the current tab or null if there is no tab selected or no tabs are open
*/
val currentTabIndex: Int?
/**
* Removes a tab at the specified index and selects another tab.
*
* @param indexToDelete The index of the tab to delete
* @param indexToSelect The index of the tab to select after deletion
*/
fun removeTabAt(indexToDelete: Int, indexToSelect: Int)
/**
* Moves the current tab to the specified index.
*
* @param index The index to move the current tab to
* @throws IllegalStateException if there is no tab selected or no tabs are open
*/
fun moveCurrentTabToIndex(index: Int)
/**
* Closes all tabs except the current one.
*
* @throws IllegalStateException if there is no tab selected
*/
fun closeAllExceptCurrentTab()
/**
* Checks if a pattern matches a text.
*
* @param pattern The regular expression pattern to match
* @param text The text to check against the pattern
* @param ignoreCase Whether to ignore case when matching
* @return True if the pattern matches the text, false otherwise
*/
fun matches(pattern: String, text: String, ignoreCase: Boolean = false): Boolean
/**
* Finds all matches of a pattern in a text.
*
* @param text The text to search in
* @param pattern The regular expression pattern to search for
* @return A list of pairs representing the start and end offsets of each match
*/
fun getAllMatches(text: String, pattern: String): List<Pair<Int, Int>>
/**
* Selects the next window in the editor.
*/
fun selectNextWindow()
/**
* Selects the previous window in the editor.
*/
fun selectPreviousWindow()
/**
* Selects a window by its index.
*
* @param index The index of the window to select (1-based).
*/
fun selectWindow(index: Int)
/**
* Splits the current window vertically and optionally opens a file in the new window.
*
* @param filePath Path of the file to open in the new window. If null, the new window will show the same file.
*/
fun splitWindowVertically(filePath: Path? = null)
/**
* Splits the current window horizontally and optionally opens a file in the new window.
*
* @param filePath Path of the file to open in the new window. If null, the new window will show the same file.
*/
fun splitWindowHorizontally(filePath: Path? = null)
/**
* Closes all windows except the current one.
*/
fun closeAllExceptCurrentWindow()
/**
* Closes the current window.
*/
fun closeCurrentWindow()
/**
* Closes all windows in the editor.
*/
fun closeAllWindows()
/**
* Parses and executes the given Vimscript string.
*
* @param script The Vimscript string to execute
* @return The result of the execution, which can be Success or Error
*/
fun execute(script: String): Boolean
/**
* Registers a new Vim command.
*
* Example usage:
* ```
* command("MyCommand") { cmd ->
* println("Command executed: $cmd")
* }
* ```
*
* @param command The name of the command to register, as entered by the user.
* @param block The logic to execute when the command is invoked. Receives the command name
* entered by the user as a parameter.
*/
fun command(command: String, block: VimApi.(String) -> Unit)
/**
* Gets keyed data from a Vim window.
*
* @param key The key to retrieve data for
* @return The data associated with the key, or null if no data is found
*/
fun <T> getDataFromWindow(key: String): T?
/**
* Stores keyed user data in a Vim window.
*
* @param key The key to store data for
* @param data The data to store
*/
fun <T> putDataToWindow(key: String, data: T)
/**
* Gets data from buffer.
*
* @param key The key to retrieve data for
* @return The data associated with the key, or null if no data is found
*/
fun <T> getDataFromBuffer(key: String): T?
/**
* Puts data to buffer.
*
* @param key The key to store data for
* @param data The data to store
*/
fun <T> putDataToBuffer(key: String, data: T)
/**
* Gets data from tab (group of windows).
*
* @param key The key to retrieve data for
* @return The data associated with the key, or null if no data is found
*/
fun <T> getDataFromTab(key: String): T?
/**
* Puts data to tab (group of windows).
*
* @param key The key to store data for
* @param data The data to store
*/
fun <T> putDataToTab(key: String, data: T)
/**
* Gets data from window or puts it if it doesn't exist.
*
* @param key The key to retrieve or store data for
* @param provider A function that provides the data if it doesn't exist
* @return The existing data or the newly created data
*/
fun <T> getOrPutWindowData(key: String, provider: () -> T): T =
getDataFromWindow(key) ?: provider().also { putDataToWindow(key, it) }
/**
* Gets data from buffer or puts it if it doesn't exist.
*
* @param key The key to retrieve or store data for
* @param provider A function that provides the data if it doesn't exist
* @return The existing data or the newly created data
*/
fun <T> getOrPutBufferData(key: String, provider: () -> T): T =
getDataFromBuffer(key) ?: provider().also { putDataToBuffer(key, it) }
/**
* Gets data from tab or puts it if it doesn't exist.
*
* @param key The key to retrieve or store data for
* @param provider A function that provides the data if it doesn't exist
* @return The existing data or the newly created data
*/
fun <T> getOrPutTabData(key: String, provider: () -> T): T =
getDataFromTab(key) ?: provider().also { putDataToTab(key, it) }
/**
* Saves the current file.
*/
fun saveFile()
/**
* Closes the current file.
*/
fun closeFile()
/**
* Finds the start offset of the next word in camel case or snake case text.
*
* @param chars The character sequence to search in (e.g., document text)
* @param startIndex The index to start searching from (inclusive). Must be within the bounds of chars: [0, chars.length)
* @param count Find the [count]-th occurrence. Must be greater than 0.
* @return The offset of the next word start, or null if not found
*/
fun getNextCamelStartOffset(chars: CharSequence, startIndex: Int, count: Int = 1): Int?
/**
* Finds the start offset of the previous word in camel case or snake case text.
*
* @param chars The character sequence to search in (e.g., document text)
* @param endIndex The index to start searching backward from (exclusive). Must be within the bounds of chars: [0, chars.length]
* @param count Find the [count]-th occurrence. Must be greater than 0.
* @return The offset of the previous word start, or null if not found
*/
fun getPreviousCamelStartOffset(chars: CharSequence, endIndex: Int, count: Int = 1): Int?
/**
* Finds the end offset of the next word in camel case or snake case text.
*
* @param chars The character sequence to search in (e.g., document text)
* @param startIndex The index to start searching from (inclusive). Must be within the bounds of chars: [0, chars.length)
* @param count Find the [count]-th occurrence. Must be greater than 0.
* @return The offset of the next word end, or null if not found
*/
fun getNextCamelEndOffset(chars: CharSequence, startIndex: Int, count: Int = 1): Int?
/**
* Finds the end offset of the previous word in camel case or snake case text.
*
* @param chars The character sequence to search in (e.g., document text)
* @param endIndex The index to start searching backward from (exclusive). Must be within the bounds of chars: [0, chars.length]
* @param count Find the [count]-th occurrence. Must be greater than 0.
* @return The offset of the previous word end, or null if not found
*/
fun getPreviousCamelEndOffset(chars: CharSequence, endIndex: Int, count: Int = 1): Int?
}
/**
* Sets a variable with the specified name and value.
*
* In Vim, this is equivalent to `let varname = value`.
*
* Example usage:
* ```
* setVariable<Int>("g:my_var", 42)
* ```
*
* @param name The name of the variable, optionally prefixed with a scope (g:, b:, etc.)
* @param value The value to set
*/
inline fun <reified T : Any> VimApi.setVariable(name: String, value: T) {
val kType: KType = typeOf<T>()
setVariable(name, value, kType)
}
/**
* Retrieves a variable of the specified type and name.
*
* Example usage:
* ```
* val value: String? = getVariable<String>("myVariable")
* ```
*
* @param name The name of the variable to retrieve.
* @return The variable of type `T` if found, otherwise `null`.
*/
inline fun <reified T : Any> VimApi.getVariable(name: String): T? {
val kType: KType = typeOf<T>()
return getVariable(name, kType)
}

View File

@@ -0,0 +1,18 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api
/**
* Annotation used to describe a Vim plugin.
*
* @property name Specifies the name of the plugin.
*/
@Target(AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class VimPlugin(val name: String)

View File

@@ -0,0 +1,70 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.models
/**
* Represents the type of text selection in Vim.
*/
enum class TextType {
/**
* Character-wise selection, where text is selected character by character.
*/
CHARACTER_WISE,
/**
* Line-wise selection, where text is selected line by line.
*/
LINE_WISE,
/**
* Block-wise selection, where text is selected in a rectangular block.
*/
BLOCK_WISE,
}
/**
* Represents a line of text in the editor.
*
* @property number The line number (0-based or 1-based depending on context).
* @property text The content of the line.
* @property start The offset of the first character in the line.
* @property end The offset after the last character in the line.
*/
data class Line(val number: Int, val text: String, val start: Int, val end: Int)
/**
* Represents a caret with its associated information.
* A pair of [CaretId] and [CaretInfo].
*/
typealias CaretData = Pair<CaretId, CaretInfo>
/**
* A unique identifier for a caret in the editor.
*
* @property id The string representation of the caret identifier.
*/
@JvmInline
value class CaretId(val id: String)
/**
* Contains information about a caret's position and selection.
*
* @property offset The current offset (position) of the caret in the document.
* @property selection The selection range as a pair of start and end offsets, or null if no selection.
*/
data class CaretInfo(
val offset: Int,
val selection: Pair<Int, Int>?,
)
/**
* Represents an identifier for a highlight in the editor.
* Used for tracking and managing highlights applied to text.
*/
interface HighlightId

View File

@@ -0,0 +1,55 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.models
/**
* Represents a color in RGBA format.
*
* @property hexCode The string representation of the color in hex format (#RRGGBB or #RRGGBBAA).
*/
data class Color(
val hexCode: String,
) {
/**
* Creates a color from individual RGB(A) components.
*
* @param r Red component (0-255).
* @param g Green component (0-255).
* @param b Blue component (0-255).
* @param a Alpha component (0-255), defaults to 255 (fully opaque).
*/
constructor(r: Int, g: Int, b: Int, a: Int = 255) : this(String.format("#%02x%02x%02x%02x", r, g, b, a))
/**
* The red component of the color (0-255).
*/
val r: Int = hexCode.substring(1..2).toInt(16)
/**
* The green component of the color (0-255).
*/
val g: Int = hexCode.substring(3..4).toInt(16)
/**
* The blue component of the color (0-255).
*/
val b: Int = hexCode.substring(5..6).toInt(16)
/**
* The alpha component of the color (0-255).
* Defaults to 255 (fully opaque) if not specified in the hex code.
*/
val a: Int = if (hexCode.length == 9) hexCode.substring(7..8).toInt(16) else 255
init {
require(hexCode.matches(Regex("^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"))) {
"Hex code should be in format #RRGGBB[AA]"
}
}
}

View File

@@ -0,0 +1,31 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.models
import org.jetbrains.annotations.Range
/**
* Represents a Vim jump location.
*/
data class Jump(
/**
* The 0-based line number of the jump.
*/
val line: @Range(from = 0, to = Int.MAX_VALUE.toLong()) Int,
/**
* The 0-based column number of the jump.
*/
val col: @Range(from = 0, to = Int.MAX_VALUE.toLong()) Int,
/**
* The file path where the jump is located.
*/
val filepath: Path,
)

View File

@@ -0,0 +1,36 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.models
import org.jetbrains.annotations.Range
/**
* Represents a Vim mark.
*/
data class Mark(
/**
* The character key of the mark (a-z for local marks, A-Z for global marks).
*/
val key: Char,
/**
* The 0-based line number of the mark.
*/
val line: @Range(from = 0, to = Int.MAX_VALUE.toLong()) Int,
/**
* The 0-based column number of the mark.
*/
val col: @Range(from = 0, to = Int.MAX_VALUE.toLong()) Int,
/**
* The file path where the mark is located.
*/
val filePath: Path,
)

View File

@@ -0,0 +1,140 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.models
/**
* Represents a Vim editor mode.
*/
enum class Mode {
/**
* Normal mode - the default mode where commands and motions can be executed.
*/
NORMAL,
/**
* Operator-pending mode - entered after an operator command is given but before a motion is provided.
*/
OP_PENDING,
/**
* Operator-pending mode with forced characterwise operation.
*/
OP_PENDING_CHARACTERWISE,
/**
* Operator-pending mode with forced linewise operation.
*/
OP_PENDING_LINEWISE,
/**
* Operator-pending mode with forced blockwise operation.
*/
OP_PENDING_BLOCKWISE,
/**
* Normal mode using i_CTRL-O in Insert-mode.
*/
NORMAL_FROM_INSERT,
/**
* Normal mode using i_CTRL-O in Replace-mode.
*/
NORMAL_FROM_REPLACE,
/**
* Normal mode using i_CTRL-O in Virtual-Replace-mode.
*/
NORMAL_FROM_VIRTUAL_REPLACE,
/**
* Visual mode with character-wise selection.
*/
VISUAL_CHARACTER,
/**
* Visual mode with character-wise selection using v_CTRL-O in Select mode.
*/
VISUAL_CHARACTER_FROM_SELECT,
/**
* Visual mode with line-wise selection.
*/
VISUAL_LINE,
/**
* Visual mode with line-wise selection using v_CTRL-O in Select mode.
*/
VISUAL_LINE_FROM_SELECT,
/**
* Visual mode with block-wise selection.
*/
VISUAL_BLOCK,
/**
* Visual mode with block-wise selection using v_CTRL-O in Select mode.
*/
VISUAL_BLOCK_FROM_SELECT,
/**
* Select mode with character-wise selection.
*/
SELECT_CHARACTER,
/**
* Select mode with line-wise selection.
*/
SELECT_LINE,
/**
* Select mode with block-wise selection.
*/
SELECT_BLOCK,
/**
* Insert mode - used for inserting text.
*/
INSERT,
/**
* Replace mode - used for replacing existing text.
*/
REPLACE,
/**
* Command-line mode - used for entering Ex commands.
*/
COMMAND_LINE;
/**
* Returns the TextType associated with this mode, if applicable.
* Only visual and select modes have a TextType.
*/
val selectionType: TextType?
get() = when (this) {
VISUAL_CHARACTER, VISUAL_CHARACTER_FROM_SELECT, SELECT_CHARACTER -> TextType.CHARACTER_WISE
VISUAL_LINE, VISUAL_LINE_FROM_SELECT, SELECT_LINE -> TextType.LINE_WISE
VISUAL_BLOCK, VISUAL_BLOCK_FROM_SELECT, SELECT_BLOCK -> TextType.BLOCK_WISE
else -> null
}
/**
* Returns true if this mode is a visual mode.
*/
val isVisual: Boolean
get() = this == VISUAL_CHARACTER || this == VISUAL_LINE || this == VISUAL_BLOCK ||
this == VISUAL_CHARACTER_FROM_SELECT || this == VISUAL_LINE_FROM_SELECT || this == VISUAL_BLOCK_FROM_SELECT
/**
* Returns true if this mode is a select mode.
*/
val isSelect: Boolean
get() = this == SELECT_CHARACTER || this == SELECT_LINE || this == SELECT_BLOCK
}

View File

@@ -0,0 +1,26 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.models
/**
* Represents a path.
*/
interface Path {
/**
* The protocol part of the path.
*/
val protocol: String
/**
* The segments of the path as an array of strings.
*/
val path: Array<String>
companion object
}

View File

@@ -0,0 +1,42 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.models
/**
* Represents a range of text in the editor.
* Can be either a simple linear range or a block (rectangular) range.
*/
sealed interface Range {
/**
* Represents a simple linear range of text from start to end offset.
*
* @property start The starting offset of the range.
* @property end The ending offset of the range (exclusive).
*/
data class Simple(val start: Int, val end: Int) : Range
/**
* Represents a block (rectangular) selection consisting of multiple simple ranges.
* Each simple range typically represents a line segment in the block selection.
*
* @property ranges An array of simple ranges that make up the block selection.
*/
data class Block(val ranges: Array<Simple>) : Range {
override fun equals(other: Any?): Boolean {
if (this === other) return true
if (javaClass != other?.javaClass) return false
other as Block
return ranges.contentEquals(other.ranges)
}
override fun hashCode(): Int {
return ranges.contentHashCode()
}
}
}

View File

@@ -0,0 +1,39 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes
/**
* Scope for functions that provide working with digraphs.
*/
@VimApiDsl
interface DigraphScope {
/**
* Gets the character for a digraph.
*
* In Vim, this is equivalent to entering CTRL-K followed by the two characters in insert mode.
* Example: CTRL-K a: produces 'ä'
*
* @param ch1 The first character of the digraph
* @param ch2 The second character of the digraph
* @return The Unicode codepoint of the character represented by the digraph, or the codepoint of ch2 if no digraph is found
*/
fun getCharacter(ch1: Char, ch2: Char): Int
/**
* Adds a custom digraph.
*
* In Vim, this is equivalent to the `:digraph` command with arguments.
* Example: `:digraph a: 228` adds a digraph where 'a:' produces 'ä'
*
* @param ch1 The first character of the digraph
* @param ch2 The second character of the digraph
* @param codepoint The Unicode codepoint of the character to associate with the digraph
*/
fun add(ch1: Char, ch2: Char, codepoint: Int)
}

View File

@@ -0,0 +1,189 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes
import com.intellij.vim.api.VimApi
import com.intellij.vim.api.models.CaretId
import com.intellij.vim.api.models.Mode
import com.intellij.vim.api.models.Range
/**
* Scope that provides access to various listeners.
*/
@VimApiDsl
interface ListenersScope {
/**
* Registers a callback that is invoked when the editor mode changes.
*
* The callback receives the previous mode as a parameter.
*
* Example:
* ```kotlin
* listeners {
* onModeChange { oldMode ->
* if (mode == Mode.INSERT) {
* // Do something when entering INSERT mode
* }
* }
* }
* ```
*
* @param callback The function to execute when the mode changes
*/
fun onModeChange(callback: suspend VimApi.(Mode) -> Unit)
/**
* Registers a callback that is invoked when text is yanked.
*
* The callback receives a map of caret IDs to the yanked text ranges.
*
* Example:
* ```kotlin
* listeners {
* onYank { caretRangeMap ->
* // Process yanked text ranges
* caretRangeMap.forEach { (caretId, range) ->
* // Highlight or process the yanked range
* }
* }
* }
* ```
*
* @param callback The function to execute when text is yanked
*/
fun onYank(callback: suspend VimApi.(Map<CaretId, Range.Simple>) -> Unit)
/**
* Registers a callback that is invoked when a new editor is created.
*
* Example:
* ```kotlin
* listeners {
* onEditorCreate {
* // Initialize resources for the new editor
* }
* }
* ```
*
* @param callback The function to execute when an editor is created
*/
fun onEditorCreate(callback: suspend VimApi.() -> Unit)
/**
* Registers a callback that is invoked when an editor is released.
*
* Example:
* ```kotlin
* listeners {
* onEditorRelease {
* // Clean up resources associated with the editor
* }
* }
* ```
*
* @param callback The function to execute when an editor is released
*/
fun onEditorRelease(callback: suspend VimApi.() -> Unit)
/**
* Registers a callback that is invoked when an editor gains focus.
*
* Example:
* ```kotlin
* listeners {
* onEditorFocusGain {
* // Perform actions when editor gains focus
* }
* }
* ```
*
* @param callback The function to execute when an editor gains focus
*/
fun onEditorFocusGain(callback: suspend VimApi.() -> Unit)
/**
* Registers a callback that is invoked when an editor loses focus.
*
* Example:
* ```kotlin
* listeners {
* onEditorFocusLost {
* // Perform actions when editor loses focus
* }
* }
* ```
*
* @param callback The function to execute when an editor loses focus
*/
fun onEditorFocusLost(callback: suspend VimApi.() -> Unit)
/**
* Registers a callback that is invoked when macro recording starts.
*
* Example:
* ```kotlin
* listeners {
* onMacroRecordingStart {
* // Perform actions when macro recording begins
* }
* }
* ```
*
* @param callback The function to execute when macro recording starts
*/
fun onMacroRecordingStart(callback: suspend VimApi.() -> Unit)
/**
* Registers a callback that is invoked when macro recording finishes.
*
* Example:
* ```kotlin
* listeners {
* onMacroRecordingFinish {
* // Perform actions when macro recording ends
* }
* }
* ```
*
* @param callback The function to execute when macro recording finishes
*/
fun onMacroRecordingFinish(callback: suspend VimApi.() -> Unit)
/**
* Registers a callback that is invoked when IdeaVim is enabled.
*
* Example usage:
* ```kotlin
* listeners {
* onIdeaVimEnabled {
* // Initialize plugin resources when IdeaVim is enabled
* }
* }
* ```
*
* @param callback The function to execute when IdeaVim is enabled
*/
fun onIdeaVimEnabled(callback: suspend VimApi.() -> Unit)
/**
* Registers a callback that is invoked when IdeaVim is disabled.
*
* Example usage:
* ```kotlin
* listeners {
* onIdeaVimDisabled {
* // Clean up plugin resources when IdeaVim is disabled
* }
* }
* ```
*
* @param callback The function to execute when IdeaVim is disabled
*/
fun onIdeaVimDisabled(callback: suspend VimApi.() -> Unit)
}

View File

@@ -0,0 +1,516 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes
import com.intellij.vim.api.VimApi
/**
* Scope that provides access to mappings.
*/
@VimApiDsl
interface MappingScope {
/**
* Maps a [from] key sequence to [to] in normal mode.
*/
fun nmap(from: String, to: String)
/**
* Removes a [keys] mapping in normal mode.
*
* The [keys] must fully match the 'from' keys of the original mapping.
*
* Example:
* ```kotlin
* nmap("abc", "def") // Create mapping
* nunmap("a") // × Does not unmap anything
* nunmap("abc") // ✓ Properly unmaps the mapping
* ```
*/
fun nunmap(keys: String)
/**
* Maps a [from] key sequence to [to] in visual mode.
*/
fun vmap(from: String, to: String)
/**
* Removes a [keys] mapping in visual mode.
*
* The [keys] must fully match the 'from' keys of the original mapping.
*
* Example:
* ```kotlin
* vmap("abc", "def") // Create mapping
* vunmap("a") // × Does not unmap anything
* vunmap("abc") // ✓ Properly unmaps the mapping
* ```
*/
fun vunmap(keys: String)
/**
* Maps a [from] key sequence to an [action] in normal mode.
*/
fun nmap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps a [from] key sequence to an [action] in visual mode.
*/
fun vmap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in normal mode.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun nmap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps [keys] to an [action] with an [actionName] in visual mode.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun vmap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in all modes.
*/
fun map(from: String, to: String)
/**
* Removes a [keys] mapping in all modes.
*
* The [keys] must fully match the 'from' keys of the original mapping.
*
* Example:
* ```kotlin
* map("abc", "def") // Create mapping
* unmap("a") // × Does not unmap anything
* unmap("abc") // ✓ Properly unmaps the mapping
* ```
*/
fun unmap(keys: String)
/**
* Maps a [from] key sequence to an [action] in all modes.
*/
fun map(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in all modes.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun map(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in visual exclusive mode.
*/
fun xmap(from: String, to: String)
/**
* Removes a [keys] mapping in visual exclusive mode.
*
* The [keys] must fully match the 'from' keys of the original mapping.
*
* Example:
* ```kotlin
* xmap("abc", "def") // Create mapping
* xunmap("a") // × Does not unmap anything
* xunmap("abc") // ✓ Properly unmaps the mapping
* ```
*/
fun xunmap(keys: String)
/**
* Maps a [from] key sequence to an [action] in visual exclusive mode.
*/
fun xmap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in visual exclusive mode.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun xmap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in select mode.
*/
fun smap(from: String, to: String)
/**
* Removes a [keys] mapping in select mode.
*
* The [keys] must fully match the 'from' keys of the original mapping.
*
* Example:
* ```kotlin
* smap("abc", "def") // Create mapping
* sunmap("a") // × Does not unmap anything
* sunmap("abc") // ✓ Properly unmaps the mapping
* ```
*/
fun sunmap(keys: String)
/**
* Maps a [from] key sequence to an [action] in select mode.
*/
fun smap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in select mode.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun smap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in operator pending mode.
*/
fun omap(from: String, to: String)
/**
* Removes a [keys] mapping in operator pending mode.
*
* The [keys] must fully match the 'from' keys of the original mapping.
*
* Example:
* ```kotlin
* omap("abc", "def") // Create mapping
* ounmap("a") // × Does not unmap anything
* ounmap("abc") // ✓ Properly unmaps the mapping
* ```
*/
fun ounmap(keys: String)
/**
* Maps a [from] key sequence to an [action] in operator pending mode.
*/
fun omap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in operator pending mode.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun omap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in insert mode.
*/
fun imap(from: String, to: String)
/**
* Removes a [keys] mapping in insert mode.
*
* The [keys] must fully match the 'from' keys of the original mapping.
*
* Example:
* ```kotlin
* imap("abc", "def") // Create mapping
* iunmap("a") // × Does not unmap anything
* iunmap("abc") // ✓ Properly unmaps the mapping
* ```
*/
fun iunmap(keys: String)
/**
* Maps a [from] key sequence to an [action] in insert mode.
*/
fun imap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in insert mode.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun imap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in command line mode.
*/
fun cmap(from: String, to: String)
/**
* Removes a [keys] mapping in command line mode.
*
* The [keys] must fully match the 'from' keys of the original mapping.
*
* Example:
* ```kotlin
* cmap("abc", "def") // Create mapping
* cunmap("a") // × Does not unmap anything
* cunmap("abc") // ✓ Properly unmaps the mapping
* ```
*/
fun cunmap(keys: String)
/**
* Maps a [from] key sequence to an [action] in command line mode.
*/
fun cmap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in command line mode.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun cmap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in normal mode non-recursively.
*/
fun nnoremap(from: String, to: String)
/**
* Maps a [from] key sequence to an [action] in normal mode non-recursively.
*/
fun nnoremap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in normal mode non-recursively.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun nnoremap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in visual mode non-recursively.
*/
fun vnoremap(from: String, to: String)
/**
* Maps a [from] key sequence to an [action] in visual mode non-recursively.
*/
fun vnoremap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in visual mode non-recursively.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun vnoremap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in all modes non-recursively.
*/
fun noremap(from: String, to: String)
/**
* Maps a [from] key sequence to an [action] in all modes non-recursively.
*/
fun noremap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in all modes non-recursively.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun noremap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in visual exclusive mode non-recursively.
*/
fun xnoremap(from: String, to: String)
/**
* Maps a [from] key sequence to an [action] in visual exclusive mode non-recursively.
*/
fun xnoremap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in visual exclusive mode non-recursively.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun xnoremap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in select mode non-recursively.
*/
fun snoremap(from: String, to: String)
/**
* Maps a [from] key sequence to an [action] in select mode non-recursively.
*/
fun snoremap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in select mode non-recursively.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun snoremap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in operator pending mode non-recursively.
*/
fun onoremap(from: String, to: String)
/**
* Maps a [from] key sequence to an [action] in operator pending mode non-recursively.
*/
fun onoremap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in operator pending mode non-recursively.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun onoremap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in insert mode non-recursively.
*/
fun inoremap(from: String, to: String)
/**
* Maps a [from] key sequence to an [action] in insert mode non-recursively.
*/
fun inoremap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in insert mode non-recursively.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun inoremap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
/**
* Maps a [from] key sequence to [to] in command line mode non-recursively.
*/
fun cnoremap(from: String, to: String)
/**
* Maps a key sequence in command line mode to an action non-recursively.
*
* @param from The key sequence to map from
* @param action The action to execute when the key sequence is pressed
*/
fun cnoremap(from: String, action: suspend VimApi.() -> Unit)
/**
* Maps [keys] to an [action] with an [actionName] in command line mode non-recursively.
*
* [actionName] is needed to provide an intermediate mapping from the [keys] to [action].
* Two mappings will be created: from [keys] to [actionName] and from [actionName] to [action].
* In this way, the user will be able to rewrite the default mapping to the plugin by
* providing a custom mapping to [actionName].
*/
fun cnoremap(
keys: String,
actionName: String,
action: suspend VimApi.() -> Unit,
)
}

View File

@@ -0,0 +1,171 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes
import com.intellij.vim.api.VimApi
/**
* Scope for working with modal input in IdeaVim.
*
* This scope provides methods for creating and managing modal input dialogs,
* which can be used to get user input in a Vim-like way.
*
* The ModalInput interface supports:
* - Single character input with [inputChar]
* - String input with [inputString]
* - Repeating input operations with [repeat] and [repeatWhile]
* - Updating the input prompt with [updateLabel]
* - Closing the current input dialog with [closeCurrentInput]
*/
@VimApiDsl
interface ModalInput {
/**
* Updates the label of the modal input dialog during input processing.
*
* This method allows you to dynamically modify the label shown to the user based on the current state.
*
* Example usage:
* ```kotlin
* modalInput()
* .updateLabel { currentLabel ->
* "$currentLabel - Updated"
* }
* .inputChar("Enter character:") { char ->
* // Process the character
* }
* ```
*
* @param block A function that takes the current label and returns a new label
* @return This ModalInput instance for method chaining
*/
fun updateLabel(block: (String) -> String): ModalInput
/**
* Repeats the input operation as long as the specified condition is true.
*
* This method allows you to collect multiple inputs from the user until a certain condition is met.
* The condition is evaluated before each input operation.
*
* Example usage:
* ```kotlin
* var inputCount = 0
*
* modalInput()
* .repeatWhile {
* inputCount < 3 // Continue until we've received 3 inputs
* }
* .inputChar("Enter character:") { char ->
* inputCount++
* // Process the character
* }
* ```
*
* @param condition A function that returns true if the input operation should be repeated
* @return This ModalInput instance for method chaining
*/
fun repeatWhile(condition: () -> Boolean): ModalInput
/**
* Repeats the input operation a specified number of times.
*
* This method allows you to collect a fixed number of inputs from the user.
*
* Example usage:
* ```kotlin
* modalInput()
* .repeat(3) // Get 3 characters from the user
* .inputChar("Enter character:") { char ->
* // Process each character as it's entered
* // This handler will be called 3 times
* }
* ```
*
* @param count The number of times to repeat the input operation
* @return This ModalInput instance for method chaining
*/
fun repeat(count: Int): ModalInput
/**
* Creates a modal input dialog for collecting a string from the user.
*
* This method displays a dialog with the specified label and waits for the user to enter text.
* The handler is executed after the user presses ENTER, receiving the entered string as a parameter.
*
* Example usage:
* ```kotlin
* modalInput()
* .inputString("Enter string:") { enteredString ->
* // Process the entered string
* println("User entered: $enteredString")
* }
* ```
*
* This can be combined with other methods:
*
* ```kotlin
* vimApi.modalInput()
* .repeat(2) // Get two strings from the user
* .inputString("Enter value:") { value ->
* // Process each string as it's entered
* }
* ```
*
* @param label The label to display in the dialog
* @param handler A function that will be called when the user enters input and presses ENTER
*/
fun inputString(label: String, handler: VimApi.(String) -> Unit)
/**
* Creates a modal input dialog for collecting a single character from the user.
*
* This method displays a dialog with the specified label and waits for the user to press a key.
* The handler is executed immediately after the user presses any key, receiving the entered character as a parameter.
* Unlike [inputString], this method doesn't require the user to press ENTER.
*
* Example usage:
* ```kotlin
* vimApi.modalInput()
* .inputChar("Press a key:") { char ->
* // Process the entered character
* when(char) {
* 'y', 'Y' -> println("You confirmed")
* 'n', 'N' -> println("You declined")
* else -> println("Invalid option")
* }
* }
* ```
*
* This can be combined with other methods:
*
* ```kotlin
* vimApi.modalInput()
* .repeatWhile { /* condition */ }
* .inputChar("Enter character:") { char ->
* // Process each character as it's entered
* }
* ```
*
* @param label The label to display in the dialog
* @param handler A function that will be called when the user enters a character
*/
fun inputChar(label: String, handler: VimApi.(Char) -> Unit)
/**
* Closes the current modal input dialog, if one is active.
*
* Example usage:
* ```kotlin
* modalInput().closeCurrentInput(refocusEditor = false)
* ```
*
* @param refocusEditor Whether to refocus the editor after closing the dialog (default: true)
* @return True if a dialog was closed, false if there was no active dialog
*/
fun closeCurrentInput(refocusEditor: Boolean = true): Boolean
}

View File

@@ -0,0 +1,244 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes
import kotlin.reflect.KType
import kotlin.reflect.typeOf
/**
* Scope that provides functions for working with options.
*/
@VimApiDsl
interface OptionScope {
/**
* Gets the value of an option with the specified type.
*
* **Note:** Prefer using the extension function `get<T>(name)` instead of calling this directly,
* as it provides better type safety and cleaner syntax through reified type parameters.
*
* Example of preferred usage:
* ```kotlin
* myVimApi.option {
* val ignoreCase = get<Boolean>("ignorecase")
* val history = get<Int>("history")
* val clipboard = get<String>("clipboard")
* }
* ```
*
* @param name The name of the option
* @param type The KType of the option value
* @return The value of the option
* @throws IllegalArgumentException if the type is wrong or the option doesn't exist
*/
fun <T> getOptionValue(name: String, type: KType): T
/**
* Sets an option value with the specified scope.
*
* **Note:** Prefer using the extension functions `set<T>(name, value)`, `setGlobal<T>(name, value)`,
* or `setLocal<T>(name, value)` instead of calling this directly, as they provide better type safety
* and cleaner syntax through reified type parameters.
*
* Example of preferred usage:
* ```kotlin
* myVimApi.option {
* set("ignorecase", true) // Effective scope
* setGlobal("number", 42) // Global scope
* setLocal("tabstop", 4) // Local scope
* }
* ```
*
* @param name The name of the option
* @param value The value to set
* @param type The KType of the option value
* @param scope The scope to set the option in ("global", "local", or "effective")
* @throws IllegalArgumentException if the option doesn't exist or the type is wrong
*/
fun <T> setOption(name: String, value: T, type: KType, scope: String)
/**
* Resets an option to its default value.
*
* In Vim, this is equivalent to `:set option&`.
* Example: `:set ignorecase&` resets the 'ignorecase' option to its default value.
*
* @param name The name of the option
*
* @throws IllegalArgumentException if the option doesn't exist
*/
fun reset(name: String)
/**
* Extension function to split a comma-separated option value into a list.
* This is useful for processing list options like virtualedit, whichwrap, etc.
*
* Example:
* ```kotlin
* myVimApi.option {
* val values = get<String>("virtualedit")?.split() ?: emptyList()
* // "block,all" → ["block", "all"]
* // "" → [""]
* // "all" → ["all"]
* }
* ```
*/
fun String.split(): List<String> = split(",")
}
/**
* Gets the value of an option with the specified type.
*
* In Vim, options can be accessed with the `&` prefix.
* Example: `&ignorecase` returns the value of the 'ignorecase' option.
*
* @param name The name of the option
* @return The value of the option
* @throws IllegalArgumentException if the type is wrong or the option doesn't exist
*/
inline fun <reified T> OptionScope.get(name: String): T {
val kType: KType = typeOf<T>()
return getOptionValue(name, kType)
}
/**
* Sets the global value of an option with the specified type.
*
* In Vim, this is equivalent to `:setglobal option=value`.
* Example: `:setglobal ignorecase` or `let &g:ignorecase = 1`
*
* @param name The name of the option
* @param value The value to set
*
* @throws IllegalArgumentException if the option doesn't exist or the type is wrong
*/
inline fun <reified T> OptionScope.setGlobal(name: String, value: T) {
val kType: KType = typeOf<T>()
setOption(name, value, kType, "global")
}
/**
* Sets the local value of an option with the specified type.
*
* In Vim, this is equivalent to `:setlocal option=value`.
* Example: `:setlocal ignorecase` or `let &l:ignorecase = 1`
*
* @param name The name of the option
* @param value The value to set
*
* @throws IllegalArgumentException if the option doesn't exist or the type is wrong
*/
inline fun <reified T> OptionScope.setLocal(name: String, value: T) {
val kType: KType = typeOf<T>()
setOption(name, value, kType, "local")
}
/**
* Sets the effective value of an option with the specified type.
*
* In Vim, this is equivalent to `:set option=value`.
* Example: `:set ignorecase` or `let &ignorecase = 1`
*
* @param name The name of the option
* @param value The value to set
*
* @throws IllegalArgumentException if the option doesn't exist or the type is wrong
*/
inline fun <reified T> OptionScope.set(name: String, value: T) {
val kType: KType = typeOf<T>()
setOption(name, value, kType, "effective")
}
/**
* Toggles a boolean option value.
*
* Example:
* ```kotlin
* myVimApi.option {
* toggle("ignorecase") // true → false, false → true
* }
* ```
*
* @param name The name of the boolean option to toggle
*/
fun OptionScope.toggle(name: String) {
val current = get<Boolean>(name)
set(name, !current)
}
/**
* Appends values to a comma-separated list option.
* This is equivalent to Vim's += operator for string options.
* Duplicate values are not added.
*
* Example:
* ```kotlin
* myVimApi.option {
* append("virtualedit", "block") // "" → "block"
* append("virtualedit", "onemore") // "block" → "block,onemore"
* append("virtualedit", "block") // "block,onemore" → "block,onemore" (no change)
* }
* ```
*
* @param name The name of the list option
* @param values The values to append (duplicates will be ignored)
*/
fun OptionScope.append(name: String, vararg values: String) {
val current = get<String>(name)
val currentList = if (current.isEmpty()) emptyList() else current.split()
val valuesToAdd = values.filterNot { it in currentList }
val newList = currentList + valuesToAdd
set(name, newList.joinToString(","))
}
/**
* Prepends values to a comma-separated list option.
* This is equivalent to Vim's ^= operator for string options.
* Duplicate values are not added.
*
* Example:
* ```kotlin
* myVimApi.option {
* prepend("virtualedit", "block") // "all" → "block,all"
* prepend("virtualedit", "onemore") // "block,all" → "onemore,block,all"
* prepend("virtualedit", "all") // "onemore,block,all" → "onemore,block,all" (no change)
* }
* ```
*
* @param name The name of the list option
* @param values The values to prepend (duplicates will be ignored)
*/
fun OptionScope.prepend(name: String, vararg values: String) {
val current = get<String>(name)
val currentList = if (current.isEmpty()) emptyList() else current.split()
val valuesToAdd = values.filterNot { it in currentList }
val newList = valuesToAdd + currentList
set(name, newList.joinToString(","))
}
/**
* Removes values from a comma-separated list option.
* This is equivalent to Vim's -= operator for string options.
*
* Example:
* ```kotlin
* myVimApi.option {
* remove("virtualedit", "block") // "block,all" → "all"
* remove("virtualedit", "all") // "all" → ""
* }
* ```
*
* @param name The name of the list option
* @param values The values to remove
*/
fun OptionScope.remove(name: String, vararg values: String) {
val current = get<String>(name)
val currentList = if (current.isEmpty()) emptyList() else current.split()
val newList = currentList.filterNot { it in values }
set(name, newList.joinToString(","))
}

View File

@@ -0,0 +1,60 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes
/**
* Scope that provides functions for interacting with the Vim output panel.
*/
@VimApiDsl
interface OutputPanelScope {
/**
* The text displayed in the output panel.
*/
val text: String
/**
* The label text displayed at the bottom of the output panel.
*
* This is used for status information like "-- MORE --" to indicate
* that there is more content to scroll through.
*/
val label: String
/**
* Sets the text content of the output panel.
*
* This replaces any existing text in the panel with the provided text.
*
* @param text The new text to display in the output panel.
*/
fun setText(text: String)
/**
* Appends text to the existing content of the output panel.
*
* @param text The text to append to the current content.
* @param startNewLine Whether to start the appended text on a new line.
* If true and there is an existing text, a newline character
* will be inserted before the appended text.
* Defaults to false.
*/
fun appendText(text: String, startNewLine: Boolean = false)
/**
* Sets the label text at the bottom of the output panel.
*
* @param label The new label text to display.
*/
fun setLabel(label: String)
/**
* Clears all text from the output panel.
*/
fun clearText()
}

View File

@@ -0,0 +1,13 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes
@Target(AnnotationTarget.CLASS, AnnotationTarget.TYPE)
@DslMarker
internal annotation class VimApiDsl

View File

@@ -0,0 +1,32 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes.commandline
import com.intellij.vim.api.scopes.VimApiDsl
/**
* Scope for command line functions that should be executed under read lock.
*/
@VimApiDsl
interface CommandLineRead {
/**
* The text currently displayed in the command line.
*/
val text: String
/**
* The current position of the caret in the command line.
*/
val caretPosition: Int
/**
* True if the command line is currently active, false otherwise.
*/
val isActive: Boolean
}

View File

@@ -0,0 +1,80 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes.commandline
import com.intellij.vim.api.VimApi
import com.intellij.vim.api.scopes.VimApiDsl
import kotlin.contracts.ExperimentalContracts
import kotlin.contracts.InvocationKind
import kotlin.contracts.contract
/**
* Scope for interacting with the Vim command line.
*/
@VimApiDsl
abstract class CommandLineScope {
/**
* Reads input from the command line and processes it with the provided function.
*
* @param prompt The prompt to display at the beginning of the command line.
* @param finishOn The character that, when entered, will finish the input process. If null, only Enter will finish.
* @param callback A function that will be called with the entered text when input is complete.
*/
abstract fun input(prompt: String, finishOn: Char? = null, callback: VimApi.(String) -> Unit)
/**
* Executes operations on the command line that require a read lock.
*
* Example usage:
* ```kotlin
* commandLine {
* read {
* text
* }
* }
* ```
*
* @param block A function with CommandLineRead receiver that contains the read operations to perform.
* @return A Deferred that will complete with the result of the block execution.
*/
@OptIn(ExperimentalContracts::class)
fun <T> read(block: CommandLineRead.() -> T): T {
contract {
callsInPlace(block, InvocationKind.EXACTLY_ONCE)
}
return this.ideRead(block)
}
/**
* Executes operations that require write lock on the command line.
*
* Example usage:
* ```kotlin
* // Set command line text
* commandLineScope {
* change {
* setText("Hello")
* }
* }
* ```
*
* @param block A function with CommandLineTransaction receiver that contains the write operations to perform.
* @return A Job that represents the ongoing execution of the block.
*/
@OptIn(ExperimentalContracts::class)
fun change(block: CommandLineTransaction.() -> Unit) {
contract {
callsInPlace(block, InvocationKind.EXACTLY_ONCE)
}
ideChange(block)
}
protected abstract fun <T> ideRead(block: CommandLineRead.() -> T): T
protected abstract fun ideChange(block: CommandLineTransaction.() -> Unit)
}

View File

@@ -0,0 +1,47 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes.commandline
import com.intellij.vim.api.scopes.VimApiDsl
/**
* Scope for command line functions that should be executed under write lock.
*/
@VimApiDsl
interface CommandLineTransaction {
/**
* Sets the text content of the command line. It replaces any existing text in the command line with the provided text.
*
* @param text The new text to display in the command line.
*/
suspend fun setText(text: String)
/**
* Inserts text at the specified position in the command line.
*
* @param offset The position at which to insert the text.
* @param text The text to insert.
*/
suspend fun insertText(offset: Int, text: String)
/**
* Sets the caret position in the command line.
*
* @param position The new position for the caret.
*/
suspend fun setCaretPosition(position: Int)
/**
* Closes the command line.
*
* @param refocusEditor Whether to refocus the editor after closing the command line.
* @return True if the command line was closed, false if it was not active.
*/
suspend fun close(refocusEditor: Boolean = true): Boolean
}

View File

@@ -0,0 +1,328 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes.editor
import com.intellij.vim.api.models.CaretData
import com.intellij.vim.api.models.CaretId
import com.intellij.vim.api.models.Jump
import com.intellij.vim.api.models.Line
import com.intellij.vim.api.models.Mark
import com.intellij.vim.api.models.Path
import com.intellij.vim.api.models.Range
import com.intellij.vim.api.scopes.VimApiDsl
/**
* Interface giving functions to access the editor state. Does not imply read or write locks.
*/
@VimApiDsl
interface EditorAccessor {
/**
* The total length of the text in the editor.
*/
val textLength: Long
/**
* The entire text content of the editor.
*/
val text: CharSequence
/**
* The total number of lines in the editor.
*/
val lineCount: Int
/**
* File path of the editor.
*/
val filePath: Path
/**
* Gets the start offset of the specified line.
*
* @param line The line number (0-based)
* @return The offset of the first character in the line
*/
fun getLineStartOffset(line: Int): Int
/**
* Gets the end offset of the specified line.
*
* @param line The line number (0-based)
* @param allowEnd Whether to allow the end of the document as a valid result
* @return The offset after the last character in the line
*/
fun getLineEndOffset(line: Int, allowEnd: Boolean): Int
/**
* Gets information about the line containing the specified offset.
*
* @param offset The offset in the document
* @return A Line object containing information about the line
*/
fun getLine(offset: Int): Line
/**
* A list of data for all carets in the editor.
*
* Each element in the list is a CaretData object containing information about a caret,
* such as its position, selection, and other properties.
*/
val caretData: List<CaretData>
/**
* A list of IDs for all carets in the editor.
*
* These IDs can be used with the `with` function to perform operations on specific carets.
*/
val caretIds: List<CaretId>
/**
* Gets a global mark by its character key.
*
* @param char The character key of the mark (A-Z)
* @return The mark, or null if the mark doesn't exist
*/
fun getGlobalMark(char: Char): Mark?
/**
* All global marks.
*/
val globalMarks: Set<Mark>
/**
* Gets a jump from the jump list.
*
* @param count The number of jumps to go back (negative) or forward (positive) from the current position in the jump list.
* @return The jump, or null if there is no jump at the specified position
*/
fun getJump(count: Int = 0): Jump?
/**
* Gets all jumps in the jump list.
*
* @return A list of all jumps
*/
val jumps: List<Jump>
/**
* Index of the current position in the jump list.
*
* This is used to determine which jump will be used when navigating with Ctrl-O and Ctrl-I.
*/
val currentJumpIndex: Int
/**
* Scrolls the caret into view.
*
* This ensures that the caret is visible in the editor window.
*/
fun scrollCaretIntoView()
/**
* Scrolls the editor by a specified number of lines.
*
* @param lines The number of lines to scroll. Positive values scroll down, negative values scroll up.
* @return True if the scroll was successful, false otherwise
*/
fun scrollVertically(lines: Int): Boolean
/**
* Scrolls the current line to the top of the display.
*
* @param line The line number to scroll to (1-based). If 0, uses the current line.
* @param start Whether to position the caret at the start of the line
* @return True if the scroll was successful, false otherwise
*/
fun scrollLineToTop(line: Int, start: Boolean): Boolean
/**
* Scrolls the current line to the middle of the display.
*
* @param line The line number to scroll to (1-based). If 0, uses the current line.
* @param start Whether to position the caret at the start of the line
* @return True if the scroll was successful, false otherwise
*/
fun scrollLineToMiddle(line: Int, start: Boolean): Boolean
/**
* Scrolls the current line to the bottom of the display.
*
* @param line The line number to scroll to (1-based). If 0, uses the current line.
* @param start Whether to position the caret at the start of the line
* @return True if the scroll was successful, false otherwise
*/
fun scrollLineToBottom(line: Int, start: Boolean): Boolean
/**
* Scrolls the editor horizontally by a specified number of columns.
*
* @param columns The number of columns to scroll. Positive values scroll right, negative values scroll left.
* @return True if the scroll was successful, false otherwise
*/
fun scrollHorizontally(columns: Int): Boolean
/**
* Scrolls the editor to position the caret column at the left edge of the display.
*
* @return True if the scroll was successful, false otherwise
*/
fun scrollCaretToLeftEdge(): Boolean
/**
* Scrolls the editor to position the caret column at the right edge of the display.
*
* @return True if the scroll was successful, false otherwise
*/
fun scrollCaretToRightEdge(): Boolean
/**
* Find the next paragraph-bound offset in the editor.
*
* @param startLine Line to start the search from.
* @param count Search for the [count]-th occurrence.
* @param includeWhitespaceLines Should be `true` if we consider lines with whitespaces as empty.
* @return next paragraph off
*/
fun getNextParagraphBoundOffset(startLine: Int, count: Int = 1, includeWhitespaceLines: Boolean = true): Int?
/**
* Finds the next sentence start in the editor from the given offset, based on the specified parameters.
*
* @param count Search for the [count]-th occurrence.
* @param includeCurrent If `true`, includes the current sentence if at its boundary.
* @param requireAll If `true`, returns `null` if fewer than [count] sentences are found.
* @return The offset of the next sentence start, or `null` if not found or constraints cannot be met.
*/
fun getNextSentenceStart(
startOffset: Int,
count: Int = 1,
includeCurrent: Boolean,
requireAll: Boolean = true,
): Int?
/**
* Find the next section in the editor.
*
* @param startLine The line to start searching from.
* @param marker The type of section to find.
* @param count Search for the [count]-th occurrence.
* @return The offset of the next section.
*/
fun getNextSectionStart(startLine: Int, marker: Char, count: Int = 1): Int
/**
* Find the start of the previous section in the editor.
*
* @param startLine The line to start searching from.
* @param marker The type of section to find.
* @param count Search for the [count]-th occurrence.
* @return The offset of the next section.
*/
fun getPreviousSectionStart(startLine: Int, marker: Char, count: Int = 1): Int
/**
* Find the next sentence end from the given offset.
*
* @param startOffset The offset to start searching from
* @param count Search for the [count]-th occurrence.
* @param includeCurrent Whether to count the current position as a sentence end
* @param requireAll Whether to require all sentence ends to be found
* @return The offset of the next sentence end, or null if not found
*/
fun getNextSentenceEnd(
startOffset: Int,
count: Int = 1,
includeCurrent: Boolean,
requireAll: Boolean = true,
): Int?
/**
* Find the next word in the editor's document, from the given starting point
*
* @param startOffset The offset in the document to search from
* @param count Search for the [count]-th occurrence. If negative, search backwards.
* @param isBigWord Use WORD instead of word boundaries.
* @return The offset of the [count]-th next word, or `null` if not found.
*/
fun getNextWordStartOffset(startOffset: Int, count: Int = 1, isBigWord: Boolean = false): Int?
/**
* Find the end offset of the next word in the editor's document, from the given starting point
*
* @param startOffset The offset in the document to search from
* @param count Return an offset to the [count] word from the starting position. Will search backwards if negative
* @param isBigWord Use WORD instead of word boundaries
* @return The offset of the [count] next word/WORD. Will return document bounds if not found
*/
fun getNextWordEndOffset(startOffset: Int, count: Int = 1, isBigWord: Boolean = false): Int
/**
* Find the next character on the current line
*
* @param startOffset The offset to start searching from
* @param count The number of occurrences to find
* @param char The character to find
* @return The offset of the next character, or -1 if not found
*/
fun getNextCharOnLineOffset(startOffset: Int, count: Int = 1, char: Char): Int
/**
* Find the word or WORD at or following the given offset
*
* Note that if there is no current or following word, the next WORD will be returned. If a WORD is requested, this is
* obviously a no-op.
*
* @param startOffset The offset to search from
* @return The range of the word, or null if not found
*/
fun getWordAtOrFollowingOffset(startOffset: Int, isBigWord: Boolean): Range?
/**
* Returns range of a paragraph containing the given line.
*
* @param line line to start the search from
* @param count search for the count paragraphs forward
* @param isOuter true if it is an outer motion, false otherwise
* @return the paragraph text range
*/
fun getParagraphRange(line: Int, count: Int = 1, isOuter: Boolean): Range?
/**
* Find a block quote in the current line
*
* @param startOffset The offset to start searching from
* @param quote The quote character to find
* @param isOuter Whether to include the quotes in the range
* @return The range of the block quote, or null if not found
*/
fun getBlockQuoteInLineRange(startOffset: Int, quote: Char, isOuter: Boolean): Range?
/**
* Finds all occurrences of the given pattern within a specified line range.
*
* @param pattern The Vim-style regex pattern to search for.
* @param startLine The line number to start searching from (0-based). Must be within the range [0, lineCount-1].
* @param endLine The line number to end searching at (0-based), or -1 for the whole document.
* If specified, must be within the range [startLine, lineCount-1].
* @param ignoreCase If true, performs case-insensitive search; if false, performs case-sensitive search.
* @return A list of Ranges representing all matches found. Empty list if no matches are found.
*/
fun findAll(pattern: String, startLine: Int, endLine: Int, ignoreCase: Boolean = false): List<Range>
/**
* Finds text matching the given Vim-style regular expression pattern.
*
* @param pattern The Vim-style regex pattern to search for.
* @param startOffset The offset to start searching from. Must be within the range [0, document.length].
* @param count Find the [count]-th occurrence of the pattern.
* @param backwards If true, search backward from the start offset; if false, search forward.
* @return A Range representing the matched text, or null if no match is found.
*/
fun findPattern(pattern: String, startOffset: Int, count: Int = 1, backwards: Boolean = false): Range?
}

View File

@@ -0,0 +1,82 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes.editor
import com.intellij.vim.api.scopes.VimApiDsl
import kotlin.contracts.ExperimentalContracts
import kotlin.contracts.InvocationKind
import kotlin.contracts.contract
/**
* Scope that provides access to editor functions.
*/
@VimApiDsl
abstract class EditorScope {
/**
* Executes a read-only operation on the editor.
*
* This function provides access to read-only operations through the [EditorAccessor] interface.
* It runs the provided block under a read lock to ensure thread safety when accessing editor state.
* The operation is executed asynchronously and returns a [kotlinx.coroutines.Deferred] that can be awaited for the result.
*
* Example usage:
* ```
* editor {
* val text = read {
* text // Access the editor's text content
* }.await()
* }
* ```
*
* @param block A suspending lambda with [EditorAccessor] receiver that contains the read operations to perform
* @return A [kotlinx.coroutines.Deferred] that completes with the result of the block execution
*/
@OptIn(ExperimentalContracts::class)
fun <T> read(block: ReadScope.() -> T): T {
contract {
callsInPlace(block, InvocationKind.EXACTLY_ONCE)
}
return this.ideRead(block)
}
/**
* Executes a write operation that modifies the editor's state.
*
* This function provides access to write operations through the [Transaction] interface.
* It runs the provided block under a write lock to ensure thread safety when modifying editor state.
* The operation is executed asynchronously and returns a [kotlinx.coroutines.Job] that can be joined to wait for completion.
*
* Example usage:
* ```
* editor {
* val job = change {
* // Modify editor content
* replaceText(startOffset, endOffset, newText)
*
* // Add highlights
* val highlightId = addHighlight(startOffset, endOffset, backgroundColor, foregroundColor)
* }
* job.join() // Wait for the changes to complete
* }
* ```
*
* @param block A suspending lambda with [Transaction] receiver that contains the write operations to perform
* @return A [kotlinx.coroutines.Job] that completes when all write operations are finished
*/
@OptIn(ExperimentalContracts::class)
fun change(block: Transaction.() -> Unit) {
contract {
callsInPlace(block, InvocationKind.EXACTLY_ONCE)
}
return ideChange(block)
}
protected abstract fun <T> ideRead(block: ReadScope.() -> T): T
protected abstract fun ideChange(block: Transaction.() -> Unit)
}

View File

@@ -0,0 +1,81 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes.editor
import com.intellij.vim.api.models.CaretId
import com.intellij.vim.api.scopes.VimApiDsl
import com.intellij.vim.api.scopes.editor.caret.CaretRead
/**
* Interface that provides functions that open CaretRead scope.
*/
@VimApiDsl
interface ReadScope : EditorAccessor {
/**
* Executes the provided block for each caret in the editor and returns a list of results.
*
* This function allows you to perform operations on all carets in the editor in a single call.
* The block is executed with each caret as the receiver, and the results are collected into a list.
*
* Example usage:
* ```kotlin
* editor {
* val caretOffsets = forEachCaret {
* offset // Get the offset of each caret
* }
* // caretOffsets is a List<Int> containing the offset of each caret
* }
* ```
*
* @param block The block to execute for each caret
* @return A list containing the results of executing the block for each caret
*/
fun <T> forEachCaret(block: CaretRead.() -> T): List<T>
/**
* Executes the provided block with a specific caret as the receiver.
*
* This function allows you to perform operations on a specific caret identified by its ID.
*
* Example usage:
* ```kotlin
* editor {
* with(caretId) {
* // Perform operations on the specific caret
* val caretOffset = offset
* val caretLine = line
* }
* }
* ```
*
* @param caretId The ID of the caret to use
* @param block The block to execute with the specified caret as the receiver
*/
fun <T> with(caretId: CaretId, block: CaretRead.() -> T): T
/**
* Executes the provided block with the primary caret as the receiver.
*
* This function allows you to perform operations on the primary caret in the editor.
*
* Example usage:
* ```kotlin
* editor {
* withPrimaryCaret {
* // Perform operations on the primary caret
* val primaryCaretOffset = offset
* val primaryCaretLine = line
* }
* }
* ```
*
* @param block The block to execute with the primary caret as the receiver
*/
fun <T> withPrimaryCaret(block: CaretRead.() -> T): T
}

View File

@@ -0,0 +1,198 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes.editor
import com.intellij.vim.api.models.CaretId
import com.intellij.vim.api.models.Color
import com.intellij.vim.api.models.HighlightId
import com.intellij.vim.api.models.Jump
import com.intellij.vim.api.scopes.VimApiDsl
import com.intellij.vim.api.scopes.editor.caret.CaretTransaction
/**
* Scope for editor functions that should be executed under write lock.
*/
@VimApiDsl
interface Transaction : EditorAccessor {
/**
* Executes the provided block for each caret in the editor and returns a list of results.
*
* Example usage:
* ```kotlin
* editor {
* change {
* forEachCaret {
* // Perform operations on each caret
* }
* }
* }
* ```
*
* @param block The block to execute for each caret
* @return A list containing the results of executing the block for each caret
*/
fun <T> forEachCaret(block: CaretTransaction.() -> T): List<T>
/**
* Executes the provided block with a specific caret as the receiver.
*
* This function allows you to perform write operations on a specific caret identified by its ID.
*
* Example usage:
* ```kotlin
* editor {
* change {
* val caretId = caretIds.first() // Get the ID of the first caret
* with(caretId) {
* // Perform operations on the specific caret
* deleteText(offset, offset + 5)
* updateCaret(newOffset)
* }
* }
* }
* ```
*
* @param caretId The ID of the caret to use
* @param block The block to execute with the specified caret as the receiver
*/
fun <T> with(caretId: CaretId, block: CaretTransaction.() -> T): T
/**
* Executes the provided block with the primary caret as the receiver.
*
* This function allows you to perform write operations on the primary caret in the editor.
*
* Example usage:
* ```kotlin
* editor {
* change {
* withPrimaryCaret {
* // Perform operations on the primary caret
* deleteText(offset, offset + 5)
* updateCaret(newOffset)
* }
* }
* }
* ```
*
* @param block The block to execute with the primary caret as the receiver
*/
fun <T> withPrimaryCaret(block: CaretTransaction.() -> T): T
/**
* Adds a new caret at the specified offset in the editor.
*
* @param offset The offset at which to add the caret
* @return The ID of the newly created caret if successful, null otherwise
* @throws IllegalArgumentException if offset is not in valid range `[0, fileLength - 1]`
*/
fun addCaret(offset: Int): CaretId?
/**
* Removes a caret from the editor.
*
* @param caretId The ID of the caret to remove
* @throws IllegalArgumentException if caret with [caretId] is not found
*/
fun removeCaret(caretId: CaretId)
/**
* Adds a highlight to the editor.
*
* @param startOffset The start offset of the highlight
* @param endOffset The end offset of the highlight
* @param backgroundColor The background color of the highlight, or null for no background color
* @param foregroundColor The foreground color of the highlight, or null for no foreground color
* @return The ID of the newly created highlight
*/
fun addHighlight(
startOffset: Int,
endOffset: Int,
backgroundColor: Color?,
foregroundColor: Color?,
): HighlightId
/**
* Removes a highlight from the editor.
*
* @param highlightId The ID of the highlight to remove
*/
fun removeHighlight(highlightId: HighlightId)
/**
* Sets a mark at the current position for each caret in the editor.
*
* @param char The character key of the mark (a-z, A-Z, etc.)
* @return True if the mark was successfully set, false otherwise
*/
fun setMark(char: Char): Boolean
/**
* Removes a mark for all carets in the editor.
*
* @param char The character key of the mark to remove (a-z, A-Z, etc.)
*/
fun removeMark(char: Char)
/**
* Sets a global mark at the current position.
*
* @param char The character key of the mark (A-Z)
* @return True if the mark was successfully set, false otherwise
*/
fun setGlobalMark(char: Char): Boolean
/**
* Removes a global mark.
*
* @param char The character key of the mark to remove (A-Z)
*/
fun removeGlobalMark(char: Char)
/**
* Sets a global mark at the specified offset.
*
* @param char The character key of the mark (A-Z)
* @param offset The offset to set the mark to
* @return True if the mark was successfully set, false otherwise
*/
fun setGlobalMark(char: Char, offset: Int): Boolean
/**
* Resets all marks.
*
* This removes all marks, both global and local.
*/
fun resetAllMarks()
/**
* Adds a specific jump to the jump list.
*
* @param jump The jump to add
* @param reset Whether to reset the current position in the jump list
*/
fun addJump(jump: Jump, reset: Boolean = false)
/**
* Removes a jump from the jump list.
*
* @param jump The jump to remove
*/
fun removeJump(jump: Jump)
/**
* Removes the last jump from the jump list.
*/
fun dropLastJump()
/**
* Clears all jumps from the jump list.
*/
fun clearJumps()
}

View File

@@ -0,0 +1,371 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes.editor.caret
import com.intellij.vim.api.models.CaretId
import com.intellij.vim.api.models.Line
import com.intellij.vim.api.models.Mark
import com.intellij.vim.api.models.Range
import com.intellij.vim.api.models.TextType
import com.intellij.vim.api.scopes.VimApiDsl
/**
* Scope for caret operations that should be executed under the read lock.
*/
@VimApiDsl
interface CaretRead {
/**
* The unique identifier for this caret.
*/
val caretId: CaretId
/**
* The current offset (position) of the caret in the document.
*/
val offset: Int
/**
* The current selection range of the caret.
*/
val selection: Range
/**
* Information about the current line where the caret is positioned.
*/
val line: Line
/**
* The last register that was selected for operations.
*
* Example: After using `"ay` to yank into register 'a', this would return 'a'.
* In VimScript, variable `v:register` contains this value.
*/
val lastSelectedReg: Char
/**
* The default register used when no register is explicitly specified.
*
* In Vim, this is typically the unnamed register (").
*/
val defaultRegister: Char
/**
* Indicates whether the current register was explicitly specified by the user.
*
* Example: After `"ay`, this would be true; after just `y`, this would be false.
*/
val isRegisterSpecifiedExplicitly: Boolean
/**
* Selects a register for subsequent operations.
*
* Example: In Vim, pressing `"a` before an operation selects register 'a'.
*
* @param register The register to select
* @return True if the register was successfully selected, false otherwise
*/
fun selectRegister(register: Char): Boolean
/**
* Resets all registers to their default state.
*/
fun resetRegisters()
/**
* Checks if a register is writable.
*
* Some registers in Vim are read-only. Examples of read-only registers:
* - ':' (last executed command)
* - '.' (last inserted text)
* - '/' (last search pattern)
*
* @param register The register to check
* @return True if the register is writable, false otherwise
*/
fun isWritable(register: Char): Boolean
/**
* Checks if a register is connected to the system clipboard.
*
* In Vim, registers '+' and '*' are connected to the system clipboard.
* Example: Using `"+y` yanks text to the system clipboard.
*
* @param register The register to check
* @return True if the register is connected to the system clipboard, false otherwise
*/
fun isSystemClipboard(register: Char): Boolean
/**
* Checks if the primary selection register is supported.
*
* Example: On Linux, using `"*y` yanks text to the primary selection.
*
* @return True if the primary selection register is supported, false otherwise
*/
fun isPrimaryRegisterSupported(): Boolean
/**
* The marks for the current visual selection.
*
* In Vim, these are the '< and '> marks.
* Example: After making a visual selection and then pressing ESC, `'<` and `'>` mark the beginning and end.
* In VimScript `getpos("'<")` and `getpos("'>")` are used to get these marks.
*/
val selectionMarks: Range?
/**
* The marks for the last change.
*
* In Vim, these are the '[ and '] marks.
* Example: After a change operation like `cw`, these marks indicate the changed region.
* In VimScript, `getpos("'[")` and `getpos("']")` are used to get these marks.
*/
val changeMarks: Range?
/**
* Gets the text content of a register.
*
* Example: In Vim, `:echo @a` shows the content of register 'a'.
* In VimScript `getreg('a')` is used to get the content of register 'a'.
*
* @param register The register to get text from
* @return The text content of the register, or null if the register is empty or doesn't exist
*/
fun getReg(register: Char): String?
/**
* Gets the type of text stored in a register (character-wise, line-wise, or block-wise).
*
* In VimScript, `getregtype('a')` is used to get the type of register 'a'.
*
* @param register The register to get the type from
* @return The type of text in the register, or null if the register is empty or doesn't exist
*/
fun getRegType(register: Char): TextType?
/**
* Sets the text content and type of a register.
*
* In VimScript, `setreg('a', 'text', 'c')` is used to set register 'a' to "text" with character-wise type.
*
* @param register The register to set
* @param text The text to store in the register
* @param textType The type of text (character-wise, line-wise, or block-wise)
* @return True if the register was successfully set, false otherwise
*/
fun setReg(register: Char, text: String, textType: TextType = TextType.CHARACTER_WISE): Boolean
/**
* Gets a mark by its character key for the current caret.
*
* @param char The character key of the mark (a-z, 0-9, etc.)
* @return The mark, or null if the mark doesn't exist
*/
fun getMark(char: Char): Mark?
/**
* All local marks for the current caret.
*/
val localMarks: Set<Mark>
/**
* Sets a mark at the current caret position.
*
* @param char The character key of the mark (a-z, etc.)
* @return True if the mark was successfully set, false otherwise
*/
fun setMark(char: Char): Boolean
/**
* Sets a mark at the specified offset.
*
* @param char The character key of the mark (a-z, etc.)
* @param offset The offset to set the mark to
* @return True if the mark was successfully set, false otherwise
*/
fun setMark(char: Char, offset: Int): Boolean
/**
* Removes a local mark for the current caret.
*
* @param char The character key of the mark to remove (a-z, etc.)
*/
fun removeLocalMark(char: Char)
/**
* Resets all marks for the current caret.
*/
fun resetAllMarksForCaret()
/**
* Scrolls a full page up or down.
*
* @param pages The number of pages to scroll. Positive values scroll down, negative values scroll up.
* @return True if the scroll was successful, false otherwise
*/
fun scrollFullPage(pages: Int): Boolean
/**
* Scrolls half a page up.
*
* @param lines The number of lines to scroll.
* @return True if the scroll was successful, false otherwise
*/
fun scrollHalfPageUp(lines: Int): Boolean
/**
* Scrolls half a page up.
*
* @param lines The number of lines to scroll.
* @return True if the scroll was successful, false otherwise
*/
fun scrollHalfPageDown(lines: Int): Boolean
/**
* Selects a window in the same row as the current window.
*
* @param relativePosition The relative position of the window to select.
* Positive values select windows to the right,
* negative values select windows to the left.
*/
fun selectWindowHorizontally(relativePosition: Int)
/**
* Selects a window in the same column as the current window.
*
* @param relativePosition The relative position of the window to select.
* Positive values select the windows below,
* negative values select the windows above.
*/
fun selectWindowInVertically(relativePosition: Int)
/**
* Finds the offset of the next paragraph boundary.
*
* @param count Search for the [count]-th occurrence.
* @param includeWhitespaceLines Should be `true` if we consider lines with whitespaces as empty.
* @return next paragraph off
*/
fun getNextParagraphBoundOffset(count: Int = 1, includeWhitespaceLines: Boolean = true): Int?
/**
* Finds the next sentence start in the editor from the given offset, based on the specified parameters.
*
* @param count Search for the [count]-th occurrence.
* @param includeCurrent If `true`, includes the current sentence if at its boundary.
* @param requireAll If `true`, returns `null` if fewer than [count] sentences are found.
* @return The offset of the next sentence start, or `null` if not found or constraints cannot be met.
*/
fun getNextSentenceStart(count: Int = 1, includeCurrent: Boolean, requireAll: Boolean = true): Int?
/**
* Find the next section in the editor.
*
* @param marker The type of section to find.
* @param count Search for the [count]-th occurrence.
* @return The offset of the next section.
*/
fun getNextSectionStart(marker: Char, count: Int = 1): Int
/**
* Find the start of the previous section in the editor.
*
* @param marker The type of section to find.
* @param count Search for the [count]-th occurrence.
* @return The offset of the next section.
*/
fun getPreviousSectionStart(marker: Char, count: Int = 1): Int
/**
* Finds the end offset of the next sentence from the current caret position.
*
* @param count Search for the [count]-th occurrence.
* @param includeCurrent Whether to count the current position as a sentence end
* @param requireAll Whether to require all sentence ends to be found
* @return The offset of the next sentence end, or null if not found
*/
fun getNextSentenceEnd(count: Int = 1, includeCurrent: Boolean, requireAll: Boolean = true): Int?
/**
* Finds the end offset of the next method from the current caret position.
*
* @param count Search for the [count]-th occurrence.
* @return The offset of the end of the next method.
*/
fun getMethodEndOffset(count: Int = 1): Int
/**
* Finds the start offset of the next method from the current caret position.
*
* @param count Search for the [count]-th occurrence.
* @return The offset of the start of the next method.
*/
fun getMethodStartOffset(count: Int = 1): Int
/**
* Finds the next occurrence of a specific character on the current line.
*
* @param count Search for the [count]-th occurrence.
* @param char The character to find.
* @return The offset of the found character, or -1 if not found.
*/
fun getNextCharOnLineOffset(count: Int = 1, char: Char): Int
/**
* Finds the word at or following the current caret position.
*
* Note that if no word/WORD is found at or following the caret on the current line, the WORD at or following is
* always returned.
*
* @param isBigWord Search for word or WORD.
* @return A Range representing the found word, or null if no word is found.
*/
fun getCurrentOrFollowingWord(isBigWord: Boolean): Range?
/**
* Find the range of the word text object at the location of the caret
*/
fun getWordTextObjectRange(count: Int = 1, isOuter: Boolean, isBigWord: Boolean): Range
/**
* Find the range of the sentence text object at the location of the caret
*/
fun getSentenceRange(count: Int = 1, isOuter: Boolean): Range
/**
* Returns range of a paragraph containing the caret
*
* @param count Search for the [count]-th occurrence.
* @param isOuter true if it is an outer motion, false otherwise
* @return the paragraph text range
*/
fun getParagraphRange(count: Int = 1, isOuter: Boolean): Range?
/**
* Find the range of a block tag at the location of the caret
*/
fun getBlockTagRange(count: Int = 1, isOuter: Boolean): Range?
/**
* Find a block quote in the current line at the location of the caret
*
* @param quote The quote character to find
* @param isOuter Whether to include the quotes in the range
* @return The range of the block quote, or null if not found
*/
fun getBlockQuoteInLineRange(quote: Char, isOuter: Boolean): Range?
/**
* Finds the offset of the next misspelled word from the current caret position.
*
* @param count Search for the [count]-th occurrence.
* @return The offset of the next misspelled word.
*/
fun getNextMisspelledWordOffset(count: Int = 1): Int
}

View File

@@ -0,0 +1,121 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.intellij.vim.api.scopes.editor.caret
import com.intellij.vim.api.models.Range
import com.intellij.vim.api.scopes.VimApiDsl
import com.intellij.vim.api.scopes.editor.EditorAccessor
/**
* Scope for caret operations that should be executed under the write lock.
*/
@VimApiDsl
interface CaretTransaction : CaretRead, EditorAccessor {
/**
* Updates the caret position and optionally sets a selection.
*
* If a selection is provided, the caret will have this selection after moving to the new offset.
* If no selection is provided, any existing selection will be removed.
*
* The selection range is exclusive, meaning that the character at the end offset is not
* included in the selection. For example, a selection of (0, 3) would select the first
* three characters of the text.
*
* @param offset The new offset (position) for the caret
* @param selection Optional selection range
* @throws IllegalArgumentException If the offset is not in the valid range [0, fileSize),
* or if the selection range is invalid (start or end out of range,
* or start > end)
*/
fun updateCaret(offset: Int, selection: Range.Simple? = null)
/**
* Inserts text at the specified position in the document.
*
* @param position The position (offset) where the text should be inserted
* (a zero-base character offset from the start of the document)
* @param text The text to insert
* @param caretAtEnd If true (default), places the caret after on the last character of the inserted text;
* if false, places the caret at the beginning of the inserted text
* @param insertBeforeCaret If true, inserts the text before the specified position;
* if false (default), inserts the text at the specified position
* @return true if the insertion was successful, false otherwise
* @throws IllegalArgumentException If the position is not in the valid range [0, fileSize)
*/
fun insertText(
position: Int,
text: String,
caretAtEnd: Boolean = true,
insertBeforeCaret: Boolean = false,
): Boolean
/**
* Replaces the text between startOffset (inclusive) and endOffset (exclusive)
* with the specified text. After the operation, the caret is positioned before the last
* character of the replaced text.
*
* @param startOffset The start offset (inclusive) of the text to be replaced
* @param endOffset The end offset (exclusive) of the text to be replaced
* @param text The new text to replace the existing text
* @return true if the replacement was successful, false otherwise
* @throws IllegalArgumentException If the offsets are not in the valid range [0, fileSize),
* or if startOffset > endOffset
*/
fun replaceText(
startOffset: Int,
endOffset: Int,
text: String,
): Boolean
/**
* Replaces text in multiple ranges (blocks) with new text.
*
* This function performs a blockwise replacement, replacing each range in the block
* with the corresponding string from the text list. The number of replacement strings
* must match the number of ranges in the block.
*
* @param range A block of ranges to be replaced
* @param text A list of strings to replace each range in the block
* @throws IllegalArgumentException If the size of the text list doesn't match the number of ranges in the block,
* or if any range in the block is invalid
*/
fun replaceTextBlockwise(
range: Range.Block,
text: List<String>,
)
/**
* Deletes text between the specified offsets.
*
* This function deletes the text between startOffset (inclusive) and endOffset (exclusive).
* If startOffset equals endOffset, no text is deleted.
* If startOffset > endOffset, the implementation swaps them and deletes the text between them.
*
* @param startOffset The start offset (inclusive) of the text to be deleted
* @param endOffset The end offset (exclusive) of the text to be deleted
* @return true if the deletion was successful, false otherwise
* @throws Exception If endOffset is beyond the file size
*/
fun deleteText(
startOffset: Int,
endOffset: Int,
): Boolean
/**
* Adds a jump with the current caret's position to the jump list.
*
* @param reset Whether to reset the current position in the jump list
*/
fun addJump(reset: Boolean)
/**
* Saves the location of the current caret to the jump list and sets the ' mark.
*/
fun saveJumpLocation()
}

View File

@@ -31,12 +31,13 @@ import kotlinx.serialization.json.putJsonObject
import org.eclipse.jgit.api.Git
import org.eclipse.jgit.lib.RepositoryBuilder
import org.intellij.markdown.ast.getTextInNode
import org.intellij.markdown.ast.impl.ListCompositeNode
import org.jetbrains.changelog.Changelog
import org.jetbrains.intellij.platform.gradle.TestFrameworkType
import org.jetbrains.intellij.platform.gradle.tasks.aware.SplitModeAware
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
import org.jetbrains.kotlin.gradle.dsl.KotlinVersion
import org.kohsuke.github.GHUser
import java.net.HttpURLConnection
import java.net.URL
buildscript {
repositories {
@@ -45,19 +46,19 @@ buildscript {
}
dependencies {
classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:2.0.21")
classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:2.2.0")
classpath("com.github.AlexPl292:mark-down-to-slack:1.1.2")
classpath("org.eclipse.jgit:org.eclipse.jgit:6.6.0.202305301015-r")
// This is needed for jgit to connect to ssh
classpath("org.eclipse.jgit:org.eclipse.jgit.ssh.apache:7.1.0.202411261347-r")
classpath("org.eclipse.jgit:org.eclipse.jgit.ssh.apache:7.3.0.202506031305-r")
classpath("org.kohsuke:github-api:1.305")
classpath("io.ktor:ktor-client-core:3.1.1")
classpath("io.ktor:ktor-client-cio:3.1.1")
classpath("io.ktor:ktor-client-auth:3.1.1")
classpath("io.ktor:ktor-client-content-negotiation:3.1.1")
classpath("io.ktor:ktor-serialization-kotlinx-json:3.1.1")
classpath("io.ktor:ktor-client-core:3.3.0")
classpath("io.ktor:ktor-client-cio:3.3.0")
classpath("io.ktor:ktor-client-auth:3.3.0")
classpath("io.ktor:ktor-client-content-negotiation:3.3.0")
classpath("io.ktor:ktor-serialization-kotlinx-json:3.3.0")
// This comes from the changelog plugin
// classpath("org.jetbrains:markdown:0.3.1")
@@ -66,14 +67,19 @@ buildscript {
plugins {
java
kotlin("jvm") version "2.0.21"
kotlin("jvm") version "2.2.0"
application
id("java-test-fixtures")
id("org.jetbrains.intellij.platform") version "2.3.0"
id("org.jetbrains.changelog") version "2.2.1"
// NOTE: Unignore "test block comment falls back to line comment when not available" test
// After changing this version. It supposed to work on the next version of the gradle plugin
// Or go report to the devs that this test still fails.
id("org.jetbrains.intellij.platform") version "2.9.0"
id("org.jetbrains.changelog") version "2.4.0"
id("org.jetbrains.kotlinx.kover") version "0.6.1"
id("com.dorongold.task-tree") version "4.0.1"
id("com.google.devtools.ksp") version "2.0.21-1.0.25"
id("com.google.devtools.ksp") version "2.2.0-2.0.2"
}
val moduleSources by configurations.registering
@@ -103,21 +109,26 @@ repositories {
dependencies {
api(project(":vim-engine"))
api(project(":api"))
ksp(project(":annotation-processors"))
compileOnly(project(":annotation-processors"))
compileOnly("org.jetbrains.kotlin:kotlin-stdlib:$kotlinVersion")
compileOnly("org.jetbrains:annotations:26.0.2")
compileOnly("org.jetbrains:annotations:26.0.2-1")
intellijPlatform {
// Snapshots don't use installers
// https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html#target-versions-installers
val useInstaller = "EAP-SNAPSHOT" !in ideaVersion
var useInstaller = "EAP-SNAPSHOT" !in ideaVersion
if (ideaType == "RD") {
// Using Rider as a target IntelliJ Platform with `useInstaller = true` is currently not supported, please set `useInstaller = false` instead. See: https://github.com/JetBrains/intellij-platform-gradle-plugin/issues/1852
useInstaller = false
}
// Note that it is also possible to use local("...") to compile against a locally installed IDE
// E.g. local("/Users/{user}/Applications/IntelliJ IDEA Ultimate.app")
// Or something like: intellijIdeaUltimate(ideaVersion)
create(ideaType, ideaVersion, useInstaller)
create(ideaType, ideaVersion) { this.useInstaller = useInstaller }
pluginVerifier()
zipSigner()
@@ -127,16 +138,27 @@ dependencies {
// AceJump is an optional dependency. We use their SessionManager class to check if it's active
plugin("AceJump", "3.8.19")
plugin("com.intellij.classic.ui", "243.21565.122")
plugin("com.intellij.classic.ui", "251.23774.318")
bundledPlugins("org.jetbrains.plugins.terminal", "com.intellij.modules.json")
bundledPlugins("org.jetbrains.plugins.terminal")
// VERSION UPDATE: This module is required since 2025.2
if (ideaVersion == "LATEST-EAP-SNAPSHOT") {
bundledModule("intellij.spellchecker")
}
if (ideaVersion.startsWith("2025.2")) {
bundledModule("intellij.spellchecker")
}
if (ideaVersion.startsWith("2025.3")) {
bundledModule("intellij.spellchecker")
}
}
moduleSources(project(":vim-engine", "sourcesJarArtifacts"))
// --------- Test dependencies ----------
testApi("com.squareup.okhttp3:okhttp:4.12.0")
testApi("com.squareup.okhttp3:okhttp:5.0.0")
// https://mvnrepository.com/artifact/com.ensarsarajcic.neovim.java/neovim-api
testImplementation("com.ensarsarajcic.neovim.java:neovim-api:0.2.3")
@@ -149,19 +171,19 @@ dependencies {
testFixturesImplementation("org.jetbrains.kotlin:kotlin-test:$kotlinVersion")
// https://mvnrepository.com/artifact/org.mockito.kotlin/mockito-kotlin
testImplementation("org.mockito.kotlin:mockito-kotlin:5.4.0")
testImplementation("org.mockito.kotlin:mockito-kotlin:6.1.0")
testImplementation("org.junit.jupiter:junit-jupiter-api:5.12.0")
testImplementation("org.junit.jupiter:junit-jupiter-engine:5.12.0")
testImplementation("org.junit.jupiter:junit-jupiter-params:5.12.0")
testFixturesImplementation("org.junit.jupiter:junit-jupiter-api:5.12.0")
testFixturesImplementation("org.junit.jupiter:junit-jupiter-engine:5.12.0")
testFixturesImplementation("org.junit.jupiter:junit-jupiter-params:5.12.0")
testImplementation("org.junit.jupiter:junit-jupiter-api:6.0.0")
testImplementation("org.junit.jupiter:junit-jupiter-engine:6.0.0")
testImplementation("org.junit.jupiter:junit-jupiter-params:6.0.0")
testFixturesImplementation("org.junit.jupiter:junit-jupiter-api:6.0.0")
testFixturesImplementation("org.junit.jupiter:junit-jupiter-engine:6.0.0")
testFixturesImplementation("org.junit.jupiter:junit-jupiter-params:6.0.0")
// Temp workaround suggested in https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-faq.html#junit5-test-framework-refers-to-junit4
// Can be removed when IJPL-159134 is fixed
// testRuntimeOnly("junit:junit:4.13.2")
testImplementation("org.junit.vintage:junit-vintage-engine:5.12.0")
testImplementation("org.junit.vintage:junit-vintage-engine:6.0.0")
// testFixturesImplementation("org.junit.vintage:junit-vintage-engine:5.10.3")
}
@@ -189,12 +211,9 @@ tasks {
useJUnitPlatform()
// Set teamcity env variable locally to run additional tests for leaks.
// By default, this test runs on TC only, but this test doesn't take a lot of time,
// so we can turn it on for local development
if (environment["TEAMCITY_VERSION"] == null) {
println("Set env TEAMCITY_VERSION to X to enable project leak checks from the platform")
environment("TEAMCITY_VERSION" to "X")
}
println("Project leak checks: If you experience project leaks on TeamCity that doesn't reproduce locally")
println("Uncomment the following line in build.gradle to enable leak checks (see build.gradle config)")
// environment("TEAMCITY_VERSION" to "X")
systemProperty("ideavim.nvim.test", System.getProperty("nvim") ?: false)
@@ -214,42 +233,11 @@ tasks {
options.encoding = "UTF-8"
}
compileKotlin {
kotlinOptions {
jvmTarget = javaVersion
// See https://plugins.jetbrains.com/docs/intellij/using-kotlin.html#kotlin-standard-library
// For the list of bundled versions
apiVersion = "2.0"
freeCompilerArgs = listOf(
"-Xjvm-default=all-compatibility",
// Needed to compile the AceJump which uses kotlin beta
// Without these two option compilation fails
"-Xskip-prerelease-check",
"-Xallow-unstable-dependencies",
)
// allWarningsAsErrors = true
}
}
compileTestKotlin {
enabled = false
kotlinOptions {
jvmTarget = javaVersion
apiVersion = "2.0"
// Needed to compile the AceJump which uses kotlin beta
// Without these two option compilation fails
freeCompilerArgs += listOf("-Xskip-prerelease-check", "-Xallow-unstable-dependencies")
// allWarningsAsErrors = true
}
}
// Note that this will run the plugin installed in the IDE specified in dependencies. To run in a different IDE, use
// a custom task (see below)
runIde {
systemProperty("octopus.handler", System.getProperty("octopus.handler") ?: true)
systemProperty("idea.trust.all.projects", "true")
}
// Uncomment to run the plugin in a custom IDE, rather than the IDE specified as a compile target in dependencies
@@ -318,6 +306,23 @@ kotlin {
jvmToolchain {
languageVersion.set(JavaLanguageVersion.of(javaVersion))
}
compilerOptions {
jvmTarget.set(JvmTarget.fromTarget(javaVersion))
// See https://plugins.jetbrains.com/docs/intellij/using-kotlin.html#kotlin-standard-library
// For the list of bundled versions
apiVersion.set(KotlinVersion.KOTLIN_2_0)
freeCompilerArgs = listOf(
"-Xjvm-default=all-compatibility",
// Needed to compile the AceJump which uses kotlin beta
// Without these two option compilation fails
"-Xskip-prerelease-check",
"-Xallow-unstable-dependencies",
)
// allWarningsAsErrors = true
}
}
gradle.projectsEvaluated {
@@ -364,7 +369,7 @@ intellijPlatform {
password.set(providers.environmentVariable("PRIVATE_KEY_PASSWORD"))
}
verifyPlugin {
pluginVerification {
teamCityOutputFormat = true
ides {
recommended()
@@ -379,6 +384,7 @@ ksp {
arg("vimscript_functions_file", "intellij_vimscript_functions.json")
arg("ex_commands_file", "intellij_ex_commands.json")
arg("commands_file", "intellij_commands.json")
arg("extensions_file", "ideavim_extensions.json")
}
afterEvaluate {
@@ -409,7 +415,7 @@ koverMerged {
// --- Slack notification
tasks.register("slackNotification") {
tasks.register<Task>("slackNotification") {
doLast {
if (version.toString().last() != '0') return@doLast
if (slackUrl.isBlank()) {
@@ -437,20 +443,25 @@ tasks.register("slackNotification") {
""".trimIndent()
println("Parsed data: $slackDown")
val post = URL(slackUrl)
with(post.openConnection() as HttpURLConnection) {
requestMethod = "POST"
doOutput = true
setRequestProperty("Content-Type", "application/json")
outputStream.write(message.toByteArray())
runBlocking {
val client = HttpClient(CIO)
try {
val response = client.post(slackUrl) {
contentType(ContentType.Application.Json)
setBody(message)
}
val postRc = responseCode
println("Response code: $postRc")
if (postRc == 200) {
println(inputStream.bufferedReader().use { it.readText() })
} else {
println(errorStream.bufferedReader().use { it.readText() })
val responseCode = response.status.value
println("Response code: $responseCode")
val responseBody = response.body<String>()
println(responseBody)
} catch (e: Exception) {
println("Error sending Slack notification: ${e.message}")
throw e
} finally {
client.close()
}
}
}
@@ -465,7 +476,7 @@ tasks.register("slackNotification") {
// }
// --- Update authors
tasks.register("updateAuthors") {
tasks.register<Task>("updateAuthors") {
doLast {
val uncheckedEmails = setOf(
"aleksei.plate@jetbrains.com",
@@ -481,7 +492,7 @@ tasks.register("updateAuthors") {
val prId: String by project
tasks.register("updateMergedPr") {
tasks.register<Task>("updateMergedPr") {
doLast {
val x = changelog.getUnreleased()
println("x")
@@ -494,13 +505,13 @@ tasks.register("updateMergedPr") {
}
}
tasks.register("updateChangelog") {
tasks.register<Task>("updateChangelog") {
doLast {
updateChangelog()
}
}
tasks.register("updateYoutrackOnCommit") {
tasks.register<Task>("updateYoutrackOnCommit") {
doLast {
updateYoutrackOnCommit()
}
@@ -511,12 +522,13 @@ val fixVersionsFieldId = "123-285"
val fixVersionsFieldType = "VersionProjectCustomField"
val fixVersionsElementType = "VersionBundleElement"
tasks.register("releaseActions") {
tasks.register<Task>("releaseActions") {
group = "other"
doLast {
if (releaseType == "patch") return@doLast
val tickets = getYoutrackTicketsByQuery("%23%7BReady+To+Release%7D%20and%20tag:%20%7BIdeaVim%20Released%20In%20EAP%7D%20")
val tickets =
getYoutrackTicketsByQuery("%23%7BReady+To+Release%7D%20and%20tag:%20%7BIdeaVim%20Released%20In%20EAP%7D%20")
if (tickets.isNotEmpty()) {
println("Updating statuses for tickets: $tickets")
setYoutrackStatus(tickets, "Fixed")
@@ -534,7 +546,7 @@ tasks.register("releaseActions") {
}
}
tasks.register("integrationsTest") {
tasks.register<Task>("integrationsTest") {
group = "other"
doLast {
val testTicketId = "VIM-2784"
@@ -583,7 +595,7 @@ fun guard(check: Boolean, ifWrong: () -> String) {
}
}
tasks.register("testUpdateChangelog") {
tasks.register<Task>("testUpdateChangelog") {
group = "verification"
description = "This is a task to manually assert the correctness of the update tasks"
doLast {
@@ -822,7 +834,9 @@ fun updateAuthors(uncheckedEmails: Set<String>) {
org.intellij.markdown.parser.MarkdownParser(org.intellij.markdown.flavours.gfm.GFMFlavourDescriptor())
val tree = parser.buildMarkdownTreeFromString(authors)
val contributorsSection = tree.children[24]
val contributorsSection = tree.children
.filter { it is ListCompositeNode }
.single { it.getTextInNode(authors).contains("yole") }
val existingEmails = mutableSetOf<String>()
for (child in contributorsSection.children) {
if (child.children.size > 1) {

View File

@@ -16,10 +16,137 @@ in `~/.ideavimrc`. E.g. `set nosurround`.
Available plugins:
<details>
<summary><h2>easymotion</h2></summary>
<summary><h2>anyobject: Useful text objects like functions, arguments, classes, loops, list items, block comments, and more.</h2></summary>
### Summary:
An extension for IdeaVim plugin that adds useful text objects to improve your productivity on JetBrains IDEs.
Text objects allow a more efficient way of communicating edition or selection actions in the editor. Instead of thinking in terms of characters, words, lines, or paragraphs, use more advance text constructs like quoted text, text between brackets, items in a collection, or programming language constructs like arguments, classes, functions, loops, or comments.
By Ricardo Rodriguez
### Setup
- Install [Vim AnyObject](https://plugins.jetbrains.com/plugin/28333-vim-anyobject)
- Add `set anyobject` to your `~/.ideavimrc` file, then run `:source ~/.ideavimrc`
or restart the IDE.
### Instructions
[https://plugins.jetbrains.com/plugin/28333-vim-anyobject](https://plugins.jetbrains.com/plugin/28333-vim-anyobject)
</details>
<details>
<summary><h2>argtextobj: Provides a text-object 'a' argument</h2></summary>
Original plugin: [argtextobj.vim](https://www.vim.org/scripts/script.php?script_id=2699).
### Summary:
This plugin provides a text-object 'a' (argument).
You can d(elete), c(hange), v(select)... an argument or inner argument in familiar ways.
That is, such as 'daa'(delete-an-argument) 'cia'(change-inner-argument) 'via'(select-inner-argument).
What this script does is more than just typing
F,dt,
because it recognizes inclusion relationship of parentheses.
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'vim-scripts/argtextobj.vim'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'vim-scripts/argtextobj.vim'</code>
<br/>
<code>Plug 'https://github.com/vim-scripts/argtextobj.vim'</code>
<br/>
<code>Plug 'argtextobj.vim'</code>
<br/>
<code>Plug 'https://www.vim.org/scripts/script.php?script_id=2699'</code>
<br/>
<code>set argtextobj</code>
</details>
### Instructions
By default, only the arguments inside parenthesis are considered. To extend the functionality
to other types of brackets, set `g:argtextobj_pairs` variable to a comma-separated
list of colon-separated pairs (same as VIM's `matchpairs` option), like
`let g:argtextobj_pairs="(:),{:},<:>"`. The order of pairs matters when
handling symbols that can also be operators: `func(x << 5, 20) >> 17`. To handle
this syntax parenthesis, must come before angle brackets in the list.
https://www.vim.org/scripts/script.php?script_id=2699
</details>
<details>
<summary><h2>commentary: Adds mapping for quickly commenting stuff out</h2></summary>
By [Daniel Leong](https://github.com/dhleong)
Original plugin: [commentary.vim](https://github.com/tpope/vim-commentary).
### Summary:
Comment stuff out.
Use gcc to comment out a line (takes a count), gc to comment out the target of a motion
(for example, gcap to comment out a paragraph), gc in visual mode to comment out the selection,
and gc in operator pending mode to target a comment.
You can also use it as a command, either with a range like :7,17Commentary,
or as part of a :global invocation like with :g/TODO/Commentary.
That's it.
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'tpope/vim-commentary'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'tpope/vim-commentary'</code>
<br/>
<code>Plug 'https://github.com/tpope/vim-commentary'</code>
<br/>
<code>Plug 'vim-commentary'</code>
<br/>
<code>Plug 'tcomment_vim'</code>
<br/>
<code>set commentary</code>
</details>
### Instructions
https://github.com/tpope/vim-commentary/blob/master/doc/commentary.txt
</details>
<details>
<summary><h2>dial: Advanced text increment and decrement functionality.</h2></summary>
### Summary:
IdeaVim extension with advanced text increment and decrement functionality. It enhances the standard increment/decrement functionality found in Vim editors by adding support for complex text patterns beyond simple numbers.
Cycle through related values from various text elements, including numbers, dates, boolean values, operators, and programming language-specific keywords.
By Ricardo Rodriguez
### Setup
- Install [Vim Dial](https://plugins.jetbrains.com/plugin/28237-vim-dial)
- Add `set dial` to your `~/.ideavimrc` file, then run `:source ~/.ideavimrc`
or restart the IDE.
### Instructions
[https://plugins.jetbrains.com/plugin/28237-vim-dial](https://plugins.jetbrains.com/plugin/28237-vim-dial)
</details>
<details>
<summary><h2>easymotion: Simplifies some motions</h2></summary>
Original plugin: [vim-easymotion](https://github.com/easymotion/vim-easymotion).
### Summary:
EasyMotion provides a much simpler way to use some motions in vim.
It takes the \<number> out of \<number>w or \<number>f{char} by highlighting all possible choices
and allowing you to press one key to jump directly to the target.
### Setup:
- Install [IdeaVim-EasyMotion](https://plugins.jetbrains.com/plugin/13360-ideavim-easymotion/)
and [AceJump](https://plugins.jetbrains.com/plugin/7086-acejump/) plugins.
@@ -41,80 +168,176 @@ All commands with the mappings are supported. See the [full list of supported co
</details>
<details>
<summary><h2>sneak</h2></summary>
<summary><h2>exchange: Easy text exchange operator</h2></summary>
<img src="images/sneakIcon.svg" width="80" height="80" alt="icon"/>
By [fan-tom](https://github.com/fan-tom)
Original plugin: [vim-exchange](https://github.com/tommcdo/vim-exchange).
### Summary:
Easy text exchange operator for Vim.
By [Mikhail Levchenko](https://github.com/Mishkun)
Original repository with the plugin: https://github.com/Mishkun/ideavim-sneak
Original plugin: [vim-sneak](https://github.com/justinmk/vim-sneak).
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'justinmk/vim-sneak'`
### Instructions
* Type `s` and two chars to start sneaking in forward direction
* Type `S` and two chars to start sneaking in backward direction
* Type `;` or `,` to proceed with sneaking just as if you were using `f` or `t` commands
</details>
<details>
<summary><h2>NERDTree</h2></summary>
Original plugin: [NERDTree](https://github.com/preservim/nerdtree).
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'preservim/nerdtree'`
- Add the following command to `~/.ideavimrc`: `Plug 'tommcdo/vim-exchange'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'preservim/nerdtree'</code>
<code>Plugin 'tommcdo/vim-exchange'</code>
<br/>
<code>Plug 'https://github.com/preservim/nerdtree'</code>
<code>Plug 'https://github.com/tommcdo/vim-exchange'</code>
<br/>
<code>Plug 'nerdtree'</code>
<code>Plug 'vim-exchange'</code>
<br/>
<code>set NERDTree</code>
<code>set exchange</code>
</details>
### Instructions
[See here](NERDTree-support.md).
https://github.com/tommcdo/vim-exchange/blob/master/doc/exchange.txt
</details>
<details>
<summary><h2>surround</h2></summary>
Original plugin: [vim-surround](https://github.com/tpope/vim-surround).
<summary><h2>FunctionTextObj: Adds text objects for manipulating functions/methods</h2></summary>
By Julien Phalip
### Summary:
An extension for IdeaVim that adds text objects for manipulating functions/methods in your code.
Similar to how iw operates on words or i" operates on quoted strings,
this plugin provides if and af to operate on functions
### Setup
Add `set functiontextobj` to your `~/.ideavimrc` file, then run `:source ~/.ideavimrc`
or restart the IDE.
### Instructions
https://plugins.jetbrains.com/plugin/25897-vim-functiontextobj
</details>
<details>
<summary><h2>highlightedyank: Highlights the yanked region</h2></summary>
By [KostkaBrukowa](https://github.com/KostkaBrukowa)
Original plugin: [vim-highlightedyank](https://github.com/machakann/vim-highlightedyank).
### Summary:
Make the yanked region apparent!
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'tpope/vim-surround'`
- Add the following command to `~/.ideavimrc`: `Plug 'machakann/vim-highlightedyank'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'tpope/vim-surround'</code>
<code>Plugin 'machakann/vim-highlightedyank'</code>
<br/>
<code>Plug 'https://www.vim.org/scripts/script.php?script_id=1697'</code>
<code>Plug 'https://github.com/machakann/vim-highlightedyank'</code>
<br/>
<code>Plug 'vim-surround'</code>
<code>Plug 'vim-highlightedyank'</code>
<br/>
<code>set surround</code>
<code>set highlightedyank</code>
</details>
### Instructions
https://github.com/tpope/vim-surround/blob/master/doc/surround.txt
If you want to optimize highlight duration, assign a time in milliseconds:
`let g:highlightedyank_highlight_duration = "1000"`
A negative number makes the highlight persistent.
If you want to change background color of highlight you can provide the rgba of the color you want e.g.
`let g:highlightedyank_highlight_color = "rgba(160, 160, 160, 155)"`
If you want to change text color of highlight you can provide the rgba of the color you want e.g.
`let g:highlightedyank_highlight_foreground_color = "rgba(0, 0, 0, 255)"`
https://github.com/machakann/vim-highlightedyank/blob/master/doc/highlightedyank.txt
</details>
<details>
<summary><h2>multiple-cursors</h2></summary>
<summary><h2>indent-object: Adds text objects for manipulating sentences/paragraphs/etc...</h2></summary>
By [Shrikant Sharat Kandula](https://github.com/sharat87)
Original plugin: [vim-indent-object](https://github.com/michaeljsmith/vim-indent-object).
### Summary:
Vim text objects provide a convenient way to select and operate on various types of objects.
These objects include regions surrounded by various types of brackets and various parts of language
(ie sentences, paragraphs, etc).
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'michaeljsmith/vim-indent-object'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'michaeljsmith/vim-indent-object'</code>
<br/>
<code>Plug 'https://github.com/michaeljsmith/vim-indent-object'</code>
<br/>
<code>Plug 'vim-indent-object'</code>
<br/>
<code>set textobj-indent</code>
</details>
### Instructions
https://github.com/michaeljsmith/vim-indent-object/blob/master/doc/indent-object.txt
</details>
<details>
<summary><h2>matchit.vim: Extends the % key functionality</h2></summary>
By [Martin Yzeiri](https://github.com/myzeiri)
Original plugin: [matchit.vim](https://github.com/chrisbra/matchit).
### Summary:
In Vim, as in plain vi, the percent key, |%|, jumps the cursor from a brace, bracket, or paren to its match.
This can be configured with the 'matchpairs' option.
The matchit plugin extends this in several ways...
### Setup:
- Add the following command to `~/.ideavimrc`: `packadd matchit`
<details>
<summary>Alternative syntax</summary>
<code>Plug 'vim-matchit'</code>
<br/>
<code>Plug 'chrisbra/matchit'</code>
<br/>
<code>set matchit</code>
</details>
### Instructions
https://github.com/adelarsq/vim-matchit/blob/master/doc/matchit.txt
</details>
<details>
<summary><h2>Mini.ai: Extend and create a/i textobjects (IMPORTANT: The plugin is not related with artificial intelligence)</h2></summary>
### Summary:
Extend and create a/i textobjects
### Features:
Provides additional text object motions for handling quotes and brackets. The following motions are included:
- aq: Around any quotes.
- iq: Inside any quotes.
- ab: Around any parentheses, curly braces, and square brackets.
- ib: Inside any parentheses, curly braces, and square brackets.
Original plugin: [mini.ai](https://github.com/echasnovski/mini.ai).
### Setup:
- Add the following command to `~/.ideavimrc`: `set mini-ai`
</details>
<details>
<summary><h2>multiple-cursors: Extends multicursor support</h2></summary>
Original plugin: [vim-multiple-cursors](https://github.com/terryma/vim-multiple-cursors).
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'terryma/vim-multiple-cursors'`
<details>
@@ -127,7 +350,7 @@ Original plugin: [vim-multiple-cursors](https://github.com/terryma/vim-multiple-
<br/>
<code>set multiple-cursors</code>
</details>
### Instructions
At the moment, the default key binds for this plugin do not get mapped correctly in IdeaVim (see [VIM-2178](https://youtrack.jetbrains.com/issue/VIM-2178)). To enable the default key binds, add the following to your `.ideavimrc` file...
@@ -153,38 +376,118 @@ xmap <leader>g<C-n> <Plug>AllOccurrences
</details>
<details>
<summary><h2>commentary</h2></summary>
<summary><h2>NERDTree: Adds NERDTree navigation to the project panel</h2></summary>
Original plugin: [NERDTree](https://github.com/preservim/nerdtree).
By [Daniel Leong](https://github.com/dhleong)
Original plugin: [commentary.vim](https://github.com/tpope/vim-commentary).
### Summary:
Adds NERDTree navigation to the project panel.
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'tpope/vim-commentary'`
- Add the following command to `~/.ideavimrc`: `Plug 'preservim/nerdtree'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'tpope/vim-commentary'</code>
<code>Plugin 'preservim/nerdtree'</code>
<br/>
<code>Plug 'https://github.com/tpope/vim-commentary'</code>
<code>Plug 'https://github.com/preservim/nerdtree'</code>
<br/>
<code>Plug 'vim-commentary'</code>
<code>Plug 'nerdtree'</code>
<br/>
<code>Plug 'tcomment_vim'</code>
<br/>
<code>set commentary</code>
<code>set NERDTree</code>
</details>
### Instructions
https://github.com/tpope/vim-commentary/blob/master/doc/commentary.txt
[See here](NERDTree-support.md).
</details>
<details>
<summary><h2>ReplaceWithRegister</h2></summary>
<summary><h2>paragraph-motion: Extends the { and } motions to ignore whitespace on otherwise empty lines</h2></summary>
Original plugin: [vim-paragraph-motion](https://github.com/dbakker/vim-paragraph-motion).
### Summary:
Normally the { and } motions only match completely empty lines.
With this plugin lines that only contain whitespace are also matched.
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'dbakker/vim-paragraph-motion'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'dbakker/vim-paragraph-motion'</code>
<br/>
<code>Plug 'https://github.com/dbakker/vim-paragraph-motion'</code>
<br/>
<code>Plug 'vim-paragraph-motion'</code>
<br/>
<code>Plug 'https://github.com/vim-scripts/Improved-paragraph-motion'</code>
<br/>
<code>Plug 'vim-scripts/Improved-paragraph-motion'</code>
<br/>
<code>Plug 'Improved-paragraph-motion'</code>
<br/>
<code>set vim-paragraph-motion</code>
</details>
### Instructions
https://github.com/dbakker/vim-paragraph-motion#vim-paragraph-motion
</details>
<details>
<summary><h2>Peekaboo: Extends " @ CTRL-r to show a popup of the register contents</h2></summary>
By Julien Phalip
Original plugin: [vim-peekaboo](https://github.com/junegunn/vim-peekaboo).
### Summary:
Peekaboo extends " and @ in normal mode and <CTRL-R> in insert mode so you can see the contents of the registers.
### Setup
Add `set peekaboo` to your `~/.ideavimrc` file, then run `:source ~/.ideavimrc`
or restart the IDE.
### Instructions
https://plugins.jetbrains.com/plugin/25776-vim-peekaboo
</details>
<details>
<summary><h2>quick-scope: Always-on highlight for a unique character in every word on a line to help use f, F, etc.</h2></summary>
Original plugin: [quick-scope](https://github.com/unblevable/quick-scope).
### Summary:
An always-on highlight for a unique character in every word on a line to help you use f, F, and family.
This plugin should help you get to any word on a line in two or three keystrokes with Vim's built-in f<char>
(which moves your cursor to <char>).
### Setup:
- Install [IdeaVim-Quickscope](https://plugins.jetbrains.com/plugin/19417-ideavim-quickscope) plugin.
- Add the following command to `~/.ideavimrc`: `set quickscope`
### Instructions
https://plugins.jetbrains.com/plugin/19417-ideavim-quickscope
</details>
<details>
<summary><h2>ReplaceWithRegister: Adds two-in-one command that replaces text with the contents of a register.</h2></summary>
By [igrekster](https://github.com/igrekster)
Original plugin: [ReplaceWithRegister](https://github.com/vim-scripts/ReplaceWithRegister).
### Summary:
This plugin offers a two-in-one command that replaces text covered by a
{motion}, entire line(s) or the current selection with the contents of a
register; the old text is deleted into the black-hole register, i.e. it's
gone. (But of course, the command can be easily undone.)
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'vim-scripts/ReplaceWithRegister'`
<details>
@@ -203,78 +506,99 @@ Original plugin: [ReplaceWithRegister](https://github.com/vim-scripts/ReplaceWit
<br/>
<code>set ReplaceWithRegister</code>
</details>
### Instructions
https://github.com/vim-scripts/ReplaceWithRegister/blob/master/doc/ReplaceWithRegister.txt
</details>
<details>
<summary><h2>argtextobj</h2></summary>
<summary><h2>sneak: Jump to any location specified by two characters</h2></summary>
<img src="images/sneakIcon.svg" width="80" height="80" alt="icon"/>
By [Mikhail Levchenko](https://github.com/Mishkun)
Original repository with the plugin: https://github.com/Mishkun/ideavim-sneak
Original plugin: [vim-sneak](https://github.com/justinmk/vim-sneak).
### Summary:
Jump to any location specified by two characters.
Original plugin: [argtextobj.vim](https://www.vim.org/scripts/script.php?script_id=2699).
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'vim-scripts/argtextobj.vim'`
- Add the following command to `~/.ideavimrc`: `Plug 'justinmk/vim-sneak'`
### Instructions
* Type `s` and two chars to start sneaking in forward direction
* Type `S` and two chars to start sneaking in backward direction
* Type `;` or `,` to proceed with sneaking just as if you were using `f` or `t` commands
</details>
<details>
<summary><h2>surround: Adds provides mappings to easily delete, change, and add surroundings in pairs</h2></summary>
Original plugin: [vim-surround](https://github.com/tpope/vim-surround).
### Summary:
Surround.vim is all about "surroundings": parentheses, brackets, quotes, XML tags, and more.
The plugin provides mappings to easily delete, change, and add such surroundings in pairs.
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'tpope/vim-surround'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'vim-scripts/argtextobj.vim'</code>
<code>Plugin 'tpope/vim-surround'</code>
<br/>
<code>Plug 'https://github.com/vim-scripts/argtextobj.vim'</code>
<code>Plug 'https://www.vim.org/scripts/script.php?script_id=1697'</code>
<br/>
<code>Plug 'argtextobj.vim'</code>
<code>Plug 'vim-surround'</code>
<br/>
<code>Plug 'https://www.vim.org/scripts/script.php?script_id=2699'</code>
<br/>
<code>set argtextobj</code>
<code>set surround</code>
</details>
### Instructions
By default, only the arguments inside parenthesis are considered. To extend the functionality
to other types of brackets, set `g:argtextobj_pairs` variable to a comma-separated
list of colon-separated pairs (same as VIM's `matchpairs` option), like
`let g:argtextobj_pairs="(:),{:},<:>"`. The order of pairs matters when
handling symbols that can also be operators: `func(x << 5, 20) >> 17`. To handle
this syntax parenthesis, must come before angle brackets in the list.
https://www.vim.org/scripts/script.php?script_id=2699
https://github.com/tpope/vim-surround/blob/master/doc/surround.txt
</details>
<details>
<summary><h2>exchange</h2></summary>
<summary><h2>Switch: Switch some text under the cursor based on regex patterns</h2></summary>
By Julien Phalip
Original plugin: [switch.vim](https://github.com/AndrewRadev/switch.vim).
### Summary:
The purpose of the plugin is to switch some text under the cursor based on regex patterns.
The main entry point is a single command, :Switch.
When the command is executed,
the plugin looks for one of a few specific patterns under the cursor and performs a substitution depending on it.
### Setup
Add `set switch` to your `~/.ideavimrc` file, then run `:source ~/.ideavimrc`
or restart the IDE.
By [fan-tom](https://github.com/fan-tom)
Original plugin: [vim-exchange](https://github.com/tommcdo/vim-exchange).
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'tommcdo/vim-exchange'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'tommcdo/vim-exchange'</code>
<br/>
<code>Plug 'https://github.com/tommcdo/vim-exchange'</code>
<br/>
<code>Plug 'vim-exchange'</code>
<br/>
<code>set exchange</code>
</details>
### Instructions
https://github.com/tommcdo/vim-exchange/blob/master/doc/exchange.txt
https://plugins.jetbrains.com/plugin/25899-vim-switch
</details>
<details>
<summary><h2>textobj-entire</h2></summary>
<summary><h2>textobj-entire: Adds mapping for selecting entire contents of file regardless of cursor position</h2></summary>
By [Alexandre Grison](https://github.com/agrison)
Original plugin: [vim-textobj-entire](https://github.com/kana/vim-textobj-entire).
### Summary:
vim-textobj-entire is a Vim plugin to provide text objects
(ae and ie by default) to select the entire content of a buffer.
Though these are trivial operations (e.g. ggVG), text object versions are more handy,
because you do not have to be conscious of the cursor position (e.g. vae).
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'kana/vim-textobj-entire'`
<details>
@@ -295,158 +619,13 @@ https://github.com/kana/vim-textobj-entire/blob/master/doc/textobj-entire.txt
</details>
<details>
<summary><h2>highlightedyank</h2></summary>
By [KostkaBrukowa](https://github.com/KostkaBrukowa)
Original plugin: [vim-highlightedyank](https://github.com/machakann/vim-highlightedyank).
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'machakann/vim-highlightedyank'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'machakann/vim-highlightedyank'</code>
<br/>
<code>Plug 'https://github.com/machakann/vim-highlightedyank'</code>
<br/>
<code>Plug 'vim-highlightedyank'</code>
<br/>
<code>set highlightedyank</code>
</details>
### Instructions
If you want to optimize highlight duration, assign a time in milliseconds:
`let g:highlightedyank_highlight_duration = "1000"`
A negative number makes the highlight persistent.
If you want to change background color of highlight you can provide the rgba of the color you want e.g.
`let g:highlightedyank_highlight_color = "rgba(160, 160, 160, 155)"`
If you want to change text color of highlight you can provide the rgba of the color you want e.g.
`let g:highlightedyank_highlight_foreground_color = "rgba(0, 0, 0, 255)"`
https://github.com/machakann/vim-highlightedyank/blob/master/doc/highlightedyank.txt
</details>
<details>
<summary><h2>vim-paragraph-motion</h2></summary>
Original plugin: [vim-paragraph-motion](https://github.com/dbakker/vim-paragraph-motion).
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'dbakker/vim-paragraph-motion'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'dbakker/vim-paragraph-motion'</code>
<br/>
<code>Plug 'https://github.com/dbakker/vim-paragraph-motion'</code>
<br/>
<code>Plug 'vim-paragraph-motion'</code>
<br/>
<code>Plug 'https://github.com/vim-scripts/Improved-paragraph-motion'</code>
<br/>
<code>Plug 'vim-scripts/Improved-paragraph-motion'</code>
<br/>
<code>Plug 'Improved-paragraph-motion'</code>
<br/>
<code>set vim-paragraph-motion</code>
</details>
### Instructions
https://github.com/dbakker/vim-paragraph-motion#vim-paragraph-motion
</details>
<details>
<summary><h2>vim-indent-object</h2></summary>
By [Shrikant Sharat Kandula](https://github.com/sharat87)
Original plugin: [vim-indent-object](https://github.com/michaeljsmith/vim-indent-object).
### Setup:
- Add the following command to `~/.ideavimrc`: `Plug 'michaeljsmith/vim-indent-object'`
<details>
<summary>Alternative syntax</summary>
<code>Plugin 'michaeljsmith/vim-indent-object'</code>
<br/>
<code>Plug 'https://github.com/michaeljsmith/vim-indent-object'</code>
<br/>
<code>Plug 'vim-indent-object'</code>
<br/>
<code>set textobj-indent</code>
</details>
### Instructions
https://github.com/michaeljsmith/vim-indent-object/blob/master/doc/indent-object.txt
</details>
<details>
<summary><h2>matchit.vim</h2></summary>
By [Martin Yzeiri](https://github.com/myzeiri)
Original plugin: [matchit.vim](https://github.com/chrisbra/matchit).
### Setup:
- Add the following command to `~/.ideavimrc`: `packadd matchit`
<details>
<summary>Alternative syntax</summary>
<code>Plug 'vim-matchit'</code>
<br/>
<code>Plug 'chrisbra/matchit'</code>
<br/>
<code>set matchit</code>
</details>
### Instructions
https://github.com/adelarsq/vim-matchit/blob/master/doc/matchit.txt
</details>
<details>
<summary><h2>IdeaVim-Quickscope</h2></summary>
Original plugin: [quick-scope](https://github.com/unblevable/quick-scope).
### Setup:
- Install [IdeaVim-Quickscope](https://plugins.jetbrains.com/plugin/19417-ideavim-quickscope) plugin.
- Add the following command to `~/.ideavimrc`: `set quickscope`
### Instructions
https://plugins.jetbrains.com/plugin/19417-ideavim-quickscope
</details>
<details>
<summary><h2>Mini.ai: Extend and create a/i textobjects (IMPORTANT: The plugin is not related with artificial intelligence)</h2></summary>
### Features:
Provides additional text object motions for handling quotes and brackets. The following motions are included:
- aq: Around any quotes.
- iq: Inside any quotes.
- ab: Around any parentheses, curly braces, and square brackets.
- ib: Inside any parentheses, curly braces, and square brackets.
Original plugin: [mini.ai](https://github.com/echasnovski/mini.ai).
### Setup:
- Add the following command to `~/.ideavimrc`: `set mini-ai`
</details>
<details>
<summary><h2>Which-Key</h2></summary>
<summary><h2>Which-Key: Displays available keybindings in popup</h2></summary>
Original plugin: [vim-which-key](https://github.com/liuchengxu/vim-which-key).
### Summary:
vim-which-key is vim port of emacs-which-key that displays available keybindings in popup.
### Setup:
- Install [Which-Key](https://plugins.jetbrains.com/plugin/15976-which-key) plugin.
- Add the following command to `~/.ideavimrc`: `set which-key`
@@ -456,49 +635,3 @@ Original plugin: [vim-which-key](https://github.com/liuchengxu/vim-which-key).
https://github.com/TheBlob42/idea-which-key?tab=readme-ov-file#installation
</details>
<details>
<summary><h2>Vim Peekaboo</h2></summary>
By Julien Phalip
Original plugin: [vim-peekaboo](https://github.com/junegunn/vim-peekaboo).
### Setup
Add `set peekaboo` to your `~/.ideavimrc` file, then run `:source ~/.ideavimrc`
or restart the IDE.
### Instructions
https://plugins.jetbrains.com/plugin/25776-vim-peekaboo
</details>
<details>
<summary><h2>FunctionTextObj</h2></summary>
By Julien Phalip
### Setup
Add `set functiontextobj` to your `~/.ideavimrc` file, then run `:source ~/.ideavimrc`
or restart the IDE.
### Instructions
https://plugins.jetbrains.com/plugin/25897-vim-functiontextobj
</details>
<details>
<summary><h2>Switch</h2></summary>
By Julien Phalip
Original plugin: [switch.vim](https://github.com/AndrewRadev/switch.vim).
### Setup
Add `set switch` to your `~/.ideavimrc` file, then run `:source ~/.ideavimrc`
or restart the IDE.
### Instructions
https://plugins.jetbrains.com/plugin/25899-vim-switch

View File

@@ -0,0 +1,113 @@
# Introduction to IdeaVim Plugin Development
> **⚠️ EXPERIMENTAL API WARNING**
>
> The Plugin API is currently in an **experimental stage** and is not yet recommended for production use.
>
> - The API is subject to breaking changes without notice
> - Features may be added, modified, or removed in future releases
> - Documentation may not fully reflect the current implementation
> - Use at your own risk for experimental purposes only
>
> We welcome feedback and bug reports to help improve the API, but please be aware that stability is not guaranteed at this time.
This guide explains and gives examples on how to create plugins for IdeaVim, the Vim emulation plugin for IntelliJ-based IDEs.
Existing plugins can be found [here](IdeaVim%20Plugins.md).
## Table of Contents
- [Introduction](#introduction)
- [Plugin Architecture](#plugin-architecture)
- [Scopes](#scopes)
- [Examples](#scopes-example)
- [Read and write operations](#read-and-transaction-operations)
## Introduction
IdeaVim plugins aim to extend the functionality of the IdeaVim plugin, allowing you to add custom Vim-like features to your IntelliJ-based IDE.
These plugins can define new commands, mappings, operators, and more, just like Vim plugins do.
The IdeaVim API provides a Kotlin DSL that makes it easy to create new plugins.
## Plugin Architecture
IdeaVim plugins are built using a scope-based architecture.
Starting scope is the `VimApi`, which provides access to various aspects of the editor and Vim functionality.
An IdeaVim plugin written with this API consists of:
1. An entry point function with no parameters and return value annotated with `@VimPlugin`
2. One or more scope blocks that define the plugin's functionality
3. Mappings, commands, or other extensions that users can interact with
Here's a minimal plugin structure:
```kotlin
@VimPlugin(name = "MyPlugin")
fun VimApi.init() {
// Plugin initialization code
mappings {
nmap(keys = "<leader>x", label = "MyPluginAction") {
// Action implementation
}
}
}
```
## Scopes
IdeaVim plugins are written in scopes.
They provide a structured way to write code, improve readability and ensure that functions can be called only within a specific scope.
The base scope is `VimApi`, which provides access to general Vim functionality. From there, plugin writers can access more specialized scopes.
The list of all scopes and their functions is available in the API reference ([link](Plugin-API-reference.md)).
### Scopes example
```kotlin
editor {
// Now in EditorScope
change {
// Make changes to the document
withPrimaryCaret {
insertText(offset, "New text")
}
}
}
mappings {
// Now in MappingScope
nmap(keys = "gx", label = "OpenURL") {
// Action implementation
}
}
```
### Read and Transaction Operations
In the IdeaVim API there is a distinction between read and write operations:
- **Read operations** access the state of the editor without modifying it
- **Transaction operations** modify the state of the editor
These operations must be executed under the appropriate locks to ensure thread safety:
```kotlin
// Read operation
val deferred: Deferred<CharSequence> = editor {
read {
text // Get the text of the document
}
}
runBlocking { println(deferred.await()) }
// Transaction operation
val job: Job = editor {
change {
forEachCaret {
insertText(offset, "Hello, world!")
}
}
}
runBlocking { job.join() }
```

View File

@@ -0,0 +1,177 @@
# Quick Start Guide for IdeaVim Plugin Development
> **⚠️ EXPERIMENTAL API WARNING**
>
> The Plugin API is currently in an **experimental stage** and is not yet recommended for production use.
>
> - The API is subject to breaking changes without notice
> - Features may be added, modified, or removed in future releases
> - Documentation may not fully reflect the current implementation
> - Use at your own risk for experimental purposes only
>
> We welcome feedback and bug reports to help improve the API, but please be aware that stability is not guaranteed at this time.
This guide will help you get started with developing plugins for IdeaVim.
We'll cover the essential concepts and show you how to create a simple plugin.
## Setting Up Your First Plugin
### 1. Project Setup
For now, you can create plugin in the IdeaVim extensions package - [link](https://github.com/JetBrains/ideavim/tree/4764ffbbf545607ad4a5c482d74e0219002a5aca/src/main/java/com/maddyhome/idea/vim/extension).
### 2. Create the Plugin Entry Point
The entry point for an IdeaVim plugin is a function annotated with `@VimPlugin`:
```kotlin
@VimPlugin(name = "MyFirstPlugin")
fun VimApi.init() {
// Plugin initialization code goes here
}
```
Here we will register mappings, listeners, commands etc.
### 3. Add Functionality
Let's add a simple mapping that displays a message in the output panel:
```kotlin
@VimPlugin(name = "MyFirstPlugin")
fun VimApi.init() {
mappings {
nmap(keys = "<leader>h", label = "HelloWorld") {
outputPanel {
setText("Hello from my first IdeaVim plugin!")
}
}
}
}
```
## Basic Functionality Examples
### Key Mappings
You can define mappings for different Vim modes:
```kotlin
mappings {
// Normal mode mapping
nmap(keys = "<leader>x", label = "MyNormalAction") {
// Action implementation
}
// Visual mode mapping
vmap(keys = "<leader>y", label = "MyVisualAction") {
// Action implementation
}
// Insert mode mapping
imap(keys = "<C-d>", label = "MyInsertAction") {
// Action implementation
}
}
```
### Working with Variables
You can get and set Vim variables:
```kotlin
// Get a variable
val count = getVariable<Int>("v:count1") ?: 1
val register = getVariable<String>("v:register") ?: "\""
// Set a variable
setVariable("g:my_plugin_enabled", true)
```
### Executing Commands
You can execute normal mode commands and Ex commands:
```kotlin
// Execute a normal mode command
normal("dd")
// Execute an Ex command
execute(":set number")
```
### Text Manipulation
You can manipulate text in the editor:
```kotlin
editor {
change {
forEachCaret {
// Insert text at the current caret position
insertText(offset, "Hello, world!")
// Replace text in a range
replaceText(startOffset, endOffset, "New text")
// Delete text in a range
deleteText(startOffset, endOffset)
}
}
}
```
### Working with Registers
Since JetBrains IDEs have multiple-caret support, in IdeaVim every caret has its own registers and marks.
You can read from and write to registers like this:
```kotlin
// Read from register 'a'
val text = editor {
read {
withPrimaryCaret { getReg('a') }
}
}
runBlocking { println(text.await()) }
// Write to register 'b'
val job = editor {
change {
withPrimaryCaret {
setReg('b', "New content", TextType.CHARACTER_WISE)
}
}
}
runBlocking { job.join() }
```
## A Simple Plugin Example
Here's a simple plugin that adds a mapping to uppercase the selected text:
```kotlin
@VimPlugin(name = "ToUppercase")
fun VimApi.init() {
mappings {
vmap(keys = "<leader>ll", label = "ToUpperCase") {
editor {
val job = change {
forEachCaret {
// Get the current selection
val selectionStart = (selection as Range.Simple).start
val selectionEnd = (selection as Range.Simple).end
// Get the selected text
val selectedText = text.substring(selectionStart, selectionEnd)
// Replace with uppercase version
replaceText(selectionStart, selectionEnd, selectedText.uppercase())
}
}
}
}
}
}
```

564
doc/Plugin-API-reference.md Normal file
View File

@@ -0,0 +1,564 @@
# API Reference
> **⚠️ EXPERIMENTAL API WARNING**
>
> The Plugin API is currently in an **experimental stage** and is not yet recommended for production use.
>
> - The API is subject to breaking changes without notice
> - Features may be added, modified, or removed in future releases
> - Documentation may not fully reflect the current implementation
> - Use at your own risk for experimental purposes only
>
> We welcome feedback and bug reports to help improve the API, but please be aware that stability is not guaranteed at this time.
## VimApi
The `VimApi` class is the main entry point for interacting with the Vim editor. It provides access to various functionalities like variable management, window operations, and text manipulation.
### Properties
| Property | Type | Description |
|----------|------|-------------|
| `mode` | `Mode` | The current mode of the Vim editor. |
| `tabCount` | `Int` | Gets the number of tabs in the current window. |
| `currentTabIndex` | `Int?` | The index of the current tab or null if there is no tab selected or no tabs are open. |
### Methods
#### Variable Management
| Method | Description | Return Value |
|--------|---------------------------------------------------------------------------------------------------------|--------------|
| `getVariable<T : Any>(name: String): T?` | Gets a variable with the specified name and scope. | The variable value or null if not found. |
| `setVariable<T : Any>(name: String, value: T)` | Sets a variable with the specified name and value. In Vim, this is equivalent to `let varname = value`. | None |
#### Operator Functions
| Method | Description | Return Value |
|--------------------------------------------------------------------------------|-------------|--------------|
| `exportOperatorFunction(name: String, function: suspend VimApi.() -> Boolean)` | Exports a function as an operator function. | None |
| `setOperatorFunction(name: String)` | Sets the operator function to use. | None |
| `normal(command: String)` | Executes a normal mode command. | None |
#### Editor Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `editor<T>(block: EditorScope.() -> T): T` | Executes a block of code in the context of the current editor. | The result of the block. |
| `forEachEditor<T>(block: EditorScope.() -> T): List<T>` | Executes a block of code for each open editor. | A list of results from each editor. |
#### Scope Access
| Method | Description | Return Value |
|--------|-------------|--------------|
| `mappings(block: MappingScope.() -> Unit)` | Executes a block of code in the mapping scope. | None |
| `listeners(block: ListenersScope.() -> Unit)` | Executes a block of code in the listeners scope. | None |
| `outputPanel(block: OutputPanelScope.() -> Unit)` | Executes a block of code in the output panel scope. | None |
| `modalInput(): ModalInput` | Gets the modal input scope. | The modal input scope. |
| `commandLine(block: CommandLineScope.() -> Unit)` | Executes a block of code in the command line scope. | None |
| `option<T>(block: OptionScope.() -> T): T` | Executes a block of code in the option scope. | The result of the block execution. |
| `digraph(block: DigraphScope.() -> Unit)` | Executes a block of code in the digraph scope. | None |
#### Tab Management
| Method | Description | Return Value |
|--------|-------------|--------------|
| `removeTabAt(indexToDelete: Int, indexToSelect: Int)` | Removes a tab at the specified index and selects another tab. | None |
| `moveCurrentTabToIndex(index: Int)` | Moves the current tab to the specified index. | None |
| `closeAllExceptCurrentTab()` | Closes all tabs except the current one. | None |
#### Pattern Matching
| Method | Description | Return Value |
|--------|-------------|--------------|
| `matches(pattern: String, text: String, ignoreCase: Boolean = false): Boolean` | Checks if a pattern matches a text. | True if the pattern matches the text, false otherwise. |
| `getAllMatches(text: String, pattern: String): List<Pair<Int, Int>>` | Finds all matches of a pattern in a text. | A list of pairs representing the start and end offsets of each match. |
#### Window Management
| Method | Description | Return Value |
|--------|-------------|--------------|
| `selectNextWindow()` | Selects the next window in the editor. | None |
| `selectPreviousWindow()` | Selects the previous window in the editor. | None |
| `selectWindow(index: Int)` | Selects a window by its index. | None |
| `splitWindowVertically(filename: String? = null)` | Splits the current window vertically and optionally opens a file in the new window. | None |
| `splitWindowHorizontally(filename: String? = null)` | Splits the current window horizontally and optionally opens a file in the new window. | None |
| `closeAllExceptCurrentWindow()` | Closes all windows except the current one. | None |
| `closeCurrentWindow()` | Closes the current window. | None |
| `closeAllWindows()` | Closes all windows in the editor. | None |
#### Script Execution
| Method | Description | Return Value |
|------------------------------------------------------------|-------------|--------------|
| `execute(script: String): Boolean` | Parses and executes the given Vimscript string. It can be used to execute ex commands, such as `:set`, `:map`, etc. | The result of the execution, which can be Success or Error. |
| `command(command: String, block: VimApi.(String) -> Unit)` | Defines a new command. | None |
#### Data Storage
| Method | Description | Return Value |
|--------|-------------|--------------|
| `getDataFromWindow<T>(key: String): T?` | Gets keyed data from a Vim window. | The data associated with the key, or null if no data is found. |
| `putDataToWindow<T>(key: String, data: T)` | Stores keyed user data in a Vim window. | None |
| `getDataFromBuffer<T>(key: String): T?` | Gets data from buffer. Vim stores there buffer scoped (`b:`) variables and local options. | The data associated with the key, or null if no data is found. |
| `putDataToBuffer<T>(key: String, data: T)` | Puts data to buffer. Vim stores there buffer scoped (`b:`) variables and local options. | None |
| `getDataFromTab<T>(key: String): T?` | Gets data from tab (group of windows). Vim stores there tab page scoped (`t:`) variables. | The data associated with the key, or null if no data is found. |
| `putDataToTab<T>(key: String, data: T)` | Puts data to tab (group of windows). Vim stores there tab page scoped (`t:`) variables. | None |
| `getOrPutWindowData<T>(key: String, provider: () -> T): T` | Gets data from window or puts it if it doesn't exist. | The existing data or the newly created data. |
| `getOrPutBufferData<T>(key: String, provider: () -> T): T` | Gets data from buffer or puts it if it doesn't exist. | The existing data or the newly created data. |
| `getOrPutTabData<T>(key: String, provider: () -> T): T` | Gets data from tab or puts it if it doesn't exist. | The existing data or the newly created data. |
#### File Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `saveFile()` | Saves the current file. In Vim, this is equivalent to the `:w` command. | None |
| `closeFile()` | Closes the current file. In Vim, this is equivalent to the `:q` command. | None |
#### Text Navigation
| Method | Description | Return Value |
|--------|-------------|--------------|
| `getNextCamelStartOffset(chars: CharSequence, startIndex: Int, count: Int = 1): Int?` | Finds the start offset of the next word in camel case or snake case text. | The offset of the next word start, or null if not found. |
| `getPreviousCamelStartOffset(chars: CharSequence, endIndex: Int, count: Int = 1): Int?` | Finds the start offset of the previous word in camel case or snake case text. | The offset of the previous word start, or null if not found. |
| `getNextCamelEndOffset(chars: CharSequence, startIndex: Int, count: Int = 1): Int?` | Finds the end offset of the next word in camel case or snake case text. | The offset of the next word end, or null if not found. |
| `getPreviousCamelEndOffset(chars: CharSequence, endIndex: Int, count: Int = 1): Int?` | Finds the end offset of the previous word in camel case or snake case text. | The offset of the previous word end, or null if not found. |
## EditorScope
The `EditorScope` class provides access to read and write operations on the editor. It serves as a bridge between the read-only and transaction-based operations.
### Methods
| Method | Description | Return Value |
|--------|-------------|--------------|
| `read<T>(block: suspend Read.() -> T): Deferred<T>` | Executes a block of code in the context of read operations. This allows for reading the editor state without modifying it. | A Deferred result of the block execution. |
| `change(block: suspend Transaction.() -> Unit): Job` | Executes a block of code in the context of transaction operations. This allows for modifying the editor state. | A Job representing the asynchronous operation. |
## ReadScope
The `ReadScope` interface provides read-only access to the editor content and state. It includes methods for navigating text, working with carets, and querying editor information.
### Properties
| Property | Type | Description |
|--------------------|-------------------|-------------------------------------------------|
| `textLength` | `Long` | The total length of the text in the editor. |
| `text` | `CharSequence` | The entire text content of the editor. |
| `lineCount` | `Int` | The number of lines in the editor. |
| `filePath` | `Path` | File path of the editor. |
| `caretData` | `List<CaretData>` | Information about all carets in the editor. |
| `caretIds` | `List<CaretId>` | The IDs of all carets in the editor. |
| `globalMarks` | `Set<Mark>` | All global marks defined in the editor. |
| `jumps` | `List<Jump>` | All jumps in the jump list. |
| `currentJumpIndex` | `Int` | Index of the current position in the jump list. |
### Methods
#### Caret Operations
| Method | Description | Return Value |
|------------------------------------------------------------------|-------------|------------------------------------|
| `forEachCaret<T>(block: suspend CaretRead.() -> T): List<T>` | Executes a block of code for each caret in the editor. | A list of results from each caret. |
| `with<T>(caretId: CaretId, block: suspend CaretRead.() -> T): T` | Executes a block of code with a specific caret. | Result from caret. |
| `withPrimaryCaret<T>(block: suspend CaretRead.() -> T): T` | Executes a block of code with the primary caret. | Result from caret. |
#### Line Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `getLineStartOffset(line: Int): Int` | Gets the offset of the start of a line. | The offset of the line start. |
| `getLineEndOffset(line: Int, allowEnd: Boolean): Int` | Gets the offset of the end of a line. | The offset of the line end. |
| `getLine(offset: Int): Line` | Gets the line at the specified offset. | The Line object. |
#### Mark and Jump Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `getGlobalMark(char: Char): Mark?` | Gets a global mark by its character key. | The mark, or null if the mark doesn't exist. |
| `getJump(count: Int = 0): Jump?` | Gets a jump from the jump list. | The jump, or null if there is no jump at the specified position. |
#### Scrolling Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `scrollCaretIntoView()` | Scrolls the caret into view. | None |
| `scrollVertically(lines: Int): Boolean` | Scrolls the editor by a specified number of lines. | True if the scroll was successful, false otherwise. |
| `scrollLineToTop(line: Int, start: Boolean): Boolean` | Scrolls the current line to the top of the display. | True if the scroll was successful, false otherwise. |
| `scrollLineToMiddle(line: Int, start: Boolean): Boolean` | Scrolls the current line to the middle of the display. | True if the scroll was successful, false otherwise. |
| `scrollLineToBottom(line: Int, start: Boolean): Boolean` | Scrolls the current line to the bottom of the display. | True if the scroll was successful, false otherwise. |
| `scrollHorizontally(columns: Int): Boolean` | Scrolls the editor horizontally by a specified number of columns. | True if the scroll was successful, false otherwise. |
| `scrollCaretToLeftEdge(): Boolean` | Scrolls the editor to position the caret column at the left edge of the display. | True if the scroll was successful, false otherwise. |
| `scrollCaretToRightEdge(): Boolean` | Scrolls the editor to position the caret column at the right edge of the display. | True if the scroll was successful, false otherwise. |
#### Text Navigation
| Method | Description | Return Value |
|--------|-------------|--------------|
| `getNextParagraphBoundOffset(startLine: Int, count: Int = 1, includeWhitespaceLines: Boolean = true): Int?` | Find the next paragraph-bound offset in the editor. | The offset of the next paragraph bound, or null if not found. |
| `getNextSentenceStart(startOffset: Int, count: Int = 1, includeCurrent: Boolean, requireAll: Boolean = true): Int?` | Finds the next sentence start in the editor from the given offset. | The offset of the next sentence start, or null if not found. |
| `getNextSectionStart(startLine: Int, marker: Char, count: Int = 1): Int` | Find the next section in the editor. | The offset of the next section. |
| `getPreviousSectionStart(startLine: Int, marker: Char, count: Int = 1): Int` | Find the start of the previous section in the editor. | The offset of the previous section. |
| `getNextSentenceEnd(startOffset: Int, count: Int = 1, includeCurrent: Boolean, requireAll: Boolean = true): Int?` | Find the next sentence end from the given offset. | The offset of the next sentence end, or null if not found. |
| `getNextWordStartOffset(startOffset: Int, count: Int = 1, isBigWord: Boolean): Int?` | Find the next word in the editor's document, from the given starting point. | The offset of the next word, or null if not found. |
| `getNextWordEndOffset(startOffset: Int, count: Int = 1, isBigWord: Boolean, stopOnEmptyLine: Boolean = true): Int` | Find the end offset of the next word in the editor's document. | The offset of the next word end. |
| `getNextCharOnLineOffset(startOffset: Int, count: Int = 1, char: Char): Int` | Find the next character on the current line. | The offset of the next character, or -1 if not found. |
| `getNearestWordOffset(startOffset: Int): Range?` | Find the word at or nearest to the given offset. | The range of the word, or null if not found. |
| `getParagraphRange(line: Int, count: Int = 1, isOuter: Boolean): Range?` | Returns range of a paragraph containing the given line. | The paragraph text range, or null if not found. |
| `getBlockQuoteInLineRange(startOffset: Int, quote: Char, isOuter: Boolean): Range?` | Find a block quote in the current line. | The range of the block quote, or null if not found. |
#### Pattern Matching
| Method | Description | Return Value |
|--------|-------------|--------------|
| `findAll(pattern: String, startLine: Int, endLine: Int, ignoreCase: Boolean = false): List<Range>` | Finds all occurrences of the given pattern within a specified line range. | A list of Ranges representing all matches found. |
| `findPattern(pattern: String, startOffset: Int, count: Int = 1, backwards: Boolean = false): Range?` | Finds text matching the given Vim-style regular expression pattern. | A Range representing the matched text, or null if no match is found. |
## Transaction
The `Transaction` interface provides methods for modifying the editor content and state. It includes operations for working with carets, highlights, marks, and jumps.
### Methods
#### Caret Operations
| Method | Description | Return Value |
|-------------------------------------------------------------------------|-------------|------------------------------------|
| `forEachCaret<T>(block: suspend CaretTransaction.() -> T): List<T>` | Executes a block of code for each caret in the editor. | A list of results from each caret. |
| `with<T>(caretId: CaretId, block: suspend CaretTransaction.() -> T): T` | Executes a block of code with a specific caret. | Result from caret. |
| `withPrimaryCaret<T>(block: suspend CaretTransaction.() -> T): T` | Executes a block of code with the primary caret. | Result from caret. |
| `addCaret(offset: Int): CaretId` | Adds a new caret at the specified offset. | The ID of the newly created caret. |
| `removeCaret(caretId: CaretId)` | Removes a caret with the specified ID. | None |
#### Highlighting
| Method | Description | Return Value |
|--------|-------------|--------------|
| `addHighlight(startOffset: Int, endOffset: Int, backgroundColor: Color?, foregroundColor: Color?): HighlightId` | Adds a highlight to the editor. | The ID of the newly created highlight. |
| `removeHighlight(highlightId: HighlightId)` | Removes a highlight with the specified ID. | None |
#### Mark Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `setMark(char: Char): Boolean` | Sets a mark at the current position for each caret in the editor. | True if the mark was successfully set, false otherwise. |
| `removeMark(char: Char)` | Removes a mark for all carets in the editor. | None |
| `setGlobalMark(char: Char): Boolean` | Sets a global mark at the current position. | True if the mark was successfully set, false otherwise. |
| `removeGlobalMark(char: Char)` | Removes a global mark. | None |
| `setGlobalMark(char: Char, offset: Int): Boolean` | Sets a global mark at the specified offset. | True if the mark was successfully set, false otherwise. |
| `resetAllMarks()` | Resets all marks. | None |
#### Jump List Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `addJump(jump: Jump, reset: Boolean)` | Adds a specific jump to the jump list. | None |
| `removeJump(jump: Jump)` | Removes a jump from the jump list. | None |
| `dropLastJump()` | Removes the last jump from the jump list. | None |
| `clearJumps()` | Clears all jumps from the jump list. | None |
## CaretRead
The `CaretRead` interface provides read-only access to a caret in the editor. It includes methods for working with registers, marks, scrolling, and text navigation.
### Properties
| Property | Type | Description |
|----------|------|-------------|
| `caretId` | `CaretId` | The unique identifier for this caret. |
| `offset` | `Int` | The current offset (position) of the caret in the document. |
| `selection` | `Range` | The current selection range of the caret. |
| `line` | `Line` | Information about the current line where the caret is positioned. |
| `lastSelectedReg` | `Char` | The last register that was selected for operations. Example: After using `"ay` to yank into register 'a', this would return 'a'. In VimScript, variable `v:register` contains this value. |
| `defaultRegister` | `Char` | The default register used when no register is explicitly specified. In Vim, this is typically the unnamed register ("). |
| `isRegisterSpecifiedExplicitly` | `Boolean` | Indicates whether the current register was explicitly specified by the user. Example: After `"ay`, this would be true; after just `y`, this would be false. |
| `selectionMarks` | `Range?` | The marks for the current visual selection. In Vim, these are the '< and '> marks. |
| `changeMarks` | `Range?` | The marks for the last change. In Vim, these are the '[ and '] marks. |
| `localMarks` | `Set<Mark>` | All local marks for the current caret. |
### Methods
#### Register Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `selectRegister(register: Char): Boolean` | Selects a register for subsequent operations. Example: In Vim, pressing `"a` before an operation selects register 'a'. | True if the register was successfully selected, false otherwise. |
| `resetRegisters()` | Resets all registers to their default state. | None |
| `isWritable(register: Char): Boolean` | Checks if a register is writable. Some registers in Vim are read-only. | True if the register is writable, false otherwise. |
| `isSystemClipboard(register: Char): Boolean` | Checks if a register is connected to the system clipboard. In Vim, registers '+' and '*' are connected to the system clipboard. | True if the register is connected to the system clipboard, false otherwise. |
| `isPrimaryRegisterSupported(): Boolean` | Checks if the primary selection register is supported. Example: On Linux, using `"*y` yanks text to the primary selection. | True if the primary selection register is supported, false otherwise. |
| `getReg(register: Char): String?` | Gets the text content of a register. | The text content of the register, or null if the register is empty or doesn't exist. |
| `getRegType(register: Char): TextType?` | Gets the type of text stored in a register (character-wise, line-wise, or block-wise). | The type of text in the register, or null if the register is empty or doesn't exist. |
| `setReg(register: Char, text: String, textType: TextType = TextType.CHARACTER_WISE): Boolean` | Sets the text content and type of a register. | True if the register was successfully set, false otherwise. |
#### Mark Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `getMark(char: Char): Mark?` | Gets a mark by its character key for the current caret. | The mark, or null if the mark doesn't exist. |
| `setMark(char: Char): Boolean` | Sets a mark at the current caret position. | True if the mark was successfully set, false otherwise. |
| `setMark(char: Char, offset: Int): Boolean` | Sets a mark at the specified offset. | True if the mark was successfully set, false otherwise. |
| `removeLocalMark(char: Char)` | Removes a local mark for the current caret. | None |
| `resetAllMarksForCaret()` | Resets all marks for the current caret. | None |
#### Scrolling Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `scrollFullPage(pages: Int): Boolean` | Scrolls a full page up or down. Positive values scroll down, negative values scroll up. | True if the scroll was successful, false otherwise. |
| `scrollHalfPageUp(lines: Int): Boolean` | Scrolls half a page up. | True if the scroll was successful, false otherwise. |
| `scrollHalfPageDown(lines: Int): Boolean` | Scrolls half a page down. | True if the scroll was successful, false otherwise. |
| `selectWindowHorizontally(relativePosition: Int)` | Selects a window in the same row as the current window. Positive values select windows to the right, negative values select windows to the left. | None |
| `selectWindowInVertically(relativePosition: Int)` | Selects a window in the same column as the current window. Positive values select the windows below, negative values select the windows above. | None |
#### Text Navigation
| Method | Description | Return Value |
|--------|-------------|--------------|
| `getNextParagraphBoundOffset(count: Int = 1, includeWhitespaceLines: Boolean = true): Int?` | Finds the offset of the next paragraph boundary. | The offset of the next paragraph bound, or null if not found. |
| `getNextSentenceStart(count: Int = 1, includeCurrent: Boolean, requireAll: Boolean = true): Int?` | Finds the next sentence start in the editor from the given offset. | The offset of the next sentence start, or null if not found. |
| `getNextSectionStart(marker: Char, count: Int = 1): Int` | Find the next section in the editor. | The offset of the next section. |
| `getPreviousSectionStart(marker: Char, count: Int = 1): Int` | Find the start of the previous section in the editor. | The offset of the previous section. |
| `getNextSentenceEnd(count: Int = 1, includeCurrent: Boolean, requireAll: Boolean = true): Int?` | Finds the end offset of the next sentence from the current caret position. | The offset of the next sentence end, or null if not found. |
| `getMethodEndOffset(count: Int = 1): Int` | Finds the end offset of the next method from the current caret position. | The offset of the end of the next method. |
| `getMethodStartOffset(count: Int = 1): Int` | Finds the start offset of the next method from the current caret position. | The offset of the start of the next method. |
| `getNextCharOnLineOffset(count: Int = 1, char: Char): Int` | Finds the next occurrence of a specific character on the current line. | The offset of the found character, or -1 if not found. |
| `getNearestWordOffset(): Range?` | Finds the word at or nearest to the current caret position. | A Range representing the found word, or null if no word is found. |
| `getWordTextObjectRange(count: Int = 1, isOuter: Boolean, isBigWord: Boolean): Range` | Find the range of the word text object at the location of the caret. | The range of the word text object. |
| `getSentenceRange(count: Int = 1, isOuter: Boolean): Range` | Find the range of the sentence text object at the location of the caret. | The range of the sentence text object. |
| `getParagraphRange(count: Int = 1, isOuter: Boolean): Range?` | Returns range of a paragraph containing the caret. | The paragraph text range, or null if not found. |
| `getBlockTagRange(count: Int = 1, isOuter: Boolean): Range?` | Find the range of a block tag at the location of the caret. | The range of the block tag, or null if not found. |
| `getBlockQuoteInLineRange(quote: Char, isOuter: Boolean): Range?` | Find a block quote in the current line at the location of the caret. | The range of the block quote, or null if not found. |
| `getNextMisspelledWordOffset(count: Int = 1): Int` | Finds the offset of the next misspelled word from the current caret position. | The offset of the next misspelled word. |
## CaretTransaction
The `CaretTransaction` interface extends `CaretRead` and provides methods for modifying the caret and text in the editor. It includes operations for updating the caret position, inserting text, replacing text, and deleting text.
### Methods
#### Caret Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `updateCaret(offset: Int, selection: Range.Simple? = null)` | Updates the caret position and optionally sets a selection. If a selection is provided, the caret will have this selection after moving to the new offset. If no selection is provided, any existing selection will be removed. | None |
#### Text Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `insertText(position: Int, text: String, caretAtEnd: Boolean = true, insertBeforeCaret: Boolean = false): Boolean` | Inserts text at the specified position in the document. | True if the insertion was successful, false otherwise. |
| `replaceText(startOffset: Int, endOffset: Int, text: String): Boolean` | Replaces text between the specified offsets with new text. | True if the replacement was successful, false otherwise. |
| `replaceTextBlockwise(range: Range.Block, text: List<String>)` | Replaces text in multiple ranges (blocks) with new text. | None |
| `deleteText(startOffset: Int, endOffset: Int): Boolean` | Deletes text between the specified offsets. | True if the deletion was successful, false otherwise. |
#### Jump Operations
| Method | Description | Return Value |
|--------|-------------|--------------|
| `addJump(reset: Boolean)` | Adds a jump with the current caret's position to the jump list. | None |
| `saveJumpLocation()` | Saves the location of the current caret to the jump list and sets the ' mark. | None |
## OptionScope
The `OptionScope` interface provides comprehensive methods for managing Vim options. It supports different scopes for options (global, local, and effective) and allows for type-safe access to option values. The `option` function returns a value, making it easy to retrieve option values directly.
### Core Methods
| Method | Description | Return Value |
|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| `get<T>(name: String): T` | Gets the value of an option with the specified type. In Vim, options can be accessed with the `&` prefix. Example: `&ignorecase` returns the value of the 'ignorecase' option. | The value of the option. Throws IllegalArgumentException if the option doesn't exist or type is wrong. |
| `set<T>(name: String, value: T)` | Sets the effective value of an option with the specified type. In Vim, this is equivalent to `:set option=value`. Example: `:set ignorecase` or `let &ignorecase = 1` | None |
| `setGlobal<T>(name: String, value: T)` | Sets the global value of an option with the specified type. In Vim, this is equivalent to `:setglobal option=value`. Example: `:setglobal ignorecase` or `let &g:ignorecase = 1` | None |
| `setLocal<T>(name: String, value: T)` | Sets the local value of an option with the specified type. In Vim, this is equivalent to `:setlocal option=value`. Example: `:setlocal ignorecase` or `let &l:ignorecase = 1` | None |
| `reset(name: String)` | Resets an option to its default value. In Vim, this is equivalent to `:set option&`. Example: `:set ignorecase&` resets the 'ignorecase' option to its default value. | None |
### List Option Methods
These extension functions provide convenient ways to manipulate comma-separated list options (like `virtualedit`, `whichwrap`, etc.):
| Method | Description | Vim Equivalent |
|------------------------------------------------|-------------------------------------------------------------|----------------------|
| `append(name: String, vararg values: String)` | Appends values to a list option. Duplicates are not added. | `:set option+=value` |
| `prepend(name: String, vararg values: String)` | Prepends values to a list option. Duplicates are not added. | `:set option^=value` |
| `remove(name: String, vararg values: String)` | Removes values from a list option. | `:set option-=value` |
### Utility Methods
| Method | Description | Return Value |
|--------------------------------|-------------------------------------------------------------------------|-----------------|
| `toggle(name: String)` | Toggles a boolean option value. | None |
| `String.split(): List<String>` | Extension function to split a comma-separated option value into a list. | List of strings |
### Usage Examples
```kotlin
// Getting option values
val history = myVimApi.option { get<Int>("history") }
val ignoreCase = myVimApi.option { get<Boolean>("ignorecase") }
// Setting options
myVimApi.option {
set("number", true) // Line numbers
setGlobal("history", 100) // Command history
setLocal("tabstop", 4) // Tab width for current buffer
}
// Working with list options
myVimApi.option {
// Add values to a list option
append("virtualedit", "block", "onemore")
// Remove values from a list option
remove("virtualedit", "block")
// Prepend values to a list option
prepend("whichwrap", "b", "s")
}
// Toggle boolean options
myVimApi.option {
toggle("ignorecase") // true → false or false → true
}
// Reset to default value
myVimApi.option {
reset("tabstop") // Reset to default value
}
// Process list options
myVimApi.option {
val virtualEditModes = get<String>("virtualedit").split()
// "block,all" → ["block", "all"]
}
// Complex operations with return value
val isIgnoreCaseEnabled = myVimApi.option {
val current = get<Boolean>("ignorecase")
if (!current) {
set("ignorecase", true)
set("smartcase", true)
}
current
}
```
## OutputPanelScope
The `OutputPanelScope` interface provides methods for interacting with the Vim output panel. The output panel is used to display text output from Vim commands and operations.
### Properties
| Property | Type | Description |
|----------|------|-------------|
| `text` | `String` | The text displayed in the output panel. |
| `label` | `String` | The label text displayed at the bottom of the output panel. This is used for status information like "-- MORE --" to indicate that there is more content to scroll through. |
### Methods
| Method | Description | Return Value |
|--------|-------------|--------------|
| `setText(text: String)` | Sets the text content of the output panel. This replaces any existing text in the panel with the provided text. | None |
| `appendText(text: String, startNewLine: Boolean = false)` | Appends text to the existing content of the output panel. If startNewLine is true and there is existing text, a newline character will be inserted before the appended text. | None |
| `setLabel(label: String)` | Sets the label text at the bottom of the output panel. | None |
| `clearText()` | Clears all text from the output panel. | None |
## ModalInput
The `ModalInput` interface provides methods for creating and managing modal input dialogs, which can be used to get user input in a Vim-like way.
### Methods
| Method | Description | Return Value |
|----------------------------------------------------------------|-------------|--------------|
| `updateLabel(block: (String) -> String): ModalInput` | Updates the label of the modal input dialog using the provided function. | The ModalInput instance for method chaining. |
| `repeatWhile(condition: () -> Boolean): ModalInput` | Repeats the modal input dialog while the provided condition is true. | The ModalInput instance for method chaining. |
| `repeat(count: Int): ModalInput` | Repeats the modal input dialog the specified number of times. | The ModalInput instance for method chaining. |
| `inputString(label: String, handler: VimApi.(String) -> Unit)` | Creates a modal input dialog with the given label and handler. The handler will be executed after the user presses ENTER. | None |
| `inputChar(label: String, handler: VimApi.(Char) -> Unit)` | Creates a modal input dialog with the given label and handler. The handler will be executed after the user enters a character. | None |
| `closeCurrentInput(refocusEditor: Boolean = true): Boolean` | Closes the current modal input dialog, if any. If refocusEditor is true, the editor will be refocused after closing the dialog. | True if a dialog was closed, false otherwise. |
## ListenerScope
The `ListenerScope` interface provides methods for registering callbacks for various events in the Vim editor, such as mode changes, yanking text, editor lifecycle events, and more.
### Methods
#### Mode and Action Listeners
| Method | Description | Return Value |
|-------------------------------------------------------------------------|-------------|--------------|
| `onModeChange(callback: suspend VimApi.(Mode) -> Unit)` | Registers a callback that is invoked when the editor mode changes (e.g., from Normal to Insert). | None |
| `onYank(callback: suspend VimApi.(Map<CaretId, Range.Simple>) -> Unit)` | Registers a callback that is invoked when text is yanked. The callback receives a map of caret IDs to yanked text ranges. | None |
#### Editor Lifecycle Listeners
| Method | Description | Return Value |
|----------------------------------------------------------|-------------|--------------|
| `onEditorCreate(callback: suspend VimApi.() -> Unit)` | Registers a callback that is invoked when a new editor is created. | None |
| `onEditorRelease(callback: suspend VimApi.() -> Unit)` | Registers a callback that is invoked when an editor is released (closed). | None |
| `onEditorFocusGain(callback: suspend VimApi.() -> Unit)` | Registers a callback that is invoked when an editor gains focus. | None |
| `onEditorFocusLost(callback: suspend VimApi.() -> Unit)` | Registers a callback that is invoked when an editor loses focus. | None |
#### Macro Recording Listeners
| Method | Description | Return Value |
|---------------------------------------------------------------|-------------|--------------|
| `onMacroRecordingStart(callback: suspend VimApi.() -> Unit)` | Registers a callback that is invoked when macro recording starts. | None |
| `onMacroRecordingFinish(callback: suspend VimApi.() -> Unit)` | Registers a callback that is invoked when macro recording finishes. | None |
#### Plugin State Listeners
| Method | Description | Return Value |
|----------------------------------------------------------|-------------|--------------|
| `onIdeaVimEnabled(callback: suspend VimApi.() -> Unit)` | Registers a callback that is invoked when IdeaVim is enabled. | None |
| `onIdeaVimDisabled(callback: suspend VimApi.() -> Unit)` | Registers a callback that is invoked when IdeaVim is disabled. | None |
## DigraphScope
The `DigraphScope` interface provides access to Vim's digraph functionality. Digraphs are special character combinations that produce a single character, often used for entering non-ASCII characters.
### Methods
| Method | Description | Return Value |
|--------|-------------|--------------|
| `getCharacter(ch1: Char, ch2: Char): Int` | Gets the character for a digraph. | The Unicode codepoint of the character represented by the digraph, or the codepoint of ch2 if no digraph is found. |
| `addDigraph(ch1: Char, ch2: Char, codepoint: Int)` | Adds a custom digraph. | None |
| `clearCustomDigraphs()` | Clears all custom digraphs. | None |
## CommandLineScope
The `CommandLineScope` class provides methods for interacting with the Vim command line. The command line is used for entering Ex commands, search patterns, and other input.
### Methods
| Method | Description | Return Value |
|------------------------------------------------------------------------------------|-------------|--------------|
| `input(prompt: String, finishOn: Char? = null, callback: VimApi.(String) -> Unit)` | Reads input from the command line and processes it with the provided function. | None |
| `read<T>(block: suspend CommandLineRead.() -> T): Deferred<T>` | Executes a block of code in the context of read operations on the command line. This allows for reading the command line state without modifying it. | A Deferred result of the block execution. |
| `change(block: suspend CommandLineTransaction.() -> Unit): Job` | Executes a block of code in the context of transaction operations on the command line. This allows for modifying the command line state. | A Job representing the asynchronous operation. |
## CommandLineRead
The `CommandLineRead` interface provides read-only access to the command line state. It includes properties for accessing the current text, caret position, and active state of the command line.
### Properties
| Property | Type | Description |
|----------|------|-------------|
| `text` | `String` | The text currently displayed in the command line. |
| `caretPosition` | `Int` | The current position of the caret in the command line. |
| `isActive` | `Boolean` | True if the command line is currently active, false otherwise. |
## CommandLineTransaction
The `CommandLineTransaction` interface provides methods for modifying the command line state. It includes operations for setting text, inserting text, setting the caret position, and closing the command line.
### Methods
| Method | Description | Return Value |
|--------|-------------|--------------|
| `setText(text: String)` | Sets the text content of the command line. This replaces any existing text in the command line with the provided text. | None |
| `insertText(offset: Int, text: String)` | Inserts text at the specified position in the command line. | None |
| `setCaretPosition(position: Int)` | Sets the caret position in the command line. | None |
| `close(refocusEditor: Boolean = true): Boolean` | Closes the command line. If refocusEditor is true, the editor will be refocused after closing the command line. | True if the command line was closed, false if it was not active. |

View File

@@ -0,0 +1,275 @@
# Tutorial: Creating an IdeaVim Plugin with the New API
> **⚠️ EXPERIMENTAL API WARNING**
>
> The Plugin API is currently in an **experimental stage** and is not yet recommended for production use.
>
> - The API is subject to breaking changes without notice
> - Features may be added, modified, or removed in future releases
> - Documentation may not fully reflect the current implementation
> - Use at your own risk for experimental purposes only
>
> We welcome feedback and bug reports to help improve the API, but please be aware that stability is not guaranteed at this time.
This tutorial will guide you through the process of creating a plugin for IdeaVim using the new API. We'll implement a "Replace with Register" plugin that allows you to replace text with the contents of a register.
## Table of Contents
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Project Setup](#project-setup)
- [Plugin Structure](#plugin-structure)
- [Implementing the Plugin](#implementing-the-plugin)
- [Step 1: Create the init function](#step-1-create-the-init-function)
- [Step 2: Define Mappings](#step-2-define-mappings)
- [Step 3: Implement Core Functionality](#step-3-implement-core-functionality)
- [Step 4: Handle Different Selection Types](#step-4-handle-different-selection-types)
- [Testing Your Plugin](#testing-your-plugin)
## Introduction
The "Replace with Register" plugin ([link](https://github.com/vim-scripts/ReplaceWithRegister) to the original Vim plugin) demonstrates several important concepts in IdeaVim plugin development:
- Creating custom mappings for different Vim modes
- Working with registers
- Manipulating text in the editor
- Handling different types of selections (character-wise, line-wise, block-wise)
- Creating operator functions
This tutorial will walk you through each part of the implementation, explaining the concepts and techniques used.
## Project Setup
1. Clone the IdeaVim repo. (Todo: update)
## Plugin Structure
IdeaVim plugins using the new API are typically structured as follows:
1. An `init` function that sets up mappings and functionality
2. Helper functions that implement specific features
Let's look at how to implement each part of our "Replace with Register" plugin.
## Implementing the Plugin
### Step 1: Create the init function
First, create a Kotlin file for your plugin:
```kotlin
@VimPlugin(name = "ReplaceWithRegister")
fun VimApi.init() {
// We'll add mappings and functionality here
}
```
The `init` function has a responsibility to set up our plugin within the `VimApi`.
### Step 2: Define Mappings
Now, let's add mappings to our plugin. We'll define three mappings:
1. `gr` + motion: Replace the text covered by a motion with register contents
2. `grr`: Replace the current line with register contents
3. `gr` in visual mode: Replace the selected text with register contents
Add this code to the `init` function:
```kotlin
@VimPlugin(name = "ReplaceWithRegister", shortPath = "username/ReplaceWithRegister")
fun VimApi.init() {
mappings {
nmap(keys = "gr", label = "ReplaceWithRegisterOperator", isRepeatable = true) {
rewriteMotion()
}
nmap(keys = "grr", label = "ReplaceWithRegisterLine", isRepeatable = true) {
rewriteLine()
}
vmap(keys = "gr", label = "ReplaceWithRegisterVisual", isRepeatable = true) {
rewriteVisual()
}
}
exportOperatorFunction("ReplaceWithRegisterOperatorFunc") {
operatorFunction()
}
}
```
Let's break down what's happening:
- The `mappings` block gives us access to the `MappingScope`
- `nmap` defines a normal mode mapping, `vmap` defines a visual mode mapping
- Each mapping has:
- `keys`: The key sequence to trigger the mapping
- `label`: A unique identifier for the mapping
- `isRepeatable`: Whether the mapping can be repeated with the `.` command
- The lambda for each mapping calls a function that we'll implement next
- `exportOperatorFunction` registers a function that will be called when the operator is used with a motion
### Step 3: Implement Core Functionality
Now, let's implement the functions we referenced in our mappings:
```kotlin
private fun VimApi.rewriteMotion() {
setOperatorFunction("ReplaceWithRegisterOperatorFunc")
normal("g@")
}
private suspend fun VimApi.rewriteLine() {
val count1 = getVariable<Int>("v:count1") ?: 1
val job: Job
editor {
job = change {
forEachCaret {
val endOffset = getLineEndOffset(line.number + count1 - 1, true)
val lineStartOffset = line.start
val registerData = prepareRegisterData() ?: return@forEachCaret
replaceText(lineStartOffset, endOffset, registerData.first)
updateCaret(offset = lineStartOffset)
}
}
}
job.join()
}
private suspend fun VimApi.rewriteVisual() {
val job: Job
editor {
job = change {
forEachCaret {
val selectionRange = selection
val registerData = prepareRegisterData() ?: return@forEachCaret
replaceTextAndUpdateCaret(this@rewriteVisual, selectionRange, registerData)
}
}
}
job.join()
mode = Mode.NORMAL()
}
private suspend fun VimApi.operatorFunction(): Boolean {
fun CaretTransaction.getSelection(): Range? {
return when (this@operatorFunction.mode) {
is Mode.NORMAL -> changeMarks
is Mode.VISUAL -> selection
else -> null
}
}
val job: Job
editor {
job = change {
forEachCaret {
val selectionRange = getSelection() ?: return@forEachCaret
val registerData = prepareRegisterData() ?: return@forEachCaret
replaceTextAndUpdateCaret(this@operatorFunction, selectionRange, registerData)
}
}
}
job.join()
return true
}
```
Let's examine each function:
- `rewriteMotion()`: Sets up an operator function and triggers it with `g@`
- `rewriteLine()`: Replaces one or more lines with register contents
- `rewriteVisual()`: Replaces the visual selection with register contents
- `operatorFunction()`: Implements the operator function
Notice the use of scopes:
- `editor { }` gives us access to the editor
- `change { }` creates a transaction for modifying text
- `forEachCaret { }` iterates over all carets (useful for multi-cursor editing)
### Step 4: Handle Different Selection Types
Now, let's implement the helper functions that prepare register data and handle different types of selections:
```kotlin
private suspend fun CaretTransaction.prepareRegisterData(): Pair<String, TextType>? {
val lastRegisterName: Char = lastSelectedReg
var registerText: String = getReg(lastRegisterName) ?: return null
var registerType: TextType = getRegType(lastRegisterName) ?: return null
if (registerType.isLine && registerText.endsWith("\n")) {
registerText = registerText.removeSuffix("\n")
registerType = TextType.CHARACTER_WISE
}
return registerText to registerType
}
private suspend fun CaretTransaction.replaceTextAndUpdateCaret(
vimApi: VimApi,
selectionRange: Range,
registerData: Pair<String, TextType>,
) {
val (text, registerType) = registerData
if (registerType == TextType.BLOCK_WISE) {
val lines = text.lines()
if (selectionRange is Range.Simple) {
val startOffset = selectionRange.start
val endOffset = selectionRange.end
val startLine = getLine(startOffset)
val diff = startOffset - startLine.start
lines.forEachIndexed { index, lineText ->
val offset = getLineStartOffset(startLine.number + index) + diff
if (index == 0) {
replaceText(offset, endOffset, lineText)
} else {
insertText(offset, lineText)
}
}
updateCaret(offset = startOffset)
} else if (selectionRange is Range.Block) {
val selections: Array<Range.Simple> = selectionRange.ranges
selections.zip(lines).forEach { (range, lineText) ->
replaceText(range.start, range.end, lineText)
}
}
} else {
if (selectionRange is Range.Simple) {
val textLength = this.text.length
if (textLength == 0) {
insertText(0, text)
} else {
replaceText(selectionRange.start, selectionRange.end, text)
}
} else if (selectionRange is Range.Block) {
val selections: Array<Range.Simple> = selectionRange.ranges.sortedByDescending { it.start }.toTypedArray()
val lines = List(selections.size) { text }
replaceTextBlockwise(selectionRange, lines)
vimApi.mode = Mode.NORMAL()
updateCaret(offset = selections.last().start)
}
}
}
```
These functions handle:
1. `prepareRegisterData()`: Gets the content and type of the last used register
2. `replaceTextAndUpdateCaret()`: Handles the replacement logic for different types of selections and register contents
## Testing Your Plugin
For the "Replace with Register" plugin, you can test it by:
1. Yanking some text with `y`
2. Moving to different text and using `gr` followed by a motion
3. Selecting text in visual mode and using `gr`
4. Using `grr` to replace a whole line
For more information, check out the [API Reference](Plugin-API-reference.md) and the [Quick Start Guide](Plugin-API-quick-start-guide.md).

View File

@@ -16,11 +16,11 @@
# https://data.services.jetbrains.com/products?code=IC
# Maven releases are here: https://www.jetbrains.com/intellij-repository/releases
# And snapshots: https://www.jetbrains.com/intellij-repository/snapshots
ideaVersion=2024.3
ideaVersion=2025.1
# Values for type: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#intellij-extension-type
ideaType=IC
instrumentPluginCode=true
version=chylex-44
version=chylex-52
javaVersion=21
remoteRobotVersion=0.11.23
antlrVersion=4.10.1
@@ -28,7 +28,7 @@ antlrVersion=4.10.1
# Please don't forget to update kotlin version in buildscript section
# Also update kotlinxSerializationVersion version
kotlinVersion=2.0.21
kotlinVersion=2.2.0
publishToken=token
publishChannels=eap

View File

@@ -1,6 +1,6 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME

3
gradlew vendored
View File

@@ -86,8 +86,7 @@ done
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
' "$PWD" ) || exit
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum

View File

@@ -20,27 +20,25 @@ repositories {
}
dependencies {
compileOnly("org.jetbrains.kotlin:kotlin-stdlib:2.1.10")
compileOnly("org.jetbrains.kotlin:kotlin-stdlib:2.2.20")
implementation("io.ktor:ktor-client-core:3.1.1")
implementation("io.ktor:ktor-client-cio:3.1.1")
implementation("io.ktor:ktor-client-content-negotiation:3.1.1")
implementation("io.ktor:ktor-serialization-kotlinx-json:3.1.1")
implementation("io.ktor:ktor-client-auth:3.1.1")
implementation("io.ktor:ktor-client-core:3.3.0")
implementation("io.ktor:ktor-client-cio:3.3.0")
implementation("io.ktor:ktor-client-content-negotiation:3.3.0")
implementation("io.ktor:ktor-serialization-kotlinx-json:3.3.0")
implementation("io.ktor:ktor-client-auth:3.3.0")
implementation("org.eclipse.jgit:org.eclipse.jgit:6.6.0.202305301015-r")
// This is needed for jgit to connect to ssh
implementation("org.eclipse.jgit:org.eclipse.jgit.ssh.apache:7.1.0.202411261347-r")
implementation("org.eclipse.jgit:org.eclipse.jgit.ssh.apache:7.3.0.202506031305-r")
implementation("com.vdurmont:semver4j:3.1.0")
}
val releaseType: String? by project
tasks {
compileKotlin {
kotlinOptions {
freeCompilerArgs = listOf("-Xjvm-default=all-compatibility")
}
kotlin {
compilerOptions {
freeCompilerArgs = listOf("-Xjvm-default=all-compatibility")
}
}

View File

@@ -43,6 +43,14 @@ val knownPlugins = setOf(
"com.julienphalip.ideavim.peekaboo", // https://plugins.jetbrains.com/plugin/25776-vim-peekaboo
"com.julienphalip.ideavim.switch", // https://plugins.jetbrains.com/plugin/25899-vim-switch
"com.julienphalip.ideavim.functiontextobj", // https://plugins.jetbrains.com/plugin/25897-vim-functiontextobj
"com.miksuki.HighlightCursor", // https://plugins.jetbrains.com/plugin/26743-highlightcursor
"com.ugarosa.idea.edgemotion", // https://plugins.jetbrains.com/plugin/27211-edgemotion
"cn.mumukehao.plugin",
"com.magidc.ideavim.anyObject",
"dev.ghostflyby.ideavim.toggleIME",
"com.magidc.ideavim.dial",
)
suspend fun main() {

View File

@@ -19,4 +19,5 @@ include("tests:long-running-tests")
include("tests:ui-ij-tests")
include("tests:ui-py-tests")
include("tests:ui-fixtures")
include("api")
include("tests:ui-rd-tests")

View File

@@ -37,6 +37,7 @@ import com.maddyhome.idea.vim.helper.MacKeyRepeat;
import com.maddyhome.idea.vim.listener.VimListenerManager;
import com.maddyhome.idea.vim.newapi.IjVimInjectorKt;
import com.maddyhome.idea.vim.newapi.IjVimSearchGroup;
import com.maddyhome.idea.vim.thinapi.IjPluginExtensionsScanner;
import com.maddyhome.idea.vim.ui.StatusBarIconFactory;
import com.maddyhome.idea.vim.vimscript.services.VariableService;
import com.maddyhome.idea.vim.yank.YankGroupBase;
@@ -330,6 +331,12 @@ public class VimPlugin implements PersistentStateComponent<Element>, Disposable
// 2.2) Register extensions
VimExtensionRegistrar.registerExtensions();
// 2.2.1) Register extensions with new API
//VimInjectorKt.getInjector().getJsonExtensionProvider().init();
//VimInjectorKt.getInjector()
// .getJsonExtensionProvider()
// .addExtensions(IjPluginExtensionsScanner.Companion.instance().scanAllPlugins());
// 2.3) Register functions
VimInjectorKt.getInjector().getFunctionService().registerHandlers();
@@ -355,7 +362,12 @@ public class VimPlugin implements PersistentStateComponent<Element>, Disposable
if (unsubscribe) {
VimListenerManager.INSTANCE.turnOff();
}
injector.getCommandLine().fullReset();
// Use getServiceIfCreated to avoid creating the service during the dispose (this is prohibited by the platform)
@Nullable VimCommandLineService service =
ApplicationManager.getApplication().getServiceIfCreated(VimCommandLineService.class);
if (service != null) {
service.fullReset();
}
// Unregister vim actions in command mode
RegisterActions.unregisterActions();
@@ -371,8 +383,7 @@ public class VimPlugin implements PersistentStateComponent<Element>, Disposable
if (isEnabled() && !ApplicationManager.getApplication().isUnitTestMode()) {
stateUpdated = true;
if (SystemInfo.isMac) {
final MacKeyRepeat keyRepeat = MacKeyRepeat.getInstance();
final Boolean enabled = keyRepeat.isEnabled();
final Boolean enabled = MacKeyRepeat.INSTANCE.isEnabled();
final Boolean isKeyRepeat = getEditor().isKeyRepeat();
if ((enabled == null || !enabled) && (isKeyRepeat == null || isKeyRepeat)) {
// This system property is used in IJ ui robot to hide the startup tips
@@ -382,7 +393,7 @@ public class VimPlugin implements PersistentStateComponent<Element>, Disposable
if (showNotification) {
if (VimPlugin.getNotifications().enableRepeatingMode() == Messages.YES) {
getEditor().setKeyRepeat(true);
keyRepeat.setEnabled(true);
MacKeyRepeat.INSTANCE.setEnabled(true);
}
else {
getEditor().setKeyRepeat(false);

View File

@@ -18,7 +18,7 @@ import com.maddyhome.idea.vim.ui.ex.ExEntryPanel
internal class VimProjectService(val project: Project) : Disposable {
override fun dispose() {
// Not sure if this is a best solution
ExEntryPanel.getInstance().setEditor(null)
ExEntryPanel.instance?.setEditor(null)
}
companion object {

View File

@@ -88,7 +88,7 @@ class VimTypedActionHandler(origHandler: TypedActionHandler) : TypedActionHandle
LOG.info("VimTypedAction '$charTyped': $duration ms")
}
} catch (e: ProcessCanceledException) {
// Nothing
throw e
} catch (e: Throwable) {
LOG.error(e)
}

View File

@@ -1,52 +0,0 @@
package com.maddyhome.idea.vim.action
import com.intellij.openapi.actionSystem.ActionUpdateThread
import com.intellij.openapi.actionSystem.AnActionEvent
import com.intellij.openapi.command.UndoConfirmationPolicy
import com.intellij.openapi.command.WriteCommandAction
import com.intellij.openapi.fileEditor.TextEditor
import com.intellij.openapi.fileEditor.ex.FileEditorManagerEx
import com.intellij.openapi.project.DumbAwareAction
import com.maddyhome.idea.vim.KeyHandler
import com.maddyhome.idea.vim.api.injector
import com.maddyhome.idea.vim.newapi.IjEditorExecutionContext
import com.maddyhome.idea.vim.newapi.vim
import com.maddyhome.idea.vim.state.mode.Mode
class VimRunLastMacroInOpenFiles : DumbAwareAction() {
override fun update(e: AnActionEvent) {
val lastRegister = injector.macro.lastRegister
val isEnabled = lastRegister != 0.toChar()
e.presentation.isEnabled = isEnabled
e.presentation.text = if (isEnabled) "Run Macro '${lastRegister}' in Open Files" else "Run Last Macro in Open Files"
}
override fun getActionUpdateThread(): ActionUpdateThread {
return ActionUpdateThread.EDT
}
override fun actionPerformed(e: AnActionEvent) {
val project = e.project ?: return
val fileEditorManager = FileEditorManagerEx.getInstanceExIfCreated(project) ?: return
val editors = fileEditorManager.allEditors.filterIsInstance<TextEditor>()
WriteCommandAction.writeCommandAction(project)
.withName(e.presentation.text)
.withGlobalUndo()
.withUndoConfirmationPolicy(UndoConfirmationPolicy.REQUEST_CONFIRMATION)
.run<RuntimeException> {
val reg = injector.macro.lastRegister
for (editor in editors) {
fileEditorManager.openFile(editor.file, true)
val vimEditor = editor.editor.vim
vimEditor.mode = Mode.NORMAL()
KeyHandler.getInstance().reset(vimEditor)
injector.macro.playbackRegister(vimEditor, IjEditorExecutionContext(e.dataContext), reg, 1)
}
}
}
}

View File

@@ -35,11 +35,9 @@ import com.maddyhome.idea.vim.handler.enableOctopus
import com.maddyhome.idea.vim.handler.isOctopusEnabled
import com.maddyhome.idea.vim.helper.EditorHelper
import com.maddyhome.idea.vim.helper.HandlerInjector
import com.maddyhome.idea.vim.helper.inInsertMode
import com.maddyhome.idea.vim.helper.inNormalMode
import com.maddyhome.idea.vim.helper.isIdeaVimDisabledHere
import com.maddyhome.idea.vim.helper.isPrimaryEditor
import com.maddyhome.idea.vim.helper.isTemplateActive
import com.maddyhome.idea.vim.helper.updateCaretsVisualAttributes
import com.maddyhome.idea.vim.key.ShortcutOwner
import com.maddyhome.idea.vim.key.ShortcutOwnerInfo
@@ -59,11 +57,8 @@ import javax.swing.KeyStroke
*
*
* These keys are not passed to [com.maddyhome.idea.vim.VimTypedActionHandler] and should be handled by actions.
*
* This class is used in Which-Key plugin, so don't make it internal. Generally, we should provide a proper
* way to get ideavim keys for this plugin. See VIM-3085
*/
class VimShortcutKeyAction : AnAction(), DumbAware/*, LightEditCompatible*/ {
internal class VimShortcutKeyAction : AnAction(), DumbAware/*, LightEditCompatible*/ {
init {
initInjector()
@@ -92,9 +87,10 @@ class VimShortcutKeyAction : AnAction(), DumbAware/*, LightEditCompatible*/ {
val duration = System.currentTimeMillis() - start
LOG.info("VimShortcut execution '$keyStroke': $duration ms")
}
} catch (_: ProcessCanceledException) {
// Control-flow exceptions (like ProcessCanceledException) should never be logged
} catch (e: ProcessCanceledException) {
// Control-flow exceptions (like ProcessCanceledException) should never be logged and should be rethrown
// See {@link com.intellij.openapi.diagnostic.Logger.checkException}
throw e
} catch (throwable: Throwable) {
LOG.error(throwable)
}
@@ -177,33 +173,6 @@ class VimShortcutKeyAction : AnAction(), DumbAware/*, LightEditCompatible*/ {
}
}
if (keyCode == KeyEvent.VK_TAB && editor.isTemplateActive()) {
return ActionEnableStatus.no("The key is tab and the template is active", LogLevel.INFO)
}
if (editor.inInsertMode) {
if (keyCode == KeyEvent.VK_TAB) {
// TODO: This stops VimEditorTab seeing <Tab> in insert mode and correctly scrolling the view
// There are multiple actions registered for VK_TAB. The important items, in order, are this, the Live
// Templates action and TabAction. Returning false in insert mode means that the Live Template action gets to
// execute, and this allows Emmet to work (VIM-674). But it also means that the VimEditorTab handle is never
// called, so we can't scroll the caret into view correctly.
// If we do return true, VimEditorTab handles the Vim side of things and then invokes
// IdeActions.ACTION_EDITOR_TAB, which inserts the tab. It also bypasses the Live Template action, and Emmet
// no longer works.
// This flag is used when recording text entry/keystrokes for repeated insertion. Because we return false and
// don't execute the VimEditorTab handler, we don't record tab as an action. Instead, we see an incoming text
// change of multiple whitespace characters, which is normally ignored because it's auto-indent content from
// hitting <Enter>. When this flag is set, we record the whitespace as the output of the <Tab>
VimPlugin.getChange().tabAction = true
return ActionEnableStatus.no("Tab action in insert mode", LogLevel.INFO)
}
// Debug watch, Python console, etc.
if (keyStroke in NON_FILE_EDITOR_KEYS && !EditorHelper.isFileEditor(editor)) {
return ActionEnableStatus.no("Non file editor keys", LogLevel.INFO)
}
}
if (keyStroke in VIM_ONLY_EDITOR_KEYS) {
return ActionEnableStatus.yes("Vim only editor keys", LogLevel.INFO)
}
@@ -271,7 +240,7 @@ class VimShortcutKeyAction : AnAction(), DumbAware/*, LightEditCompatible*/ {
private fun getEditor(e: AnActionEvent): Editor? {
return e.getData(PlatformDataKeys.EDITOR)
?: if (e.getData(PlatformDataKeys.CONTEXT_COMPONENT) is ExTextField) {
ExEntryPanel.getInstance().ijEditor
ExEntryPanel.getOrCreatePanelInstance().ijEditor
} else {
null
}
@@ -292,7 +261,7 @@ class VimShortcutKeyAction : AnAction(), DumbAware/*, LightEditCompatible*/ {
return keyStroke !in parsedLookupKeys
}
private fun parseLookupKeys(value: VimString) = IjOptions.lookupkeys.split(value.asString())
private fun parseLookupKeys(keys: VimString) = IjOptions.lookupkeys.split(keys.value)
.map { injector.parser.parseKeys(it) }
.filter { it.isNotEmpty() }
.map { it.first() }
@@ -349,14 +318,6 @@ class VimShortcutKeyAction : AnAction(), DumbAware/*, LightEditCompatible*/ {
private const val ACTION_ID = "VimShortcutKeyAction"
private val NON_FILE_EDITOR_KEYS: Set<KeyStroke> = ImmutableSet.builder<KeyStroke>()
.addAll(getKeyStrokes(KeyEvent.VK_ENTER, 0))
.addAll(getKeyStrokes(KeyEvent.VK_ESCAPE, 0))
.addAll(getKeyStrokes(KeyEvent.VK_TAB, 0))
.addAll(getKeyStrokes(KeyEvent.VK_UP, 0))
.addAll(getKeyStrokes(KeyEvent.VK_DOWN, 0))
.build()
private val LOG = logger<VimShortcutKeyAction>()
@JvmStatic

View File

@@ -10,7 +10,6 @@ package com.maddyhome.idea.vim.action.change
import com.intellij.vim.annotations.CommandOrMotion
import com.intellij.vim.annotations.Mode
import com.maddyhome.idea.vim.KeyHandler
import com.maddyhome.idea.vim.VimPlugin
import com.maddyhome.idea.vim.api.ExecutionContext
import com.maddyhome.idea.vim.api.VimCaret
import com.maddyhome.idea.vim.api.VimEditor
@@ -27,7 +26,6 @@ import com.maddyhome.idea.vim.group.MotionGroup
import com.maddyhome.idea.vim.group.visual.VimSelection
import com.maddyhome.idea.vim.handler.VimActionHandler
import com.maddyhome.idea.vim.handler.VisualOperatorActionHandler
import com.maddyhome.idea.vim.helper.MessageHelper
import com.maddyhome.idea.vim.helper.inRepeatMode
import com.maddyhome.idea.vim.newapi.ij
import com.maddyhome.idea.vim.state.mode.SelectionType
@@ -45,7 +43,7 @@ private fun doOperatorAction(
): Boolean {
val func = injector.globalOptions().operatorfunc
if (func.isEmpty()) {
VimPlugin.showMessage(MessageHelper.message("E774"))
injector.messages.showStatusBarMessage(editor, injector.messages.message("E774"))
return false
}
@@ -63,21 +61,21 @@ private fun doOperatorAction(
handler = value.handler
}
} catch (_: ExException) {
// Get the argument for function('...') or funcref('...') for the error message
// Get the argument for function(...) or funcref(...) for the error message
val functionName = if (expression is FunctionCallExpression && expression.arguments.isNotEmpty()) {
expression.arguments[0].evaluate(editor, context, scriptContext).toString()
expression.arguments[0].evaluate(editor, context, scriptContext).toOutputString()
} else {
func
}
VimPlugin.showMessage("E117: Unknown function: $functionName")
injector.messages.showStatusBarMessage(editor, injector.messages.message("E117", functionName))
return false
}
}
}
if (handler == null) {
VimPlugin.showMessage("E117: Unknown function: $func")
injector.messages.showStatusBarMessage(editor, injector.messages.message("E117", func))
return false
}

View File

@@ -9,8 +9,10 @@
package com.maddyhome.idea.vim.action.editor
import com.intellij.openapi.actionSystem.IdeActions
import com.intellij.openapi.editor.actions.TabAction
import com.intellij.vim.annotations.CommandOrMotion
import com.intellij.vim.annotations.Mode
import com.maddyhome.idea.vim.action.VimShortcutKeyAction
import com.maddyhome.idea.vim.api.ExecutionContext
import com.maddyhome.idea.vim.api.VimEditor
import com.maddyhome.idea.vim.api.injector
@@ -20,6 +22,7 @@ import com.maddyhome.idea.vim.command.OperatorArguments
import com.maddyhome.idea.vim.handler.IdeActionHandler
import com.maddyhome.idea.vim.handler.VimActionHandler
import com.maddyhome.idea.vim.helper.enumSetOf
import com.maddyhome.idea.vim.key.VimActionsPromoter
import com.maddyhome.idea.vim.undo.VimKeyBasedUndoService
import com.maddyhome.idea.vim.undo.VimTimestampBasedUndoService
import java.util.*
@@ -52,6 +55,27 @@ internal class VimEditorDown : IdeActionHandler(IdeActions.ACTION_EDITOR_MOVE_CA
}
}
/**
* Invoke the IDE's "EditorTab" action
*
* Insert mode handler for `<Tab>` and `<C-I>`. This will invoke the IDE's "EditorTab" action, which will insert the
* tab or the appropriate number of spaces.
*
* Note that `Tab` has special handling in [VimActionsPromoter]. Typically, the promoter makes sure that
* [VimShortcutKeyAction] is the first action to be evaluated and potentially invoked. However, when the list of
* possible actions for the shortcut includes [TabAction], the promoter will actually demote [VimShortcutKeyAction] so
* that it is invoked almost last, second only to [TabAction]. This means the user has the chance to invoke context
* specific IDE `Tab` actions without the Vim commands interfering, e.g., accepting LLM output, Next Edit Suggestions,
* expanding Live Templates, etc.
*
* In Normal mode, the Vim handler for `Tab` will not insert a tab but move around the jump list. In Insert mode (below)
* it invokes "EditorTab" and inserts the text. In both cases, [VimShortcutKeyAction] handles the shortcut and the
* default [TabAction] is not involved. The benefit of this is that we can now map `<Tab>` in both Normal and Insert
* modes.
*
* Also, by inserting `Tab` with our action, we will correctly update the scroll position to keep the caret visible,
* applying `'scrolloff'` and `'sidescrolloff'`.
*/
@CommandOrMotion(keys = ["<Tab>", "<C-I>"], modes = [Mode.INSERT])
internal class VimEditorTab : IdeActionHandler(IdeActions.ACTION_EDITOR_TAB) {
override val type: Command.Type = Command.Type.INSERT

View File

@@ -0,0 +1,67 @@
package com.maddyhome.idea.vim.action.macro
import com.intellij.openapi.command.CommandProcessor
import com.intellij.openapi.command.UndoConfirmationPolicy
import com.intellij.openapi.command.impl.FinishMarkAction
import com.intellij.openapi.command.impl.StartMarkAction
import com.intellij.openapi.fileEditor.TextEditor
import com.intellij.openapi.fileEditor.ex.FileEditorManagerEx
import com.intellij.vim.annotations.CommandOrMotion
import com.intellij.vim.annotations.Mode
import com.maddyhome.idea.vim.KeyHandler
import com.maddyhome.idea.vim.api.ExecutionContext
import com.maddyhome.idea.vim.api.VimEditor
import com.maddyhome.idea.vim.api.injector
import com.maddyhome.idea.vim.command.Argument
import com.maddyhome.idea.vim.command.Command
import com.maddyhome.idea.vim.command.OperatorArguments
import com.maddyhome.idea.vim.handler.VimActionHandler
import com.maddyhome.idea.vim.newapi.ij
import com.maddyhome.idea.vim.newapi.vim
@CommandOrMotion(keys = ["z@"], modes = [Mode.NORMAL])
class PlaybackRegisterInOpenFilesAction : VimActionHandler.SingleExecution() {
override val type: Command.Type = Command.Type.OTHER_SELF_SYNCHRONIZED
override val argumentType: Argument.Type = Argument.Type.CHARACTER
private val playbackRegisterAction = PlaybackRegisterAction()
override fun execute(
editor: VimEditor,
context: ExecutionContext,
cmd: Command,
operatorArguments: OperatorArguments,
): Boolean {
val argument = cmd.argument as? Argument.Character ?: return false
val project = editor.ij.project ?: return false
val fileEditorManager = FileEditorManagerEx.getInstanceExIfCreated(project) ?: return false
val register = argument.character.let { if (it == '@') injector.macro.lastRegister else it }
val commandName = "Execute Macro '$register' in All Open Files"
val action = Runnable {
CommandProcessor.getInstance().markCurrentCommandAsGlobal(project)
for (textEditor in fileEditorManager.allEditors.filterIsInstance<TextEditor>()) {
fileEditorManager.openFile(textEditor.file, true)
val editor = textEditor.editor
val vimEditor = editor.vim
vimEditor.mode = com.maddyhome.idea.vim.state.mode.Mode.NORMAL()
KeyHandler.Companion.getInstance().reset(vimEditor)
val startMarkAction = StartMarkAction.start(editor, project, commandName)
playbackRegisterAction.execute(vimEditor, context, cmd, operatorArguments)
FinishMarkAction.finish(project, editor, startMarkAction)
}
}
CommandProcessor.getInstance()
.executeCommand(project, action, commandName, null, UndoConfirmationPolicy.REQUEST_CONFIRMATION)
return true
}
}

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2003-2023 The IdeaVim authors
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
@@ -14,10 +14,6 @@ import com.maddyhome.idea.vim.api.injector
import com.maddyhome.idea.vim.state.VimStateMachine
import org.jetbrains.annotations.ApiStatus
/**
* COMPATIBILITY-LAYER: Additional class
* Please see: https://jb.gg/zo8n0r
*/
@Deprecated("Use `injector.vimState`")
@ApiStatus.ScheduledForRemoval
class CommandState(private val machine: VimStateMachine) {

View File

@@ -11,16 +11,17 @@ package com.maddyhome.idea.vim.customization.feature.terminal
import com.intellij.openapi.editor.Editor
import com.maddyhome.idea.vim.key.IdeaVimDisablerExtensionPoint
import org.jetbrains.plugins.terminal.block.util.TerminalDataContextUtils.isAlternateBufferEditor
import org.jetbrains.plugins.terminal.block.util.TerminalDataContextUtils.isAlternateBufferModelEditor
import org.jetbrains.plugins.terminal.block.util.TerminalDataContextUtils.isOutputEditor
import org.jetbrains.plugins.terminal.block.util.TerminalDataContextUtils.isOutputModelEditor
import org.jetbrains.plugins.terminal.block.util.TerminalDataContextUtils.isPromptEditor
/**
* The only implementation is defined right here.
*/
// [VERSION UPDATE] 2025.1+ Add 2 new predicates
internal class IdeaVimTerminalDisablerExtension : IdeaVimDisablerExtensionPoint {
override fun isDisabledForEditor(editor: Editor): Boolean {
return editor.isPromptEditor || editor.isOutputEditor || editor.isAlternateBufferEditor
// || editor.isOutputModelEditor || editor.isAlternateBufferModelEditor
|| editor.isOutputModelEditor || editor.isAlternateBufferModelEditor
}
}

View File

@@ -67,6 +67,14 @@ class ExOutputModel(private val myEditor: WeakReference<Editor>) : VimOutputPane
panel.scrollLine()
}
override fun setContent(text: String) {
this.text = text
}
override fun clearText() {
text = ""
}
override var text: String = ""
get() = if (!ApplicationManager.getApplication().isUnitTestMode) {
editor?.let { ExOutputPanel.getInstance(it).text } ?: ""
@@ -79,7 +87,7 @@ class ExOutputModel(private val myEditor: WeakReference<Editor>) : VimOutputPane
// never pass null to ExOutputPanel, but we do store it for tests, so we know if we're active or not
val newValue = value.removeSuffix("\n")
if (!ApplicationManager.getApplication().isUnitTestMode) {
editor?.let { ExOutputPanel.getInstance(it).setText(newValue) }
editor?.let { ExOutputPanel.getInstance(it).text = newValue }
} else {
field = newValue
isActiveInTestMode = newValue.isNotEmpty()
@@ -109,7 +117,7 @@ class ExOutputModel(private val myEditor: WeakReference<Editor>) : VimOutputPane
get() {
val notNullEditor = editor ?: return false
val panel = ExOutputPanel.getNullablePanel(notNullEditor) ?: return false
return panel.isAtEnd()
return panel.isAtEnd
}
override fun onBadKey() {

View File

@@ -0,0 +1,118 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.maddyhome.idea.vim.extension
import com.intellij.openapi.Disposable
import com.intellij.openapi.actionSystem.AnActionEvent
import com.intellij.openapi.actionSystem.CustomShortcutSet
import com.intellij.openapi.actionSystem.KeyboardShortcut
import com.intellij.openapi.actionSystem.ShortcutSet
import com.intellij.openapi.project.DumbAwareAction
import com.intellij.ui.KeyStrokeAdapter
import com.maddyhome.idea.vim.api.injector
import com.maddyhome.idea.vim.key.KeyStrokeTrie
import java.awt.event.KeyEvent
import javax.swing.JComponent
import javax.swing.KeyStroke
internal open class ShortcutDispatcher<T>(
name: String,
data: Map<List<KeyStroke>, T>,
private val listener: Listener<T>,
) : DumbAwareAction() {
interface Listener<T> {
fun onMatch(e: AnActionEvent, keyStrokes: MutableList<KeyStroke>, data: T) {}
fun onInvalid(e: AnActionEvent, keyStrokes: MutableList<KeyStroke>) {}
fun onKey(e: AnActionEvent, keyStrokes: MutableList<KeyStroke>, entries: Sequence<KeyStrokeTrie.TrieNode<T>>) {}
}
constructor(
name: String,
data: Map<String, T>,
onMatch: (T) -> Unit,
onInvalid: () -> Unit,
onKey: (Sequence<KeyStrokeTrie.TrieNode<T>>) -> Unit,
) : this(name, data.mapKeys { injector.parser.parseKeys(it.key) }.toMap(), object : Listener<T> {
override fun onMatch(e: AnActionEvent, keyStrokes: MutableList<KeyStroke>, data: T) = onMatch(data)
override fun onInvalid(e: AnActionEvent, keyStrokes: MutableList<KeyStroke>) = onInvalid()
override fun onKey(
e: AnActionEvent,
keyStrokes: MutableList<KeyStroke>,
entries: Sequence<KeyStrokeTrie.TrieNode<T>>,
) = onKey(entries)
})
protected val trie = KeyStrokeTrie<T>(name)
private val shortcutSet: ShortcutSet
init {
val keys: MutableList<KeyStroke> = mutableListOf()
for ((k, v) in data) {
keys.addAll(k)
trie.add(k, v)
}
val shortcuts = keys.map { KeyboardShortcut(it, null) }
shortcutSet = CustomShortcutSet(*shortcuts.toTypedArray())
}
protected val keyStrokes: MutableList<KeyStroke> = mutableListOf()
final override fun actionPerformed(e: AnActionEvent) {
var keyStroke = getKeyStroke(e) ?: return
// Omit the modifier (shift) from keyStroke
keyStroke.keyChar.let {
if (it != KeyEvent.CHAR_UNDEFINED) {
keyStroke = KeyStroke.getKeyStroke(it)
}
}
keyStrokes.add(keyStroke)
listener.onKey(e, keyStrokes, trie.getEntries(keyStrokes))
trie.getData(keyStrokes)?.let {
listener.onMatch(e, keyStrokes, it)
return
}
if (!trie.isPrefix(keyStrokes)) {
listener.onInvalid(e, keyStrokes)
}
}
fun register(component: JComponent?) = registerCustomShortcutSet(shortcutSet, component)
fun register(component: JComponent?, parentDisposable: Disposable?) =
registerCustomShortcutSet(shortcutSet, component, parentDisposable)
/**
* getDefaultKeyStroke is needed for NEO layout keyboard VIM-987
* but we should cache the value because on the second call (isEnabled -> actionPerformed)
* the event is already consumed
*
* @author Alex Plate
*/
private var keyStrokeCache: Pair<KeyEvent?, KeyStroke?> = null to null
/**
* @author Alex Plate
*/
private fun getKeyStroke(e: AnActionEvent): KeyStroke? {
val inputEvent = e.inputEvent
if (inputEvent is KeyEvent) {
val defaultKeyStroke = KeyStrokeAdapter.getDefaultKeyStroke(inputEvent)
val strokeCache = keyStrokeCache
if (defaultKeyStroke != null) {
keyStrokeCache = inputEvent to defaultKeyStroke
return defaultKeyStroke
} else if (strokeCache.first === inputEvent) {
keyStrokeCache = null to null
return strokeCache.second
}
return KeyStroke.getKeyStrokeForEvent(inputEvent)
}
return null
}
}

View File

@@ -0,0 +1,19 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.maddyhome.idea.vim.extension
import com.intellij.vim.api.VimApi
import com.maddyhome.idea.vim.common.ListenerOwner
import com.maddyhome.idea.vim.key.MappingOwner
import com.maddyhome.idea.vim.thinapi.VimApiImpl
internal fun VimExtension.api(): VimApi = VimApiImpl(
ListenerOwner.Plugin.get(this.name),
MappingOwner.Plugin.get(this.name),
)

View File

@@ -146,7 +146,7 @@ object VimExtensionFacade {
fun executeNormalWithoutMapping(keys: List<KeyStroke>, editor: Editor) {
val context = injector.executionContextManager.getEditorExecutionContext(editor.vim)
val keyHandler = KeyHandler.getInstance()
keys.forEach { keyHandler.handleKey(editor.vim, it, context, false, false, keyHandler.keyHandlerState) }
keys.forEach { keyHandler.handleKey(editor.vim, it, context, false, keyHandler.keyHandlerState) }
}
/** Returns a single key stroke from the user input similar to 'getchar()'. */
@@ -214,7 +214,13 @@ object VimExtensionFacade {
/** Set the current contents of the given register */
@JvmStatic
fun setRegisterForCaret(register: Char, caret: ImmutableVimCaret, keys: List<KeyStroke?>?) {
fun setRegisterForCaret(
editor: VimEditor,
context: ExecutionContext,
register: Char,
caret: ImmutableVimCaret,
keys: List<KeyStroke?>?,
) {
caret.registerStorage.setKeys(register, keys?.filterNotNull() ?: emptyList())
}
@@ -264,7 +270,7 @@ object VimExtensionFacade {
fun VimExtensionFacade.exportOperatorFunction(name: String, function: OperatorFunction) {
exportScriptFunction(null, name, listOf("type"), emptyList(), false, noneOfEnum()) { editor, context, args ->
val type = args["type"]?.asString()
val type = args["type"]?.toVimString()?.value
val selectionType = when (type) {
"line" -> SelectionType.LINE_WISE
"block" -> SelectionType.BLOCK_WISE

View File

@@ -65,7 +65,7 @@ internal object VimExtensionRegistrar : VimExtensionRegistrator {
val option = ToggleOption(name, OptionDeclaredScope.GLOBAL, getAbbrev(name), false)
VimPlugin.getOptionGroup().addOption(option)
VimPlugin.getOptionGroup().addGlobalOptionChangeListener(option) {
if (injector.optionGroup.getOptionValue(option, OptionAccessScope.GLOBAL(null)).asBoolean()) {
if (injector.optionGroup.getOptionValue(option, OptionAccessScope.GLOBAL(null)).booleanValue) {
initExtension(extensionBean, name)
PluginState.Util.enabledExtensions.add(name)
} else {

View File

@@ -204,7 +204,7 @@ public class VimArgTextObjExtension implements VimExtension {
bracketPairs = BracketPairs.fromBracketPairList(bracketPairsVar);
} catch (BracketPairs.ParseException parseException) {
@VimNlsSafe String message =
MessageHelper.message("argtextobj.invalid.value.of.g.argtextobj.pairs.0", parseException.getMessage());
MessageHelper.message("argtextobj.error.invalid.value.of.g.argtextobj.pairs.0", parseException.getMessage());
VimPlugin.showMessage(message);
VimPlugin.indicateError();
return null;

View File

@@ -221,14 +221,16 @@ internal class CommentaryExtension : VimExtension {
val endOffset = editor.vim.getLineEndOffset(logicalLine, true)
val startElement = file.findElementAt(startOffset) ?: return false
var next: PsiElement? = startElement
var hasComment = false
while (next != null && next.textRange.startOffset <= endOffset) {
if (next !is PsiWhiteSpace && !isComment(next)) {
return false
when {
next is PsiWhiteSpace -> {} // Skip whitespace elementl
isComment(next) -> hasComment = true // Mark when we find a comment
else -> return false // Non-comment content found, exit early
}
next = PsiTreeUtil.nextLeaf(next, true)
}
return true
return hasComment
}
private fun isComment(element: PsiElement) =

View File

@@ -33,7 +33,6 @@ import com.maddyhome.idea.vim.extension.VimExtensionFacade.putExtensionHandlerMa
import com.maddyhome.idea.vim.extension.VimExtensionFacade.putKeyMappingIfMissing
import com.maddyhome.idea.vim.extension.VimExtensionFacade.setRegister
import com.maddyhome.idea.vim.extension.exportOperatorFunction
import com.maddyhome.idea.vim.helper.fileSize
import com.maddyhome.idea.vim.helper.moveToInlayAwareLogicalPosition
import com.maddyhome.idea.vim.helper.moveToInlayAwareOffset
import com.maddyhome.idea.vim.key.OperatorFunction
@@ -138,7 +137,7 @@ internal class VimExchangeExtension : VimExtension {
val endAdj = if (!(isVisualLine) && (hlArea == HighlighterTargetArea.EXACT_RANGE || isVisual)) 1 else 0
return ijEditor.markupModel.addRangeHighlighter(
ijEditor.getMarkOffset(ex.start),
(ijEditor.getMarkOffset(ex.end) + endAdj).coerceAtMost(ijEditor.fileSize),
(ijEditor.getMarkOffset(ex.end) + endAdj).coerceAtMost(editor.fileSize().toInt()),
HighlighterLayer.SELECTION - 1,
attributes,
hlArea,

View File

@@ -209,13 +209,15 @@ internal class VimHighlightedYank : VimExtension, VimYankListener, ModeChangeLis
}
private fun extractUsersHighlightColor(): Color {
val value = VimPlugin.getVariableService().getGlobalVariableValue(HIGHLIGHT_COLOR_VARIABLE_NAME)
val value =
VimPlugin.getVariableService().getGlobalVariableValue(HIGHLIGHT_COLOR_VARIABLE_NAME)?.toVimString()?.value
if (value != null) {
return try {
parseRgbaColor(value.asString())
parseRgbaColor(value)
} catch (e: Exception) {
@Suppress("DialogTitleCapitalization")
@VimNlsSafe val message = MessageHelper.message(
"highlightedyank.invalid.value.of.0.1",
"highlightedyank.error.invalid.value.of.0.1",
"g:$HIGHLIGHT_COLOR_VARIABLE_NAME",
e.message ?: "",
)
@@ -227,14 +229,17 @@ internal class VimHighlightedYank : VimExtension, VimYankListener, ModeChangeLis
}
private fun extractUserHighlightForegroundColor(): Color? {
val value = VimPlugin.getVariableService().getGlobalVariableValue(HIGHLIGHT_FOREGROUND_COLOR_VARIABLE_NAME)
?: return null
val value =
VimPlugin.getVariableService().getGlobalVariableValue(HIGHLIGHT_FOREGROUND_COLOR_VARIABLE_NAME)
?.toVimString()?.value
?: return null
return try {
parseRgbaColor(value.asString())
parseRgbaColor(value)
} catch (e: Exception) {
@Suppress("DialogTitleCapitalization")
@VimNlsSafe val message = MessageHelper.message(
"highlightedyank.invalid.value.of.0.1",
"highlightedyank.error.invalid.value.of.0.1",
"g:$HIGHLIGHT_FOREGROUND_COLOR_VARIABLE_NAME",
e.message ?: "",
)
@@ -263,8 +268,9 @@ internal class VimHighlightedYank : VimExtension, VimYankListener, ModeChangeLis
return try {
extractFun(value)
} catch (e: Exception) {
@Suppress("DialogTitleCapitalization")
@VimNlsSafe val message = MessageHelper.message(
"highlightedyank.invalid.value.of.0.1",
"highlightedyank.error.invalid.value.of.0.1",
"g:$variable",
e.message ?: "",
)

View File

@@ -0,0 +1,121 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.maddyhome.idea.vim.extension.hints
import com.intellij.ui.treeStructure.Tree
import java.awt.Component
import java.awt.Point
import java.util.*
import javax.accessibility.Accessible
import javax.swing.SwingUtilities
internal sealed class HintGenerator {
private var hints: Map<Accessible, String> = emptyMap()
protected val previousHints get() = hints
abstract fun generate(targets: List<HintTarget>)
fun <T> generate(root: T, glassPane: Component): List<HintTarget> where T : Accessible, T : Component =
collectTargets(root, glassPane).also { targets ->
generate(targets)
hints = WeakHashMap(targets.associateBy(HintTarget::component, HintTarget::hint).filterValues(String::isNotEmpty))
}
class Permutation(private val alphabet: List<Char>) : HintGenerator() {
init {
require(alphabet.size > 1) { "Alphabet must contain at least two characters" }
}
override fun generate(targets: List<HintTarget>) = generate(targets, true)
/**
* @param preserve Whether to preserve the previous hints if possible
*/
private fun generate(targets: List<HintTarget>, preserve: Boolean) {
val length = generateSequence(1) { it * alphabet.size }.takeWhile {
it < targets.size + if (preserve) previousHints.size else 0
}.count()
val hintIterator = alphabet.permutations(length).map { it.joinToString("") }.iterator()
targets.forEach { target ->
target.hint = if (preserve) {
previousHints[target.component] ?: hintIterator.firstOrNull {
// Check if the hint is not already used by previous targets
!previousHints.values.any { hint -> hint.startsWith(it) || it.startsWith(hint) }
} ?: return generate(targets, false) // do not preserve previous hints if failed
} else {
hintIterator.next()
}
}
}
}
}
private fun <T> collectTargets(
component: T,
destination: Component,
): List<HintTarget> where T : Accessible, T : Component = mutableMapOf<Accessible, HintTarget>().also {
collectTargets(it, component, SwingUtilities.convertPoint(component.parent, component.location, destination))
}.values.toList()
private fun collectTargets(
targets: MutableMap<Accessible, HintTarget>,
component: Accessible,
location: Point,
depth: Int = 0,
): Unit = with(component.accessibleContext) {
val accessible = accessibleComponent ?: return
val location = location + (accessible.location ?: return)
accessible.size?.let { size ->
if (accessible.isShowing && (component.isClickable() || component is Tree)) {
targets[component].let {
// For some reason, the same component may appear multiple times in the accessible tree.
if (it == null || it.depth > depth) {
targets[component] = HintTarget(component, location, size, depth)
}
}
}
}
// Skip the children of the Tree, otherwise it will easily lead to performance problems
if (component is Tree) return
// recursively collect children
for (i in 0..<accessibleChildrenCount) {
collectTargets(targets, getAccessibleChild(i), location, depth + 1)
}
}
/**
* Check if the component is clickable
*
* @return whether the component is clickable
*/
private fun Accessible.isClickable(): Boolean = (accessibleContext.accessibleAction?.accessibleActionCount ?: 0) > 0
private operator fun Point.plus(other: Point) = Point(x + other.x, y + other.y)
private fun <T> Collection<T>.permutations(length: Int): Sequence<List<T>> = sequence {
if (length == 0) {
yield(emptyList())
return@sequence
}
for (element in this@permutations) {
this@permutations.permutations(length - 1).forEach { subPermutation ->
yield(listOf(element) + subPermutation)
}
}
}
private fun <T> Iterator<T>.firstOrNull(predicate: (T) -> Boolean): T? {
while (hasNext()) {
val next = next()
if (predicate(next)) return next
}
return null
}

View File

@@ -0,0 +1,20 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.maddyhome.idea.vim.extension.hints
import java.awt.Dimension
import java.awt.Point
import java.awt.Rectangle
import javax.accessibility.Accessible
internal data class HintTarget(val component: Accessible, val location: Point, val size: Dimension, val depth: Int) {
var hint: String = ""
val bounds: Rectangle get() = Rectangle(location, size)
}

View File

@@ -0,0 +1,136 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.maddyhome.idea.vim.extension.hints
import com.intellij.openapi.actionSystem.ActionUpdateThread
import com.intellij.openapi.actionSystem.AnActionEvent
import com.intellij.openapi.actionSystem.PlatformDataKeys
import com.intellij.openapi.project.DumbAwareToggleAction
import com.intellij.openapi.ui.popup.JBPopupFactory
import com.intellij.openapi.ui.popup.JBPopupListener
import com.intellij.openapi.ui.popup.LightweightWindowEvent
import com.intellij.openapi.wm.impl.IdeGlassPaneImpl
import com.intellij.ui.JBColor
import com.intellij.util.Alarm
import com.maddyhome.idea.vim.api.injector
import com.maddyhome.idea.vim.extension.ShortcutDispatcher
import com.maddyhome.idea.vim.newapi.globalIjOptions
import java.awt.Color
import javax.swing.JComponent
import javax.swing.JLabel
import javax.swing.JPanel
import javax.swing.JRootPane
import javax.swing.SwingUtilities
class ToggleHintsAction : DumbAwareToggleAction() {
/** The mask layer container for placing all hints */
private var cover: JComponent? = null
private val alarm = Alarm(Alarm.ThreadToUse.SWING_THREAD)
private val highlight = HighlightComponent()
private val generator = HintGenerator.Permutation(alphabet)
override fun getActionUpdateThread(): ActionUpdateThread = ActionUpdateThread.BGT
override fun isSelected(e: AnActionEvent): Boolean = cover != null
override fun setSelected(e: AnActionEvent, selected: Boolean) {
val rootPane = SwingUtilities.getRootPane(e.getData(PlatformDataKeys.CONTEXT_COMPONENT)) ?: return
if (!injector.globalIjOptions().vimHints) return
val glassPane = rootPane.glassPane as IdeGlassPaneImpl
if (selected) {
enable(rootPane, glassPane)
} else {
disable(glassPane)
}
}
private fun enable(rootPane: JRootPane, glassPane: IdeGlassPaneImpl) {
val targets = generator.generate(rootPane, glassPane)
val cover = JPanel().apply {
cover = this
layout = null // no layout manager (absolute positioning)
isOpaque = false
targets.map(HintTarget::createCover).forEach(::add)
size = glassPane.size
}
if (highlight !in glassPane.components) glassPane.add(highlight)
if (cover !in glassPane.components) glassPane.add(cover)
glassPane.isVisible = true
val select = JPanel()
val popup = JBPopupFactory.getInstance().createComponentPopupBuilder(select, select).createPopup()
popup.setRequestFocus(true)
popup.addListener(object : JBPopupListener {
override fun onClosed(event: LightweightWindowEvent) {
disable(glassPane)
}
})
ShortcutDispatcher("hints", targets.associateBy { it.hint.lowercase() }, { target ->
popup.closeOk(null)
alarm.cancelAllRequests()
target.component.accessibleContext?.apply {
if (accessibleAction?.doAccessibleAction(0) == null && !accessibleComponent.isFocusTraversable) return@apply
accessibleComponent.requestFocus()
highlight.setTarget(target)
alarm.addRequest({ highlight.setTarget(null) }, highlightDuration)
}
}, {
popup.cancel()
injector.messages.indicateError()
}, { entries ->
cover.removeAll()
entries.map { it.data!! }.map(HintTarget::createCover).forEach(cover::add)
cover.revalidate()
cover.repaint()
}).register(select, popup)
popup.showInCenterOf(rootPane)
}
private fun disable(glassPane: IdeGlassPaneImpl) {
cover?.let(glassPane::remove)
glassPane.revalidate()
glassPane.repaint()
cover = null
}
}
private fun HintTarget.createCover() = JPanel().apply {
isOpaque = false
bounds = this@createCover.bounds
add(JLabel().apply {
text = hint
isOpaque = true
background = JBColor.YELLOW.let { Color(it.red, it.green, it.blue, 200) }
foreground = JBColor.foreground()
})
}
private class HighlightComponent : JPanel() {
init {
background = JBColor.GREEN.let { Color(it.red, it.green, it.blue, 100) }
border = javax.swing.border.LineBorder(JBColor.GREEN, 1)
}
fun setTarget(target: HintTarget?) {
if (target != null) {
bounds = target.bounds
isVisible = true
} else {
isVisible = false
}
}
}
private const val highlightDuration = 500
private val alphabet = "ASDFGHJKL".toList()

View File

@@ -210,7 +210,7 @@ internal class VimMultipleCursorsExtension : VimExtension {
if (nextOffset != -1) {
caretModel.allCarets.forEach {
if (it.selectionStart == nextOffset) {
VimPlugin.showMessage(MessageHelper.message("message.no.more.matches"))
VimPlugin.showMessage(MessageHelper.message("multiple-cursors.message.no.more.matches"))
return
}
}
@@ -219,7 +219,7 @@ internal class VimMultipleCursorsExtension : VimExtension {
editor.updateCaretsVisualAttributes()
editor.vimMultipleCursorsLastSelection = selectText(caret, pattern, nextOffset)
} else {
VimPlugin.showMessage(MessageHelper.message("message.no.more.matches"))
VimPlugin.showMessage(MessageHelper.message("multiple-cursors.message.no.more.matches"))
}
}
}
@@ -234,7 +234,7 @@ internal class VimMultipleCursorsExtension : VimExtension {
val text = if (editor.inVisualMode) {
primaryCaret.selectedText ?: return
} else {
val range = injector.searchHelper.findWordNearestCursor(editor.vim, primaryCaret.vim) ?: return
val range = injector.searchHelper.findWordAtOrFollowingCursor(editor.vim, primaryCaret.vim, isBigWord = false) ?: return
if (range.startOffset > primaryCaret.offset) return
IjVimEditor(editor).getText(range)
}
@@ -269,7 +269,7 @@ internal class VimMultipleCursorsExtension : VimExtension {
if (nextOffset != -1) {
editor.caretModel.allCarets.forEach {
if (it.selectionStart == nextOffset) {
VimPlugin.showMessage(MessageHelper.message("message.no.more.matches"))
VimPlugin.showMessage(MessageHelper.message("multiple-cursors.message.no.more.matches"))
return
}
}
@@ -300,7 +300,7 @@ internal class VimMultipleCursorsExtension : VimExtension {
private fun selectWordUnderCaret(editor: Editor, caret: Caret): TextRange? {
// TODO: I think vim-multiple-cursors uses a text object rather than the star operator
val range = injector.searchHelper.findWordNearestCursor(editor.vim, caret.vim) ?: return null
val range = injector.searchHelper.findWordAtOrFollowingCursor(editor.vim, caret.vim, isBigWord = false) ?: return null
if (range.startOffset > caret.offset) return null
enterVisualMode(editor.vim)

View File

@@ -0,0 +1,63 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.maddyhome.idea.vim.extension.nerdtree
import com.intellij.openapi.actionSystem.ActionUpdateThread
import com.intellij.openapi.actionSystem.AnActionEvent
import com.intellij.openapi.actionSystem.PlatformDataKeys
import com.intellij.ui.treeStructure.Tree
import com.maddyhome.idea.vim.api.injector
import com.maddyhome.idea.vim.diagnostic.vimLogger
import com.maddyhome.idea.vim.extension.ShortcutDispatcher
import java.awt.event.KeyEvent
import javax.swing.KeyStroke
/**
* Handles keyboard shortcuts and delegates them to appropriate actions.
*/
internal abstract class AbstractDispatcher(name: String, mappings: Map<List<KeyStroke>, NerdTreeAction>) :
ShortcutDispatcher<NerdTreeAction>(name, mappings, NerdTreeListener) {
private object NerdTreeListener : Listener<NerdTreeAction> {
override fun onMatch(e: AnActionEvent, keyStrokes: MutableList<KeyStroke>, data: NerdTreeAction) {
val component = e.getData(PlatformDataKeys.CONTEXT_COMPONENT)
if (component is Tree) {
data.action(e, component)
} else {
LOG.error("Component is not a tree: $component")
}
keyStrokes.clear()
}
override fun onInvalid(e: AnActionEvent, keyStrokes: MutableList<KeyStroke>) {
keyStrokes.clear()
injector.messages.indicateError()
}
}
override fun update(e: AnActionEvent) {
e.presentation.isEnabled = true
// If <ESC> is pressed, clear the keys; skip only if there are no keys
if ((e.inputEvent as? KeyEvent)?.keyCode == KeyEvent.VK_ESCAPE) {
e.presentation.isEnabled = keyStrokes.isNotEmpty()
keyStrokes.clear()
}
// Skip if SpeedSearch is active
if (e.getData(PlatformDataKeys.SPEED_SEARCH_TEXT) != null) {
e.presentation.isEnabled = false
}
}
override fun getActionUpdateThread() = ActionUpdateThread.BGT
companion object {
val LOG = vimLogger<AbstractDispatcher>()
}
}

View File

@@ -0,0 +1,137 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.maddyhome.idea.vim.extension.nerdtree
import com.intellij.openapi.options.advanced.AdvancedSettings
import com.intellij.util.ui.tree.TreeUtil
import com.maddyhome.idea.vim.VimPlugin
import com.maddyhome.idea.vim.api.injector
import com.maddyhome.idea.vim.vimscript.model.datatypes.VimString
import javax.swing.KeyStroke
import javax.swing.tree.TreeNode
fun MutableMap<List<KeyStroke>, NerdTreeAction>.register(
variable: String,
defaultMapping: String,
action: NerdTreeAction,
) {
val variableValue = VimPlugin.getVariableService().getGlobalVariableValue(variable)
val mapping = if (variableValue is VimString) {
variableValue.value
} else {
defaultMapping
}
register(mapping, action)
}
fun MutableMap<List<KeyStroke>, NerdTreeAction>.register(mapping: String, action: NerdTreeAction) {
this[injector.parser.parseKeys(mapping)] = action
}
/**
* Navigation-related mappings
* <pre><code>
* Default~
* Key Description Map settings
*
* O........Recursively open the selected directory..................*NERDTreeMapOpenRecursively*
* x........Close the current nodes parent..................................*NERDTreeMapCloseDir*
* X........Recursively close all children of the current node.........*NERDTreeMapCloseChildren*
*
* P........Jump to the root node...........................................*NERDTreeMapJumpRoot*
* p........Jump to current nodes parent..................................*NERDTreeMapJumpParent*
* K........Jump up inside directories at the current tree depth......*NERDTreeMapJumpFirstChild*
* J........Jump down inside directories at the current tree depth.....*NERDTreeMapJumpLastChild*
* <C-J>....Jump down to next sibling of the current directory.......*NERDTreeMapJumpNextSibling*
* <C-K>....Jump up to previous sibling of the current directory.....*NERDTreeMapJumpPrevSibling*
* </code></pre>
*/
val navigationMappings: Map<List<KeyStroke>, NerdTreeAction> = mutableMapOf<List<KeyStroke>, NerdTreeAction>().apply {
// TODO support going [count] lines upward/downward or to line [count]
register("k", NerdTreeAction.ij("Tree-selectPrevious"))
register("j", NerdTreeAction.ij("Tree-selectNext"))
register("G", NerdTreeAction.ij("Tree-selectLast"))
register("gg", NerdTreeAction.ij("Tree-selectFirst"))
// FIXME lazy loaded tree nodes are not expanded
register("NERDTreeMapOpenRecursively", "O", NerdTreeAction.ij("FullyExpandTreeNode"))
// This action respects `ide.tree.collapse.recursively`. We may prompt the user to disable it
register("NERDTreeMapCloseDir", "x", NerdTreeAction { _, tree ->
tree.selectionPath?.parentPath?.let {
if (tree.getRowForPath(it) >= 0) { // skip if invisible, but we cannot use `tree.isVisible(path)` here
tree.selectionPath = it
tree.collapsePath(it)
tree.scrollPathToVisible(it)
}
}
})
register(
"NERDTreeMapCloseChildren",
"X",
NerdTreeAction { _, tree ->
val path = tree.selectionPath ?: return@NerdTreeAction
// FIXME We should avoid relying on `ide.tree.collapse.recursively` since it closes visible paths only
val recursive = AdvancedSettings.getBoolean("ide.tree.collapse.recursively")
try {
AdvancedSettings.setBoolean("ide.tree.collapse.recursively", true)
// Note that we cannot use `tree.collapsePaths` here since it does not respect `ide.tree.collapse.recursively`
TreeUtil.listChildren(path.lastPathComponent as TreeNode).filterNot(TreeNode::isLeaf)
.map(path::pathByAddingChild).forEach(tree::collapsePath)
} finally {
AdvancedSettings.setBoolean("ide.tree.collapse.recursively", recursive)
}
tree.scrollPathToVisible(path)
},
)
register("NERDTreeMapJumpRoot", "P", NerdTreeAction { _, tree ->
// Note that we should not consider the root simply the first row
// It cannot be guaranteed that the tree has a single visible root
var path = tree.selectionPath ?: return@NerdTreeAction
while (path.parentPath != null && tree.getRowForPath(path.parentPath) >= 0) {
path = path.parentPath
}
tree.selectionPath = path
tree.scrollPathToVisible(path)
})
register("NERDTreeMapJumpParent", "p", NerdTreeAction.ij("Tree-selectParentNoCollapse"))
register(
"NERDTreeMapJumpFirstChild",
"K",
NerdTreeAction { _, tree ->
var path = tree.selectionPath ?: return@NerdTreeAction
while (true) {
val previous = TreeUtil.previousVisibleSibling(tree, path) ?: break
path = previous
}
tree.selectionPath = path
tree.scrollPathToVisible(path)
},
)
register(
"NERDTreeMapJumpLastChild",
"J",
NerdTreeAction { _, tree ->
var path = tree.selectionPath ?: return@NerdTreeAction
while (true) {
val next = TreeUtil.nextVisibleSibling(tree, path) ?: break
path = next
}
tree.selectionPath = path
tree.scrollPathToVisible(path)
},
)
register("NERDTreeMapJumpNextSibling", "<C-J>", NerdTreeAction.ij("Tree-selectNextSibling"))
register("NERDTreeMapJumpPrevSibling", "<C-K>", NerdTreeAction.ij("Tree-selectPreviousSibling"))
register("/", NerdTreeAction.ij("SpeedSearch"))
register("<ESC>", NerdTreeAction { _, _ -> })
}

View File

@@ -1,18 +0,0 @@
/*
* Copyright 2003-2023 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.maddyhome.idea.vim.extension.nerdtree
import com.intellij.openapi.actionSystem.AnActionEvent
import com.intellij.openapi.actionSystem.DataContext
import com.intellij.openapi.project.Project
internal sealed class NerdAction {
class ToIj(val name: String) : NerdAction()
class Code(val action: (Project, DataContext, AnActionEvent) -> Unit) : NerdAction()
}

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2003-2023 The IdeaVim authors
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
@@ -9,49 +9,32 @@
package com.maddyhome.idea.vim.extension.nerdtree
import com.intellij.ide.projectView.ProjectView
import com.intellij.ide.projectView.impl.AbstractProjectViewPane
import com.intellij.ide.projectView.impl.ProjectViewImpl
import com.intellij.openapi.actionSystem.ActionManager
import com.intellij.openapi.actionSystem.ActionUpdateThread
import com.intellij.openapi.actionSystem.AnActionEvent
import com.intellij.openapi.actionSystem.CommonDataKeys
import com.intellij.openapi.actionSystem.PlatformDataKeys
import com.intellij.openapi.application.ApplicationManager
import com.intellij.openapi.diagnostic.logger
import com.intellij.openapi.components.Service
import com.intellij.openapi.components.service
import com.intellij.openapi.fileEditor.ex.FileEditorManagerEx
import com.intellij.openapi.project.DumbAwareAction
import com.intellij.openapi.fileEditor.impl.EditorWindow
import com.intellij.openapi.project.Project
import com.intellij.openapi.project.ProjectManager
import com.intellij.openapi.startup.ProjectActivity
import com.intellij.openapi.wm.ToolWindow
import com.intellij.openapi.wm.ToolWindowId
import com.intellij.openapi.wm.ex.ToolWindowManagerEx
import com.intellij.openapi.wm.ex.ToolWindowManagerListener
import com.intellij.ui.KeyStrokeAdapter
import com.intellij.ui.TreeExpandCollapse
import com.intellij.ui.speedSearch.SpeedSearchSupply
import com.intellij.util.ui.tree.TreeUtil
import com.maddyhome.idea.vim.VimPlugin
import com.maddyhome.idea.vim.api.ExecutionContext
import com.maddyhome.idea.vim.api.VimEditor
import com.maddyhome.idea.vim.api.injector
import com.maddyhome.idea.vim.common.CommandAlias
import com.maddyhome.idea.vim.common.CommandAliasHandler
import com.maddyhome.idea.vim.diagnostic.vimLogger
import com.maddyhome.idea.vim.ex.ranges.Range
import com.maddyhome.idea.vim.extension.VimExtension
import com.maddyhome.idea.vim.group.KeyGroup
import com.maddyhome.idea.vim.helper.MessageHelper
import com.maddyhome.idea.vim.helper.runAfterGotFocus
import com.maddyhome.idea.vim.key.KeyStrokeTrie
import com.maddyhome.idea.vim.key.MappingOwner
import com.maddyhome.idea.vim.key.RequiredShortcut
import com.maddyhome.idea.vim.key.add
import com.maddyhome.idea.vim.extension.VimExtensionFacade
import com.maddyhome.idea.vim.newapi.ij
import com.maddyhome.idea.vim.newapi.vim
import com.maddyhome.idea.vim.vimscript.model.datatypes.VimString
import java.awt.event.KeyEvent
import java.util.concurrent.locks.ReentrantReadWriteLock
import javax.swing.KeyStroke
import javax.swing.SwingConstants
import kotlin.concurrent.read
import kotlin.concurrent.write
/**
* Features and issues:
@@ -113,29 +96,42 @@ import javax.swing.SwingConstants
* ?........Toggle the display of the quick help.......................|NERDTree-?|
*/
internal class NerdTree : VimExtension {
override fun getName(): String = pluginName
override fun getName(): String = PLUGIN_NAME
override fun init() {
LOG.info("IdeaVim: Initializing NERDTree extension. Disable this extension if you observe a strange behaviour of the project tree. E.g. moving down on 'j'")
lock.write {
enabled = true
registerCommands()
addCommand("NERDTreeFocus", IjCommandHandler("ActivateProjectToolWindow"))
addCommand("NERDTree", IjCommandHandler("ActivateProjectToolWindow"))
addCommand("NERDTreeToggle", ToggleHandler())
addCommand("NERDTreeClose", CloseHandler())
addCommand("NERDTreeFind", IjCommandHandler("SelectInProjectView"))
addCommand("NERDTreeRefreshRoot", IjCommandHandler("Synchronize"))
synchronized(Util.monitor) {
Util.commandsRegistered = true
ProjectManager.getInstance().openProjects.forEach { project -> installDispatcher(project) }
VimExtensionFacade.addCommand("NERDTreeFocus", IjCommandHandler("ActivateProjectToolWindow"))
VimExtensionFacade.addCommand("NERDTree", IjCommandHandler("ActivateProjectToolWindow"))
VimExtensionFacade.addCommand("NERDTreeToggle", ToggleHandler())
VimExtensionFacade.addCommand("NERDTreeClose", CloseHandler())
VimExtensionFacade.addCommand("NERDTreeFind", IjCommandHandler("SelectInProjectView"))
VimExtensionFacade.addCommand("NERDTreeRefreshRoot", IjCommandHandler("Synchronize"))
}
ProjectManager.getInstance().openProjects.forEach(::installDispatcher)
}
override fun dispose() {
lock.write {
enabled = false
// TODO remove ex-commands
ProjectManager.getInstance().openProjects.forEach { project ->
val component = (ProjectView.getInstance(project) as ProjectViewImpl).component
if (component != null) {
NerdDispatcher.getInstance(project).unregisterCustomShortcutSet(component)
} else {
LOG.error("$project: project view component is null")
}
}
}
super.dispose()
}
class IjCommandHandler(private val actionId: String) : CommandAliasHandler {
override fun execute(command: String, range: Range, editor: VimEditor, context: ExecutionContext) {
Util.callAction(editor, actionId, context)
NerdTreeAction.callAction(editor, actionId, context)
}
}
@@ -146,7 +142,7 @@ internal class NerdTree : VimExtension {
if (toolWindow.isVisible) {
toolWindow.hide()
} else {
Util.callAction(editor, "ActivateProjectToolWindow", context)
NerdTreeAction.callAction(editor, "ActivateProjectToolWindow", context)
}
}
}
@@ -161,403 +157,142 @@ internal class NerdTree : VimExtension {
}
}
class ProjectViewListener(private val project: Project) : ToolWindowManagerListener {
override fun toolWindowShown(toolWindow: ToolWindow) {
if (ToolWindowId.PROJECT_VIEW != toolWindow.id) return
val dispatcher = NerdDispatcher.getInstance(project)
if (dispatcher.speedSearchListenerInstalled) return
// I specify nullability explicitly as we've got a lot of exceptions saying this property is null
val currentProjectViewPane: AbstractProjectViewPane? = ProjectView.getInstance(project).currentProjectViewPane
val tree = currentProjectViewPane?.tree ?: return
val supply = SpeedSearchSupply.getSupply(tree, true) ?: return
// NB: Here might be some issues with concurrency, but it's not really bad, I think
dispatcher.speedSearchListenerInstalled = true
supply.addChangeListener {
dispatcher.waitForSearch = false
}
}
}
// TODO I'm not sure is this activity runs at all? Should we use [RunOnceUtil] instead?
class NerdStartupActivity : ProjectActivity {
override suspend fun execute(project: Project) {
synchronized(Util.monitor) {
if (!Util.commandsRegistered) return
installDispatcher(project)
}
installDispatcher(project)
}
}
class NerdDispatcher : DumbAwareAction() {
internal var waitForSearch = false
internal var speedSearchListenerInstalled = false
private val keys = mutableListOf<KeyStroke>()
override fun actionPerformed(e: AnActionEvent) {
var keyStroke = getKeyStroke(e) ?: return
val keyChar = keyStroke.keyChar
if (keyChar != KeyEvent.CHAR_UNDEFINED) {
keyStroke = KeyStroke.getKeyStroke(keyChar)
}
keys.add(keyStroke)
actionsRoot.getData(keys)?.let { action ->
when (action) {
is NerdAction.ToIj -> Util.callAction(null, action.name, e.dataContext.vim)
is NerdAction.Code -> e.project?.let { action.action(it, e.dataContext, e) }
}
keys.clear()
}
}
override fun update(e: AnActionEvent) {
// Special processing of esc.
if ((e.inputEvent as? KeyEvent)?.keyCode == ESCAPE_KEY_CODE) {
e.presentation.isEnabled = waitForSearch
return
}
if (waitForSearch) {
e.presentation.isEnabled = false
return
}
e.presentation.isEnabled = !speedSearchIsHere(e)
}
override fun getActionUpdateThread() = ActionUpdateThread.BGT
private fun speedSearchIsHere(e: AnActionEvent): Boolean {
val searchText = e.getData(PlatformDataKeys.SPEED_SEARCH_TEXT)
return !searchText.isNullOrEmpty()
}
@Service(Service.Level.PROJECT)
class NerdDispatcher : AbstractDispatcher(PLUGIN_NAME, createMappings()) {
companion object {
fun getInstance(project: Project): NerdDispatcher {
return project.getService(NerdDispatcher::class.java)
}
private const val ESCAPE_KEY_CODE = 27
}
/**
* getDefaultKeyStroke is needed for NEO layout keyboard VIM-987
* but we should cache the value because on the second call (isEnabled -> actionPerformed)
* the event is already consumed
*/
private var keyStrokeCache: Pair<KeyEvent?, KeyStroke?> = null to null
private fun getKeyStroke(e: AnActionEvent): KeyStroke? {
val inputEvent = e.inputEvent
if (inputEvent is KeyEvent) {
val defaultKeyStroke = KeyStrokeAdapter.getDefaultKeyStroke(inputEvent)
val strokeCache = keyStrokeCache
if (defaultKeyStroke != null) {
keyStrokeCache = inputEvent to defaultKeyStroke
return defaultKeyStroke
} else if (strokeCache.first === inputEvent) {
keyStrokeCache = null to null
return strokeCache.second
}
return KeyStroke.getKeyStrokeForEvent(inputEvent)
}
return null
}
}
private fun registerCommands() {
// TODO: 22.01.2021 Should not just to the last line after the first
registerCommand("j", NerdAction.ToIj("Tree-selectNext"))
registerCommand("k", NerdAction.ToIj("Tree-selectPrevious"))
registerCommand(
"NERDTreeMapActivateNode",
"o",
NerdAction.Code { project, dataContext, _ ->
val tree = ProjectView.getInstance(project).currentProjectViewPane.tree
val array = CommonDataKeys.NAVIGATABLE_ARRAY.getData(dataContext)?.filter { it.canNavigateToSource() }
if (array.isNullOrEmpty()) {
val row = tree.selectionRows?.getOrNull(0) ?: return@Code
if (tree.isExpanded(row)) {
tree.collapseRow(row)
} else {
tree.expandRow(row)
}
} else {
array.forEach { it.navigate(true) }
}
},
)
registerCommand(
"NERDTreeMapPreview",
"go",
NerdAction.Code { _, dataContext, _ ->
CommonDataKeys.NAVIGATABLE_ARRAY
.getData(dataContext)
?.filter { it.canNavigateToSource() }
?.forEach { it.navigate(false) }
},
)
registerCommand(
"NERDTreeMapOpenInTab",
"t",
NerdAction.Code { _, dataContext, _ ->
// FIXME: 22.01.2021 Doesn't work correct
CommonDataKeys.NAVIGATABLE_ARRAY
.getData(dataContext)
?.filter { it.canNavigateToSource() }
?.forEach { it.navigate(true) }
},
)
registerCommand(
"NERDTreeMapOpenInTabSilent",
"T",
NerdAction.Code { _, dataContext, _ ->
// FIXME: 22.01.2021 Doesn't work correct
CommonDataKeys.NAVIGATABLE_ARRAY
.getData(dataContext)
?.filter { it.canNavigateToSource() }
?.forEach { it.navigate(true) }
},
)
// TODO: 21.01.2021 Should option in left split
registerCommand("NERDTreeMapOpenVSplit", "s", NerdAction.ToIj("OpenInRightSplit"))
// TODO: 21.01.2021 Should option in above split
registerCommand(
"NERDTreeMapOpenSplit",
"i",
NerdAction.Code { project, _, event ->
val file = event.getData(CommonDataKeys.VIRTUAL_FILE) ?: return@Code
if (file.isDirectory) return@Code
val splitters = FileEditorManagerEx.getInstanceEx(project).splitters
val currentWindow = splitters.currentWindow
currentWindow?.split(SwingConstants.HORIZONTAL, true, file, true)
},
)
registerCommand(
"NERDTreeMapPreviewVSplit",
"gs",
NerdAction.Code { project, context, event ->
val file = event.getData(CommonDataKeys.VIRTUAL_FILE) ?: return@Code
val splitters = FileEditorManagerEx.getInstanceEx(project).splitters
val currentWindow = splitters.currentWindow
currentWindow?.split(SwingConstants.VERTICAL, true, file, true)
// FIXME: 22.01.2021 This solution bouncing a bit
Util.callAction(null, "ActivateProjectToolWindow", context.vim)
},
)
registerCommand(
"NERDTreeMapPreviewSplit",
"gi",
NerdAction.Code { project, context, event ->
val file = event.getData(CommonDataKeys.VIRTUAL_FILE) ?: return@Code
val splitters = FileEditorManagerEx.getInstanceEx(project).splitters
val currentWindow = splitters.currentWindow
currentWindow?.split(SwingConstants.HORIZONTAL, true, file, true)
Util.callAction(null, "ActivateProjectToolWindow", context.vim)
},
)
registerCommand(
"NERDTreeMapOpenRecursively",
"O",
NerdAction.Code { project, _, _ ->
val tree = ProjectView.getInstance(project).currentProjectViewPane.tree
TreeExpandCollapse.expandAll(tree)
tree.selectionPath?.let {
TreeUtil.scrollToVisible(tree, it, false)
}
},
)
registerCommand(
"NERDTreeMapCloseChildren",
"X",
NerdAction.Code { project, _, _ ->
val tree = ProjectView.getInstance(project).currentProjectViewPane.tree
TreeExpandCollapse.collapse(tree)
tree.selectionPath?.let {
TreeUtil.scrollToVisible(tree, it, false)
}
},
)
registerCommand(
"NERDTreeMapCloseDir",
"x",
NerdAction.Code { project, _, _ ->
val tree = ProjectView.getInstance(project).currentProjectViewPane.tree
val currentPath = tree.selectionPath ?: return@Code
if (tree.isExpanded(currentPath)) {
tree.collapsePath(currentPath)
} else {
val parentPath = currentPath.parentPath ?: return@Code
if (parentPath.parentPath != null) {
// The real root of the project is not shown in the project view, so we check the grandparent of the node
tree.collapsePath(parentPath)
TreeUtil.scrollToVisible(tree, parentPath, false)
}
}
},
)
registerCommand("NERDTreeMapJumpRoot", "P", NerdAction.ToIj("Tree-selectFirst"))
registerCommand(
"NERDTreeMapJumpParent",
"p",
NerdAction.Code { project, _, _ ->
val tree = ProjectView.getInstance(project).currentProjectViewPane.tree
val currentPath = tree.selectionPath ?: return@Code
val parentPath = currentPath.parentPath ?: return@Code
if (parentPath.parentPath != null) {
// The real root of the project is not shown in the project view, so we check the grandparent of the node
tree.selectionPath = parentPath
TreeUtil.scrollToVisible(tree, parentPath, false)
}
},
)
registerCommand(
"NERDTreeMapJumpFirstChild",
"K",
NerdAction.Code { project, _, _ ->
val tree = ProjectView.getInstance(project).currentProjectViewPane.tree
val currentPath = tree.selectionPath ?: return@Code
val parent = currentPath.parentPath ?: return@Code
val row = tree.getRowForPath(parent)
tree.setSelectionRow(row + 1)
tree.scrollRowToVisible(row + 1)
},
)
registerCommand(
"NERDTreeMapJumpLastChild",
"J",
NerdAction.Code { project, _, _ ->
val tree = ProjectView.getInstance(project).currentProjectViewPane.tree
val currentPath = tree.selectionPath ?: return@Code
val currentPathCount = currentPath.pathCount
var row = tree.getRowForPath(currentPath)
var expectedRow = row
while (true) {
row++
val nextPath = tree.getPathForRow(row) ?: break
val pathCount = nextPath.pathCount
if (pathCount == currentPathCount) expectedRow = row
if (pathCount < currentPathCount) break
}
tree.setSelectionRow(expectedRow)
tree.scrollRowToVisible(expectedRow)
},
)
registerCommand(
"NERDTreeMapJumpNextSibling",
"<C-J>",
NerdAction.ToIj("Tree-selectNextSibling"),
)
registerCommand(
"NERDTreeMapJumpPrevSibling",
"<C-K>",
NerdAction.ToIj("Tree-selectPreviousSibling"),
)
registerCommand(
"NERDTreeMapRefresh",
"r",
NerdAction.ToIj("SynchronizeCurrentFile"),
)
registerCommand("NERDTreeMapToggleHidden", "I", NerdAction.ToIj("ProjectView.ShowExcludedFiles"))
registerCommand("NERDTreeMapNewFile", "n", NerdAction.ToIj("NewFile"))
registerCommand("NERDTreeMapNewDir", "N", NerdAction.ToIj("NewDir"))
registerCommand("NERDTreeMapDelete", "d", NerdAction.ToIj("\$Delete"))
registerCommand("NERDTreeMapCopy", "y", NerdAction.ToIj("\$Copy"))
registerCommand("NERDTreeMapPaste", "v", NerdAction.ToIj("\$Paste"))
registerCommand("NERDTreeMapRename", "<C-r>", NerdAction.ToIj("RenameElement"))
registerCommand("NERDTreeMapRefreshRoot", "R", NerdAction.ToIj("Synchronize"))
registerCommand("NERDTreeMapMenu", "m", NerdAction.ToIj("ShowPopupMenu"))
registerCommand("NERDTreeMapQuit", "q", NerdAction.ToIj("HideActiveWindow"))
registerCommand(
"NERDTreeMapToggleZoom",
"A",
NerdAction.ToIj("MaximizeToolWindow"),
)
registerCommand(
"/",
NerdAction.Code { project, _, _ ->
NerdDispatcher.getInstance(project).waitForSearch = true
},
)
registerCommand(
"<ESC>",
NerdAction.Code { project, _, _ ->
val instance = NerdDispatcher.getInstance(project)
if (instance.waitForSearch) {
instance.waitForSearch = false
}
},
)
}
object Util {
internal val monitor = Any()
internal var commandsRegistered = false
fun callAction(editor: VimEditor?, name: String, context: ExecutionContext) {
val action = ActionManager.getInstance().getAction(name) ?: run {
VimPlugin.showMessage(MessageHelper.message("action.not.found.0", name))
return
}
val application = ApplicationManager.getApplication()
if (application.isUnitTestMode) {
injector.actionExecutor.executeAction(editor, action.vim, context)
} else {
runAfterGotFocus {
injector.actionExecutor.executeAction(editor, action.vim, context)
}
return project.service<NerdDispatcher>()
}
}
}
companion object {
const val pluginName = "NERDTree"
private val LOG = logger<NerdTree>()
const val PLUGIN_NAME = "NERDTree"
private val LOG = vimLogger<NerdTree>()
}
}
private fun addCommand(alias: String, handler: CommandAliasHandler) {
VimPlugin.getCommand().setAlias(alias, CommandAlias.Call(0, -1, alias, handler))
}
private fun createMappings(): Map<List<KeyStroke>, NerdTreeAction> = navigationMappings.toMutableMap().apply {
register(
"NERDTreeMapActivateNode",
"o",
NerdTreeAction { event, tree ->
val array = CommonDataKeys.NAVIGATABLE_ARRAY.getData(event.dataContext)?.filter { it.canNavigateToSource() }
if (array.isNullOrEmpty()) {
val row = tree.selectionRows?.getOrNull(0) ?: return@NerdTreeAction
if (tree.isExpanded(row)) {
tree.collapseRow(row)
} else {
tree.expandRow(row)
}
} else {
array.forEach { it.navigate(true) }
}
},
)
register(
"NERDTreeMapPreview",
"go",
NerdTreeAction { event, _ ->
CommonDataKeys.NAVIGATABLE_ARRAY.getData(event.dataContext)?.filter { it.canNavigateToSource() }
?.forEach { it.navigate(false) }
},
)
register(
"NERDTreeMapOpenInTab",
"t",
NerdTreeAction { event, _ ->
// FIXME: 22.01.2021 Doesn't work correct
CommonDataKeys.NAVIGATABLE_ARRAY.getData(event.dataContext)?.filter { it.canNavigateToSource() }
?.forEach { it.navigate(true) }
},
)
register(
"NERDTreeMapOpenInTabSilent",
"T",
NerdTreeAction { event, _ ->
// FIXME: 22.01.2021 Doesn't work correct
CommonDataKeys.NAVIGATABLE_ARRAY.getData(event.dataContext)?.filter { it.canNavigateToSource() }
?.forEach { it.navigate(true) }
},
)
private fun registerCommand(variable: String, defaultMapping: String, action: NerdAction) {
val variableValue = VimPlugin.getVariableService().getGlobalVariableValue(variable)
val mapping = if (variableValue is VimString) {
variableValue.value
} else {
defaultMapping
}
registerCommand(mapping, action)
}
// TODO: 21.01.2021 Should option in left split
register("NERDTreeMapOpenVSplit", "s", NerdTreeAction.ij("OpenInRightSplit"))
// TODO: 21.01.2021 Should option in above split
register(
"NERDTreeMapOpenSplit",
"i",
NerdTreeAction { event, _ ->
val file = event.getData(CommonDataKeys.VIRTUAL_FILE) ?: return@NerdTreeAction
if (file.isDirectory) return@NerdTreeAction
val currentWindow = getSplittersCurrentWindow(event)
currentWindow?.split(SwingConstants.HORIZONTAL, true, file, true)
},
)
register(
"NERDTreeMapPreviewVSplit",
"gs",
NerdTreeAction { event, _ ->
val file = event.getData(CommonDataKeys.VIRTUAL_FILE) ?: return@NerdTreeAction
val currentWindow = getSplittersCurrentWindow(event)
currentWindow?.split(SwingConstants.VERTICAL, true, file, true)
private fun registerCommand(mapping: String, action: NerdAction) {
actionsRoot.add(mapping, action)
injector.parser.parseKeys(mapping).forEach {
distinctShortcuts.add(it)
}
}
// FIXME: 22.01.2021 This solution bouncing a bit
NerdTreeAction.callAction(null, "ActivateProjectToolWindow", event.dataContext.vim)
},
)
register(
"NERDTreeMapPreviewSplit",
"gi",
NerdTreeAction { event, _ ->
val file = event.getData(CommonDataKeys.VIRTUAL_FILE) ?: return@NerdTreeAction
val currentWindow = getSplittersCurrentWindow(event)
currentWindow?.split(SwingConstants.HORIZONTAL, true, file, true)
private val actionsRoot: KeyStrokeTrie<NerdAction> = KeyStrokeTrie<NerdAction>("NERDTree")
private val distinctShortcuts = mutableSetOf<KeyStroke>()
private fun installDispatcher(project: Project) {
val dispatcher = NerdTree.NerdDispatcher.getInstance(project)
val shortcuts = distinctShortcuts.map { RequiredShortcut(it, MappingOwner.Plugin.get(NerdTree.pluginName)) }
dispatcher.registerCustomShortcutSet(
KeyGroup.toShortcutSet(shortcuts),
(ProjectView.getInstance(project) as ProjectViewImpl).component,
NerdTreeAction.callAction(null, "ActivateProjectToolWindow", event.dataContext.vim)
},
)
register(
"NERDTreeMapRefresh",
"r",
NerdTreeAction.ij("SynchronizeCurrentFile"),
)
register("NERDTreeMapToggleHidden", "I", NerdTreeAction.ij("ProjectView.ShowExcludedFiles"))
register("NERDTreeMapNewFile", "n", NerdTreeAction.ij("NewFile"))
register("NERDTreeMapNewDir", "N", NerdTreeAction.ij("NewDir"))
register("NERDTreeMapDelete", "d", NerdTreeAction.ij($$"$Delete"))
register("NERDTreeMapCopy", "y", NerdTreeAction.ij($$"$Copy"))
register("NERDTreeMapPaste", "v", NerdTreeAction.ij($$"$Paste"))
register("NERDTreeMapRename", "<C-r>", NerdTreeAction.ij("RenameElement"))
register("NERDTreeMapRefreshRoot", "R", NerdTreeAction.ij("Synchronize"))
register("NERDTreeMapMenu", "m", NerdTreeAction.ij("ShowPopupMenu"))
register("NERDTreeMapQuit", "q", NerdTreeAction.ij("HideActiveWindow"))
register(
"NERDTreeMapToggleZoom",
"A",
NerdTreeAction.ij("MaximizeToolWindow"),
)
}
private fun getSplittersCurrentWindow(event: AnActionEvent): EditorWindow? {
val splitters = FileEditorManagerEx.getInstanceEx(event.project ?: return null).splitters
return splitters.currentWindow
}
private val lock = ReentrantReadWriteLock()
private var enabled = false
private fun installDispatcher(project: Project) {
lock.read {
if (!enabled) return
val dispatcher = NerdTree.NerdDispatcher.getInstance(project)
dispatcher.register((ProjectView.getInstance(project) as ProjectViewImpl).component)
}
}

View File

@@ -0,0 +1,51 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.maddyhome.idea.vim.extension.nerdtree
import com.intellij.openapi.actionSystem.ActionManager
import com.intellij.openapi.actionSystem.AnActionEvent
import com.intellij.openapi.application.ApplicationManager
import com.intellij.ui.treeStructure.Tree
import com.maddyhome.idea.vim.VimPlugin
import com.maddyhome.idea.vim.api.ExecutionContext
import com.maddyhome.idea.vim.api.VimEditor
import com.maddyhome.idea.vim.api.injector
import com.maddyhome.idea.vim.helper.MessageHelper
import com.maddyhome.idea.vim.helper.runAfterGotFocus
import com.maddyhome.idea.vim.newapi.vim
/**
* Defines the actual behavior of actions in NERDTree
*/
class NerdTreeAction(val action: (AnActionEvent, Tree) -> Unit) {
companion object {
fun callAction(editor: VimEditor?, name: String, context: ExecutionContext) {
val action = ActionManager.getInstance().getAction(name) ?: run {
VimPlugin.showMessage(MessageHelper.message("nerdtree.error.action.not.found", name))
return
}
val application = ApplicationManager.getApplication()
if (application.isUnitTestMode) {
injector.actionExecutor.executeAction(editor, action.vim, context)
} else {
runAfterGotFocus {
injector.actionExecutor.executeAction(editor, action.vim, context)
}
}
}
/**
* Creates an [NerdTreeAction] that executes an IntelliJ action identified by its ID.
*
* @param id A string representing the ID of the action to execute.
* @return An [NerdTreeAction] that runs the specified action when triggered.
*/
fun ij(id: String) = NerdTreeAction { event, _ -> callAction(null, id, event.dataContext.vim) }
}
}

View File

@@ -0,0 +1,70 @@
/*
* Copyright 2003-2025 The IdeaVim authors
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE.txt file or at
* https://opensource.org/licenses/MIT.
*/
package com.maddyhome.idea.vim.extension.nerdtree
import com.intellij.openapi.components.Service
import com.intellij.openapi.components.service
import com.intellij.ui.treeStructure.Tree
import com.maddyhome.idea.vim.extension.VimExtension
import java.awt.KeyboardFocusManager
import java.awt.event.ActionEvent
import java.awt.event.KeyEvent
import java.beans.PropertyChangeListener
import javax.swing.KeyStroke
/**
* This plugin extends NERDTree support to components other than the Project Tool Window.
*
* TODO:
* It should be considered a "sub-plugin" of NERDTree and cannot be enabled independently,
* i.e., should not function after the NERDTree plugin is turned off.
*/
internal class NerdTreeEverywhere : VimExtension {
companion object {
const val PLUGIN_NAME = "NERDTreeEverywhere" // This is a temporary name
}
override fun getName() = PLUGIN_NAME
val focusListener = PropertyChangeListener { evt ->
val newFocusOwner = evt.newValue
val oldFocusOwner = evt.oldValue
val dispatcher = service<Dispatcher>()
if (newFocusOwner is Tree) {
// It's okay to have `register` called multiple times, as its internal implementation prevents duplicate registrations
dispatcher.register(newFocusOwner)
}
// Unregistration of the shortcut is required to make the plugin disposable
if (oldFocusOwner is Tree) {
dispatcher.unregisterCustomShortcutSet(oldFocusOwner)
}
}
override fun init() {
KeyboardFocusManager.getCurrentKeyboardFocusManager().addPropertyChangeListener("focusOwner", focusListener)
}
@Service
class Dispatcher : AbstractDispatcher(PLUGIN_NAME, navigationMappings.toMutableMap().apply {
register("NERDTreeMapActivateNode", "o", NerdTreeAction { _, tree ->
// TODO a more reliable way of invocation (such as double-clicking?)
val listener = tree.getActionForKeyStroke(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0))
listener.actionPerformed(ActionEvent(tree, ActionEvent.ACTION_PERFORMED, null))
})
}) {
init {
templatePresentation.isEnabledInModalContext = true
}
}
override fun dispose() {
KeyboardFocusManager.getCurrentKeyboardFocusManager().removePropertyChangeListener("focusOwner", focusListener)
super.dispose()
}
}

Some files were not shown because too many files have changed in this diff Show More