feat: test ci

loctvl842 · loctvl842 · commit 64708f40667d · 2024-02-03T22:58:01.000+07:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,72 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Neovim
+        shell: bash
+        run: |
+          mkdir -p /tmp/nvim
+          wget -q https://github.com/neovim/neovim/releases/download/nightly/nvim.appimage -O /tmp/nvim/nvim.appimage
+          cd /tmp/nvim
+          chmod a+x ./nvim.appimage
+          ./nvim.appimage --appimage-extract
+          echo "/tmp/nvim/squashfs-root/usr/bin/" >> $GITHUB_PATH
+      - name: Run Tests
+        run: |
+          nvim --version
+          [ ! -d tests ] && exit 0
+          nvim --headless -u tests/init.lua -c "PlenaryBustedDirectory tests/ {minimal_init = 'tests/init.lua', sequential = true}"
+  docs:
+    runs-on: ubuntu-latest
+    needs: tests
+    if: ${{ github.ref == 'refs/heads/master' }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: panvimdoc
+        uses: kdheepak/panvimdoc@main
+        with:
+          vimdoc: BeastVim
+          version: "Neovim >= 0.8.0"
+          demojify: true
+          treesitter: true
+      - name: Push changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: "chore(build): auto-generate vimdoc"
+          commit_user_name: "github-actions[bot]"
+          commit_user_email: "github-actions[bot]@users.noreply.github.com"
+          commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
+  release:
+    name: release
+    if: ${{ github.ref == 'refs/heads/master' }}
+    needs:
+      - docs
+      - tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: simple
+          package-name: BeastVim
+      - uses: actions/checkout@v3
+      - name: tag stable versions
+        if: ${{ steps.release.outputs.release_created }}
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email github-actions[bot]@users.noreply.github.com
+          git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/google-github-actions/release-please-action.git"
+          git tag -d stable || true
+          git push origin :stable || true
+          git tag -a stable -m "Last Stable Release"
+          git push origin stable
diff --git a/lua/tvl/config/lsp/keymaps.lua b/lua/tvl/config/lsp/keymaps.lua
@@ -33,7 +33,7 @@ function M.get()
   }
 end
 
-function M.resolve(buffer)
+function M.resolve(bufnr)
   local Keys = require("lazy.core.handler.keys")
   local keymaps = {}
 
@@ -50,7 +50,7 @@ function M.resolve(buffer)
   end
 
   local opts = require("tvl.util").opts("nvim-lspconfig")
-  local clients = vim.lsp.get_active_clients({ bufnr = buffer })
+  local clients = vim.lsp.get_active_clients({ bufnr = bufnr })
   for _, client in ipairs(clients) do
     local maps = opts.servers[client.name] and opts.servers[client.name].keys or {}
     for _, keymap in ipairs(maps) do
@@ -60,14 +60,14 @@ function M.resolve(buffer)
   return keymaps
 end
 
-M.attach = function(_, buffer)
+M.attach = function(_, bufnr)
   local Keys = require("lazy.core.handler.keys")
-  local keymaps = M.resolve(buffer)
+  local keymaps = M.resolve(bufnr)
 
   for _, keys in pairs(keymaps) do
     local opts = Keys.opts(keys)
     opts.silent = opts.silent ~= false
-    opts.buffer = buffer
+    opts.buffer = bufnr
     vim.keymap.set(keys.mode or "n", keys.lhs, keys.rhs, opts)
   end
 end
diff --git a/lua/tvl/config/lualine/HOW_TO_CREATE_COMPONENT.md b/lua/tvl/config/lualine/HOW_TO_CREATE_COMPONENT.md
@@ -0,0 +1,14 @@
+# How to Create a Component
+
+A lualine component is a function that return a string.
+
+To create a new component, follow these steps:
+1. Open the `components.lua` file.
+2. Add the following code snippet to the file:
+```lua
+M.<your_component_name> = function()
+    return <content>
+end
+```
+Replace `<your_component_name>` with the desired name for your component.
+Replace `<content>` with the code or functionality you want your component to have.
diff --git a/lua/tvl/config/lualine/components.lua b/lua/tvl/config/lualine/components.lua
@@ -1,13 +1,17 @@
-local config = require("tvl.config.lualine.config").options
-local icons = require("tvl.core.icons")
+local Config = require("tvl.config.lualine.config").options
+local Icons = require("tvl.core.icons")
+local Util = require("tvl.util")
 
 local M = {}
 
