harpoon

⇁ ГАРПУН 2

Это устаревшая версия, и все будущие изменения будут относиться к ветке harpoon2 .

Гарпун 2

СТАТУС : Слияние с основной веткой 20 апреля или 9 июня (хорошо)

---

README устаревшего гарпуна

Гарпун

Доберитесь туда, куда вы хотите, с помощью наименьшего количества нажатий клавиш.

-- изображение предоставлено Бобом Растом

⇁ незавершенное производство

Он не полностью готов, хотя используется несколькими людьми. Если у вас возникнут какие-либо проблемы, вы увидите какое-то улучшение, которое, по вашему мнению, было бы потрясающим, или просто хотите оставить отзыв о гарпуне (или обо мне), создайте проблему!

⇁ Проблемы:

1. Вы работаете над кодовой базой. средний, большой, маленький, да какой угодно. Вы часто пользуетесь небольшим набором файлов и устали от нечеткого поиска, :bnext и :bprev становятся слишком повторяющимися, альтернативный файл не совсем подходит и т. д. и т. п.
2. Вы хотите выполнить некоторые команды, специфичные для проекта, или иметь любое количество постоянных терминалов, к которым можно легко перейти.

⇁ Решения:

1. Возможность указывать или на лету отмечать и создавать постоянные нажатия клавиш для перехода к нужным файлам.
2. Неограниченное количество терминалов и навигации.

⇁ Установка

• требуется неовим 0.5.0+
• установите с помощью вашего любимого менеджера плагинов (в данном примере vim-plug )

Plug ' nvim-lua/plenary.nvim ' " don't forget to add this one if you don't have it yet!
Plug ' ThePrimeagen/harpoon ' 

⇁ Гарпунинг

здесь мы объясним, как использовать силу гарпуна:

Знаки

вы отмечаете файлы, к которым хотите вернуться позже

: lua require ( " harpoon.mark " ). add_file ()

Навигация по файлам

просмотреть все отметки проекта с помощью:

: lua require ( " harpoon.ui " ). toggle_quick_menu ()

вы можете перемещаться вверх и вниз по списку, вводить, удалять или изменять порядок. q и <ESC> выйти и сохранить меню.

вы также можете переключиться на любую отметку, не вызывая меню, используйте приведенный ниже индекс нужной отметки

: lua require ( " harpoon.ui " ). nav_file ( 3 )                  -- navigates to file 3

вы также можете циклически просматривать список в обоих направлениях

: lua require ( " harpoon.ui " ). nav_next ()                   -- navigates to next mark
: lua require ( " harpoon.ui " ). nav_prev ()                   -- navigates to previous mark

из быстрого меню откройте файл в: вертикальном разделении с помощью control+v, горизонтальном разделении с помощью control+x, новой вкладке с помощью control+t

Терминальная навигация

это работает как навигация по файлам, за исключением того, что если по указанному индексу нет терминала, создается новый терминал.

 lua require ( " harpoon.term " ). gotoTerminal ( 1 )             -- navigates to term 1

Команды терминалам

команды можно отправлять на любой терминал

 lua require ( " harpoon.term " ). sendCommand ( 1 , " ls -La " )    -- sends ls -La to tmux window 1

еще больше команд можно сохранить для быстрого последующего использования.

 lua require ( ' harpoon.cmd-ui ' ). toggle_quick_menu ()       -- shows the commands menu
lua require ( " harpoon.term " ). sendCommand ( 1 , 1 )           -- sends command 1 to term 1

Поддержка Tmux

tmux поддерживается «из коробки» и может использоваться в качестве замены обычных терминалов, просто переключая 'term' with 'tmux' вот так

 lua require ( " harpoon.tmux " ). gotoTerminal ( 1 )             -- goes to the first tmux window
lua require ( " harpoon.tmux " ). sendCommand ( 1 , " ls -La " )    -- sends ls -La to tmux window 1
lua require ( " harpoon.tmux " ). sendCommand ( 1 , 1 )           -- sends command 1 to tmux window 1

sendCommand и goToTerminal также принимают любой действительный идентификатор панели tmux.

 lua require ( " harpoon.tmux " ). gotoTerminal ( " {down-of} " )   -- focus the pane directly below
lua require ( " harpoon.tmux " ). sendCommand ( " %3 " , " ls " )     -- send a command to the pane with id '%3'

Как только вы переключитесь на окно tmux, вы всегда можете переключиться обратно на neovim, это небольшой bash-скрипт, который переключится на окно, в котором работает neovim.

В вашем tmux.conf (или в любом другом месте, где у вас есть привязки клавиш) добавьте это

bind-key -r G run-shell " path-to-harpoon/harpoon/scripts/tmux/switch-back-to-nvim "

