Merge pull request #13 from venkatarenduchintala/feat/ci-validate-pipeline

feat(ci): add GitHub Actions pipeline to validate Neovim config

Author: venkatarenduchintala

.github/workflows/validate.yml

@@ -0,0 +1,46 @@
+name: Validate Neovim Config
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+    branches: [master]
+
+jobs:
+  validate:
+    name: Build & validate Neovim
+    runs-on: ubuntu-latest
+    # Skip docs: and chore: commits on push; always run on pull requests
+    if: |
+      github.event_name == 'pull_request' ||
+      (
+        !startsWith(github.event.head_commit.message, 'docs:') &&
+        !startsWith(github.event.head_commit.message, 'chore:')
+      )
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build devcontainer image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: .devcontainer/Dockerfile
+          tags: nvim-config:ci
+          load: true
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Check Neovim version
+        run: docker run --rm nvim-config:ci nvim --version
+
+      - name: Validate Neovim starts headless
+        run: |
+          docker run --rm \
+            -v "${{ github.workspace }}:/home/dev/.config/nvim:ro" \
+            nvim-config:ci \
+            nvim --headless --noplugin +qall

README.md

@@ -1,59 +1,40 @@
 # Neovim configuration for Java, Python, Rust and Lua
 
-This is my personal LUA based configuration for Neovim that I use on a daily basis as Java, Python and RUST IDE. This setup is the product of continuous enhancements based in what I have found in configurations shared by other users. It is an ongoing project that may evolve with time as I come accross with new plugins, refine mappings or refactor configuration files.<br>Feel free to fork this repository and adapt it to your own needs.
+Personal Lua-based Neovim configuration used as a daily IDE for Java, Python and Rust development.
 
-<br>
-
-*Autocompletion*
-![lsp autocompletion](./screenshots/nvim_lsp_cmp.png?raw=true)
-
-*Compilation errors*
-![lsp autocompletion](./screenshots/nvim_lsp_errors.png?raw=true)
-
-*Debug*
-![lsp autocompletion](./screenshots/nvim_dap.png?raw=true)
+> **Disclaimer:** This configuration is based on and forked from [magidc/nvim-config](https://github.com/magidc/nvim-config). Credits to the original author for the foundational setup.
 
-*Launching Java application*
-![lsp autocompletion](./screenshots/nvim_java_launch.png?raw=true)
-
-*Telescope fuzzy finder*
-![telecope usage](./screenshots/nvim_telescope.png?raw=true)
+<br>
 
 # Installation
 ## Manual Setup
 0. Clone this repository into `~/.config/nvim`:
     ```
     git clone --depth 1 https://github.com/venkatarenduchintala/nvim-config.git ~/.config/nvim
     ```
-1. Install latest [NeoVIM version](https://github.com/neovim/neovim/wiki/Installing-Neovim). The configuration also includes an script to install automatically Neovim in APT based Linux distributions (Debian, Ubuntu, PopOs...). See [install_nvim.sh](https://github.com/magidc/nvim-config/blob/master/install_nvim.sh)
-2. Install [ripgrep](https://github.com/BurntSushi/ripgrep) into your OS. It is required by some [Telescope](https://github.com/nvim-telescope/telescope.nvim) plugin searching modes.
-
-3. This environment is preconfigured with Language Server Providers (LSP) and Debug Adapters  (DAP) for Java, Python, Rust and Lua. These components provide IDE features like autocompletions, error highlight or debugging. As it is required to have installed these components in your system, this Neovim setup relies on [mason.nvim](https://github.com/mason-org/mason.nvim#installation) plugin to install them automatically if they are missing.
-<br>
-
-# UI theme
-Several UI themes are preconfigured in this setup. Active theme is set by editing file `lua/settings.lua`.
-Default active theme is [Tokyonight](https://github.com/folke/tokyonight.nvim).
+1. Install latest [Neovim](https://github.com/neovim/neovim/wiki/Installing-Neovim).
+2. Install [ripgrep](https://github.com/BurntSushi/ripgrep) — required by some [Telescope](https://github.com/nvim-telescope/telescope.nvim) search modes.
+3. LSP servers and DAP adapters (Java, Python, Rust, Lua) are managed automatically by [mason.nvim](https://github.com/mason-org/mason.nvim) on first launch.
 
 <br>
 
-# Custom mappings
-Most of mappings are defined in file `lua/mappings.lua`. WhichKey plugin is used in order to provide a description for each one of them.
-Other mappings can be found in specific plugin configuration files in `lua/plugins/configs` directory. Also, language specific mappings are defined in LSP config files, these mappings are only available when working with specific programming languages (when LSP are attached)
+# UI Theme
+Several UI themes are preconfigured. The active theme is set in `lua/settings.lua`.
+Default: [Tokyonight](https://github.com/folke/tokyonight.nvim).
 
 <br>
 
-# Equivalent mapping configurations for other IDEs VIM integrations
-I have created configuration files with (almost) equivalent mappings for [Eclipse IDE vim plugin (vrapper)](https://github.com/magidc/dotfiles/blob/master/vrapperrc), [IntelliJ vim plugin (ideaVim)](https://github.com/magidc/dotfiles/blob/master/jetbrains/ideavimrc) and [VSCode vim plugin (vscodevim)](https://github.com/magidc/dotfiles/blob/master/vscode/keybindings.json).
-These configurations will allow users who are used to these key combinations to remain confortable and efficient while working with other IDEs.
+# Custom Mappings
+Core mappings are defined in `lua/mappings.lua`. [WhichKey](https://github.com/folke/which-key.nvim) provides inline descriptions for all bindings.
+Plugin-specific mappings live in `lua/plugins/configs/`. LSP mappings are defined in `lua/lsp/` and are only active when a language server is attached.
 
 <br>
 
-# Featured plugins
+# Featured Plugins
 * [Telescope](https://github.com/nvim-telescope/telescope.nvim)
     > Highly extendable fuzzy finder over lists
 * [Neotree](https://github.com/nvim-neo-tree/neo-tree.nvim)
-    > Tree file explorer 
+    > Tree file explorer
 * [Aerial](https://github.com/stevearc/aerial.nvim)
     > Code outline window for skimming and quick navigation
 * [WhichKey](https://github.com/folke/which-key.nvim)
@@ -63,14 +44,3 @@ These configurations will allow users who are used to these key combinations to
 * [Nvim-dap](https://github.com/mfussenegger/nvim-dap)
     > Debug Adapter Protocol client implementation for Neovim
 * Others...
-
-<br>
-
-# Troubleshooting
-If you have problems while installing or using this setup, please report an issue, 
-
-<br>
-
-# Feedback and suggestions
-I would appreciate suggestions and feedback regarding this Neovim configuration. As it is an ongoing project I will be changing over the time to become more useful and easy to use. Please do not hesitate to contact me if you have any comments
-