### 🧭 Compass - Better Code Navigation

<p align="center">
<a href="https://www.sublimetext.com/">
    <img src="https://img.shields.io/badge/Made%20For-Sublime-ff9800?logo=sublime%20text" /></a>
<a href="https://packagecontrol.io/packages/Compass%20Navigator"> 
    <img src="https://img.shields.io/packagecontrol/dt/Compass%20Navigator" /></a>
<a href="https://github.com/kapitanluffy/sublime-compass/releases">
    <img src="https://img.shields.io/github/v/tag/kapitanluffy/sublime-compass?label=release" /></a>
<a href="https://github.com/sponsors/kapitanluffy">
    <img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/kapitanluffy"></a>
</p>

---

Lost? Tired of endlessly scrolling through tabs just to find the previous file you were working on?

Compass provides you the list of most-recently used tabs. It also helps you filter them by special tags!

By default, `ctrl+tab` jumps you to the next view in the MRU stack without showing the stack.
Compass provides you a visual guide of where you have been.

---

### Installation

1. In your package directory, clone the repo
```
git clone git@github.com:kapitanluffy/sublime-compass.git "Compass Navigator"
```

2. Run `Preferences: Compass Keybindings` and copy pre-commented the keybindings (or you can set it to your preferred keybinds)

3. Press `ctrl+tab` to show the Compass 🧭

#### Open Compass

> `ctrl+tab`

Open the quick panel. Displays most-recently used tabs by default.

https://github.com/kapitanluffy/sublime-compass/assets/485799/b62c1d9b-3a10-4aba-9c0f-ccadac667f01

#### Quick switching

You can do this by pressing `ctrl+tab` on the first and second items

https://github.com/kapitanluffy/sublime-compass/assets/485799/d051d3f1-90f2-4849-99fa-0c46b908391e


#### Close Compass and select Current Highlight

> `ctrl+ctrl`

Select the current highlight and close the quick panel


#### Close Compass and go back to initial view

> `alt+alt`

Go back to the initial tab and close the quick panel

https://github.com/kapitanluffy/sublime-compass/assets/485799/b0613890-8b93-4c6f-b7c2-f66e4739eb11


#### Filtering

Type a query. `#` are for filters

https://github.com/kapitanluffy/sublime-compass/assets/485799/a37b6f12-0c00-4120-933e-1a9e7b74b3f4


#### Opening files

If you have [ripgrep](https://github.com/BurntSushi/ripgrep) set in the settings, you can enable this feature.
Please note that this will be slow in large projects!

https://github.com/kapitanluffy/sublime-compass/assets/485799/7e3282b6-46d0-4c76-ba6e-69aebb376891