From 02b1533ff4002f1015b9c26cf69256d821ddb6b1 Mon Sep 17 00:00:00 2001 From: Kyren223 Date: Thu, 22 Feb 2024 22:34:10 +0200 Subject: Rebranded to "Trident" --- README.md | 85 +++++++++++++++++++++++++++++++++------------------------------ 1 file changed, 45 insertions(+), 40 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7f2ba7f..b03fc1a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@
-# Harpoon for JetBrains -##### Getting you where you want with the fewest keystrokes. +# Trident +##### Effortless file traversal to minimize keystrokes and maximize productivity + +[![GitHub release](https://img.shields.io/github/v/release/Kyren223/Trident?style=for-the-badge)](https://github.com/Kyren223/Trident/releases/tag/1.0)
## Table of Contents @@ -14,80 +16,83 @@ * [Contact](#contact) ## Description -This plugin is inspired by the original [Harpoon](https://github.com/ThePrimeagen/harpoon) NeoVim plugin by ThePrimeagen -but aims to provide the same functionality for JetBrains IDEs. +Trident is a plugin for JetBrains IDEs that allows you to quickly navigate to your most used files with as few keystrokes as possible. + +The plugin is inspired by the [Harpoon](https://github.com/ThePrimeagen/harpoon) NeoVim plugin by ThePrimeagen but aims to add additional features and proper integration with the IDE. ## Features * Navigate to your most used files with a single keystroke. -* Easily append files to your Harpoon list. +* Easily append files to a per-project list for fast access. * Quick Menu - * Select a file from your Harpoon list and open it. - * Delete a file from your Harpoon list. - * Reorder / Move files in your Harpoon list. - * Add / Insert files to your Harpoon list. + * Select a file from the list and open it. + * Delete a file from the list. + * Reorder / Move files in the list. + * Add / Insert files to the list. * Project-relative file paths using `...` syntax. -* Per-project Harpoon lists. -* Configurable Vim & IDE keymaps for all actions. +* Per-project lists. +* Configurable IdeaVim and IDE keymaps for all actions. ## Installation * Version 2023.1 or later of any IntelliJ-based IDE is required. -* Install the plugin from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23771-harpoonforjb). +* Install the plugin from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23771-trident). ## Getting Started +* All actions can be mapped to IDE keymaps like usual, the examples below are for IdeaVim only. +* Make sure to download IdeaVim if you want to configure the keymaps via .ideavimrc ### Example .ideavimrc Configuration ```vimrc -" Append the current file to the Harpoon list -map a :action HarpoonAppend +" Append the current file to the list +map a :action TridentAppend -" Open the Harpoon quick menu -map :action HarpoonToggleQuickMenu +" Open the quick menu +map :action TridentToggleQuickMenu " Select the given file (from the Quick Menu) and open it -map o :action HarpoonQuickMenuSelect +map o :action TridentQuickMenuSelect -" Hotkeys to open the first 4 items in the Harpoon list -map :action HarpoonSelect1 -map :action HarpoonSelect2 -map :action HarpoonSelect3 -map :action HarpoonSelect4 +" Hotkeys to open the first 4 items in the list +map :action TridentSelect1 +map :action TridentSelect2 +map :action TridentSelect3 +map :action TridentSelect4 -" Toggle previous & next buffers stored within Harpoon list -map :action HarpoonSelectPrev -map :action HarpoonSelectNext +" Toggle previous & next buffers stored within the list +map :action TridentSelectPrev +map :action TridentSelectNext ``` ### My .ideavimrc Configuration ```vimrc -map a :action HarpoonAppend -map :action HarpoonToggleQuickMenu +map a :action TridentAppend +map :action TridentToggleQuickMenu " I am Using "Enter" from settings so no need to map it here -map :action HarpoonSelect1 -map :action HarpoonSelect2 -map :action HarpoonSelect3 -map :action HarpoonSelect4 +map :action TridentSelect1 +map :action TridentSelect2 +map :action TridentSelect3 +map :action TridentSelect4 ``` ### Settings **Descriptions** -* Harpoon Width - Describes how wide the Harpoon Quick Menu should be. -* Harpoon Height - Describes how tall the Harpoon Quick Menu -* Harpoon Font Size - Describes the font size of the Harpoon Quick Menu -* Enter - When checked the Harpoon Quick Menu will open the file when you press enter, otherwise it will look for your .ideavimrc file for the keybinding. +* Width - Describes how wide the Quick Menu should be. +* Height - Describes how tall the Quick Menu +* Font Size - Describes the font size of the Quick Menu +* Enter to select - When checked the Quick Menu will open the file when you press enter, otherwise it will look for your .ideavimrc file for the keybinding. **Defaults** -* Harpoon Width - 800 -* Harpoon Height - 400 -* Harpoon Font Size - 20 -* Enter - true +* Width - 800 +* Height - 400 +* Font Size - 20 +* Enter to select - true ## Contribution This plugin is open-source and contributions are welcome. -Note to beginners or first-time contributors: I recommend starting by going to the issues tab and looking for issues to work on. +I recommend looking at the issues tab or the [TODO.md](TODO.md) file for ideas on what to work on. ### Steps to contribute 1. Fork the repository. -- cgit v1.3.1