Initial commit
This commit is contained in:
		
							parent
							
								
									5aeddfdd5d
								
							
						
					
					
						commit
						3c2ffabd40
					
				| 
						 | 
					@ -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. -->
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
```
 | 
					 | 
				
			||||||
```
 | 
					 | 
				
			||||||
| 
						 | 
					@ -1,8 +0,0 @@
 | 
				
			||||||
***************************************************************************
 | 
					 | 
				
			||||||
**NOTE**
 | 
					 | 
				
			||||||
Please verify that the `base repository` above has the intended destination!
 | 
					 | 
				
			||||||
Github by default opens Pull Requests against the parent of a forked repository.
 | 
					 | 
				
			||||||
If this is your personal fork and you didn't intend to open a PR for contribution
 | 
					 | 
				
			||||||
to the original project then adjust the `base repository` accordingly.
 | 
					 | 
				
			||||||
**************************************************************************
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
| 
						 | 
					@ -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 .
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
							
								
								
									
										107
									
								
								init.lua
								
								
								
								
							
							
						
						
									
										107
									
								
								init.lua
								
								
								
								
							| 
						 | 
					@ -1,89 +1,3 @@
 | 
				
			||||||
--[[
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
=====================================================================
 | 
					 | 
				
			||||||
==================== READ THIS BEFORE CONTINUING ====================
 | 
					 | 
				
			||||||
=====================================================================
 | 
					 | 
				
			||||||
========                                    .-----.          ========
 | 
					 | 
				
			||||||
========         .----------------------.   | === |          ========
 | 
					 | 
				
			||||||
========         |.-""""""""""""""""""-.|   |-----|          ========
 | 
					 | 
				
			||||||
========         ||                    ||   | === |          ========
 | 
					 | 
				
			||||||
========         ||   KICKSTART.NVIM   ||   |-----|          ========
 | 
					 | 
				
			||||||
========         ||                    ||   | === |          ========
 | 
					 | 
				
			||||||
========         ||                    ||   |-----|          ========
 | 
					 | 
				
			||||||
========         ||:Tutor              ||   |:::::|          ========
 | 
					 | 
				
			||||||
========         |'-..................-'|   |____o|          ========
 | 
					 | 
				
			||||||
========         `"")----------------(""`   ___________      ========
 | 
					 | 
				
			||||||
========        /::::::::::|  |::::::::::\  \ no mouse \     ========
 | 
					 | 
				
			||||||
========       /:::========|  |==hjkl==:::\  \ required \    ========
 | 
					 | 
				
			||||||
========      '""""""""""""'  '""""""""""""'  '""""""""""'   ========
 | 
					 | 
				
			||||||
========                                                     ========
 | 
					 | 
				
			||||||
=====================================================================
 | 
					 | 
				
			||||||
=====================================================================
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
What is Kickstart?
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
  Kickstart.nvim is *not* a distribution.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
  Kickstart.nvim is a starting point for your own configuration.
 | 
					 | 
				
			||||||
    The goal is that you can read every line of code, top-to-bottom, understand
 | 
					 | 
				
			||||||
    what your configuration is doing, and modify it to suit your needs.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    Once you've done that, you can start exploring, configuring and tinkering to
 | 
					 | 
				
			||||||
    make Neovim your own! That might mean leaving Kickstart just the way it is for a while
 | 
					 | 
				
			||||||
    or immediately breaking it into modular pieces. It's up to you!
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    If you don't know anything about Lua, I recommend taking some time to read through
 | 
					 | 
				
			||||||
    a guide. One possible example which will only take 10-15 minutes:
 | 
					 | 
				
			||||||
      - https://learnxinyminutes.com/docs/lua/
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    After understanding a bit more about Lua, you can use `:help lua-guide` as a
 | 
					 | 
				
			||||||
    reference for how Neovim integrates Lua.
 | 
					 | 
				
			||||||
    - :help lua-guide
 | 
					 | 
				
			||||||
    - (or HTML version): https://neovim.io/doc/user/lua-guide.html
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Kickstart Guide:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
  TODO: The very first thing you should do is to run the command `:Tutor` in Neovim.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    If you don't know what this means, type the following:
 | 
					 | 
				
			||||||
      - <escape key>
 | 
					 | 
				
			||||||
      - :
 | 
					 | 
				
			||||||
      - Tutor
 | 
					 | 
				
			||||||
      - <enter key>
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    (If you already know the Neovim basics, you can skip this step.)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
  Once you've completed that, you can continue working through **AND READING** the rest
 | 
					 | 
				
			||||||
  of the kickstart init.lua.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
  Next, run AND READ `:help`.
 | 
					 | 
				
			||||||
    This will open up a help window with some basic information
 | 
					 | 
				
			||||||
    about reading, navigating and searching the builtin help documentation.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    This should be the first place you go to look when you're stuck or confused
 | 
					 | 
				
			||||||
    with something. It's one of my favorite Neovim features.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    MOST IMPORTANTLY, we provide a keymap "<space>sh" to [s]earch the [h]elp documentation,
 | 
					 | 
				
			||||||
    which is very useful when you're not exactly sure of what you're looking for.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
  I have left several `:help X` comments throughout the init.lua
 | 
					 | 
				
			||||||
    These are hints about where to find more information about the relevant settings,
 | 
					 | 
				
			||||||
    plugins or Neovim features used in Kickstart.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
   NOTE: Look for lines like this
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    Throughout the file. These are for you, the reader, to help you understand what is happening.
 | 
					 | 
				
			||||||
    Feel free to delete them once you know what you're doing, but they should serve as a guide
 | 
					 | 
				
			||||||
    for when you are first encountering a few different constructs in your Neovim config.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
If you experience any errors while trying to install kickstart, run `:checkhealth` for more info.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
I hope you enjoy your Neovim journey,
 | 
					 | 
				
			||||||
- TJ
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
P.S. You can delete this when you're done too. It's your config now! :)
 | 
					 | 
				
			||||||
--]]
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
-- Set <space> as the leader key
 | 
					-- Set <space> as the leader key
 | 
				
			||||||
