Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/tar80/mug.nvim

Mixed utilities for git
https://github.com/tar80/mug.nvim

git neovim neovim-plugin

Last synced: 1 day ago
JSON representation

Mixed utilities for git

Awesome Lists containing this project

README 

          
# ☕ mug.nvim



mug(mixed utilities for git)は、neovim 上で git を操作するためのコマンド集です。  

windows 版 neovim(非 wsl)をターゲットに作成しています。  

いくつかの他作者様が作成された vim plugin の機能を内包します。



## 動作条件



- Neovim >= 0.10

- Git >= 2.39.2



## インストール



- lazy.nvim



```lua

{ 'tar80/mug.nvim',

 event = 'UIEnter',

 opts = {

   ...,

   variables = {

     ...,

   },

   highlights = {

     ...,

   }

 },

}

```



## 機能



mug.nvim を導入するとバッファのカレントディレクトリが常に git リポジトリのルート、

または(git リポジトリでなければ)親ディレクトリを指すようになります。

この機能は[mattn/vim-findroot](https://github.com/mattn/vim-findroot)をベースにしていますがいくつか異なる点があります。

詳細はMugFindrootをご覧ください。



MugFloat



mug が生成するフローティングウィンドウ(MugFloat)にはそれぞれのコマンドで使用するキーマップの他に、

一律で以下のキーマップが設定されます。また、MugFloat が存在する間``が上書きされ

MugFloat のフォーカスに割り当てられます。



| キー             | 説明                 |

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

| q, \        | フロート閉じる       |

| g?               | キーマップ参照       |

| \M-[hjkl] | フロート移動         |

| M-p              | 次のウィンドウに移動 |



**variables**



- float_winblend `integer`(上書き)  

  背景の疑似透過性を指定します。



[float.mp4](https://github.com/tar80/mug.nvim/assets/45842304/a8867a19-08d5-4560-b815-aceb7b5f8bb6)



## コマンド



**標準コマンド**



MugFindroot



```lua

require('mug').setup({

  variables = {

    symbol_not_repository = '---',

    root_patterns = { '.git/', '.gitignore' },

    ignore_filetypes = { 'git', 'gitcommit', 'gitrebase' },

  }

})

```



**:MugFindroot [stopglobal|stoplocal]**



mug の標準機能です。[mattn/vim-findroot](https://github.com/mattn/vim-findroot) をベースに独自の変更を加えてあります。



- vim-findroot は標準で様々なプロジェクトルートマーカーに対応していますが、mug が対応するのは git のみです。

  また、ディレクトリを下層へ移動する時に動作を抑制するオプションはありません。



- MugFindroot は自動実行されます。手動実行時には実行結果の詳細が出力されます。

  引数`stopglobal` `stoplocal`を指定するとそれぞれ`g:mug_findroot_disable=v:true` `b:mug_findroot_disable=v:true`が設定され

  自動実行を抑制します。解除は`MugFindroot`、または`unlet g:mug_findroot_disable` `unlet b:mug_findroot_disable`を実行します。



- MugFindroot が git リポジトリを検知したとき、ブランチ名、ブランチのデタッチ状態、インデックスを取得し、

  それぞれ`b:mug_branch_name` `b:mug_branch_info` `b:mug_branch_stats`を設定します。

  `b:mug_branch_stats`はインデックスの状態をテーブル{ s = stage, u = unstate, c = conflict }として保持します。

  ブランチのキャッシュ・デタッチ状態の取得は[kana/vim-g/branch](https://github.com/kana/vim-g)の機能を取り入れています。



**variables**



- symbol_not_repository(上書き)  

  カレントディレクトリが git リポジトリではなかったときに b:mug_branch_name に設定される文字列です。



- root_patterns `table`(上書き)  

  記述フォーマットは vim-findroot の root marker patterns に倣います。優先度があり、先に記述されたパターンが優先されます。

  以下のようなディレクトリ構造を持つファイル file.vim を開いたときにカレントディレクトリは

  `root_patterns`の値により、表のように設定されます。



  ```text

  main/

    ├ .git/

    ├ submodule/

    │   ├ .git/

    │   ├ script/

    │   │   ├ .gitignore

    │   │   └ file.vim

    │   └ .gitignore

    ├ .gitmodules

    └ .gitignore

  ```



  | root_patterns                  | current directory     |

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

  | .gitmodules, .git/, .gitignore | main                  |

  | .git/, .gitignore              | main/submodule        |

  | .gitignore                     | main/submodule/script |



- ignore_filetypes `table`(追加)  

  指定したファイルタイプは MugFindroot 自動実行の対象外となります。

  ファイルタイプに`*`(ワイルドカード)は指定できません。



Edit



```lua

require('mug').setup({

  variables = {

    edit_command = 'Edit',

  }

})

```



**:Edit [!] [\]**



カレントファイルの親ディレクトリを基準に`:edit[!] []`を実行します。



**variables**



- edit_command `string`(上書き)  

  コマンド`Edit`を別名で登録します。コマンドが不要であれば`""`空文字を指定します。



File



```lua

require('mug').setup({

  variables = {

    file_command = 'File',

  }

})

```



**:File[!] \**



カレントファイルの親ディレクトリを基準に`:file[!] `を実行します。



**variables**



- file_command `string`(上書き)  

  コマンド`File`を別名で登録します。コマンドが不要であれば`""`空文字を指定します。



Write



```lua

require('mug').setup({

  variables = {

    write_command = 'Write'

  }

})

```



**:Write[!]**



`:update | git add`を実行します。`!`を付けると`--force`が付加されます。



**variables**



- write_command `string`(上書き)  

  コマンド`Write`を別名で登録します。コマンドが不要であれば`""`空文字を指定します。



**無効化されているコマンド**



Mug



```lua

require('mug').setup({

  subcommand = true,

  variables = {

    sub_command = 'Mug',

    result_position = 'botright',

    result_log_format = {

      '--graph --date=short --format=%C(cyan)%h\\ %C(magenta)[%ad]\\ %C(reset)%s%C(auto)%d',

      '--graph -10 --name-status --oneline --date=short --format=%C(yellow\\ reverse)%h%C(reset)\\ %C(magenta)[%ad]%C(cyan)%an\\ %C(green)%s%C(auto)%d',

    },

    result_map = {},

  }

})

```



**:Mug \ [\]**



`git`のラッパーです。コマンドのリザルトを専用のバッファに表示します。  

既知の問題として色の表示がずれます。原因がわかれば直します。



**リザルト出力バッファ**



gitコマンドの結果を出力するバッファです。実体は`nvim_open_term`で開いた疑似ターミナル

であるため、通常のバッファとは挙動が異なります。



| モード | キー  | 説明                                               |

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

|   n    |   q   | バッファを閉じる                                   |

|   n    |   p   | (カーソル下)コミット詳細をフロートウィンドウに表示 |

|   n    |   o   | (カーソル下)ファイル名を代替バッファとして開く     |

|   n    | \ | (カーソル下)ファイル名を開く(gf相当)               |



**variables**



- sub_command `string`(上書き)  

  コマンド`Mug`を別名で登録します。



- result_position `string`(上書き)  

  出力バッファの起動位置です。  

  `vertical`に加え、`topleft`、`botright`、`aboveleft`、`belowright`を指定できます。



- result_log_format `table`(上書き)

  `Mug log`の補完リストに独自の文字列を追加します。



- result_map `table`(上書き)  

  出力バッファにキーマップを設定します。  

  書式は、`result_map = { lhs = {mode, rhs , {opts}}`とします。

  `opts`は`nvim_buf_set_keymap`に準じます。いくつか設定例を挙げておきます。



  ```lua

  result_map = {

    --カーソル下コミットハッシュを対象に`git reset`

    r = {

        'n',

        'callback',

        {

        callback = function()

            local word = vim.fn.expand('')

            if not word:find('[^%w]') then

            local resp = vim.system({ 'git', 'reset', word }):wait()

            if resp.code == 0 then

                vim.notify(resp.stdout, vim.log.levels.INFO)

            else

                vim.notify(resp.stderr, vim.log.levels.WARN)

            end

            end

        end,

        },

    },



    --代替バッファを対象にカーソル下コミットハッシュを`MugDiff`

    d = {

        'n',

        'callback',

        {

        callback = function()

            local word = vim.fn.expand('')

            if not word:find('[^%w]') then

                local winid = vim.fn.bufwinid('#')



                if winid ~= -1 then

                    vim.api.nvim_win_call(winid, function()

                    vim.cmd.MugDiff(word)

                    end)

                    vim.cmd.bwipeout({bang = true})

                end

            end

        end,

        },

    },

  }

  ```



[subcommand.mp4](https://github.com/tar80/mug.nvim/assets/45842304/41d497ad-c71b-4e88-bf78-07dbf160ec28)



MugCommit



```lua

require('mug').setup({

  commit = true,

  variables = {

    strftime = '%c',

    commit_notation = 'none',

    commit_gpg_sign = nil,

    patch_window_height = 20,

  }

})

```



**:MugCommit[!] [\] [\]**



引数なしで実行するとコミット編集バッファを開きます。`!`を付けると最初に`git add .`を実行します。  

``には以下のいずれかを指定できます。



- `amend` ステージされた変更を HEAD に追加します。

- `empty` 空コミットを作成します。コミットメッセージには"empty commit(created by mug)"が設定されます。

- ~~`fixup`~~ **Deleted**

- `rebase` fixup の代替です。フローティングウィンドウが起動し、`git log`の結果が出力されます。  

  カーソル行のコミットに対して`f`キーで fixup、`s`キーで squash を設定し、起点になるコミットにカーソルを合わせ、

  ``で実行します。`c`キーで選択をクリアできます。

- `m ` 直接コミットメッセージを入力できます。スペースを含む場合でも""で括る必要はありません。



**:MugCommitSign[!] [\] [\]**



オプション`--gpg-sign`を付加します。使用する署名を指定する場合は、variables に`commit_gpg_sign`を設定します。



**コミット編集バッファ**



コミットメッセージの詳細編集用に、`commit_notation`で指定したテンプレート(COMMIT_EDITMSG)をタブで開きます。  

コミット編集バッファには、スペルチェック、短縮入力、キーマップが設定されます。



| モード |      キー       | 説明                                |

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

|   n    |        ^        | スペルチェックをトグル              |

|   n    |       gd        | 差分バッファを水平方向にトグル      |

|   n    |       gD        | 差分バッファを縦方向にトグル        |

|  n,i   |       F5        | 時刻の挿入                          |

|   n    |       F6        | HEAD のコミットメッセージを書き出す |

|   n    | q(差分バッファ) | 差分バッファ閉じる(キャッシュ削除)  |



NOTE: 差分バッファはトグルしても更新されません。更新が必要なときは`q`で一度バッファを閉じます。



コミット編集バッファは`git commit`で開かれたバッファではないため、いかなる変更もリポジトリに影響を与えません。

コミットの作成にはコマンドを使用します。



- `:C` commit

- `:CA` commit amend

- `:CE` commit empty

- `:CS` commit-sign

- `:CSA` commit-sign amend



**variables**



- strftime `string`(上書き)  

  ``で挿入する時刻の書式を指定します。



- commit_notation `string`(上書き)  

  コミットの形式を指定します。`conventional` `genaral` `none`が指定でき、

  指定した形式に合わせたコミットテンプレートと短縮入力が設定されます。  

  また、`mug/lua/template/`内に``と`.lua`を作成し、

  `commit_notation = `を指定することでユーザー設定が適用されます。

  ``はコミットテンプレート、`.lua`は短縮入力の設定です。

  スクリプト内`M.additional_settings`に関数を設定すれば、キーマップやコマンドを追加することもできます。

  記述方法は他のテンプレートを参考にしてください。



- ~~commit_diffキャッシュd_height `integer`(上書き)~~ **Deleted**



- commit_gpg_sign `string`(上書き)  

  署名に使用する鍵(gpg)を指定します。  

  指定しない場合はデフォルト(コミッター ID)になります。



- patch_window_height `integer`(上書き)

  差分バッファの高さを指定します。



[commit.mp4](https://github.com/tar80/mug.nvim/assets/45842304/3f9fc79e-8a27-48cf-bc98-3648d04cead2)



MugConfilct



```lua

require('mug').setup({

  conflict = true,

  variables = {

    loclist_position = 'left',

    loclist_disable_number = false,

    filewin_beacon = '@@',

    filewin_indicate_position = 'center',

    conflict_begin = '^<<<<<<< ',

    conflict_anc = '^||||||| ',

    conflict_sep = '^=======$',

    conflict_end = '^>>>>>>> '

  }

})

```



**:MugConflict**



新規タブを開き、`git merge`によってコンクリクトしたハンクを抽出、ロケーションリストに展開します。  

[rhysd/conflict-marker.vim](https://github.com/rhysd/conflict-marker.vim/)と似たような操作をロケーションリスト上で実行できます。

conflict-marker は、コンフリクトのあるバッファに対してキーが設定されますが、

MugConflict はロケーションリストにキーを設定します。



- ロケーションリストの表示中は`g:mug_loclist_loaded=v:true`が設定されます。

- ロケーションリストでカーソル移動するとファイルウィンドウの表示位置が連動します。

- ``を押すと、カーソルと表示位置を Ours-Theirs 間で往復します。

- `w`(更新内容を保存)実行後にすべてのコンフリクトが解消されていた場合、継続してコミットの作成を促す選択肢を表示します。

- undo/redo は仮対応しています。ハイライトが一致しなかったりします。

- conflict-marker と併用できます。MugConflict 実行時は重複するハイライトが上書きされます。



|      キー      | 説明                                      |

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

|       q        | タブ閉じる                                |

|       w        | すべての更新内容を保存                    |

|       g?       | キーマップ参照                            |

|       o        | Ours-commit の差分でハンクを置き換え      |

|       t        | Theirs-commit の差分でハンクを置き換え    |

|       b        | Base-commit の差分でハンクを置き換え      |

|       B        | Ours, Theirs 両方の差分でハンクを置き換え |

|       ^        | filewindow の連動状態をトグル             |

| \, \ | filewindow のカーソルを 1/2 ページ移動    |

| \, \ | filewindow のカーソルを 1 行移動          |



**variables**



- loclist_position `string`(上書き)  

  ロケーションリストの表示位置を指定します。`top` `bottom` `left` `right`を指定します。



- loclist_disable_number `boolean`(上書き)  

  ロケーションリストの行番号を非表示にするなら`true`を指定します。



- filewin_beacon `string`(上書き)  

  ハンクの開始位置(signcolumn)に表示される文字を指定します。



- filewin_indicate_position `string`(上書き)  

  ファイルウィンドウ連動時の、ハンクの画面上の位置です。  

  `upper` `center` `lower`から指定します。



**highlights**



- MugConflictHeader `fg=#777777 bg=#000000`

- MugConflictBase `DiffDelete`

- MugConflictTheirs `DiffAdd`

- MugConflictOurs `DiffChange`

- MugConflictBoth `Normal`をベースに赤と緑を強調した色

- MugConflictBeacon `Search`



[conflict.mp4](https://github.com/tar80/mug.nvim/assets/45842304/b54392d4-3bb3-4621-b76e-4725acf07607)



MugDiff



```lua

require('mug').setup({

  diff = true,

  variables = {

    diff_position = ,

  }

})

```



カレントファイルと指定した tree-ish との差分を vimdiff で表示します。  

差分バッファの表示中は独自のキーマップが割り当てられます。



| モード | キー | 説明                |

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

|  n,x   |  du  | `Diffupdate`を実行  |

|   x    |  do  | 選択範囲を`Diffget` |

|   x    |  dp  | 選択範囲を`Diffput` |

|   x    |  dd  | 選択範囲を削除      |



**:MugDiff [\] [\] [\]**



``に`:new`バッファを開き、`git cat-file -p :`の結果を展開します。



- 引数``は、差分バッファを開く位置です。カレントバッファを起点に`top` `bottom` `left` `right`を指定できます。

  初期値は`diffopt`の値から決定されます。また、`diff_position`で標準の位置を指定できます。

- 引数``の初期値は`""`(空文字)です。

- 引数``の初期値は`%`です。



**:MugDiffFetchRemote [\] [\] [\]**



`git fetch orgin `を実行後、``に`:new`バッファを開き、`git cat-file -p origin/:`の結果を展開します。



- 引数``の初期値は現在アクティブなブランチ名です。



**variables**



- diff_position `string`(上書き)  

  ``のデファルト値を`top` `bottom` `left` `right`のいずれかを指定します。



MugFiles



```lua

require('mug').setup({

  files = true,

})

```



**:MugFileMove[!] \**



カレントファイルに対し`git mv  `を適用し、バッファを開き直します。

``はカレントディレクトリを基準とします。  

`!`を付けると`--force`が付加されます。



**:MugFileRename[!] \**



カレントファイルに対し`git -C  mv  `を適用し、バッファを開き直します。

``はカレントファイルの親ディレクトリを基準とし、パスの指定はできません。  

`!`を付けると`--force`が付加されます。



**:MugFileDelete[!]**



カレントファイルをリポジトリのインデックスから削除します。  

`!`を付けるとファイル自体も削除されます。



MugIndex



```lua

require('mug').setup({

  index = true,

  variables = {

    index_add_key = 'a',

    index_force_key = 'f',

    index_reset_key = 'r',

    index_clear_key = 'c',

    index_input_bar = '@',

    index_commit = '`',

    index_auto_update = false,

  }

})

```



**:MugIndex[!]**



`git status`の結果をフローティングウィンドウに出力します。`!`を付けると`--ignored`が付加されます。  

行ごとに Stage・Unstage・Force stage を選択でき、``で実行されます。一番上の行を選択すると全体が選択状態になり、

最下行にはエラーが表示されます。  

MugIndex ウィンドウには独自のキーマップが割り当てられます。



|  キー   | 説明                          |

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

|    a    | 行を選択(Stage)               |

|    f    | 行を選択(Force stage)         |

|    r    | 行を選択(Unstage)             |

|    c    | 選択状態をクリア              |

|  J, K   | 行を選択(Stage)後カーソル移動 |

|   gf    | 行のパスを開く                |

|   gd    | 行のパスを`MugDiff`           |

|  \  | リストを更新                  |

|    @    | コミットメッセージ入力バー    |

| shift+@ | `MugCommit`を実行             |



コミット入力バー



|     キー     | 説明                           |

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

| \\ | オプション`--gpg-sign`をトグル |

| \\ | オプション`--amend`をトグル    |



**variables**



- index_add_key `string`(上書き)  

  行選択(Stage)に使用するキーを指定します。



- index_force_key `string`(上書き)  

  行選択(Force stage)に使用するキーを指定します。



- index_reset_key `string`(上書き)  

  行選択(Reset)に使用するキーを指定します。



- index_clear_key `string`(上書き)  

  行選択を解除するキーを指定します。



- index_input_bar `string`(上書き)  

  コミット入力バーの呼び出しキーを指定します。



- index_commit `string`(上書き)  

  `MugCommit`の実行キーを指定します。



- index_auto_update `boolean`(上書き)  

  MugIndex のフロートウィンドウを離れてから、戻ったときに  

  `git status`を実行しリストを更新します。



**highlights**



- MugIndexHeader `String`

- MugIndexStage `Statement`

- MugIndexUnstage `ErrorMsg`

- MugIndexWarning `ErrorMsg`



[index.mp4](https://github.com/tar80/mug.nvim/assets/45842304/d6c9e1e1-6266-43ca-b973-ec417f04fa45)



MugMerge



```lua

require('mug').setup({

  MugMerge = true,

})

```



**:MugMerge[!] \ [\]**



コミットを作って、カレントブランチに\をマージ。  

`git -c merge.conflictstyle=diff3 merge --no-ff [] `を実行し、コミットメッセージの編集を確認する選択肢を表示します。

コンフリクト発生時には、処理を継続するか中止するかの選択肢を表示します。  

[!]を付けると、\の補完候補が`--strategy-option=ours` `--strategy-option=theirs`の二択になります。

また、マージ継続中は補完候補が`--abort` `--continue` `--quit`の三択になります。



**:MugMergeFF[!] \ [\]**



コミットは作らず、カレントブランチに\をマージ。  

`git merge --ff-only [] `を実行します。コンフリクト発生時はエラーを返します。  

[!]を付けると、\の補完候補が`--strategy-option=ours` `--strategy-option=theirs`の二択になります。



**:MugMergeTo[!] \**



コミットは作らず、カレントブランチを\にマージ。  

`git fetch . :`を実行します。コンフリクト発生時はエラーを返します。  

[!]を付けると、`--force`が付加されます。



[merge.mp4](https://github.com/tar80/mug.nvim/assets/45842304/478bbc44-c295-4935-9b68-5b5ef7e5033b)



MugMkrepo



```lua

require('mug').setup({

  mkrepo = true,

  variables = {

    remote_url = nil,

    commit_initial_message = 'Initial commit',

  }

})

```



**:MugMkrepo [!] [\]**



指定したパスにリポジトリを作成後、`Initial commit`を作成し、上流ブランチを設定します。  

引数なしのときはカレントファイルの親ディレクトリに、パスを指定したときはそのパスに、名前を指定したときは

カレントファイルの親ディレクトリ下にその名前で、リポジトリを作成します。  

`!`を付けるとパス内のファイルを含めた`Initial commit`を作成します。  

すでにリポジトリが存在していたときはエラーを返します。



**variables**



- remote_url `string`(上書き)  

  リモートブランチの URL。HTTPS または、SSH を指定します。  

  未設定の場合、上流ブランチの設定に失敗します。



- commit_initial_message `string`(上書き)  

  初期化コミットに使用されるメッセージを指定します。



[mkrepo.mp4](https://github.com/tar80/mug.nvim/assets/45842304/6c84c540-5593-4339-8caf-3d9f5565f83e)



MugRebase



```lua

require('mug').setup({

  rebase = true,

  variables = {

    rebase_log_format = '%as <%cn> %d%s',

    rebase_fixup_key = 'f',

    rebase_squash_key = 's',

    rebase_clear_key = 'c',

    rebase_preview_pos = 'bottom',

    rebase_preview_subpos = 'right',

  }

})

```



**:MugRebase[!] \ [\]**



フローティングウィンドウに出力した`git log`の結果から起点になるコミットを選択し、  

環境変数`GIT_SEQUENCE_EDITOR`を介して RPC 経由で`git rebase`を実行し、リベース ToDo バッファを開きます。  

`!`を付けるとオプション`--autostash`を付加します。



**:MugRebaseSign[!] \ [\]**



オプション`--gpg-sign`を付加します。使用する署名を指定する場合は、variables に`commit_gpg_sign`を設定します。



**リベース ToDo バッファ**



filetype`gitrebase`で使用できるキーと、以下のキーが有効です。



| モード |      キー      | 説明                                    |

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

|   n    |       ^        | 連動ビューをトグル                      |

|   n    |      j,k       | 連動ビュー有効時、差分バッファ連動      |

|   n    |       gd       | 差分バッファを水平方向にトグル          |

|   n    |       gD       | 差分バッファを縦方向にトグル            |

|   n    |       q        | 差分バッファ閉じる                      |

|   n    | \, \ | 差分バッファのカーソルを 1/2 ページ移動 |

|   n    | \, \ | 差分バッファのカーソルを 1 行移動       |



**variables**



- rebase_log_format `string`(上書き)  

  フローティングウィンドウに表示される`git log`の書式を指定します。



- rebase_fixup_key `string`(上書き)  

  `MugCommit rebase`で行選択(Fixup)に使用するキーを指定します。



- rebase_squash_key' `string`(上書き)  

  `MugCommit rebase`で行選択(Squash)に使用するキーを指定します。



- rebase_clear_key `string`(上書き)  

  `MugCommit rebase`で行選択を解除するキーを指定します。



- rebase_preview_pos `string`(上書き)  

  リベース ToDo バッファ上で`gd`を実行したときに差分バッファを開く位置を指定します。



- rebase_preview_subpos' `string`(上書き)  

  リベース ToDo バッファ上で`gD`を実行したときに差分バッファを開く位置を指定します。



**highlights**



- MugRebaseFixup `NormalFloat`または`Normal`をベースにした緑っぽい色

- MugRebaseSquash `NormalFloat`または`Normal`をベースにした青っぽい色

- MugLogHash `Special`

- MugLogDate `Statement`

- MugLogOwner `Conditional`

- MugLogHead `Keyword`



MugShow



```lua

require('mug').setup({

  show = true,

  variables = {

    show_command = 'MugShow',

  }

})

```



**:MugShow[!] \**



MugShow は git とは関連のないコマンドです。引数に指定した変数、関数、コマンドの結果をフローティングウィンドウに出力します。

なんでもは表示できませんがそこそこ表示されます。  

引数入力時の接頭辞(接尾辞)によって、補完候補と出力対象が選択されます。関数には引数も指定できます。

補完候補は完全には対応できていません。



| 接頭辞       | 出力対象       | 使用例                      |

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

| `$`          | 環境変数       | `$vim`                      |

| `_G.`        | lua 変数       | `_G._VERSION`               |

| `[gwbtv]:`   | vim 変数       | `v:version`                 |

| `&`          | vim オプション | `&rtp`                      |

| `vim.`       | 関数           | `vim.uv`, `vim.uv.cwd()`    |

| `()`(接尾辞) | vim 関数       | `expand('~')`               |

| `nvim_`      | nvim 関数      | `nvim_list_runtime_paths()` |

| `:`          | コマンド       | `:version`                  |

| `MugShow!`   | shell コマンド | `ls`, `git show`            |



**variables**



- show_command `string`(上書き)  

  コマンド`MugShow`を別名で登録します。



[show.mp4](https://github.com/tar80/mug.nvim/assets/45842304/66610ce5-ffa2-4bc0-beed-9afb28ec7823)



MugTerm



```lua

require('mug').setup({

  terminal = true,

  variables = {

    term_command = 'MugTerm',

    term_height = 1,

    term_width = 0.9,

    term_shell = vim.o.shell,

    term_position = 'top',

    term_disable_columns = false,

    term_nvim_pseudo = false,

    term_nvim_opener = 'tabnew',

    }

  }

})

```



**:[\]MugTerm[!] [\] [\]**



MugTerm は git とは関連のないコマンドです。バッファ、またはフローティングウィンドウで

シェルを開きます。ターミナル内でエディタを必要とする git コマンドを実行したときに

neovim をネストさせない機能があります。



- ``にはバッファのサイズを指定できます。横幅の最低値は`20`、高さの最低値は`3`が設定されています。

- 引数``はターミナルを開く位置です。カレントバッファを起点に`top` `bottom` `left` `right` `float`を指定できます。

  初期値は`top`です。`term_position`で初期値を変更できます。

- 引数``はターミナルで実行するコマンドです。コマンド終了時にバッファは閉じられます。  

  `tig` `lazygit`などのインタフェースを持つコマンドを指定します。

- `!`を付けると git commit などの実行時に、ターミナル内ではなくタブにバッファを開きます。

  この機能は[lambdalisue/edita.vim](https://github.com/lambdalisue/edita.vim)をベースにしています。

  edita.vim では環境変数`EDITOR`を書き換えますが、MugTerm では`GIT_EDITOR`を書き換えます。

  variables`term_nvim_pseudo`を`true`に設定すると、`!`の有無にかかわらず有効になります。



**variables**



- term_command `string`(上書き)  

  コマンド`MugTerm`を別名で登録します。



- term_height `float`(上書き)  

  フローティングウィンドウの高さを比率で指定します。



- term_width `float`(上書き)  

  フローティングウィンドウの横幅を比率で指定します。



- term_shell `string`(上書き)  

  ``を指定しなかったときに指定したシェルを実行します。初期値は`&shell`です。



- term_position `string`(上書き)  

  MugTerm の初期位置を設定します。`top` `bottom` `left` `right` `float`のいずれかを指定します。



- term_disable_columns `boolean`(上書き)  

  行番号などを非表示にします。



- term_nvim_pseudo `boolean`(上書き)  

  git commit などエディタが必要な git コマンドの実行時に、常に実行元のインスタンスで

  バッファを開くようになります。



- term_nvim_opener `string`(上書き)  

  `term_nvim_pseudo = ture`設定時にバッファを開く方法を指定します。初期値は`tabnew`です。



## 全設定初期値



```lua

  require('mug').setup({

    commit = false,

    conflict = false,

    diff = false,

    files = false,

    index = false,

    merge = false,

    mkrepo = false,

    show = false,

    terminal = false,



    variables = {

      -- Float

      float_winblend = 0,



      -- Findroot

      symbol_not_repository = '---',

      root_patterns = { '.git/', '.gitignore' },

      ignore_filetypes = { 'git', 'gitcommit', 'gitrebase' },



      -- Default commands

      edit_command = 'Edit',

      file_command = 'File',

      write_command = 'Write'



      -- Commit

      strftime = '%c',

      commit_notation = 'none',

      -- commit_diffcached_height = 20, [Deleted]

      commit_gpg_sign = nil,



      -- Conflict

      conflict_begin = '^<<<<<<< ',

      conflict_anc = '^||||||| ',

      conflict_sep = '^=======$',

      conflict_end = '^>>>>>>> ',

      filewin_beacon = '@@',

      filewin_indicate_position = 'center',

      loclist_position = 'left',

      loclist_disable_number = false,



      -- Diff

      diff_position = nil,



      -- Index

      index_add_key = 'a',

      index_force_key = 'f',

      index_reset_key = 'r',

      index_clear_key = 'c',

      index_inputbar = '@',

      index_commit = '`',



      -- Mkrepo

      remote_url = nil,

      commit_initial_message = 'Initial commit',



      -- Show

      show_command = 'MugShow',



      -- Term

      term_command = 'MugTerm',

      term_height = 1, -- floating window

      term_width = 0.9, -- floating window

      term_shell = vim.o.shell,

      term_position = 'top', -- normal window

      term_disable_columns = false,

      term_nvim_pseudo = false,

      term_nvim_opener = 'tabnew',



      -- Patch

      -- git diffの差分を表示する窓

      patch_window_height = 20,

    },



    highlights = {

      -- Conflict

      MugConflictHeader = { fg = '#777777' bg = '#000000' },

      MugConflictBase = { link = 'DiffDelete' },

      MugConflictTheirs = { link = 'DiffAdd' },

      MugConflictOurs = { link = 'DiffChange' },

      MugConflictBoth = { bg = Normalをベースに赤と緑を強調した色 },

      MugConflictBeacon = { link = 'Search' },



      -- Index

      MugIndexHeader = { link = 'String' },

      MugIndexStage = { link = 'Statement' },

      MugIndexUnstage = { link = 'ErrorMsg' },

      MugIndexWarning = { link = 'ErrorMsg' },

      MugIndexAdd = { bg = Normalをベースに緑を強調した色 },

      MugIndexForce = { bg = Normalをベースに青を強調した色 },

      MugIndexReset = { bg = Normalをベースに赤を強調した色 },



      -- Rebase

      MugRebaseFixup = { bg = Normalをベースに緑を強調した色 },

      MugRebaseSquash = { bg = Normalをベースに青を強調した色 },

      MugLogHash = { link = 'Special' },

      MugLogDate = { link = 'Statement' },

      MugLogOwner = { link = 'Conditional' },

      MugLogHead = { link = 'Keyword' },

    },

  })

```



## ToDo



- [x] rebase 暫定的に追加

- [x] ハイライトの設定を追加

- [ ] log を追加したい

- [ ] テスト そのうち



## 謝辞



mug.nvim は以下の vim-plugin のコードを内包します。  

該当部分のライセンスはそれぞれのプロジェクトのライセンスに従います。



- [mattn/vim-findroot](https://github.com/mattn/vim-findroot)

- [kana/vim-g](https://github.com/kana/vim-g)

- [ms-jpg/lua-async-await](https://github.com/ms-jpq/lua-async-await)

- [lambdalisue/edita.vim](https://github.com/lambdalisue/edita.vim) **Deprecated**



また以下のプロジェクトを参考にさせていただきました。



- [rhysd/conflict-marker.vim](https://github.com/rhysd/conflict-marker.vim/)

- [akinsho/git-conflict.nvim](https://github.com/akinsho/git-conflict.nvim)

- [Rasukarusan/nvim-select-multi-line](https://github.com/Rasukarusan/nvim-select-multi-line)



プロジェクトを公開されておられる作者様に御礼申し上げます。