The starter for LightBoat.

• rg
• curl
• unzip
• make
• npm
• node
• pngpaste: macOS only, for image pasting in markdown files
• xclip or wl-paste: Linux only, for image pasting in markdown files

• java
• python3

Executables which may be installed automatically by mason.nvim:

• google-java-format: when java and python3 are executable, this will be installed automatically
• java-debug-adapter: when java, python3, and unzip are executable, this will be installed automatically
• java-test: when java, python3, and unzip are executable, this will be installed automatically
• jdtls: when java and python3 are executable, this will be installed automatically

Executables which may be installed automatically by mason.nvim:

• shellcheck: when bash is executable, this will be installed automatically
• bash-language-server: when bash and npm are executable, this will be installed automatically

Executables which may be installed automatically by mason.nvim:

• lua-language-server: this will be installed automatically
• stylua: when unzip is executable, this will be installed automatically

Executables which may be installed automatically by mason.nvim:

• bazelrc-lsp: when bazel is executable, this will be installed automatically
• buildifier: when bazel is executable, this will be installed automatically
• clangd: when unzip is executable, this will be installed automatically
• codelldb: when unzip is executable, this will be installed automatically
• neocmakelsp: when cmake is executable, this will be installed automatically
• clang-format: when python3 is executable, this will be installed automatically

• go

Executables which may be installed automatically by mason.nvim:

• gopls: when go is executable, this will be installed automatically
• goimports: when go is executable, this will be installed automatically

• python3

Executables which may be installed automatically by mason.nvim:

• pyright: when python3 and npm are executable, this will be installed automatically
• autopep8: when python3 is executable, this will be installed automatically

Executables which may be installed automatically by mason.nvim:

• eslint-lsp: when npm is executable, this will be installed automatically
• json-lsp: when npm is executable, this will be installed automatically
• typescript-language-server: when npm is executable, this will be installed automatically
• prettier: when npm is executable, this will be installed automatically
• yaml-language-server: when npm is executable, this will be installed automatically
• tailwindcss-language-server: when npm is executable, this will be installed automatically
• vue-language-server: when npm is executable, this will be installed automatically
• lemminx: when unzip is executable, this will be installed automatically
• markdown-oxide: this will be installed automatically

You may not want to install all of the above executables. You can configure vim.g.lightboat_opts.mason.ensure_installed in lua/core/lazy.lua to disable some of them.

For example, You can use those below to not install some executables:

vim.g.lightboat_opts = {
  mason = {
    ensure_installed = {
      ['lemminx'] = false,
      ['json-lsp'] = false,
      ['eslint-lsp'] = false,
      ['vue-language-server'] = false,
      ['yaml-language-server'] = false,
      ['typescript-language-server'] = false,
    }
  }
}

1. Backup your old configuration:

# run in bash
mv ~/.config/nvim{,.bak}
mv ~/.local/share/nvim{,.bak}
mv ~/.local/state/nvim{,.bak}
mv ~/.cache/nvim{,.bak}

2. Clone the repository:

git clone https://github.com/Kaiser-Yang/LightBoat.starter.git ~/.config/nvim

3. Run nvim to download the plugins.

4. You can remove the .git directory in the repository so that you can create your own git repository.

NOTE: When running nvim at the first time, you may encounter many errors. You just need to restart nvim many times, and wait for the plugins intallation.

Or you can use the Dockerfile to build a docker image with everything set up:

docker build -t lightboat-starter .
docker run -it --rm lightboat-starter
nvim

NOTE: The first time you run nvim, it will download the plugins. When all plugins are downloaded, you should restart nvim.

NOTE: Mason may not install executables automatically, and you just need to restart nvim and run :Mason in nvim.

Check LightBoat to learn how to customize.