From f9c653c21116a298a49177c9dffa77f736698bf3 Mon Sep 17 00:00:00 2001 From: S4NKALP Date: Fri, 8 May 2026 18:23:07 +0545 Subject: [PATCH] feat(root): introduce modern UI and core developer experience Add comprehensive documentation outlining new features introduced, structural changes, and productivity improvements. New Features - Native plugin manager with interactive UI (`:PackUI`) and automatic plugin installation/cleanup. - Integration of Snacks.nvim modules: Dashboard, Picker, Notifier, Scratch, Explorer. - Modern UI/UX enhancements: Smart Column, dynamic `colorcolumn`, animations via `Snacks.animate`. - Auto-save, secure `.env` masking, and automatic directory creation on file save. - LSP and Tree-sitter auto-installation and configuration. Enhancements - Revamped README with organized sections and modern styling. - Added keybinding tables and WhichKey integration for discoverability. - Structured project layout with dedicated Lua modules for plugins, options, autocmds, and keys. Bug Fixes - None --- README.md | 104 +++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 76 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 743405c..038c172 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,109 @@

- keycodex + KeyCodeX

-

- License - - - People + License - Stars - - - Forks - - - Watches + Stars - Last Updated + Last Updated

> All commit messages in this repo are AI-generated using [DevGen](https://github.com/S4NKALP/DevGen) -

My Personalized Dev Env ❤️👨‍💻

+

Handcrafted Neovim setup for the ultimate CLI development experience. ❤️👨‍💻

-
- keycodex screenshot -
keycodex screenshot
+ KeyCodeX screenshot
-

Handcrafted Neovim setup for the ultimate CLI dev experience

-
+--- + +## ✨ Features + +- **📦 Native Plugin Management** + - Leverages Neovim's built-in package system for robust and fast plugin loading. + - Interactive UI for managing plugins with `:PackUI`. + - Automatic detection and installation of missing plugins on startup. + - Non-interactive cleaning of inactive plugins. + +- **🚀 Powered by [Snacks.nvim](https://github.com/folke/snacks.nvim)** + - **Dashboard**: Beautiful startup screen with quick actions. + - **Picker**: Ultra-fast file, grep, and project fuzzy finding. + - **Notifier**: Modern notification system with history. + - **Scratch**: Persistent scratchpads for quick notes or code snippets. + - **Explorer**: Integrated file explorer and rename utilities. + +- **🎨 Modern UI & UX** + - **Smart Column**: Dynamic `colorcolumn` that only appears when lines exceed limits. + - **Aesthetic Design**: Curated color schemes and smooth animations via `Snacks.animate`. + - **Mini Ecosystem**: Leveraging `mini.nvim` for files, icons, pairs, and more. + +- **🛠️ Developer Productivity** + - **LSP & Tree-sitter**: Fully configured with auto-installation via `:TSInstallAll`. + - **Auto-Save**: Smart debounced auto-saving (3s) to prevent data loss. + - **Secure Env**: Automatic masking of sensitive values in `.env` files. + - **Auto-Directory**: Automatically creates parent directories when saving a new file. + +--- + ## 💻 Installation ```bash +# Clone the repository to your Neovim config directory git clone https://github.com/S4NKALP/keycodex ~/.config/nvim + +# Launch Neovim - Missing plugins will install automatically! +nvim ``` -## 🚀 Usage +--- -### Core +## 📂 Project Structure -Files in [lua/core](./lua/core/) control the core of neovim: +- [`init.lua`](./init.lua) - Main entry point and orchestration. +- [`lua/`](./lua/) - Core logic and system configurations. + - [`pack_helper.lua`](./lua/pack_helper.lua) - Helper functions and `add` API for native plugins. + - [`packui.lua`](./lua/packui.lua) - Interactive UI for the native plugin manager. + - [`keys.lua`](./lua/keys.lua) - Base keybindings and leader configuration. + - [`autocmd.lua`](./lua/autocmd.lua) - Smart automation (Auto-save, Smart Column, `.env` masking, Auto-install). + - [`options.lua`](./lua/options.lua) - Global Neovim settings & performance tweaks. + - [`lsp.lua`](./lua/lsp.lua) - Language Server Protocol & Tree-sitter setup. +- [`plugin/`](./plugin/) - Detailed plugin configurations. + - [`snacks.lua`](./plugin/snacks.lua) - Modern UI modules (Dashboard, Picker, Notifier, Scratchpad). + - [`whichkey.lua`](./plugin/whichkey.lua) - Interactive keyboard shortcut groupings. + - [`mini.lua`](./plugin/mini.lua) - Mini ecosystem utilities (Files, Icons, Pairs). -- [options](./lua/core/options.lua), -- [functions](./lua/core/functions.lua) -- [autocmds](./lua/core/autocmd.lua) +--- -### ⌨️ Keybindings +## ⌨️ Keybindings -Apart from [core/keys](./lua/core/keys.lua) most keybindings are configured using [which-key](./lua/plugins/whichkey.lua) +The **Leader Key** is mapped to ``. + +| Key | Action | +| --- | --- | +| `ff` | Find Files | +| `fg` | Live Grep | +| `ee` | Explore Files (Mini) | +| `eE` | Explorer (Snacks) | +| `ps` | Open Plugin Manager (Pack) | +| `ca` | LSP Code Actions | +| `cr` | Rename Symbol | +| `wz` | Toggle Zen Mode | + +*Tip: Use `` and wait for **WhichKey** to show you the full list of available commands.* + +--- + +
+

Handcrafted with ❤️ by Sankalp

+