-- See `:help mapleader`
 | 
					-- See `:help mapleader`
 | 
				
			||||||
--  NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used)
 | 
					--  NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used)
 | 
				
			||||||
| 
						 | 
					@ -91,7 +5,7 @@ vim.g.mapleader = ' '
 | 
				
			||||||
vim.g.maplocalleader = ' '
 | 
					vim.g.maplocalleader = ' '
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-- Set to true if you have a Nerd Font installed and selected in the terminal
 | 
					-- Set to true if you have a Nerd Font installed and selected in the terminal
 | 
				
			||||||
vim.g.have_nerd_font = false
 | 
					vim.g.have_nerd_font = true
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-- [[ Setting options ]]
 | 
					-- [[ Setting options ]]
 | 
				
			||||||
-- See `:help vim.opt`
 | 
					-- See `:help vim.opt`
 | 
				
			||||||
| 
						 | 
					@ -102,7 +16,7 @@ vim.g.have_nerd_font = false
 | 
				
			||||||
vim.opt.number = true
 | 
					vim.opt.number = true
 | 
				
			||||||
-- You can also add relative line numbers, to help with jumping.
 | 
					-- You can also add relative line numbers, to help with jumping.
 | 
				
			||||||
--  Experiment for yourself to see if you like it!
 | 
					--  Experiment for yourself to see if you like it!
 | 
				
			||||||
-- vim.opt.relativenumber = true
 | 
					vim.opt.relativenumber = true
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-- Enable mouse mode, can be useful for resizing splits for example!
 | 
					-- Enable mouse mode, can be useful for resizing splits for example!
 | 
				
			||||||
vim.opt.mouse = 'a'
 | 
					vim.opt.mouse = 'a'
 | 
				
			||||||
| 
						 | 
					@ -214,20 +128,14 @@ end ---@diagnostic disable-next-line: undefined-field
 | 
				
			||||||
vim.opt.rtp:prepend(lazypath)
 | 
					vim.opt.rtp:prepend(lazypath)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-- [[ Configure and install plugins ]]
 | 
					-- [[ Configure and install plugins ]]
 | 
				
			||||||
--
 | 
					 | 
				
			||||||
--  To check the current status of your plugins, run
 | 
					 | 
				
			||||||
--    :Lazy
 | 
					 | 
				
			||||||
--
 | 
					 | 
				
			||||||
--  You can press `?` in this menu for help. Use `:q` to close the window
 | 
					 | 
				
			||||||
--
 | 
					 | 
				
			||||||
--  To update plugins you can run
 | 
					 | 
				
			||||||
--    :Lazy update
 | 
					 | 
				
			||||||
--
 | 
					 | 
				
			||||||
-- NOTE: Here is where you install your plugins.
 | 
					-- NOTE: Here is where you install your plugins.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
require('lazy').setup({
 | 
					require('lazy').setup({
 | 
				
			||||||
  -- NOTE: Plugins can be added with a link (or for a github repo: 'owner/repo' link).
 | 
					  -- NOTE: Plugins can be added with a link (or for a github repo: 'owner/repo' link).
 | 
				
			||||||
  'tpope/vim-sleuth', -- Detect tabstop and shiftwidth automatically
 | 
					  'tpope/vim-sleuth', -- Detect tabstop and shiftwidth automatically
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					  'github/copilot.vim',
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  -- NOTE: Plugins can also be added by using a table,
 | 
					  -- NOTE: Plugins can also be added by using a table,
 | 
				
			||||||
  -- with the first argument being the link and the following
 | 
					  -- with the first argument being the link and the following
 | 
				
			||||||
  -- keys can be used to configure plugin behavior/loading/etc.
 | 
					  -- keys can be used to configure plugin behavior/loading/etc.
 | 
				
			||||||
| 
						 | 
					@ -565,10 +473,11 @@ require('lazy').setup({
 | 
				
			||||||
      --  - settings (table): Override the default settings passed when initializing the server.
 | 
					      --  - settings (table): Override the default settings passed when initializing the server.
 | 
				
			||||||
      --        For example, to see the options for `lua_ls`, you could go to: https://luals.github.io/wiki/settings/
 | 
					      --        For example, to see the options for `lua_ls`, you could go to: https://luals.github.io/wiki/settings/
 | 
				
			||||||
      local servers = {
 | 
					      local servers = {
 | 
				
			||||||
        -- clangd = {},
 | 
					        clangd = {},
 | 
				
			||||||
 | 
					        cmake = {},
 | 
				
			||||||
        -- gopls = {},
 | 
					        -- gopls = {},
 | 
				
			||||||
        -- pyright = {},
 | 
					        -- pyright = {},
 | 
				
			||||||
        -- rust_analyzer = {},
 | 
					        rust_analyzer = {},
 | 
				
			||||||
        -- ... etc. See `:help lspconfig-all` for a list of all the pre-configured LSPs
 | 
					        -- ... etc. See `:help lspconfig-all` for a list of all the pre-configured LSPs
 | 
				
			||||||
        --
 | 
					        --
 | 
				
			||||||
        -- Some languages (like typescript) have entire language plugins that can be useful:
 | 
					        -- Some languages (like typescript) have entire language plugins that can be useful:
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue