https://github.com/saccarosium/neomarks

A new take on vim marks
https://github.com/saccarosium/neomarks

Last synced: 3 months ago
JSON representation

A new take on vim marks

• Host: GitHub
• URL: https://github.com/saccarosium/neomarks
• Owner: saccarosium
• License: mit
• Archived: true
• Created: 2023-09-21T14:44:02.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-11T12:33:41.000Z (about 1 year ago)
• Last Synced: 2024-04-16T02:42:15.447Z (7 months ago)
• Language: Lua
• Size: 22.5 KB
• Stars: 35
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> **Important**

> All the credits for the idea for the plugin goes to [ThePrimegean][1] and his

> plugin [harpoon][2]. I highly suggest you to watch is [vimconf video][3] to

> understand the usage of this plugin.

> **Warning**

> This plugin is not stable. Is expected changes in the API. If you experience bugs open an issue



# Neomarks

A new take on vim marks.



## Table of contents

* [Goals](#goals)

* [Non Goals](#non-goals)

* [Why](#why)

* [Installation](#installation)

* [Setup](#setup)

  * [Branch specific marks](#branch-specific-marks)

* [Roadmap](#roadmap)

* [UI Mappings](#ui-mappings)

## Goals

* No opt-out dependencies

* Take advantage of native neovim features

## Non Goals

* Feature compatible with harpoon

* Support anything other than marking file

## Why

[Harpoon][2] is great and all but as a lot of features that I don't really need

and depends on `plenary.nvim`. This plugin focus on minimalism, do the minimum

set of features to be usable and use only neovim standard functions.

## Installation

Using your favorite Package manager:

```

"saccarosium/neomarks"

```

Put it directly in your config:

```sh

curl https://raw.githubusercontent.com/saccarosium/neomarks/main/lua/neomarks.lua -o "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim/lua/neomarks.lua

```

## Setup

Call the `setup` function (the following are the defaults):

```lua

require("neomarks").setup({

  storagefile = vim.fn.stdpath('data') .. "/neomarks.json",

  menu = {

    title = "Neomarks",

    title_pos = "center",

    border = "rounded",

    width = 60,

    height = 10,

  }

})

```

Now you can remap as you wish the following functions:

```lua

require("neomarks").mark_file() -- Mark file

require("neomarks").menu_toggle() -- Toggle the UI

require("neomarks").jump_to() -- Jump to specific index

```

### Branch specific marks

> **Note**

> For enabling branch specific files you need to: or install some sort of git integration plugin, that exposes a function to get the current branch name, or build a function on your own. It is preferable to achive this using a plugin. Some options are: [gitsigns.nvim][4] or [vim-fugitive][5].

To enable the feature you need to pass a function that returns the current branch name.

```lua

git_branch = vim.fn["FugitiveHead"], -- For vim-fugitive

git_branch = function() return vim.api.nvim_buf_get_var(0, "gitsigns_head") end, -- For gitsigns.nvim

git_branch = function() ... end, -- For custom function that returns branch name

```

## Roadmap

- [x] Support branch specific marks

- [ ] Mark specific buffer symbol using tree-sitter

## UI Mappings

| Keys | Action |

| :--- | :----- |

| ``, `e`, `E` | edit file under the cursor |

| ``, ``, `q` | close UI |

[1]: https://github.com/ThePrimeagen

[2]: https://github.com/ThePrimeagen/harpoon

[3]: https://www.youtube.com/watch?v=Qnos8aApa9g

[4]: https://github.com/lewis6991/gitsigns.nvim

[5]: https://github.com/tpope/vim-fugitive