Scalex Documentation Search
Search Scala and Scalaz documentation right from Sublime Text.
Details
Installs
- Total 1K
- Win 506
- Mac 465
- Linux 316
Apr 2 | Apr 1 | Mar 31 | Mar 30 | Mar 29 | Mar 28 | Mar 27 | Mar 26 | Mar 25 | Mar 24 | Mar 23 | Mar 22 | Mar 21 | Mar 20 | Mar 19 | Mar 18 | Mar 17 | Mar 16 | Mar 15 | Mar 14 | Mar 13 | Mar 12 | Mar 11 | Mar 10 | Mar 9 | Mar 8 | Mar 7 | Mar 6 | Mar 5 | Mar 4 | Mar 3 | Mar 2 | Mar 1 | Feb 28 | Feb 27 | Feb 26 | Feb 25 | Feb 24 | Feb 23 | Feb 22 | Feb 21 | Feb 20 | Feb 19 | Feb 18 | Feb 17 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 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 |
Mac | 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 | 0 | 0 | 0 | 0 | 0 | 0 | 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 | 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 |
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 textmap
list map
Search for the textlist
and the textmap
list[a] => (a => boolean) => list[a]
Search for the typeList[A] => (A => Boolean) => List[A]
: list[a] => a
Search for the typeList[A] => A
conserve: List[a] => (a => b) => List[b]
Search for the textconserve
and the typeList[A] => (A => B) => List[B]
Packages
You can reduce the search scope to one or more packages:
foldl +scala
Searchfoldl
only inscala
foldl +scalaz
Searchfoldl
only inscalaz
foldl -scalaz
Searchfoldl
everywhere except inscalaz
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:
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.
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