Master Key

Appearance

master-key.search ​

Moves cursor (and possibly the selection) to matching string (or regex).

Arguments

  • text: The text to search for; if left blank, search string is requested from user
  • acceptAfter (optional): If specified, limits the number of characters required from the user to the given number.
  • backwards (default=false): Whether to search forward (default) or backwards from cursor position
  • caseSensitive (default=false): Whether the search-string matching is sensitive to the case of letters.
  • regex (default=false): If true the provided search text will be interpreted as a regular expression
  • wrapAround: (default=false): If true search will wrap back to the top of the file when hitting the end of the file, and back to the bottom when hitting the top.
  • selectTillMatch (default=false): If true, all text from the current cursor position up until the searched-to position will be highlighted. (Technically this means that the final character position of the cursor is one character further)
  • highlightMatches (default=true): If true search-string matches visible in the editor will be highlighted.
  • offset (default='closerBoundary'): determines where the cursor will land with respect to the search match. The possible values are:
    • 'closerBoundary': move selection or cursor to the boundary of the search term which is closer to the starting position. When moving forward this is at the start of the search term, and when moving backwards this is at the end of the search term.
    • 'fartherBoundary': move selection or cursor to the boundary of the search term that is farther from the starting position. When moving forward this is at the end of the search term, and when moving backwards this is at the start of the search term.
    • 'start': cursor will land on the first character of the match
    • 'end': cursor will land on the last character of the match
    • {'from': [string], by: [number]}: land on the character that is by steps away from the offset specified in 'from'. When by is 0, this is identical to specifying from as the offset (e.g. {'from': 'start', 'by': 0} is the same as 'start'). The direction of movement implied by a positive value depends on the offset specified. The two boundary offsets (closertBoundary and fartherBoundary) imply an offset where positive values move in the same direction as search moved. start and end imply an offset where positive values move forward in the file and negative backwards.
  • register (default="default"): A unique name determining where search state will be stored. Calls to (nextMatch/previousMatch) use this state to determine where to jump. If you have multiple search commands you can use registers to avoid the two commands using a shared search state.
  • skip (default=0): the number of matches to skip before stopping.