kickstart.nvim - 個人のnvim設定の起動ポイント

(A launch point for your personal nvim configuration)

Created at: 2022-06-24 11:11:24
Language: Lua
License: MIT

キックスタート.nvim

紹介

ネオビムの出発点は次のとおりです。

  • 小さい
  • 単一ファイル (複数ファイルへの移行例あり)
  • 記載
  • モジュラー

このリポジトリは、Neovimの旅を始めるためにあなたが使用することを目的としています。使用しないものを削除し、見逃したものを追加します。

配布の選択肢:

  • LazyVim: @folke (lazy.nvim の作者、ここで使われているパッケージマネージャ) によって維持されている楽しいディストリビューション

取り付け

Kickstart.nvimは、Neovimの最新の「安定版」と最新の「ナイトリー」のみをターゲットにしています。問題が発生している場合は、最新バージョンを使用していることを確認してください。

  • 以前の構成をバックアップする
  • (推奨)このリポジトリをフォークします(変更できる独自のコピーを作成します)。
  • キックスタートリポジトリを(Linux / Mac)または(Windows)に複製します
    $HOME/.config/nvim/
    ~/AppData/Local/nvim/
    • gitリポジトリとして含めたくない場合は、クローンを作成してからファイルをこの場所に移動できます
  • Neovim()を起動し、インストールを完了できるようにします。
    nvim
    lazy.nvim
  • ネオビムを再起動します
  • これで準備完了です。

追加のシステム要件:

構成と拡張機能

  • フォーク内では、好きなファイルを自由に変更してください!それはあなたのフォークです!
  • 次に、次の 2 つの主要な構成オプションを使用できます。
    • 構成にファイルを含めます。
      lua/kickstart/plugins/*
    • 新しい構成をファイルに追加し、次を使用して自動ソース化されます。
      lua/custom/plugins/*
      lazy.nvim
      • 注:これを有効にするには、
        { import = 'custom.plugins' }
        init.lua

リポジトリからの更新/変更をフォークにマージして、デフォルト設定の変更を最新の状態に保つこともできます

例: オートペアプラグインの追加

ファイル: に、以下を追加します。

lua/custom/plugins/autopairs.lua

-- File: lua/custom/plugins/autopairs.lua

return {
  "windwp/nvim-autopairs",
  config = function()
    require("nvim-autopairs").setup {}
  end,
}

これにより、起動時に自動的にインストールされ、有効になります。詳細については、lazy.nvim のドキュメントを参照してください。

nvim-autopairs

例: ファイルツリープラグインの追加

ファイル: に、以下を追加します。

lua/custom/plugins/filetree.lua

return {
  "nvim-neo-tree/neo-tree.nvim",
  version = "*",
  dependencies = {
    "nvim-lua/plenary.nvim",
    "nvim-tree/nvim-web-devicons", -- not strictly required, but recommended
    "MunifTanjim/nui.nvim",
  },
  config = function ()
    -- Unless you are still migrating, remove the deprecated commands from v1.x
    vim.cmd([[ let g:neo_tree_remove_legacy_commands = 1 ]])

    require('neo-tree').setup {}
  end,
}

これにより、ツリープラグインがインストールされ、コマンドが追加されます。詳細については、neo-tree.nvim のドキュメントを参照してください。

:NeoTree

例: デフォルト・オプションを変更するためのファイルの追加

デフォルト・オプションを変更するには、フォルダにファイルを追加して(「」を参照)、独自のオプション、キーマップ、オートグループなどを含めます。次に、サンプル ファイルを示します (にあります)。

/after/plugin/
:help load-plugins
defaults.lua
$HOME/.config/nvim/after/plugin/defaults.lua

vim.opt.relativenumber = true

vim.keymap.set('n', '<leader>sr', require('telescope.builtin').resume, { desc = '[S]earch [R]esume' })

寄付

プルリクエストは大歓迎です。このリポジトリの目的は、Neovim 構成フレームワークを作成することではなく、Neovim で使用可能な機能を例で示す開始テンプレートを提供することです。含まれないもの:

  • カスタム言語サーバーの構成 (null-ls テンプレート)
  • LSP ハイライト グループに必要な既定の配色を超えるテーマ

各PR、特に行数を増やすPRには、PRが必要な理由を説明する必要があります。

FAQ

  • 既存のneovim構成がある場合はどうすればよいですか?
    • バックアップしてから、関連付けられているすべてのファイルを削除する必要があります。
    • これには.lua既存のinitと、
      ~/.local
      rm -rf ~/.local/share/nvim/
    • lazy.nvim の移行ガイドもご覧ください。
  • この構成を「アンインストール」したい場合はどうすればよいですか?
  • このプラグインに関するクールなビデオはありますか?
    • キックスタートの現在のイテレーション(近日公開予定)
    • キックスタートの以前のイテレーションについての1つは、Kickstart.nvimのビデオ紹介です。

ウィンドウズのインストール

インストールには、ビルドツールのインストールと、の実行コマンドの更新が必要になる場合があります。

telescope-fzf-native

詳細については、ドキュメントを参照してください。

telescope-fzf-native

これには以下が必要です。

  • CMake と Microsoft C++ Build Tools を Windows にインストールする
use {'nvim-telescope/telescope-fzf-native.nvim', run = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }