ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Scalex Documentation Search

by pkukielka ST3

Search Scala and Scalaz documentation right from Sublime Text.

Details

Installs

  • Total 1K
  • Win 373
  • OS X 413
  • Linux 288
Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7
Windows 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 1 1 0 0 0 0 0 0 0 0 1
OS X 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

SublimeScalex

Introduction

This plugin provides integration between Sublime Text and Scalex.
It allows you to search for any Scala or Scalaz function directly from ST.
Quoting Scalex main page:

Names and Types

Searches can be either textual (a list of words), or by type (a type signature) or both. A search is considered a text search unless it contains a combination of text and symbols, or if it starts with :. To search for both a type and a name, place a : between them, for example size: List[A] => Int.

Example queries
  • map Search for the text map
  • list map Search for the text list and the text map
  • list[a] => (a => boolean) => list[a] Search for the type List[A] => (A => Boolean) => List[A]
  • : list[a] => a Search for the type List[A] => A
  • conserve: List[a] => (a => b) => List[b] Search for the text conserve and the type List[A] => (A => B) => List[B]
Packages

You can reduce the search scope to one or more packages:

  • foldl +scala Search foldl only in scala
  • foldl +scalaz Search foldl only in scalaz
  • foldl -scalaz Search foldl everywhere except in scalaz

Installation

Right now SublimeScalex works only under ST3 (or at least was not tested under ST2 yet). If there will be enough interest I'll port it to older version as well.

The easiest way to install SublimeScalex is to use Package Control. You can also install it from here, by downloading and copying this folder to your packages directory.

Usage

Open the Command Palette and search for 'SublimeScalex' or just hit Ctrl + Alt + F to open Function search bar:

alt text

Describe what you are looking for as explained in the Introduction section and hit Enter. You will see list filled with entries matching your query. You can filter it further using standard Sublime fuzzy search.

alt text

If you want to see more details about any entry highlight it and hit Enter again (or just click it with the mouse). You will be moved to appropriate scaladoc, if it exists.
If you down want to open scaladoc just hit Esc.

Default number of showed results is limited to 20 to speed up querying, but you can change it in settings if you like.

Final notes

For bigger Scala projects I still prefer to use IntelliJ, but for simple scripts and snippets I found Sublime to be more pleasant. If you want to turn your Sublime into powerful Scala development environment then I recommend you to look at few more plugins:

  • sublime-ensime - error checking with Scala presentation compiler, and more
  • SublimeREPL - Scala REPL inside Sublime, let you play with your code in more interactive way
  • LoadFileToRepl - load current file into REPL, very comfortable to use