-local hl_str = function(str, hl_cur, hl_after)
+---@param text string text to be highlighted
+---@param hl_cur string highlight group for current text
+---@param hl_after? string highlight group for text after current text
+local hl_str = function(text, hl_cur, hl_after)
   if hl_after == nil then
-    return "%#" .. hl_cur .. "#" .. str .. "%*"
+    return "%#" .. hl_cur .. "#" .. text .. "%*"
   end
-  return "%#" .. hl_cur .. "#" .. str .. "%*" .. "%#" .. hl_after .. "#"
+  return "%#" .. hl_cur .. "#" .. text .. "%*" .. "%#" .. hl_after .. "#"
 end
 
 local function hide_in_width()
@@ -35,26 +39,26 @@ M.branch = {
     end
     prev_branch = str
     local icon = hl_str("  ", "SLGitIcon", "SLBranchName")
-    return hl_str(config.separator_icon.left, "SLSeparator")
+    return hl_str(Config.separator_icon.left, "SLSeparator")
       .. hl_str(icon, "SLGitIcon")
       .. hl_str(truncate(str, 10), "SLBranchName")
-      .. hl_str(config.separator_icon.right, "SLSeparator", "SLSeparator")
+      .. hl_str(Config.separator_icon.right, "SLSeparator", "SLSeparator")
   end,
 }
 
 M.position = function()
   -- print(vim.inspect(config.separator_icon))
   local current_line = vim.fn.line(".")
   local current_column = vim.fn.col(".")
-  local left_sep = hl_str(config.separator_icon.left, "SLSeparator")
-  local right_sep = hl_str(config.separator_icon.right, "SLSeparator", "SLSeparator")
+  local left_sep = hl_str(Config.separator_icon.left, "SLSeparator")
+  local right_sep = hl_str(Config.separator_icon.right, "SLSeparator", "SLSeparator")
   local str = "Ln " .. current_line .. ", Col " .. current_column
   return left_sep .. hl_str(str, "SLPosition", "SLPosition") .. right_sep
 end
 
 M.spaces = function()
-  local left_sep = hl_str(config.separator_icon.left, "SLSeparator")
-  local right_sep = hl_str(config.separator_icon.right, "SLSeparator", "SLSeparator")
+  local left_sep = hl_str(Config.separator_icon.left, "SLSeparator")
+  local right_sep = hl_str(Config.separator_icon.right, "SLSeparator", "SLSeparator")
   local str = "Spaces: " .. vim.api.nvim_buf_get_option(0, "shiftwidth")
   return left_sep .. hl_str(str, "SLShiftWidth", "SLShiftWidth") .. right_sep
 end
@@ -73,15 +77,32 @@ M.diagnostics = function()
   end
 
   local error_count, warn_count, info_count, hint_count = nvim_diagnostic()
-  local error_hl = hl_str(icons.diagnostics.error .. " " .. error_count, "SLError", "SLError")
-  local warn_hl = hl_str(icons.diagnostics.warn .. " " .. warn_count, "SLWarning", "SLWarning")
-  local info_hl = hl_str(icons.diagnostics.info .. " " .. info_count, "SLInfo", "SLInfo")
-  local hint_hl = hl_str(icons.diagnostics.hint .. " " .. hint_count, "SLInfo", "SLInfo")
-  local left_sep = hl_str(config.thin_separator_icon.left, "SLSeparator")
-  local right_sep = hl_str(config.thin_separator_icon.right, "SLSeparator", "SLSeparator")
+  local error_hl = hl_str(Icons.diagnostics.error .. " " .. error_count, "SLError", "SLError")
+  local warn_hl = hl_str(Icons.diagnostics.warn .. " " .. warn_count, "SLWarning", "SLWarning")
+  ---@diagnostic disable-next-line: unused-local
+  local info_hl = hl_str(Icons.diagnostics.info .. " " .. info_count, "SLInfo", "SLInfo")
+  local hint_hl = hl_str(Icons.diagnostics.hint .. " " .. hint_count, "SLInfo", "SLInfo")
+  local left_sep = hl_str(Config.thin_separator_icon.left, "SLSeparator")
+  local right_sep = hl_str(Config.thin_separator_icon.right, "SLSeparator", "SLSeparator")
   return left_sep .. error_hl .. " " .. warn_hl .. " " .. hint_hl .. right_sep
 end
 
