feat(dashboard): added new dashboard snack (#77)

## Description A new dashboard plugin that comes with sane defaults, and can be fully customized to your liking. ## Screenshots ![image](https://github.com/user-attachments/assets/944373ea-f443-4c16-bfe0-2dc78101f8f5) ![image](https://github.com/user-attachments/assets/492b075e-168d-4d58-af39-1268c047f374) ![image](https://github.com/user-attachments/assets/53a388c2-ca5a-4efb-94f2-752222f43584) ![image](https://github.com/user-attachments/assets/3c6ee94b-6785-4035-8ed2-2f67f39b5f06) ![image](https://github.com/user-attachments/assets/5b7a7117-e504-4b36-88db-91ccc89d8997)
folke · Nov 18, 2024 · d540fa6 · d540fa6
1 parent 0635251
commit d540fa6
Show file tree

Hide file tree

Showing 19 changed files with 2,506 additions and 43 deletions.
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -16,6 +16,7 @@ core:
   - changed-files:
       - any-glob-to-any-file:
           - "lua/snacks/init.lua"
+          - "lua/snacks/health.lua"
           - "plugins/**"
           - "queries/**"
           - "scripts/**"
@@ -27,6 +28,9 @@ bigfile:
 bufdelete:
   - changed-files:
       - any-glob-to-any-file: "lua/snacks/bufdelete.lua"
+dashboard:
+  - changed-files:
+      - any-glob-to-any-file: "lua/snacks/dashboard.lua"
 debug:
   - changed-files:
       - any-glob-to-any-file: "lua/snacks/debug.lua"

diff --git a/README.md b/README.md
@@ -8,6 +8,7 @@ A collection of small QoL plugins for Neovim.
 | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---: |
 | [bigfile](https://github.com/folke/snacks.nvim/blob/main/docs/bigfile.md)           | Deal with big files                                                                                                                                                                     |  ‼️   |
 | [bufdelete](https://github.com/folke/snacks.nvim/blob/main/docs/bufdelete.md)       | Delete buffers without disrupting window layout                                                                                                                                         |       |
+| [dashboard](https://github.com/folke/snacks.nvim/blob/main/docs/dashboard.md)       | Beautiful declarative dashboards                                                                                                                                                        |  ‼️   |
 | [debug](https://github.com/folke/snacks.nvim/blob/main/docs/debug.md)               | Pretty inspect & backtraces for debugging                                                                                                                                               |       |
 | [git](https://github.com/folke/snacks.nvim/blob/main/docs/git.md)                   | Useful functions for Git                                                                                                                                                                |       |
 | [gitbrowse](https://github.com/folke/snacks.nvim/blob/main/docs/gitbrowse.md)       | Open the repo of the active file in the browser (e.g., GitHub)                                                                                                                          |       |
@@ -84,13 +85,15 @@ Please refer to the readme of each plugin for their specific configuration.
 ---@field quickfile? { enabled: boolean }
 ---@field statuscolumn? snacks.statuscolumn.Config  | { enabled: boolean }
 ---@field styles? table<string, snacks.win.Config>
+---@field dashboard? snacks.dashboard.Config  | { enabled: boolean }
 ---@field terminal? snacks.terminal.Config
 ---@field toggle? snacks.toggle.Config
 ---@field win? snacks.win.Config
 ---@field words? snacks.words.Config
 {
   styles = {},
   bigfile = { enabled = false },
+  dashboard = { enabled = false },
   notifier = { enabled = false },
   quickfile = { enabled = false },
   statuscolumn = { enabled = false },
@@ -116,6 +119,7 @@ See the example below for how to configure `snacks.nvim`.
   ---@type snacks.Config
   opts = {
     bigfile = { enabled = true },
+    dashboard = { enabled = true },
     notifier = {
       enabled = true,
       timeout = 3000,