Update init.lua

2022-12-17 21:39:42 -05:00
14 changed files with 437 additions and 1340 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@ -1,28 +0,0 @@
 ---
 name: Bug report
 about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
 ---
 <!-- Any bug report not following this template will be immediately closed. Thanks -->
 ## Describe the bug
 <!-- A clear and concise description of what the bug is. -->
 ## To Reproduce
 <!-- Steps to reproduce the behavior. -->
 1. ...
 ## Desktop
 <!-- please complete the following information. -->
 - OS: 
 - Terminal: 
 ## Neovim Version
 <!-- Output of running `:version` from inside of neovim. -->
 ```
 ```
--- a/.github/workflows/stylua.yml
+++ b/.github/workflows/stylua.yml
@ -1,21 +0,0 @@
 # Check Lua Formatting
 name: Check Lua Formatting
 on: pull_request_target
 jobs:
  stylua-check:
    if: github.repository == 'nvim-lua/kickstart.nvim'
    name: Stylua Check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v2
        with:
          ref: ${{ github.event.pull_request.head.sha }}
      - name: Stylua Check
        uses: JohnnyMorganz/stylua-action@v3
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          version: latest
          args: --check .
--- a/.gitignore
+++ b/.gitignore
@ -2,6 +2,3 @@ tags
 test.sh
 .luarc.json
 nvim
 spell/
 lazy-lock.json
--- a/.stylua.toml
+++ b/.stylua.toml
@ -3,4 +3,4 @@ line_endings = "Unix"
 indent_type = "Spaces"
 indent_width = 2
 quote_style = "AutoPreferSingle"
-call_parentheses = "None"
+no_call_parentheses = true
--- a/34
+++ b/34
@ -0,0 +1,34 @@
 # Build neovim separately in the first stage
 FROM alpine:latest AS base
 RUN apk --no-cache add \
    autoconf \
    automake \
    build-base \
    cmake \
    ninja \
    coreutils \
    curl \
    gettext-tiny-dev \
    git \
    libtool \
    pkgconf \
    unzip
 # Build neovim (and use it as an example codebase
 RUN git clone https://github.com/neovim/neovim.git
 ARG VERSION=master
 RUN cd neovim && git checkout ${VERSION} && make CMAKE_BUILD_TYPE=RelWithDebInfo install
 # To support kickstart.nvim
 RUN apk --no-cache add \
    fd  \
    ctags \
    ripgrep \
    git
 # Copy the kickstart.nvim init.lua
 COPY ./init.lua /root/.config/nvim/init.lua
 WORKDIR /neovim
--- a/README.md
+++ b/README.md
@ -1,277 +1,60 @@
-# kickstart.nvim
+### Introduction
 ## Introduction
 A starting point for Neovim that is:
-* Small
+* Small (~370 lines)
 * Single-file
-* Completely Documented
+* Documented
 * Modular
