Mini.nvim が Tangled に登場
Mini.nvim Is Now on Tangled (tangled.org)
要約
mini.nvim は、Neovim の体験を向上させる 45 以上の独立した Lua モジュールのライブラリです。これは Neovim プラグインにおける「スイスアーミーナイフ」のようなもので、各モジュールは単独で使用でき、最小限のオーバーヘッドで済みます。記事では、インストール方法、機能別のモジュール一覧、設計原則について詳しく説明しています。
全文翻訳
Mini.nvim が Tangled に登場
[画像: mini.nvim]
オールインワン プラグイン #
最小限の労力で Neovim (バージョン 0.10 以降) 全体の体験を向上させる 45 以上の独立した Lua モジュールのライブラリです。これらはすべて同じ設定アプローチと一般的な設計原則を共有しています。
このプロジェクトを Neovim プラグインにおける「スイスアーミーナイフ」と考えてください。一般的なタスクのほとんどに適した、さまざまな独立したツール(モジュール)が含まれています。各モジュールは、起動時や使用時のオーバーヘッドなしに個別に利用できます。
このプロジェクトの成長を支援したいが、どこから始めればよいかわからない場合は:
- 'mini.nvim' (任意の サポートされているコードフォージ) および/またはその他の MINI プロジェクト にスターを付けてください。
- コントリビューティングガイド を参照してください。
変更履歴 を参照して、現在の開発バージョンを含む変更の履歴を確認してください。
'mini.nvim' に基づいた完全な設定例については、MiniMax を参照してください。
注意
これは以前 echasnovski/mini.nvim でホストされていました。プロジェクトの長期的な安定性を向上させるために、専用の組織に移管されました。詳細についてはこちらを参照してください。
目次 #
インストール #
このプロジェクトは複数のコードフォージでホストされています(インストールコードスニペットで好みのリンクを使用してください):
- https://github.com/nvim-mini/mini.nvim (メイン)
- https://tangled.org/nvim-mini.org/mini.nvim (ミラー)
- https://codeberg.org/nvim-mini/mini.nvim (ミラー)
インストールできるブランチは 2 つあります:
main(デフォルト、推奨) には、プラグインの最新の開発バージョンが含まれます。最後の安定リリース以降のすべての変更は、ベータテスト段階にあると見なされるべきです(つまり、アルファテストを通過しており、適度に安定しています)。stableは、mainブランチでの公開ベータテスト中にテストされたコードを含むリリースでのみ更新されます。
一般的なインストール方法のコードスニペットを以下に示します:
-
(推奨) vim.pack を使用 (Neovim 0.12 以降):
-
メインブランチ:
vim.pack.add({ 'https://github.com/nvim-mini/mini.nvim' }) -
安定ブランチ:
vim.pack.add({ { src = 'https://github.com/nvim-mini/mini.nvim', version = 'stable' }, })
-
-
git cloneを使用した手動インストール (mini.deps と互換性あり):-- 'init.lua' の先頭にこれを配置します local path_package = vim.fn.stdpath('data') .. '/site' local mini_path = path_package .. '/pack/deps/start/mini.nvim' if not vim.uv.fs_stat(mini_path) then vim.cmd('echo "Installing `mini.nvim`" | redraw') local clone_cmd = { 'git', 'clone', '--filter=blob:none', -- 次の行のコメントを外すと 'stable' ブランチが使用されます -- '--branch', 'stable', 'https://github.com/nvim-mini/mini.nvim', mini_path } vim.fn.system(clone_cmd) vim.cmd('packadd mini.nvim | helptags ALL') vim.cmd('echo "Installed `mini.nvim`" | redraw') end -
folke/lazy.nvim を使用:
-
メインブランチ:
{ 'nvim-mini/mini.nvim', version = false }, -
安定ブランチ:
{ 'nvim-mini/mini.nvim', version = '*' },
-
-
各モジュールはスタンドアロンの Git リポジトリとしても配布されています。詳細についてはモジュールの情報を参照してください。
重要: 機能が有効になるように、モジュールの setup() を呼び出すことを忘れないでください(必要な場合)。
注意: Windows を使用している場合、ファイルパスが長すぎる問題(例: error: unable to create file <some file name>: Filename too long)が発生する可能性があります。以下のいずれかを試してください:
- 対応する git グローバル設定値を有効にする:
git config --system core.longpaths true。その後、再インストールを試してください。 - より短いパスの別の場所にプラグインをインストールしてください。
モジュール #
'mini.nvim' には多くのモジュールが含まれており、最初は少し戸惑うかもしれません。それらはすべて、一度に一つずつ、独立して使用できます。
探索を容易にするために、ここではモジュールの主な機能に基づいてグループ化して提示します(ただし、一部のモジュールは複数のグループに適合する可能性があります)。詳細なリストはこちらを参照してください。
テキスト編集 #
これらのモジュールは、テキスト編集体験を向上させます。まず 'mini.ai'、'mini.operators'、'mini.surround' から始めましょう。
| モジュール | 説明 | 概要 | 詳細 |
|---|---|---|---|
| mini.ai | a/i テキストオブジェクトを拡張および作成 | README | ドキュメント |
| mini.align | テキストをインタラクティブに配置 | README | ドキュメント |
| mini.comment | 行をコメントアウト | README | ドキュメント |
| mini.completion | 補完とシグネチャヘルプ | README | ドキュメント |
| mini.keymap | 特殊キーマッピング | README | ドキュメント |
| mini.move | 任意の選択範囲を任意の方向に移動 | README | ドキュメント |
| mini.operators | テキスト編集演算子 | README | ドキュメント |
| mini.pairs | オートペア | README | ドキュメント |
| mini.snippets | スニペットの管理と展開 | README | ドキュメント |
| mini.splitjoin | 引数の分割と結合 | README | ドキュメント |
| mini.surround | 周囲の要素操作 | README | ドキュメント |
一般的なワークフロー #
これらのモジュールは、一般的なワークフローを改善します。まず 'mini.bracketed'、'mini.files'、'mini.pick' から始めましょう。
| モジュール | 説明 | 概要 | 詳細 |
|---|---|---|---|
| mini.basics | 一般的な設定プリセット | README | ドキュメント |
| mini.bracketed | 角括弧で前後に移動 | README | ドキュメント |
| mini.bufremove | バッファの削除 | README | ドキュメント |
| mini.clue | 次のキーのヒントを表示 | README | ドキュメント |
| mini.cmdline | コマンドラインの調整 | README | ドキュメント |
| mini.deps | プラグインマネージャー | README | ドキュメント |
| mini.diff | diff の変更箇所を操作 | README | ドキュメント |
| mini.extra | 追加の 'mini.nvim' 機能 | README | ドキュメント |
| mini.files | ファイルシステムをナビゲートおよび操作 | README | ドキュメント |
| mini.git | Git 連携 | README | ドキュメント |
| mini.input | ユーザー入力を取得 | README | ドキュメント |
| mini.jump | 次/前の単一文字にジャンプ | README | ドキュメント |
| mini.jump2d | 可視行内でジャンプ | README | ドキュメント |
| mini.misc | その他の機能 | README | ドキュメント |
| mini.pick | 何でも選択 | README | ドキュメント |
| mini.sessions | セッション管理 | README | ドキュメント |
| mini.visits | ファイルシステムへのアクセスを追跡・再利用 | README | ドキュメント |
外観 #
これらのモジュールは、Neovim の外観を改善します。まず 'mini.hues'、'mini.icons'、'mini.statusline' から始めましょう。
| モジュール | 説明 | 概要 | 詳細 |
|---|---|---|---|
| mini.animate | 一般的な Neovim アクションをアニメーション化 | README | ドキュメント |
| mini.base16 | Base16 カラーテーマの作成 | README | ドキュメント |
| mini.colors | カラーテーマの調整と保存 | README | ドキュメント |
| mini.cursorword | カーソル下の単語を自動ハイライト | README | ドキュメント |
| mini.hipatterns | テキスト内のパターンをハイライト | README | ドキュメント |
| mini.hues | 設定可能なカラーテーマを生成 | README | ドキュメント |
| mini.icons | アイコンプロバイダー | README | ドキュメント |
| mini.indentscope | インデントスコープを視覚化・操作 | README | ドキュメント |
| mini.map | バッファテキストの概要を表示するウィンドウ | README | ドキュメント |
| mini.notify | 通知を表示 | README | ドキュメント |
| mini.starter | スタート画面 | README | ドキュメント |
| mini.statuscolumn | ステータスカラム | README | ドキュメント |
| mini.statusline | ステータスライン | README | ドキュメント |
| mini.tabline | タブライン | README | ドキュメント |
| mini.trailspace | 末尾の空白(ハイライトと削除) | README | ドキュメント |
その他 #
これらのモジュールは、前のカテゴリにはうまく収まりません。
| モジュール | 説明 | 概要 | 詳細 |
|---|---|---|---|
| mini.doc | Neovim ヘルプファイルの生成 | README | ドキュメント |
| mini.fuzzy | ファジーマッチング | README | ドキュメント |
| mini.test | Neovim プラグインのテスト | README | ドキュメント |
一般原則 #
設計 #
各モジュールは、特定の問題を解決するように設計されており、機能豊富さ(可能な限り多くのエッジケースを処理する)と実装/サポートの容易さのバランスを取ることを目指しています。もちろん、すべてが同じバランスに落ち着いたわけではありませんが、それが目標です。
独立性 #
モジュールは互いに独立しており、外部依存なしに実行できます。ただし、一部のモジュールは完全な体験のために依存関係を必要とする場合があります。
構造 #
各モジュールは、プレースホルダーの「mini」モジュールのサブモジュールです。たとえば、「surround」モジュールは「mini.surround」として参照されるべきです。後で説明するように、このプラグインは「MiniSurround」としても参照できます。
セットアップ #
-
使用したい各モジュールは、
require(<モジュール名>).setup({})で個別に有効にする必要があります。必要に応じて{}を設定テーブルに置き換えるか、デフォルトを使用するために省略してください。設定の一部のみを指定でき、残りはデフォルトから推測されます。 -
モジュールの
setup()への呼び出しは、常に一貫したキャメルケースの名前を持つグローバル Lua オブジェクトを作成します:require('mini.surround').setup()は_G.MiniSurroundを作成します。これにより、プラグイン機能の使用が簡素化されます。require('mini.surround')の代わりにMiniSurroundを使用できます(またはコマンドラインで手動で:lua MiniSurround.*を実行)。v:luaからv:lua.MiniSurroundのように利用できます。これを考慮すると、「モジュール」と「Lua オブジェクト」の名前は相互に交換可能に使用できます。「mini.surround」と「MiniSurround」は同じ意味になります。 -
提供された各
configテーブルは、グローバルオブジェクトのconfigフィールドに格納されます。MiniSurround.configのようなものです。 -
ランタイムアクティビティに影響する
configの値は、効果を得るために実行時に変更できます。たとえば、MiniSurround.config.n_linesは実行中に変更できます。ただし、MiniSurround.config.mappingsを変更しても効果はありません(マッピングはsetup()中に一度だけ作成されるため)。 -
モジュールが特定の非デフォルトオプション値で最適に機能する場合、それは
setup()中に設定されます。値がモジュールの機能に不可欠でない場合、ユーザーまたは別のプラグインがそれを事前に設定していない場合にのみ行われます(値に関係なく)。
バッファローカル設定 #
各モジュールは、バッファローカルに特定のランタイム設定を使用するように追加で設定できます。詳細については、ヘルプファイルの mini.nvim-buffer-local-config セクションを参照してください。
バッファ名 #
すべてのモジュール関連バッファは、次の形式に従って名前が付けられます: mini<module-name>://<buffer-number>/<useful-info>(スラッシュはどのプラットフォームでも使用されます。<useful-info> は空の場合があります)。この構造により、識別可能で、比較的ユニークで、役立つバッファ名を作成できます。たとえば、「mini.files」バッファは、表示されるディレクトリ/ファイルごとに minifiles://10/path/to/displayed/directory のような名前で作成されます。
無効化 #
各モジュールのコア機能は、グローバルまたはバッファローカルで無効にできます。詳細については、モジュールのヘルプページの「無効化」セクションを参照してください。一般的なレシピについては、メインヘルプファイルの mini.nvim-disabling-recipes セクションを参照してください。
サイレンシング #
エラー以外のフィードバックを提供する各モジュール(例: 'mini.ai'、'mini.jump2d'、'mini.surround' でのアイドル時間後にキーを押すように促すリマインダー)は、config.silent = true を設定することで、それを実行しないように構成できます(setup() 呼び出し内または実行時に)。
ハイライト #
モジュールの出力の外観は、特定のハイライトグループのセットによって制御されます(:h highlight-groups を参照)。デフォルトでは、それらは通常、意味的に近い組み込みハイライトグループにリンクされ、カラーテーマが有効になった後に定義されることが保証されています。ハイライトをカスタマイズするには、:highlight コマンドまたは vim.api.nvim_set_hl() Lua 関数を使用してください。より調整された外観を表示するには、「mini.hues」、「mini.base16」、またはプラグインのカラーテーマを使用してください。
安定性 #
各モジュールは、リリース時に比較的安定していると見なされます。セットアップと機能の両方の点で。バグ修正以外の後方非互換の変更は、可能な限り段階的にリリースされます。
ファイルタイプおよび言語に依存しない #
複数のファイルタイプ/言語固有の実装を必要とする機能を含めることは、このプロジェクトの明示的な目標ではありません。これは主に、実装を最新の状態に保つためのメンテナンスの増加の可能性によるものです。ただし、ファイルタイプ/言語固有の調整が必要な部分は、ユーザーが適切なバッファオプションおよび/またはローカル設定を設定できるように設計されるべきです。
テキスト編集の繰り返し #
モジュールによって作成されたすべてのテキスト編集マッピング(演算子、テキストオブジェクト、モーションなど)は、技術的に可能な限り、組み込みの繰り返し機能をサポートします。これには、ドットリピート、マクロ、および Neovim >= 0.13 のマルチカーソルが含まれます。
プラグインカラーテーマ #
このプラグインにはいくつかのカラーテーマが付属しています(すべてダークおよびライトバリアントがあります)。通常の colorscheme として有効にできます(例: :colorscheme minischeme または vim.cmd.colorscheme('minischeme'))。
-
'mini.hues' に基づく(推奨):
minischeme: 青と黄色のメインカラーテーマ。miniwinter: アズール背景の「氷のような冬」パレット。minispring: 緑の背景を持つ「咲き誇る春」パレット。minisummer: 茶色/黄色の背景を持つ「暑い夏」パレット。miniautumn: 紫の背景を持つ「涼しい秋」パレット。randomhue: 同じ色相の中程度の彩度のランダムな背景と前景。
それらの外観は 'mini.hues' README で確認できます。
-
'mini.base16' に基づく:
minicyan: 中程度のコントラストと彩度のパレットを持つシアンとグレーのメインカラー。miniblue: 高いコントラストと彩度のパレットを持つ青と黄色のメインカラー。
それらの外観は 'mini.base16' README で確認できます。
計画中のモジュール #
これは、私が現在(私の自由時間と献身が許す限り)最終的に実装する予定のモジュールのリストです。アルファベット順です:
- 'mini.abbrev' - Insert モードの省略形を管理/設定するヘルパー。
- 'mini.cycle' - 事前定義されたルールで代替を循環させる。 monaqa/dial.nvim や AndrewRadev/switch.vim のようなもの。
- 'mini.folds' - より高機能で使いやすい折りたたみ。
- 'mini.repl' - R、Python、Julia、そしておそらく(ただおそらく)いくつかの AI ツールを組み込んだ、拡張可能な REPL ラッパー。
- 'mini.sendtext' - バッファ間でテキストを送信する。特に通常のバッファと組み込みターミナルバッファの間。
- 'mini.terminals' - 対話型ターミナルバッファを統一的に管理する。 kassio/neoterm のようなもの。後処理された結果でシェルでコードを非同期に実行する機能も組み込む可能性があります。
- 'mini.quickfix' - より高機能で使いやすい quickfix リスト。おそらくプレビューと検索・置換ワークフローのインライン編集機能付き。
- 'mini.windows' - ウィンドウマネージャー。インタラクティブなピッカー、レイアウトオーガナイザー、その他。