Skip to content

chore(init.lua): clarify section comments - #2093

Merged
oriori1703 merged 1 commit into
nvim-lua:masterfrom
rez1-dev:section-names
Jul 25, 2026
Merged

oriori1703 merged 1 commit into
nvim-lua:masterfrom
rez1-dev:section-names

Conversation

@rez1-dev

Copy link
Copy Markdown
Contributor

Now that there is section 2 for keymaps. It doesn't need to be in section 1.

Two more things:

  • You have an autocommand under keymaps.
  • Keeping comments like -- [[ Basic Keymaps ]] feels a bit redundant. I know you are keeping parity with kickstart-modular.nvim

@oriori1703

Copy link
Copy Markdown
Collaborator

oops, you are totally right :)

about the other things:

You have an autocommand under keymaps.

I agree this is not the best, but I couldn't think of a section that fits better.
Any suggestions?

Keeping comments like -- [[ Basic Keymaps ]] feels a bit redundant.
I still find them useful even if they are repeating the section headers sometimes, because most sections contain multiple "sub sections" - which those comments help separate.

@rez1-dev

Copy link
Copy Markdown
Contributor Author

Keymaps and autocommands aren't closely related. For a starter guide like Kickstart, users should be able to differentiate between what they trigger and what Neovim triggers automatically.

I prefer autocmd to be a new chapter.

-- SECTION 2: KEYMAPS
-- SECTION 3: AUTOCMDS

or you could keep it like before.

-- SECTION 2: KEYMAPS & AUTOCMDS

@oriori1703
oriori1703 merged commit 9a02381 into nvim-lua:master Jul 25, 2026
1 check passed
@oriori1703

oriori1703 commented Jul 25, 2026 •

Copy link
Copy Markdown
Collaborator

For now I will update the section header to your second suggestion, because having a whole section for just one autocmd seems weird to me.

@rez1-dev
rez1-dev deleted the section-names branch August 6, 2026 18:16
SayanShankhari added a commit to SayanShankhari/kickstart.nvim that referenced this pull request Aug 15, 2026
commit 1abedfa
Merge: ae11554 626c660
Author: Sayan Shankhari <[email protected]>
Date:   Tue Aug 11 12:45:18 2026 +0530

    Merge remote-tracking branch 'upstream/master' into sandbox

commit ae11554
Author: Sayan Shankhari <[email protected]>
Date:   Tue Aug 11 12:39:37 2026 +0530

    fix(theme): integrate colordot scotopia

    Integrate scotopia theme with colordot color indicators using
    common colorlib library.

commit 626c660
Author: orip <[email protected]>
Date:   Fri Aug 7 18:44:41 2026 +0300

    Update the CI actions

commit b84f0b7
Author: orip <[email protected]>
Date:   Fri Aug 7 18:39:45 2026 +0300

    Fix CI checkout after github new security policy

    Github now fails with the following error when using
    `on: pull_request_target`:
    ```
    Error: Refusing to check out fork pull request code from a
    'pull_request_target' workflow. This workflow runs with the base
    repository's GITHUB_TOKEN, secrets, default-branch cache scope, and
    runner access. Fetching and executing a fork's code in that trusted
    context commonly leads to "pwn request" vulnerabilities. To opt in,
    review the risks at https://gh.io/securely-using-pull_request_target and
    set 'allow-unsafe-pr-checkout: true' on the actions/checkout step.
    ```

    This reverts nvim-lua#571
    and reopens nvim-lua#570

commit bd53f28
Author: orip <[email protected]>
Date:   Fri Aug 7 18:32:36 2026 +0300

    Fix corrupted library path of lua_ls

    The previous code accidentally overwrote the library path of lua_ls
    because it used `vim.tbl_extend` instead of `vim.list_extend`.

    Because they paths that were added to the list (`luv` and `busted`) are
    not really relevant for neovim configs, they are omitted entirely.

    fixes: nvim-lua#2138

commit b01d052
Author: orip <[email protected]>
Date:   Mon Jul 27 11:19:45 2026 +0300

    Fix lua_ls diagnostics

    fixes: nvim-lua#2133

commit 267fb6a
Merge: 216e06a 7a3532a
Author: Ori Perry <[email protected]>
Date:   Sat Jul 25 21:47:36 2026 +0300

    Merge pull request nvim-lua#2068 from stephansama/feature/update-readme-for-templating

    chore: updated readme

commit 216e06a
Author: orip <[email protected]>
Date:   Sat Jul 25 20:54:30 2026 +0300

    Update section 2's name

commit 9a02381
Merge: 3a2194f 3a6511c
Author: Ori Perry <[email protected]>
Date:   Sat Jul 25 20:51:05 2026 +0300

    Merge pull request nvim-lua#2093 from rez1-dev/section-names

    chore(init.lua): clarify section comments

commit 3a2194f
Author: orip <[email protected]>
Date:   Sat Jul 25 20:44:16 2026 +0300

    Call mason-lspconfig.setup to avoid UB

    fixes: nvim-lua#2121, resolves: nvim-lua#2128

commit 7a3532a
Author: stephansama <[email protected]>
Date:   Fri Jun 12 09:52:53 2026 -0400

    chore: add language for forks

commit 3a6511c
Author: rez1 <[email protected]>
Date:   Fri Jun 12 14:16:40 2026 +0600

    chore(init.lua): clarify section comments