-**NOT** a Neovim distribution, but instead a starting point for your configuration.
+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.
-## Installation
+This repo is meant to be used as a starting point for a user's own configuration; remove the things you don't use and add what you miss. This configuration serves as the reference configuration for the [lspconfig wiki](https://github.com/neovim/nvim-lspconfig/wiki).
-### Install Neovim
+### Installation
-Kickstart.nvim targets *only* the latest
+* Backup your previous configuration
-['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest
+* Copy and paste the kickstart.nvim `init.lua` into `$HOME/.config/nvim/init.lua`
-['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim.
+* Start Neovim (`nvim`) and run `:PackerInstall` - ignore any error message about missing plugins, `:PackerInstall` will fix that shortly
-If you are experiencing issues, please make sure you have the latest versions.
+* Restart Neovim
-### Install External Dependencies
+### Configuration
-> **NOTE**
+You could directly modify the `init.lua` file with your personal customizations. This option is the most straightforward, but if you update your config from this repo, you may need to reapply your changes.
 > [Backup](#FAQ) your previous configuration (if any exists)
-External Requirements:
+An alternative approach is to create a separate `custom.plugins` module to register your own plugins. In addition, you can handle further customizations in the `/after/plugin/` directory (see `:help load-plugins`). See the following examples for more information. Leveraging this technique should make upgrading to a newer version of this repo easier. 
 - Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
 - [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
 - 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
 - Language Setup:
  - If want to write Typescript, you need `npm`
  - If want to write Golang, you will need `go`
  - etc.
-> **NOTE**
+#### Example `plugins.lua`
 > See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
 > and quick install snippets
-Neovim's configurations are located under the following paths, depending on your OS:
+The following is an example of a `plugins.lua` module (located at `$HOME/.config/nvim/lua/custom/plugins.lua`) where you can register your own plugins. 
 | OS | PATH |
 | :- | :--- |
 | Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
 | Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
 | Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
 ### Install Kickstart
 #### 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`
 #### 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`:
 ```
 git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
 ```
 If you're using `powershell.exe`
 ```
 git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
 ```
 </details>
 ### Post Installation
 Start Neovim
 ```sh
 nvim
 ```
 That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
 current plugin status.
 Read through the `init.lua` file in your configuration folder for more
 information about extending and exploring Neovim.
 #### Examples of adding popularly requested plugins
 NOTE: You'll need to uncomment the line in the init.lua that turns on loading custom plugins.
 <details>
  <summary>Adding autopairs</summary>
 This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs)
 and enable it on startup. For more information, see documentation for
 [lazy.nvim](https://github.com/folke/lazy.nvim).
 In the file: `lua/custom/plugins/autopairs.lua`, add:
 ```lua
-- File: lua/custom/plugins/autopairs.lua
+return function(use)
-
+  use({
-return {
+    "folke/which-key.nvim",
  "windwp/nvim-autopairs",
  -- Optional dependency
  dependencies = { 'hrsh7th/nvim-cmp' },
      config = function()
-    require("nvim-autopairs").setup {}
+        require("which-key").setup({})
-    -- If you want to automatically add `(` after selecting a function or method
+      end
-    local cmp_autopairs = require('nvim-autopairs.completion.cmp')
+  })
-    local cmp = require('cmp')
+end
    cmp.event:on(
      'confirm_done',
      cmp_autopairs.on_confirm_done()
    )
  end,
 }
 ```
-</details>
+#### Example `defaults.lua`
 <details>
  <summary>Adding a file tree plugin</summary>
-This will install the tree plugin and add the command `:Neotree` for you.
+For further customizations, you can add a file in the `/after/plugin/` folder (see `:help load-plugins`) to include your own options, keymaps, autogroups, and more. The following is an example `defaults.lua` file (located at `$HOME/.config/nvim/after/plugin/defaults.lua`).
 For more information, see the documentation at
 [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim).
 In the file: `lua/custom/plugins/filetree.lua`, add:
 ```lua
-- File: lua/custom/plugins/filetree.lua
+vim.opt.relativenumber = true
-return {
+vim.keymap.set('n', '<leader>sr', require('telescope.builtin').resume, { desc = '[S]earch [R]esume' })
  "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 ()
    require('neo-tree').setup {}
  end,
 }
 ```
-</details>
+### Contribution
-### Getting Started
+Pull-requests are welcome. The goal of this repo is not to create a Neovim configuration framework, but to offer a starting template that shows, by example, available features in Neovim. Some things that will not be included:
-[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
+* Custom language server configuration (null-ls templates)
-
+* Theming beyond a default colorscheme necessary for LSP highlight groups
-### FAQ
+* Lazy-loading. Kickstart.nvim should start within 40 ms on modern hardware. Please profile and contribute to upstream plugins to optimize startup time instead.
 * 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://github.com/folke/lazy.nvim#-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)
 ### Install Recipes
 Below you can find OS specific install instructions for Neovim and dependencies.
 After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.
 #### Windows Installation
 <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`
 See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)
 This requires:
 - Install CMake and the Microsoft C++ Build Tools on Windows
 ```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
 ```
 2. install all requirements using choco, exit previous cmd and
 open a new one so that choco path is set, and run in cmd as **admin**:
 ```
 choco install -y neovim git ripgrep wget fd unzip gzip mingw make
 ```
 </details>
 <details><summary>WSL (Windows Subsystem for Linux)</summary>
 ```
 wsl --install
 wsl
 sudo add-apt-repository ppa:neovim-ppa/unstable -y
 sudo apt update
 sudo apt install make gcc ripgrep unzip neovim
 ```
 </details>
 #### Linux Install
 <details><summary>Ubuntu Install Steps</summary>
 ```
 sudo add-apt-repository ppa:neovim-ppa/unstable -y
 sudo apt update
 sudo apt install make gcc ripgrep unzip neovim
 ```
 </details>
 <details><summary>Debian Install Steps</summary>
 ```
 sudo apt update
 sudo apt install make gcc ripgrep unzip git
 echo "deb https://deb.debian.org/debian unstable main" | sudo tee -a /etc/apt/sources.list
 sudo apt update
 sudo apt install -t unstable neovim
 ```
 </details>
 <details><summary>Fedora Install Steps</summary>
 ```
 sudo dnf install -y gcc make git ripgrep fd-find neovim
 ```
 </details>
 Each PR, especially those which increase the line count, should have a description as to why the PR is necessary.
--- a/doc/kickstart.txt
+++ b/doc/kickstart.txt
@ -1,24 +0,0 @@
 ================================================================================
 INTRODUCTION                                                  *kickstart.nvim*
 Kickstart.nvim is a project to help you get started on your neovim journey.
                                                            *kickstart-is-not*
 It is not:
 - Complete framework for every plugin under the sun
 - Place to add every plugin that could ever be useful
                                                                *kickstart-is*
 It is:
 - Somewhere that has a good start for the most common "IDE" type features:
    - autocompletion
    - goto-definition
    - find references
    - fuzzy finding
    - and hinting at what more can be done :)
 - A place to _kickstart_ your journey.
    - You should fork this project and use/modify it so that it matches your
      style and preferences. If you don't want to do that, there are probably
      other projects that would fit much better for you (and that's great!)!
 vim:tw=78:ts=8:ft=help:norl:
--- a/doc/tags
+++ b/doc/tags
@ -1,3 +0,0 @@
 kickstart-is	kickstart.txt	/*kickstart-is*
 kickstart-is-not	kickstart.txt	/*kickstart-is-not*
 kickstart.nvim	kickstart.txt	/*kickstart.nvim*
--- a/init.lua
+++ b/init.lua
--- a/lua/custom/plugins/init.lua
+++ b/lua/custom/plugins/init.lua
@ -1,5 +0,0 @@
 -- You can add your own plugins here or in other files in this directory!
 --  I promise not to create any merge conflicts in this directory :)
 --
 -- See the kickstart.nvim README for more information
 return {}
--- a/lua/kickstart/health.lua
+++ b/lua/kickstart/health.lua
@ -1,52 +0,0 @@
 --[[
 --
 -- This file is not required for your own configuration,
 -- but helps people determine if their system is setup correctly.
 --
 --]]
 local check_version = function()
  local verstr = string.format('%s.%s.%s', vim.version().major, vim.version().minor, vim.version().patch)
  if not vim.version.cmp then
    vim.health.error(string.format("Neovim out of date: '%s'. Upgrade to latest stable or nightly", verstr))
    return
  end
  if vim.version.cmp(vim.version(), { 0, 9, 4 }) >= 0 then
    vim.health.ok(string.format("Neovim version is: '%s'", verstr))
  else
    vim.health.error(string.format("Neovim out of date: '%s'. Upgrade to latest stable or nightly", verstr))
  end
 end
 local check_external_reqs = function()
  -- Basic utils: `git`, `make`, `unzip`
  for _, exe in ipairs { 'git', 'make', 'unzip', 'rg' } do
    local is_executable = vim.fn.executable(exe) == 1
    if is_executable then
      vim.health.ok(string.format("Found executable: '%s'", exe))
    else
      vim.health.warn(string.format("Could not find executable: '%s'", exe))
    end
  end
  return true
 end
 return {
  check = function()
    vim.health.start 'kickstart.nvim'
    vim.health.info [[NOTE: Not every warning is a 'must-fix' in `:checkhealth`
  Fix only warnings for plugins and languages you intend to use.
    Mason will give warnings for languages that are not installed.
    You do not need to install, unless you want to use those languages!]]
    local uv = vim.uv or vim.loop
    vim.health.info('System Information: ' .. vim.inspect(uv.os_uname()))
    check_version()
    check_external_reqs()
  end,
 }
--- a/lua/kickstart/plugins/debug.lua
+++ b/lua/kickstart/plugins/debug.lua
@ -1,90 +0,0 @@
 -- debug.lua
 --
 -- Shows how to use the DAP plugin to debug your code.
 --
 -- Primarily focused on configuring the debugger for Go, but can
 -- be extended to other languages as well. That's why it's called
 -- kickstart.nvim and not kitchen-sink.nvim ;)
 return {
  -- NOTE: Yes, you can install new plugins here!
  'mfussenegger/nvim-dap',
  -- NOTE: And you can specify dependencies as well
  dependencies = {
    -- Creates a beautiful debugger UI
    'rcarriga/nvim-dap-ui',
    -- Required dependency for nvim-dap-ui
    'nvim-neotest/nvim-nio',
    -- Installs the debug adapters for you
    'williamboman/mason.nvim',
    'jay-babu/mason-nvim-dap.nvim',
    -- Add your own debuggers here
    'leoluz/nvim-dap-go',
  },
  config = function()
    local dap = require 'dap'
    local dapui = require 'dapui'
    require('mason-nvim-dap').setup {
      -- Makes a best effort to setup the various debuggers with
      -- reasonable debug configurations
      automatic_setup = true,
      -- You can provide additional configuration to the handlers,
      -- see mason-nvim-dap README for more information
      handlers = {},
      -- You'll need to check that you have the required things installed
      -- online, please don't ask me how to install them :)
      ensure_installed = {
        -- Update this to ensure that you have the debuggers for the langs you want
        'delve',
      },
    }
    -- Basic debugging keymaps, feel free to change to your liking!
    vim.keymap.set('n', '<F5>', dap.continue, { desc = 'Debug: Start/Continue' })
    vim.keymap.set('n', '<F1>', dap.step_into, { desc = 'Debug: Step Into' })
    vim.keymap.set('n', '<F2>', dap.step_over, { desc = 'Debug: Step Over' })
    vim.keymap.set('n', '<F3>', dap.step_out, { desc = 'Debug: Step Out' })
    vim.keymap.set('n', '<leader>b', dap.toggle_breakpoint, { desc = 'Debug: Toggle Breakpoint' })
    vim.keymap.set('n', '<leader>B', function()
      dap.set_breakpoint(vim.fn.input 'Breakpoint condition: ')
    end, { desc = 'Debug: Set Breakpoint' })
    -- Dap UI setup
    -- For more information, see |:help nvim-dap-ui|
    dapui.setup {
      -- Set icons to characters that are more likely to work in every terminal.
      --    Feel free to remove or use ones that you like more! :)
      --    Don't feel like these are good choices.
      icons = { expanded = '▾', collapsed = '▸', current_frame = '*' },
      controls = {
        icons = {
          pause = '⏸',
          play = '▶',
          step_into = '⏎',
          step_over = '⏭',
          step_out = '⏮',
          step_back = 'b',
          run_last = '▶▶',
          terminate = '⏹',
          disconnect = '⏏',
        },
      },
    }
    -- Toggle to see last session result. Without this, you can't see session output in case of unhandled exception.
    vim.keymap.set('n', '<F7>', dapui.toggle, { desc = 'Debug: See last session result.' })
    dap.listeners.after.event_initialized['dapui_config'] = dapui.open
    dap.listeners.before.event_terminated['dapui_config'] = dapui.close
    dap.listeners.before.event_exited['dapui_config'] = dapui.close
    -- Install golang specific config
    require('dap-go').setup()
  end,
 }
--- a/lua/kickstart/plugins/indent_line.lua
+++ b/lua/kickstart/plugins/indent_line.lua
@ -1,9 +0,0 @@
 return {
  { -- Add indentation guides even on blank lines
    'lukas-reineke/indent-blankline.nvim',
    -- Enable `lukas-reineke/indent-blankline.nvim`
    -- See `:help ibl`
    main = 'ibl',
    opts = {},
  },
 }
--- a/lua/kickstart/plugins/lint.lua
+++ b/lua/kickstart/plugins/lint.lua
@ -1,55 +0,0 @@
 return {
  { -- Linting
    'mfussenegger/nvim-lint',
    event = { 'BufReadPre', 'BufNewFile' },
    config = function()
      local lint = require 'lint'
      lint.linters_by_ft = {
        markdown = { 'markdownlint' },
      }
      -- To allow other plugins to add linters to require('lint').linters_by_ft,
      -- instead set linters_by_ft like this:
      -- lint.linters_by_ft = lint.linters_by_ft or {}
      -- lint.linters_by_ft['markdown'] = { 'markdownlint' }
      --
      -- However, note that this will enable a set of default linters,
      -- which will cause errors unless these tools are available:
      -- {
      --   clojure = { "clj-kondo" },
      --   dockerfile = { "hadolint" },
      --   inko = { "inko" },
      --   janet = { "janet" },
      --   json = { "jsonlint" },
      --   markdown = { "vale" },
      --   rst = { "vale" },
      --   ruby = { "ruby" },
      --   terraform = { "tflint" },
      --   text = { "vale" }
      -- }
      --
      -- You can disable the default linters by setting their filetypes to nil:
      -- lint.linters_by_ft['clojure'] = nil
      -- lint.linters_by_ft['dockerfile'] = nil
      -- lint.linters_by_ft['inko'] = nil
      -- lint.linters_by_ft['janet'] = nil
      -- lint.linters_by_ft['json'] = nil
      -- lint.linters_by_ft['markdown'] = nil
      -- lint.linters_by_ft['rst'] = nil
      -- lint.linters_by_ft['ruby'] = nil
      -- lint.linters_by_ft['terraform'] = nil
      -- lint.linters_by_ft['text'] = nil
      -- Create autocommand which carries out the actual linting
      -- on the specified events.
      local lint_augroup = vim.api.nvim_create_augroup('lint', { clear = true })
      vim.api.nvim_create_autocmd({ 'BufEnter', 'BufWritePost', 'InsertLeave' }, {
        group = lint_augroup,
        callback = function()
          require('lint').try_lint()
        end,
      })
    end,
  },
 }