+---@param content string
+---@param type? "fill"|"empty"
+local build_module = function(content, type)
+  local left_sep = ""
+  local right_sep = ""
+  if type == "fill" then
+    left_sep = hl_str(Config.separator_icon.left, "SLSeparator")
+    right_sep = hl_str(Config.separator_icon.right, "SLSeparator", "SLSeparator")
+  end
+  if type == "empty" then
+    left_sep = hl_str(Config.thin_separator_icon.left, "SLSeparator")
+    right_sep = hl_str(Config.thin_separator_icon.right, "SLSeparator", "SLSeparator")
+  end
+  return left_sep .. content .. right_sep
+end
+
 M.diff = {
   "diff",
   colored = true,
@@ -91,16 +112,16 @@ M.diff = {
     removed = "SLDiffDelete",
   },
   symbols = {
-    added = icons.git.added .. " ",
-    modified = icons.git.modified .. " ",
-    removed = icons.git.removed .. " ",
+    added = Icons.git.added .. " ",
+    modified = Icons.git.modified .. " ",
+    removed = Icons.git.removed .. " ",
   }, -- changes diff symbols
   fmt = function(str)
     if str == "" then
       return ""
     end
-    local left_sep = hl_str(config.thin_separator_icon.left, "SLSeparator")
-    local right_sep = hl_str(config.thin_separator_icon.right, "SLSeparator", "SLSeparator")
+    local left_sep = hl_str(Config.thin_separator_icon.left, "SLSeparator")
+    local right_sep = hl_str(Config.thin_separator_icon.right, "SLSeparator", "SLSeparator")
     return left_sep .. str .. right_sep
   end,
   cond = hide_in_width,
@@ -109,12 +130,32 @@ M.diff = {
 M.mode = {
   "mode",
   fmt = function(str)
-    local left_sep = hl_str(config.separator_icon.left, "SLSeparator", "SLPadding")
-    local right_sep = hl_str(config.separator_icon.right, "SLSeparator", "SLPadding")
+    local left_sep = hl_str(Config.separator_icon.left, "SLSeparator", "SLPadding")
+    local right_sep = hl_str(Config.separator_icon.right, "SLSeparator", "SLPadding")
     return left_sep .. hl_str(str, "SLMode") .. right_sep
   end,
 }
 
+M.cmp_source = function(name)
+  local ok, _ = pcall(require, "cmp")
+  if not ok then
+    return ""
+  end
+  for _, s in ipairs(require("cmp").core.sources) do
+    if s.name == name then
+      -- Warning if not icons.misc doesn't have name
+      if not Icons.misc[name] then
+        Util.notify("No icon for " .. name, "warn")
+      end
+      print("hello")
+    end
+  end
+  return function()
+    local text = Icons.misc[name]
+    return build_module(hl_str(text, "CmpItemKindVariable"), "fill")
+  end
+end
+
 local prev_filetype = ""
 M.filetype = {
   "filetype",
@@ -155,8 +196,8 @@ M.filetype = {
       prev_filetype = str
       filetype_str = str
     end
-    local left_sep = hl_str(config.separator_icon.left, "SLSeparator")
-    local right_sep = hl_str(config.separator_icon.right, "SLSeparator", "SLSeparator")
+    local left_sep = hl_str(Config.separator_icon.left, "SLSeparator")
+    local right_sep = hl_str(Config.separator_icon.right, "SLSeparator", "SLSeparator")
     -- Upper case first character
     filetype_str = filetype_str:gsub("%a", string.upper, 1)
     local filetype_hl = hl_str(filetype_str, "SLFiletype", "SLFiletype")
diff --git a/lua/tvl/config/lualine/config.lua b/lua/tvl/config/lualine/config.lua
@@ -12,9 +12,6 @@ local default = {
   -- thin_separator_icon = { left = " ", right = " " },
 }
 
----@type LualineConfig
-M.options = {}
-
 ---@param type "bubble" | "triangle"
 local function make_separator(type)
   if type == "bubble" then
@@ -35,6 +32,4 @@ M.setup = function(opts)
   end
 end
 
-M.setup()
-
 return M
diff --git a/lua/tvl/config/lualine/init.lua b/lua/tvl/config/lualine/init.lua
@@ -2,7 +2,7 @@ local config = require("tvl.config.lualine.config")
 
 local M = {}
 
-local function setup()
+local function setup_lualine()
   local cpn = require("tvl.config.lualine.components")
   local theme = require("tvl.config.lualine.highlights").custom(config.options)
 
@@ -27,7 +27,7 @@ local function setup()
     sections = {
       lualine_a = { cpn.branch },
       lualine_b = { cpn.diagnostics },
-      lualine_c = {},
+      lualine_c = { cpn.cmp_source("codeium") },
       lualine_x = { cpn.diff },
       lualine_y = { cpn.position, cpn.filetype },
       lualine_z = { cpn.spaces, cpn.mode },
@@ -45,13 +45,13 @@ local function setup()
   })
 end
 
-M.setup = config.setup
+M.setup_config = config.setup
 
 M.load = function()
-  setup()
+  setup_lualine()
   vim.api.nvim_create_autocmd("ColorScheme", {
     callback = function()
-      setup()
+      setup_lualine()
     end,
   })
 end
diff --git a/lua/tvl/core/keymaps.lua b/lua/tvl/core/keymaps.lua
@@ -65,9 +65,11 @@ map("n", "<leader>/", ":split<CR>", opts)
 -------------------- Switch two windows ------------------------
 map("n", "<A-o>", "<C-w>r", opts)
 
+-- TODO: move this to compile.nvim
 -------------------- Compile --------------------------------
 map("n", "<c-m-n>", "<cmd>only | Compile<CR>", opts)
 
+-- TODO: move this to treesitter
 -------------------- Inspect --------------------------------
 map("n", "<F2>", "<cmd>Inspect<CR>", opts)
 
diff --git a/lua/tvl/core/resources/coding.lua b/lua/tvl/core/resources/coding.lua
@@ -14,6 +14,7 @@ return {
     },
   },
 
+  -- TODO: move to `lsp - typescript`
   {
     "mattn/emmet-vim",
     event = { "BufRead", "BufNewFile" },
diff --git a/lua/tvl/core/resources/editor.lua b/lua/tvl/core/resources/editor.lua
@@ -28,6 +28,9 @@ return {
       },
     },
     opts = require("tvl.config.neo-tree"),
+    deactivate = function()
+      vim.cmd([[Neotree close]])
+    end,
     init = function()
       vim.g.neo_tree_remove_legacy_commands = 1
       if vim.fn.argc() == 1 then
diff --git a/lua/tvl/core/resources/ui.lua b/lua/tvl/core/resources/ui.lua
@@ -113,7 +113,7 @@ return {
     end,
     config = function(_, opts)
       local lualine_config = require("tvl.config.lualine")
-      lualine_config.setup(opts)
+      lualine_config.setup_config(opts)
       lualine_config.load()
     end,
   },
@@ -346,7 +346,12 @@ return {
         },
       },
       lsp = {
-        progress = { enabled = true },
+        progress = {
+          enabled = true,
+          format = "lsp_progress",
+          format_done = "lsp_progress_done",
+          view = "mini",
+        },
         hover = { enabled = false },
         signature = { enabled = false },
         -- override markdown rendering so that **cmp** and other plugins use **Treesitter**
diff --git a/lua/tvl/util.lua b/lua/tvl/util.lua

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ return {`
`14`	`14`	`},`
`15`	`15`	`},`
`16`	`16`
	`17`	+ -- TODO: move to `lsp - typescript`
`17`	`18`	`{`
`18`	`19`	`"mattn/emmet-vim",`
`19`	`20`	`event = { "BufRead", "BufNewFile" },`