commit 2a12a5a
Merge: b8732e9 f0a2108
Author: Sayan Shankhari <[email protected]>
Date:   Thu Jun 11 21:28:14 2026 +0530

    Merge remote-tracking branch 'upstream' into sandbox

commit b8732e9
Merge: bc90fe1 ac51593 9e345b9
Author: Sayan Shankhari <[email protected]>
Date:   Thu Jun 11 21:25:11 2026 +0530

    Merge branch 'master', remote-tracking branch 'upstream' into sandbox

commit bc90fe1
Author: Sayan Shankhari <[email protected]>
Date:   Thu Jun 11 20:56:03 2026 +0530

    fix(misc): restore missing theme and options

commit c210767
Author: Sayan Shankhari <[email protected]>
Date:   Wed Jun 10 10:06:43 2026 +0530

    fix(test): force track test script

commit f1de746
Author: stephansama <[email protected]>
Date:   Thu May 28 04:07:22 2026 -0400

    chore: updated readme
SayanShankhari added a commit to SayanShankhari/kickstart.nvim that referenced this pull request Aug 16, 2026
commit 023b172
Author: Sayan Shankhari <[email protected]>
Date:   Sun Aug 16 10:03:36 2026 +0530

    fix(theme): unify local development theme setup

commit 1abedfa
Merge: ae11554 626c660
Author: Sayan Shankhari <[email protected]>
Date:   Tue Aug 11 12:45:18 2026 +0530

    Merge remote-tracking branch 'upstream/master' into sandbox

commit ae11554
Author: Sayan Shankhari <[email protected]>
Date:   Tue Aug 11 12:39:37 2026 +0530

    fix(theme): integrate colordot scotopia

    Integrate scotopia theme with colordot color indicators using
    common colorlib library.

commit 626c660
Author: orip <[email protected]>
Date:   Fri Aug 7 18:44:41 2026 +0300

    Update the CI actions

commit b84f0b7
Author: orip <[email protected]>
Date:   Fri Aug 7 18:39:45 2026 +0300

    Fix CI checkout after github new security policy

    Github now fails with the following error when using
    `on: pull_request_target`:
    ```
    Error: Refusing to check out fork pull request code from a
    'pull_request_target' workflow. This workflow runs with the base
    repository's GITHUB_TOKEN, secrets, default-branch cache scope, and
    runner access. Fetching and executing a fork's code in that trusted
    context commonly leads to "pwn request" vulnerabilities. To opt in,
    review the risks at https://gh.io/securely-using-pull_request_target and
    set 'allow-unsafe-pr-checkout: true' on the actions/checkout step.
    ```

    This reverts nvim-lua#571
    and reopens nvim-lua#570

commit bd53f28
Author: orip <[email protected]>
Date:   Fri Aug 7 18:32:36 2026 +0300

    Fix corrupted library path of lua_ls

    The previous code accidentally overwrote the library path of lua_ls
    because it used `vim.tbl_extend` instead of `vim.list_extend`.

    Because they paths that were added to the list (`luv` and `busted`) are
    not really relevant for neovim configs, they are omitted entirely.

    fixes: nvim-lua#2138

commit b01d052
Author: orip <[email protected]>
Date:   Mon Jul 27 11:19:45 2026 +0300

    Fix lua_ls diagnostics

    fixes: nvim-lua#2133

commit 267fb6a
Merge: 216e06a 7a3532a
Author: Ori Perry <[email protected]>
Date:   Sat Jul 25 21:47:36 2026 +0300

    Merge pull request nvim-lua#2068 from stephansama/feature/update-readme-for-templating

    chore: updated readme

commit 216e06a
Author: orip <[email protected]>
Date:   Sat Jul 25 20:54:30 2026 +0300

    Update section 2's name

commit 9a02381
Merge: 3a2194f 3a6511c
Author: Ori Perry <[email protected]>
Date:   Sat Jul 25 20:51:05 2026 +0300

    Merge pull request nvim-lua#2093 from rez1-dev/section-names

    chore(init.lua): clarify section comments

commit 3a2194f
Author: orip <[email protected]>
Date:   Sat Jul 25 20:44:16 2026 +0300

    Call mason-lspconfig.setup to avoid UB

    fixes: nvim-lua#2121, resolves: nvim-lua#2128

commit 7a3532a
Author: stephansama <[email protected]>
Date:   Fri Jun 12 09:52:53 2026 -0400

    chore: add language for forks

commit 3a6511c
Author: rez1 <[email protected]>
Date:   Fri Jun 12 14:16:40 2026 +0600

    chore(init.lua): clarify section comments

commit 2a12a5a
Merge: b8732e9 f0a2108
Author: Sayan Shankhari <[email protected]>
Date:   Thu Jun 11 21:28:14 2026 +0530

    Merge remote-tracking branch 'upstream' into sandbox

commit b8732e9
Merge: bc90fe1 ac51593 9e345b9
Author: Sayan Shankhari <[email protected]>
Date:   Thu Jun 11 21:25:11 2026 +0530

    Merge branch 'master', remote-tracking branch 'upstream' into sandbox

commit bc90fe1
Author: Sayan Shankhari <[email protected]>
Date:   Thu Jun 11 20:56:03 2026 +0530

    fix(misc): restore missing theme and options

commit c210767
Author: Sayan Shankhari <[email protected]>
Date:   Wed Jun 10 10:06:43 2026 +0530

    fix(test): force track test script

commit f1de746
Author: stephansama <[email protected]>
Date:   Thu May 28 04:07:22 2026 -0400

    chore: updated readme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants