The extension has commands for 6 things:
Select By
Select part of the file content surrounding the selection based on Regular Expressions. The current selection is extended by searching forward and or backward or forward twice. If there is no current selection the cursor position is used.
You can specify a "Search Back" expression, a "Search Forward" expression and a "Search Forward Next" expression. If they are not specified that search direction is not performed.
So you can extend the selection
- Forward: from the selection end (or cursor) to the next occurrence of a Regular Expression or end of the file
- Backward: from the selection start (or cursor) search back for a Regular Expression or start of the file
- ForwardNext: from the end of the Forward search, search for a different Regular Expression in the Forward direction. You can reuse captured groups from the forward Regular Expression.
- ForwardNextExtendSelection: if the Forward Regular Expression matches at the start of the selection the ForwardNext Regular Expression extends the selection. Otherwise a normal ForwardNext search.
- or combine Forward and Backward
- or combine Forward and ForwardNext
You can specify any number of ranges specified by Regular Expressions that can be linked to keyboard shortcuts. A range can have any name.
The extension exports 5 commands that use a fixed name: selectby.regex1 to selectby.regex5 use the respective range names: regex1, regex2, regex3, regex4, regex5.
The ranges are specified in the settings.json file for entry selectby.regexes.
- the key for the range can have any name
- the parameters for each range are
flags: a string with the regex flags "i" and/or "m" (default: "")backward: the regular expression to search from the selection start (or cursor) to the start of the file. If you want to select to the file start, construct a regex that will never be found. If this parameter is not present the selection start is not modified or starts at the cursor position. Or false if you want to override User setting.forward: the regular expression to search for from the selection end (or cursor) to the end of the file. If you want to select to the file end, construct a regex that will never be found. If this parameter is not present the selection end is not modified or ends at the cursor position. Or false if you want to override User setting.forwardNext: the regular expression to search for starting at the end of the forward search to the end of the file. Or false (to override User setting). See explanation.backwardInclude: should the matched backward search text be part of the selection (default: true)forwardInclude: should the matched forward search text be part of the selection (default: true)forwardNextInclude: should the matched forwardNext search text be part of the selection (default: true)forwardNextExtendSelection: should we extend the selection with the matched forwardNext search text if the begin of the selection matches the forward regex (default: false). See explanation.surround : select the text around the current selection that matches the regular expression, the selection is somewhere in the text to select, or false (to override User setting). See explanation.copyToClipboard: copy the selection to the clipboard (default: false)showSelection: modify the selection to include the new searched positions. Useful if copyToClipboard is true. (default: true)debugNotify: show a notify message of the used search properties (User and Workspace properties are merged) (default: false)moveby: the regular expression to search for. Used only by Move Bylabel, description, detail: when SelectBy is called from the command palette it shows a QuickPick list. These 3 properties (strings) are used in the construction of the QuickPickItem. The default value for label is the key name of the range. The label is decorated with additional icons in case the range contains the parameters copyToClipboard or debugNotify. In the 3 properties you can use other icons with the $(<name>)-syntax.
If newline characters are part of the regular expression you can determine if it is part of the selection (see example SectionContent).
An example
"selectby.regexes": {
"regex1": {
"flags": "i",
"backward": "%% section",
"forward": "%% section",
"backwardInclude": true,
"forwardInclude": false
},
"SectionContent": {
"backward": "%% section(\\r?\\n)?",
"forward": "%% section",
"forwardInclude": false,
"backwardInclude": false,
"copyToClipboard": true
}
}
Select By with keybindings
It could be handy to have a search for a Regular Expression bound to a keyboard shortcut.
You create key bindings in keybindings.json.
If the definition of the search is found in the setting selectby.regexes you can specify the name of the search in an array:
{
"key": "ctrl+shift+alt+f9",
"when": "editorTextFocus",
"command": "selectby.regex",
"args": ["SectionContent"]
}
You can also define the range of the search in the args property by using an object:
{
"key": "ctrl+shift+alt+f9",
"when": "editorTextFocus",
"command": "selectby.regex",
"args": {
"backward": "%% section(\\r?\\n)?",
"forward": "%% section",
"forwardInclude": false,
"backwardInclude": false,
"copyToClipboard": true
}
}
If you create a keybinding without an args property a QuickPick list, with recently used items, will be shown where you can select a range to use.
Select By with forwardNext
By using the forward and forwardNext Regular Expressions you can modify the selection from the current selection end, or cursor position, by searching first for the forward Regular Expression and from that location search again for a Regular Expression to determine the end of the new selection.
It does not make sense to specify the backward Regular Expression. It has no effect on the result.
It is possible in the forwardNext Regular Expression to use captured groups () from the forward Regular Expression. It uses a special syntax to fill in the text from the captured groups. Use {{n}} to use captured group n from the forward Regular Expression. To use captured group 1 you use {{1}}.
An example: Select the next string content
In python you can specify 4 types of string literals.
Put this in your settings.json file:
"selectby.regexes": {
"stringContent": {
"forward": "('''|\"\"\"|'|\")",
"forwardNext": "{{1}}",
"forwardInclude": false,
"forwardNextInclude": false
}
}
Define a keybinding:
{
"key": "ctrl+shift+alt+f10",
"when": "editorTextFocus",
"command": "selectby.regex",
"args": ["stringContent"]
}
Select By with forwardNextExtendSelection
Based on idea by johnnytemp.
If you set forwardNextExtendSelection to true the selection is extended with the next occurrence of forwardNext Regular Expression if the start of the selection matches the forward Regular Expression.
The forwardNext Regular Expression must match at the selection end. If there is not a match at the selection end we start a new forward search at the selection end, just like a normal forward-forwardNext. You can extend the forwardNext match to any position by prefixing the Regular Expression with [\s\S]*? or .*? (non greedy anything), depending if you want to include new lines or not.
At the moment it only works if forwardNextInclude is true.
Example 1: Extend with the next item of a tuple
This example extends the selection with the next tuple element if the selection start is after the tuple open paranthesis (.
If there are no more elements in the tuple after the selection go to the next tuple.
Put this in your settings.json file:
"selectby.regexes": {
"extendNextTupleItem": {
"forward": "\\(",
"forwardNext": "[^,)]+(\\s*,\\s*)?",
"forwardInclude": false,
"forwardNextExtendSelection": true,
"label": "Extend next tuple item $(arrow-right)",
"description": "from tuple start"
}
}
And define a keybinding.
If it is not important that the selection starts at the first tuple item and the items are all word charcters you can use:
"selectby.regexes": {
"extendNextTupleItem2": {
"forward": "(?=\\w+)",
"forwardNext": "\\w+(\\s*,\\s*)?",
"forwardNextExtendSelection": true
}
}
The forward Regular Expression searches for a location that is followed by a tuple item. It is an empty match.
Example 2: Extend selection always with forwardNext
If you want to extend the selection always with forwardNext, you can set the forward Regular Expression to the string (?=[\s\S]) or (?=.), depending if you want to include new lines or not.
The examples are to extend the selection with the next part of the sentence. If you have line breaks in the sentence you should use the second alternative.
"selectby.regexes": {
"extendWithSentensePart": {
"forward": "(?=.)",
"forwardNext": ".*?[,.]",
"forwardNextExtendSelection": true
}
}
or
"selectby.regexes": {
"extendWithSentensePart": {
"forward": "(?=[\\s\\S])",
"forwardNext": "[\\s\\S]*?[,.]",
"forwardNextExtendSelection": true
}
}
But this could already be done with this setting:
"selectby.regexes": {
"extendWithSentensePart": {
"forward": "[\\s\\S]*?[,.]"
}
}
Select By with Surround
If the cursor or selection is inside of the text you want to select and can be described with a single regular expression you use the surround Regular Expression.
If you place the cursor somewhere inside a floating point number and you want to select the number you can use the following setting:
"selectby.regexes": {
"selectFloat": {
"surround": "[-+]?\\d+(\\.\\d+)?([eE][-+]?\\d+)?[fF]?"
}
}
For fast access you can create a keybinding for this just like the Ctrl+D for select word.
User and Workspace settings
The Workspace/folder setting does override the global User setting. The settings are deep-merged.
If you have defined this User setting:
"selectby.regexes": {
"regex1": {
"flags": "i",
"backward": "%% article",
"forward": "%% article",
"backwardInclude": true,
"forwardInclude": false
}
}
And this Workspace setting:
"selectby.regexes": {
"regex1": {
"flags": "i",
"forward": "%% section",
"forwardInclude": false
}
}
There will be still a search done backward for: %% article. The extension does not know which file has defined a particular setting. You have to disable the backward search in the Workspace setting:
"selectby.regexes": {
"regex1": {
"flags": "i",
"forward": "%% section",
"forwardInclude": false,
"backward": false
}
}
Select By Paste Clipboard
If you paste the clipboard content with Ctrl+V you loose the selection.
The command Paste clipboard and select (selectby.pasteClipboard) replaces the current selection with the content of the clipboard and keep it selected.
If you need it regularly a keybinding can be handy
{
"key": "ctrl+k ctrl+v",
"when": "editorTextFocus",
"command": "selectby.pasteClipboard"
}
It only works for single selection. If you use a copy with multi cursor selections the content of the clipboard does not show where each selection begins. There are extra empty lines added but they could also be part of a selection.
Select By Line Number
If you want to place a cursor on each line where the line number matches multiple boolean expressions you can use the command Place cursor based on line number, uses boolean expression (selectby.lineNr).
The boolean expression uses the following variables:
c : contains the line number of the cursor or the start of the first selection.n : contains the line number of the line under test, each line of the current document is testedk : is a placeholder to signify a modulo placement. Can only be used in an expression like c + 6 k. Meaning every line that is a multiple (k ∈ ℕ) of 6 from the current line. Every expression of the form c + 6 k is transformed to ((n-c)%number==0 && n>=c).
The input box for the lineNr expression remembers the last entered lineNr expression for this session.
The command can be used in a keybinding:
{
"key": "ctrl+k ctrl+k",
"when": "editorTextFocus",
"command": "selectby.lineNr",
"args": { "lineNrEx": "c+5k && n-c<100" }
}
This selects every 5th line for the next 100 lines.
Place multiple cursors per block or relative to block start
The expression c + 6 k places a cursor at the start of a modulo block. Maybe you want to place cursors at lines 1, 3 and 4 relative to the block start. You can use an expression like:
n>=c && ( (n-c)%6==1 || (n-c)%6==3 || (n-c)%6==4 )
If you want to place cursors at the first 3 lines of a block use:
n>=c && (n-c)%6<3
This can also be achieved with c+6k followed by Selection | Add Cursor Below 2 times
Select By Remove Cursor
If you have a Multi Cursor you can't remove a cursor with Cursor Undo (cursorUndo) when you have done some edit action.
The following commands remove a cursor/selection:
selectby.removeCursorBelow : remove the last cursor/selectionselectby.removeCursorAbove : remove the first cursor/selection
A suggestion for keybinding:
{
"key": "ctrl+alt+/",
"command": "selectby.removeCursorAbove",
"when": "editorTextFocus"
},
{
"key": "ctrl+alt+'",
"command": "selectby.removeCursorBelow",
"when": "editorTextFocus"
}
Move By
You can move the cursor based on Regular Expressions or using a Calculation.
Move By Regular Expression
The exported command is: moveby.regex
Move By uses the regex definitions as defined for Select By or specified in the "args" property of the key binding.
If called from the Command Palette it behaves the same as a key binding with an "args" property that is an Object with the content:
"args": {
"ask": true,
"properties": ["next", "end", "nowrap"]
}
To use fixed Regular Expressions or different properties for Move By you need to create 1 or more key bindings in keybindings.json.
The details of the search are specified in the "args" property of the key binding. The "args" property can be an Array or an Object.
args of keybinding is an Array
If the "args" property of the key binding is an Array the meaning of the 5 strings are:
- index 0: the key/name of the range you want to use as defined in the settings option
selectby.regexes
- index 1:
"forward" | "backward" | "moveby" | "forwardNext" - which regex string should be used
- index 2:
"prev" | "next" - search direction - do you want to search for the previous or next occurrence of the Regular Expression (default: "next")
- index 3:
"start" | "end" - should the cursor move to the start or the end of the found Regular Expression (default: "end")
- index 4:
"wrap" | "nowrap" - optional argument: do we wrap to other side of the file and continue search if not found (default: "nowrap") (proposed by Arturo Dent)
If the last element of the array is a default value you can omit that argument. You can apply this rule multiple times. But naming the first 4 arguments helps in the readability of the keybinding.
To use regular expressions that are not used in selections you can use the "moveby" property of the selectby.regexes elements or you can duplicate the "forward" or "backward" field. This property is just added to prevent confusion in the specification of "args" ("forward" does not mean to search in the forward direction)
args of keybinding is an Object
If the "args" property of the key binding is an Object it can have the following properties:
flags: a string with the regex flags "i" and/or "m" (default: "")regex: the regular expression to use, (default: ask for regular expression with InputBox)ask: a boolean to signal that the regex should be asked from the user, it is optional because if the regex property is missing it will be asked.
Just to remind you later which regex is used.properties: an Array of strings with the values corresponding to Array indexes (2,3,4) from the section: args of keybinding is an Array
The order of the properties is not important. (default: ["next", "end", "nowrap"])repeat: how many times to repeat the moveby. An integer or a string of an integer. If value is "ask" the user needs to enter a number. Choose the correct "end" or "start" or it will only happen once (default: 1)checkCurrent: check if current cursor position is a possible match (default: false)
If you want to move the cursor(s) to the first character inside the next Python string you can use:
{
"key": "ctrl+f6", // or any other key combo
"when": "editorTextFocus",
"command": "moveby.regex",
"args": {
"regex": "('''|\"\"\"|'|\")",
"properties": ["next", "end"]
}
}
If you want to move the cursor(s) to the start of the next regex asked from the user you can use:
{
"key": "ctrl+shift+f6", // or any other key combo
"when": "editorTextFocus",
"command": "moveby.regex",
"args": {
"ask": true,
"properties": ["next", "start"]
}
}
If you want to move n, ask user how often, <td> tags forward use:
{
"key": "alt+f6", // or any other key combo
"when": "editorTextFocus",
"command": "moveby.regex",
"args": {
"regex": "<td[^>]*>",
"properties": ["next", "end"],
"repeat": "ask"
}
}
if you want to insert a snippet at the end of an HTML open tag
{
"key": "alt+f7", // or any other key combo
"when": "editorTextFocus",
"command": "extension.multiCommand.execute",
"args": {
"sequence": [
{ "command": "moveby.regex",
"args": { "regex": ">", "properties": ["next", "start"]}, "checkCurrent": true },
{ "command": "editor.action.insertSnippet",
"args": { "snippet": " class=\"$1\"$0" } }
]
}
}
In a next version it will use a selection list with recently used entries on top. The default QuickPick list does not allow to enter a new item. And a list of starting Regular Expressions.
Move By Calculation
The exported command is: moveby.calculation
All positions (line and char) are 0 based. The first line has number 0.
Move By uses 2 calculation expressions defined in the "args" property of the key binding.
lineNrEx : calculate the new line number of the selection, default value is "selection.start.line" (the line number of the start of the selection)charNrEx : calculate the new character position of the selection
The expressions can be any JavaScript expression that results in a number. The number is converted to an int with Math.floor
The expressions can use a number of variables:
selection.start.lineselection.start.characterselection.end.lineselection.end.characterselections : the full array of all current selections/cursors. You can use the start and end property of a partucular selection. To get the last selection use selections[selections.length-1]currentLine : a string with the text of the line where the selection startscurrentLine.length : the length of currentLine variable
If you want to move the cursor to the midpoint of the line the cursor is on you can use
{
"key": "ctrl+i ctrl+m", // or any other key binding
"when": "editorTextFocus",
"command": "moveby.calculation",
"args": {
"charNrEx": "currentLine.length / 2"
}
}
moveby and Multi Cursor
moveby.regex and moveby.calculation support multi cursor. For each cursor the search is performed and the cursor is moved to the new location.
If the Regular Expression is not found for a particular selection/cursor the behavior depends on the number of cursors that have found a new location:
- if none have found a new location nothing happens and selections/cursors do not change
- if one or more cursors have found a new location this selection/cursor is removed, so you are sure the cursors remaining are at valid locations, they can be at previous locations of another cursor
If more than one cursor end at the same location they will be collapsed into one.
Reveal the new cursor locations
With the setting "moveby.revealType" you can change the behavior of how the cursor should be revealed after the move. In the Settings UI, group Extensions | Select By, it is a dropdown box with possible values. These strings are identical to the VSC API enum TextEditorRevealType. If there are multiple cursors the first cursor is used.
Move By and keybindings.json
You can create a key binding with the UI of VSC but you have to add the "args" property by modifying keybindings.json. If you do not define the "args" property it behaves as called from the Command Palette.
An example key binding:
{
"key": "ctrl+shift+alt+s",
"when": "editorTextFocus",
"command": "moveby.regex",
"args": ["SectionContent", "forward", "prev", "start"]
}
Move to previous and next empty line
Created by Arturo Dent and it needed a small code change to work because the regex matches an empty string.
Add the following to selectby.regexes
"goToEmptyLine": {
"flags": "m",
"moveby": "^$"
}
Define 2 key bindings (you can change the assigned keys)
{
"key": "ctrl+shift+f7",
"when": "editorTextFocus",
"command": "moveby.regex",
"args": ["goToEmptyLine", "moveby", "prev", "start"]
},
{
"key": "ctrl+shift+f8",
"when": "editorTextFocus",
"command": "moveby.regex",
"args": ["goToEmptyLine", "moveby", "next", "start"]
}
Release Notes
v1.5.1 moveby.regex fix a few cases
v1.5.0 moveby.regex add checkCurrent option
v1.4.0 selectby.swapActive swap cursor position within selection(s)
v1.3.0 selectby.regex in keybinding can have an object as args property
v1.2.0 moveby.regex has repeat property with ask possibility
v1.1.0 selectby.removeCursor(Above|Below) reduce number of Multi Cursors
v1.0.0 moveby.calculation move the cursor to lineNr:charPos with a calculation
TODO
- Support for Multi Cursors
- Move By called from Command Palette, Enter/Select options and remember RegExes for this section of VSC
