feat: Sync complete config - Fish, Ghostty, Neovim Scratch

- Add missing Fish configs (direnv, ssh function)
- Add Tokyo Night theme for Ghostty
- Complete Neovim scratch config sync
- Rewrite install.sh for new structure
- Add comprehensive README.md
This commit is contained in:
2025-10-13 10:00:52 +02:00
parent 5a7a2fdf9f
commit 8230492c3a
60 changed files with 1893 additions and 4382 deletions

View File

@@ -1,240 +1,241 @@
# kickstart.nvim
# Neovim Configuration - Built from Scratch
## Introduction
Moderne, minimale Neovim Config optimiert für **TypeScript/Playwright QA** und **Go Development**.
A starting point for Neovim that is:
## 🎯 Philosophie
* Small
* Single-file
* Completely Documented
- **Scratch mit lazy.nvim**: Keine Distro, keine Abstraktionen
- **TypeScript First**: Optimiert für Playwright Tests
- **Go Ready**: Volle gopls Integration
- **Verständlich**: Jede Datei hat einen klaren Zweck
- **Wartbar**: Standard Neovim APIs, keine Magie
**NOT** a Neovim distribution, but instead a starting point for your configuration.
## Installation
### Install Neovim
Kickstart.nvim targets *only* the latest
['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest
['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim.
If you are experiencing issues, please make sure you have the latest versions.
### Install External Dependencies
External Requirements:
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
- if you have it set `vim.g.have_nerd_font` in `init.lua` to true
- Emoji fonts (Ubuntu only, and only if you want emoji!) `sudo apt install fonts-noto-color-emoji`
- Language Setup:
- If you want to write Typescript, you need `npm`
- If you want to write Golang, you will need `go`
- etc.
> [!NOTE]
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
> and quick install snippets
### Install Kickstart
> [!NOTE]
> [Backup](#FAQ) your previous configuration (if any exists)
Neovim's configurations are located under the following paths, depending on your OS:
| OS | PATH |
| :- | :--- |
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
| Windows (cmd)| `%localappdata%\nvim\` |
| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` |
#### Recommended Step
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
so that you have your own copy that you can modify, then install by cloning the
fork to your machine using one of the commands below, depending on your OS.
> [!NOTE]
> Your fork's URL will be something like this:
> `https://github.com/<your_github_username>/kickstart.nvim.git`
You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
too - it's ignored in the kickstart repo to make maintenance easier, but it's
[recommended to track it in version control](https://lazy.folke.io/usage/lockfile).
#### Clone kickstart.nvim
> [!NOTE]
> If following the recommended step above (i.e., forking the repo), replace
> `nvim-lua` with `<your_github_username>` in the commands below
<details><summary> Linux and Mac </summary>
```sh
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```
</details>
<details><summary> Windows </summary>
If you're using `cmd.exe`:
## 📁 Struktur
```
git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim"
~/.config/nvim/
├── init.lua # Entry point
├── lua/
│ ├── core/
│ │ ├── options.lua # Vim Settings
│ │ ├── keymaps.lua # Keybindings
│ │ └── lazy.lua # lazy.nvim Bootstrap
│ └── plugins/
│ ├── lsp.lua # LSP (ts_ls, gopls, etc.)
│ ├── completion.lua # nvim-cmp
│ ├── treesitter.lua # Syntax Highlighting
│ ├── telescope.lua # Fuzzy Finder
│ ├── harpoon.lua # File Navigation
│ ├── neotree.lua # File Explorer
│ ├── git.lua # Git Integration
│ ├── formatting.lua # Code Formatting
│ ├── ui.lua # Theme + Statusline
│ └── editor.lua # QoL Plugins
```
If you're using `powershell.exe`
## 🚀 Installation
```
git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"
### Prerequisites
```bash
# Neovim 0.10+
brew install neovim
# Ripgrep (für Telescope)
brew install ripgrep
# Node.js (für TypeScript LSP)
brew install node
# Go (für gopls)
brew install go
```
</details>
### Setup
### Post Installation
```bash
# Backup alte Config (falls vorhanden)
mv ~/.config/nvim ~/.config/nvim.backup
Start Neovim
# Symlink aus dotfiles
ln -sf ~/gits/dotfiles/.config/nvim ~/.config/nvim
```sh
# Neovim starten - lazy.nvim installiert automatisch
nvim
```
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
the current plugin status. Hit `q` to close the window.
Beim ersten Start:
1. lazy.nvim installiert sich selbst
2. Alle Plugins werden geladen
3. Mason installiert LSP Server automatisch
4. Treesitter installiert Parser
#### Read The Friendly Documentation
**Warte bis alles fertig ist!** (~2-3 Minuten)
Read through the `init.lua` file in your configuration folder for more
information about extending and exploring Neovim. That also includes
examples of adding popularly requested plugins.
## ⌨️ Key Bindings
> [!NOTE]
> For more information about a particular plugin check its repository's documentation.
### Leader Key: `Space`
### Core
- `<leader>w` - Save file
- `<Esc>` - Clear search highlight
- `jk` / `jj` - Exit insert mode
### Getting Started
### Navigation
- `<C-h/j/k/l>` - Navigate windows
- `<S-h/l>` - Previous/Next buffer
- `<leader>bd` - Delete buffer
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
### Telescope (Find)
- `<leader>ff` - Find files
- `<leader>fg` - Live grep
- `<leader>fb` - Buffers
- `<leader>fo` - Recent files
- `<leader>fw` - Find word under cursor
- `<leader>fd` - Diagnostics
- `<leader>/` - Search in buffer
### FAQ
### Harpoon (File Navigation)
- `<leader>a` - Add file to Harpoon
- `<leader>h` - Toggle Harpoon menu
- `<C-j/k/l/;>` - Jump to file 1/2/3/4
* What should I do if I already have a pre-existing Neovim configuration?
* You should back it up and then delete all associated files.
* This includes your existing init.lua and the Neovim files in `~/.local`
which can be deleted with `rm -rf ~/.local/share/nvim/`
* Can I keep my existing configuration in parallel to kickstart?
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
to maintain multiple configurations. For example, you can install the kickstart
configuration in `~/.config/nvim-kickstart` and create an alias:
```
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
```
When you run Neovim using `nvim-kickstart` alias it will use the alternative
config directory and the matching local directory
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
distribution that you would like to try out.
* What if I want to "uninstall" this configuration:
* See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
* The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily use to `git clone` as a basis for their own.
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
into smaller parts. A fork of kickstart that does this while maintaining the
same functionality is available here:
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
* Discussions on this topic can be found here:
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
### Neo-tree (Explorer)
- `<leader>e` - Toggle explorer
- `<leader>ef` - Focus filesystem
- `<leader>eb` - Focus buffers
- `<leader>eg` - Focus git status
### Install Recipes
### LSP
- `gd` - Goto definition
- `gr` - Goto references
- `gI` - Goto implementation
- `K` - Hover documentation
- `<leader>ca` - Code action
- `<leader>rn` - Rename
- `[d` / `]d` - Previous/Next diagnostic
Below you can find OS specific install instructions for Neovim and dependencies.
### Git
- `<leader>gs` - Git status (Fugitive)
- `<leader>gc` - Git commit
- `<leader>gp` - Git push
- `<leader>gb` - Git blame
- `<leader>hs` - Stage hunk
- `<leader>hr` - Reset hunk
- `<leader>hp` - Preview hunk
- `[c` / `]c` - Previous/Next git hunk
After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.
### Go Specific
- `<leader>ee` - Insert `if err != nil { return err }`
#### Windows Installation
### Formatting
- `<leader>cf` - Format buffer
- `:FormatDisable` - Disable auto-format
- `:FormatEnable` - Enable auto-format
<details><summary>Windows with Microsoft C++ Build Tools and CMake</summary>
Installation may require installing build tools and updating the run command for `telescope-fzf-native`
## 🛠️ LSP Servers
See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)
Automatisch installiert via Mason:
- **ts_ls** - TypeScript/JavaScript (Playwright)
- **gopls** - Go
- **lua_ls** - Lua
- **html** - HTML
- **cssls** - CSS
- **jsonls** - JSON (mit Schema support)
- **yamlls** - YAML (mit Schema support)
- **dockerls** - Dockerfile
- **docker_compose_language_service** - Docker Compose
This requires:
### Weitere Sprachen hinzufügen
- Install CMake and the Microsoft C++ Build Tools on Windows
1. Öffne `lua/plugins/lsp.lua`
2. Füge Server zu `ensure_installed` hinzu
3. Füge Server Config hinzu (siehe Beispiele im File)
4. `:Mason` - Check ob installiert
## 🔧 Customization
### Options ändern
Editiere `lua/core/options.lua`:
```lua
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
```
</details>
<details><summary>Windows with gcc/make using chocolatey</summary>
Alternatively, one can install gcc and make which don't require changing the config,
the easiest way is to use choco:
1. install [chocolatey](https://chocolatey.org/install)
either follow the instructions on the page or use winget,
run in cmd as **admin**:
```
winget install --accept-source-agreements chocolatey.chocolatey
opt.relativenumber = true -- Enable relative numbers
```
2. install all requirements using choco, exit the previous cmd and
open a new one so that choco path is set, and run in cmd as **admin**:
### Keybindings ändern
Editiere `lua/core/keymaps.lua`:
```lua
keymap('n', '<leader>ff', '<cmd>Telescope find_files<CR>')
```
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
```
</details>
<details><summary>WSL (Windows Subsystem for Linux)</summary>
### Plugin hinzufügen
Neue Datei in `lua/plugins/`:
```lua
-- lua/plugins/myplugin.lua
return {
{
'author/plugin-name',
config = function()
-- Setup here
end,
},
}
```
wsl --install
wsl
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
```
</details>
#### Linux Install
<details><summary>Ubuntu Install Steps</summary>
### Plugin entfernen
Datei löschen oder Plugin auskommentieren, dann:
```vim
:Lazy clean
```
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
```
</details>
<details><summary>Debian Install Steps</summary>
```
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip curl
## 🐛 Troubleshooting
# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz
sudo rm -rf /opt/nvim-linux-x86_64
sudo mkdir -p /opt/nvim-linux-x86_64
sudo chmod a+rX /opt/nvim-linux-x86_64
sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz
# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
### LSP funktioniert nicht
```vim
:LspInfo " Check LSP status
:Mason " Check installed servers
:checkhealth " General health check
```
</details>
<details><summary>Fedora Install Steps</summary>
### Plugin-Probleme
```vim
:Lazy " Plugin manager UI
:Lazy sync " Update all plugins
:Lazy clean " Remove unused plugins
```
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
```
</details>
<details><summary>Arch Install Steps</summary>
### Performance
```vim
:Lazy profile " Check startup time
```
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
```
</details>
## 📦 Updates
```bash
# In Neovim:
:Lazy sync # Update plugins
# Mason LSP updates:
:Mason # Then 'U' für update all
```
## 🎓 Lernen
Wenn du was nicht verstehst:
1. Schau in die entsprechende Datei (gut kommentiert!)
2. `:help <command>` nutzen
3. Frag Claude 😊
## 🚨 Wichtig
- **Backup**: Alte Config ist in `~/.config/nvim.kickstart-backup`
- **Dotfiles**: Diese Config sollte in Git sein!
- **Updates**: Regelmäßig `:Lazy sync` und `:Mason` checken
## 📝 Änderungslog
- **2024-10**: Initial Scratch Build
- TypeScript/Playwright optimiert
- Go Support
- Moderne LSP APIs (vim.lsp.config)
- Harpoon v2
- Clean, modular structure