Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CWood-sdf/spaceport.nvim
The blazingly fastest way to get to your projects
https://github.com/CWood-sdf/spaceport.nvim
Last synced: 7 days ago
JSON representation
The blazingly fastest way to get to your projects
- Host: GitHub
- URL: https://github.com/CWood-sdf/spaceport.nvim
- Owner: CWood-sdf
- License: apache-2.0
- Created: 2023-09-14T01:16:57.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-23T16:20:01.000Z (4 months ago)
- Last Synced: 2024-08-02T06:23:23.433Z (3 months ago)
- Language: Lua
- Homepage:
- Size: 584 KB
- Stars: 78
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - CWood-sdf/spaceport.nvim - The start screen that gets you to your projects blazingly fast. (Startup / Cursorline)
README
# Spaceport.nvim
The "blazingly fastest" way to get to your projects
## Why
I got really annoyed with the pattern of cd'ing to a project folder then doing `nvim .` then starting to program. I wanted to just type `nvim` and then a few keystrokes later, be in a project. I wanted something that was kind of like [harpoon](https://github.com/ThePrimeagen/harpoon), but for directories, not files.
## How
Spaceport automatically keeps track of every file and directory you open neovim to. It then uses this information to provide a list of the most recently used projects. Then you can navigate to a project by selecting it from the list
## Tag System
Some projects can be tagged so that they always appear as a certain number on the list. For example, I have my neovim dotfiles as tag 1, so in a new terminal window, I can type `nvim` and then `1p` and instantly be at my dotfiles, rather than having to type `cd ~/.config/nvimnvim .`.
The tag system is something I've only seen in one other startup plugin: [startup.nvim](https://github.com/startup-nvim/startup.nvim), yet even in startup.nvim the tags have to be manually defined in your config making them really clunky to use.
The tag system when properly used can make it so that you can get to your most used projects in less than half a second.
## Installation
lazy.nvim
```lua
{
'CWood-sdf/spaceport.nvim',
opts = {
},
lazy = false, -- load spaceport immediately
}
```
The default options are:
```lua
{
-- This prevents the same directory from being repeated multiple times in the recents section
-- For example, I have replaceDirs set to { {"~/projects", "_" } } so that ~/projects is not repeated a ton
-- Note every element is applied to the directory in order,
-- so if you have { {"~/projects", "_"} } and you also want to replace
-- ~/projects/foo with @, then you would need
-- { {"~/projects/foo", "@"}, {"~/projects", "_"} }
-- or { {"~/projects", "_"}, {"_/foo", "@"} }
replaceDirs = {},
-- turn /home/user/ into ~/ (also works on windows for C:\Users\user\)
replaceHome = true,
-- What to do when entering a directory, personally I use "Oil .", but Ex is preinstalled with neovim
projectEntry = "Ex",
-- The farthest back in time that directories should be shown
-- I personally use "yesterday" so that there aren't millions of directories on the screen.
-- the possible values are: "pin", "today", "yesterday", "pastWeek", "pastMonth", and "later"
lastViewTime = "later",
-- The maximum number of directories to show in the recents section (0 means show all of them)
maxRecentFiles = 0,
-- The sections to show on the screen (see `Customization` for more info)
sections = {
"_global_remaps",
"name",
"remaps",
"recents",
},
-- For true speed, it has the type string[][],
-- each element of the shortcuts array contains two strings, the first is the key, the second is a match string to a directory
-- for example, I have ~/.config/nvim as shortcut f, so I can type `f` to go to my neovim dotfiles, this is set with { { "f", ".config/nvim" } }
shortcuts = {},
--- Set to true to have more verbose logging
debug = false,
-- The path to the log file
logPath = vim.fn.stdpath("log") .. "/spaceport.log",
-- How many hours to preserve each log entry for
logPreserveHours = 24,
}
```
### Explanation of (some of) the options
- replaceDirs: Sometimes the same directory appears a lot in the recents section, this makes it harder to read the screen because a lot of the letters are repeated. This option makes it so that the same directory is not repeated a lot, which makes it _much much_ easier to find a project
- replaceHome: This option is just a more specific version of replaceDirs, it makes it so that the home directory is replaced with `~`
- lastViewTime: This option makes it so that there are not a lot of directories on the screen (which can look kind of ugly). There is also a functional purpose for this, if a directory is number 50, it would be faster to find it by using telescope than by scrolling through the list
- maxRecentFiles: This option is just a different version of lastViewTime
- shortcuts: This option is to enable true speed (AKA get to your project before spaceport can even render speed). For some directories, even typing `1p` is too slow, sometimes I just want to instantly be at a directory. This option is a 2d array, but the important thing is that the second element is a _match string_ and not an absolute directory. This makes it so that your shortcuts will work better on other computers (where your directory structure might be slightly different). I've seen a shortcut system in other startup plugins, but it required absolute directories, which is not very portable
## Performance
Spaceport is designed to be as fast as possible. The config time measured with lazy.nvim is ~0.2ms with the default configuration. Each render cycle takes only about 4-10ms.
## Usage
Spaceport automatically loads after neovim has started, there is no need to run any commands, but if you want to switch projects, run `:Spaceport` to go back to the start screen.
All the remaps are visible at the top of the screen with the default configuration. Any remap that deals with a project can either be used while hovering over the project or by prefixing the command with the project's number. For example, if I have a project with the number 1, I can type `1p` to open that project, or I can move the cursor to hover over the project and press `p`.
When you are first starting out with spaceport, it has no history of which directories you have opened, there are 3 methods to add directories to the recents section:
1. Open a directory by cd'ing to it and then running `nvim .` in your terminal
2. Use telescope and run `require('telescope').extensions.spaceport.find()`, this will allow you to fuzzy find all subdirectories of the current directory and open them (using the linux `find` command)
3. Run `:Spaceport importOldfiles` to import the files from `vim.v.oldfiles`, this option is not recommended because it will import files, not directories, and it will not import the time data, so all the files will be marked as being opened today
This is what spaceport looks like when projects are tagged.
## Customization
Spaceport is completely customizable, anything displayed on the screen can be reconfigured by changing the `sections` option. The default sections are:
```lua
{
"_global_remaps",
"name",
"remaps",
"recents",
}
```
All the preconfigured sections are:
- `_global_remaps`: This section adds a few remaps that are universally useful, like being able to refresh the screen
- `name`: This section displays an ascii art "Spaceport" logo
- `remaps`: This section displays all the remaps that are defined as visible in all the other screens
- `recents`: This section displays the most recently used projects, as well as the pinned projects
- `name_blue_green`: This section displays the ascii art logo, but with a blue-green gradient
- `hacker_news`: This section displays the top 5 stories on hacker news
### Default Screen Highlight Groups
If you want to change the highlighting of the recents or remaps sections, you can set any of the following highlight groups: `SpaceportRemapDescription`, `SpaceportRemapKey`, `SpaceportRecentsTitle`, `SpaceportRecentsProject`, or `SpaceportRecentsCount`
The code to do that would look like this:
```lua
vim.api.nvim_set_hl(0, "SpaceportRecentsTitle", {
fg = "red",
})
```
### Custom Screens
If you want to have your own section, you can add a table entry to the `sections` array. The table entry should conform to the type `SpaceportScreen` defined in `lua/spaceport/screen.lua`. An example screen could be something like this:
```lua
local i = 0
{
title = "count",
lines = function()
return {
-- lines can be strings
"Count: ",
-- or lines can be arrays of `SpaceportWord`s, this allows the words to have highlights
{
-- Spaceport words are tables with the following fields:
-- [1] = the text to display
-- colorOpts = the options to pass to `vim.api.nvim_set_hl`
-- See [nvim_set_hl docs](https://neovim.io/doc/user/api.html#nvim_set_hl())
-- Alternatively, if you want the value to be customizable, you can set the
-- _name field to the name of a global highlight group along with all the other values
-- If spaceport detects that the global highlight group exists, it will use that, otherwise it will create the highlight group with the given values
{
i .. "",
colorOpts = {
fg = "red",
},
},
},
}
end,
-- The number of empty lines to put between this section and the previous section
topBuffer = 0,
remaps = {
{
key = "w",
mode = "n",
--- Spaceport passes two parameters to action:
--- 1. The line that the cursor is on (relative to the start of the screen)
--- 2. vim.v.count
action = function(line, count)
i = i + 1
-- This will cause the screen to be re-rendered
require('spaceport.screen').render()
end,
description = "Increment count",
-- Setting this to false will make the remap not be shown in the 'remaps' section
visible = true,
-- Setting this to false will make it so that the action will only be called when the cursor is on the lines of the screen
callOutside = true,
},
},
-- if this is nil, the screen will be centered
position = {
-- Positive values are from the top, negative values are from the bottom
row = -1,
-- Positive values are from the left, negative values are from the right
col = 1,
},
onExit = function()
-- This function will be called when spaceport is exited
i = 0
end,
}
```
Note that all of these values except lines can be left nil in an actual screen, this is just all filled out to show what the possible values are.
If you have a screen that may be universally useful (like a better looking version of any default screen), open a PR with that code in a file in the `lua/spaceport/screens/` directory, you can see some other files in that directory if you need examples
## Tmux Integration
If you're in a tmux window, you can call `:Spaceport renameWindow` to rename the window, furthermore this information is saved so that whenever you reopen that directory, the tmux window name will be changed.
The same thing can be done for sessions with `:Spaceport renameSession`
If you want to split the tmux window while preserving the directory you're in, you can call `:Spaceport verticalSplit` or `:Spaceport horizontalSplit`, and it will split the window vertically and open to the project dir in a new pane.
## Telescope integration
Spaceport integrates with telescope so that you can fuzzy find projects to open. To use this, you need to have telescope installed, and then you can add this to your config:
```lua
require('telescope').load_extension('spaceport')
```
Then you can use the `projects` picker to select a project by its directory name:
```lua
require('telescope').extensions.spaceport.projects()
```
Or you can search for a specific tmux window or session name:
```lua
require('telecope').extensions.spaceport.tmux_windows()
require('telecope').extensions.spaceport.tmux_sessions()
```
Or you can search for a directory that is not yet registered in spaceport:
```lua
require('telescope').extensions.spaceport.find()
```
## Events
Spaceport emits three events:
- `SpaceportEnter`: This event is emitted when spaceport is entered
- `SpaceportDone`: This event is emitted when a project is entered, or when neovim is started with a file or directory argument
- `SpaceportDonePre`: This event is emitted before a project is entered
## Spaceport Buffer Name
The spaceport buffer is named `spaceport` with a filetype of `spaceport`. You can use this to set up autocommands for when spaceport is entered or exited
## Importing vim.v.oldfiles
All other plugins use the `vim.v.oldfiles` to keep track of your most recently used files, rather than your directories. To import this data, just call `:Spaceport importOldfiles` and pass the number of files you want to import as an argument. Spaceport will add them to the database as being opened today because `vim.v.oldfiles` does not provide time data.
## Contributing
Before contributing, please read the ARCHITECTURE.md file