# FoldFunctions

This package folds every functions in the current file, so that you can have a global view of it, and then unfold a few, so that you don't have to scroll a lot, skipping over the functions you're not interested in at the moment.

For now, the following language are supported:

- Python :heart:
- JavaScript

The good part is that it supports arguments on  multiple lines, like so (in this case, it's python):

```python
def my_function(argument_number_one, argument_number_two,
                argument_number_three):
    print('It works!!')

    for i in range(10):
        print('It really does!')
```

![Example of folding with this package - FoldFunctions - through the command palette of Sublime Text](fold-functions.gif)

## Installation

Because it is not available on package control for now, you have to add this repo "manually" to your list.

### Using package control

1. Open up the command palette (`ctrl+shift+p`), and find `Package Control: Add Repository`. Then enter the URL of this repo: `https://github.com/math2001/FoldFunctions` in the input field.
2. Open up the command palette again and find `Package Control: Install Package`, and just search for `FoldFunctions`. (just a normal install)

### Using the command line

```bash
cd "%APPDATA%\Sublime Text 3\Packages"             # on window
cd ~/Library/Application\ Support/Sublime\ Text\ 3 # on mac
cd ~/.config/sublime-text-3                        # on linux

git clone "https://github.com/math2001/FoldFunctions"
```

> Which solution do I choose?

It depends of your needs:

- If you intend to just use FoldFunctions, then pick the first solution (Package Control), **you'll get automatic update**.
- On the opposite side, if you want to tweak it, use the second solution. Note that, to get updates, you'll have to `git pull`

## Usage

The command is accessible from the command palette. 

- <kbd>ctrl+shift+p</kbd>
- Search for `Fold Functions`
- hit <kbd>enter</kbd>

Note: The caption will be the same, whichever supported language file you are editing, but the actual command will change. :wink:

### Adding a key binding

It's up to you, but I prefer to have this command bound to this command, in my case, <kbd>alt+f</kbd>. So, here's what I've done:


```json
{
    "keys": ["alt+f"],
    "command": "fold_python_functions",
    "context": [
        {"key": "selector", "operand": "source.python"}
    ]
},
{
    "keys": ["alt+f"],
    "command": "fold_javascript_functions",
    "context": [
        {"key": "selector", "operand": "source.js"}
    ]
}
```