Поддержка телескопа

Гарпун 1-го регистра как удлинитель телескопа

 require ( " telescope " ). load_extension ( ' harpoon ' )

в настоящее время в телескопе поддерживаются только метки

 :Telescope harpoon marks

⇁ Конфигурация

если требуется настройка гарпуна, это необходимо сделать с помощью функции настройки гарпуна

 require ( " harpoon " ). setup ({ ... })

Глобальные настройки

вот все доступные глобальные настройки со значениями по умолчанию

 global_settings = {
    -- sets the marks upon calling `toggle` on the ui, instead of require `:w`.
    save_on_toggle = false ,

    -- saves the harpoon file upon every change. disabling is unrecommended.
    save_on_change = true ,

    -- sets harpoon to run the command immediately as it's passed to the terminal when calling `sendCommand`.
    enter_on_sendcmd = false ,

    -- closes any tmux windows harpoon that harpoon creates when you close Neovim.
    tmux_autoclose_windows = false ,

    -- filetypes that you want to prevent from adding to the harpoon list menu.
    excluded_filetypes = { " harpoon " },

    -- set marks specific to each git branch inside git repository
    mark_branch = false ,

    -- enable tabline with harpoon marks
    tabline = false ,
    tabline_prefix = "   " ,
    tabline_suffix = "   " ,
}

Предварительно настроенные команды терминала

для предварительной настройки команд терминала для последующего использования

 projects = {
    -- Yes $HOME works
    [ " $HOME/personal/vim-with-me/server " ] = {
        term = {
            cmds = {
                " ./env && npx ts-node src/index.ts "
            }
        }
    }
}

⇁ Ведение журнала

• журналы записываются в harpoon.log по пути к кэшу nvim ( :echo stdpath("cache") )
• доступные уровни журнала: trace , debug , info , warn , error или fatal . warn по умолчанию
• уровень журнала можно установить с помощью vim.g.harpoon_log_level (должен быть перед setup() )
• запуск nvim с HARPOON_LOG=debug nvim имеет приоритет над vim.g.harpoon_log_level .
• неверные значения по умолчанию возвращаются к warn .

⇁ Другие

Чем отметки Harpoon отличаются от глобальных отметок vim

они служат одной и той же цели, однако следы гарпунов различаются по нескольким ключевым моментам:

1. Они автоматически обновляют свою позицию в файле.
2. Они сохраняются для каждого проекта .
3. Их можно редактировать вручную или заменять (обмен проще)

Мотивация использования терминалов Harpoon

1. Я хочу использовать терминал, так как я могу gF и gF на любые ошибки, возникающие в результате выполнения внутри терминала, которые не подходят для чего-то вроде диспетчеризации. (не просто запуск тестов, но, возможно, сервер, который работает в течение X времени перед сбоем).
2. Я хочу, чтобы терминал был постоянным, и я мог вернуться к одному из многих терминалов с помощью некоторых манипуляций пальцами и повторно проанализировать любую информацию о выполнении, которая не обязательно была связана с ошибкой.
3. Хотелось бы иметь команды, которые можно будет привязывать к терминалам и отправлять их, не задумываясь. Некая золотая середина между vim-test и простым вводом их в терминал (настройка телевизионного проекта Netflix не совсем сложна, и существует масса способов настройки).

Используйте динамическую ширину всплывающего меню «Гарпун».

Иногда ширина по умолчанию 60 недостаточно широка. В следующем примере показано, как настроить пользовательскую ширину, задав ширину меню относительно ширины текущего окна.

 require ( " harpoon " ). setup ({
    menu = {
        width = vim . api . nvim_win_get_width ( 0 ) - 4 ,
    }
})

Таблица

По умолчанию в строке табуляции будет использоваться тема по умолчанию вашей темы. Вы можете настроить, отредактировав следующие основные моменты:

• ГарпунНеактивный
• ГарпунАктивный
• ГарпунНомерАктивный
• ГарпунНомерНеактивный

Пример, как сделать его чище:

 vim . cmd ( ' highlight! HarpoonInactive guibg=NONE guifg=#63698c ' )
vim . cmd ( ' highlight! HarpoonActive guibg=NONE guifg=white ' )
vim . cmd ( ' highlight! HarpoonNumberActive guibg=NONE guifg=#7aa2f7 ' )
vim . cmd ( ' highlight! HarpoonNumberInactive guibg=NONE guifg=#7aa2f7 ' )
vim . cmd ( ' highlight! TabLineFill guibg=NONE guifg=white ' )

Результат:

⇁ Социальные сети

Если у вас есть вопросы о Harpoon, на сервере Discord Primeagen есть канал #harpoon.

• Раздор
• Твич
• Твиттер