perf(filter)!: enable color when filter returns true (#158)

Author: linrongbin16

.github/workflows/ci.yml

@@ -10,8 +10,8 @@ concurrency:
   group: ${{ github.ref }}-ci
   cancel-in-progress: true
 jobs:
-  pr_conventional_commit:
-    name: PR Conventional Commit
+  conventional_commit:
+    name: Conventional Commits
     if: ${{ github.ref != 'refs/heads/main' }}
     runs-on: ubuntu-latest
     steps:
@@ -24,25 +24,28 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: lunarmodules/luacheck@v1
-        with:
-          args: lua --config .luacheckrc
       - name: Install commons.nvim
-        shell: bash
         if: ${{ github.ref != 'refs/heads/main' }}
         run: |
           git clone --depth=1 https://github.com/linrongbin16/commons.nvim.git ~/.commons.nvim
           rm -rf ./lua/colorbox/commons
-          mkdir -p ./lua/colorbox/commons
-          cp -rf ~/.commons.nvim/lua/commons/*.lua ./lua/colorbox/commons
+          cp -rf ~/.commons.nvim/lua/commons ./lua/colorbox/
           cp ~/.commons.nvim/version.txt ./lua/colorbox/commons/version.txt
-          cd ./lua/colorbox/commons
-          find . -type f -name '*.lua' -exec sed -i 's/require("commons/require("colorbox.commons/g' {} \;
+          find ./lua/colorbox/commons -type f -name '*.lua' -exec sed -i 's/"commons./"colorbox.commons./g' {} \;
+      - uses: stevearc/nvim-typecheck-action@v1
+        with:
+          path: lua
+          level: Information
+          configpath: ".luarc.json"
+          neodev-version: stable
+      - uses: lunarmodules/luacheck@v1
+        with:
+          args: lua --config .luacheckrc
       - uses: JohnnyMorganz/stylua-action@v3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           version: latest
-          args: --config-path .stylua.toml ./lua ./test
+          args: --config-path .stylua.toml ./lua ./spec
       - uses: stefanzweifel/git-auto-commit-action@v4
         if: ${{ github.ref != 'refs/heads/main' }}
         with:
@@ -66,15 +69,36 @@ jobs:
         with:
           luaVersion: "luajit-2.1.0-beta3"
       - uses: leafo/gh-actions-luarocks@v4
-      - name: Run test cases
+      - name: Run Tests
+        shell: bash
+        run: |
+          luarocks install luacheck
+          luarocks install vusted
+          vusted --shuffle ./spec
+  code_coverage:
+    name: Code Coverage
+    needs:
+      - luacheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rhysd/action-setup-vim@v1
+        id: vim
+        with:
+          neovim: true
+          version: stable
+      - uses: leafo/gh-actions-lua@v10
+        with:
+          luaVersion: "luajit-2.1.0-beta3"
+      - uses: leafo/gh-actions-luarocks@v4
+      - name: Run Tests
         shell: bash
         run: |
           luarocks install luacheck
           luarocks install luacov
-          luarocks install cluacov
           luarocks install vusted
-          vusted --coverage --shuffle ./test
-      - name: Generate coverage reports
+          vusted --coverage ./spec
+      - name: Generate Coverage Report
         shell: bash
         run: |
           echo "ls ."

.luacheckrc

@@ -1,5 +1,7 @@
 globals = { "vim", "describe", "before_each", "it", "assert" }
-max_line_length = 200
+max_line_length = 500
 unused = false
 unused_args = false
-exclude_files = { "lua/colorbox/commons/*.lua" }
+exclude_files = {
+    "lua/colorbox/commons/*.lua",
+}

.luarc.json

@@ -1,4 +1,19 @@
 {
-  "diagnostics.globals": ["vim", "describe", "before_each", "it", "jit"],
+  "diagnostics.globals": [
+    "vim",
+    "describe",
+    "before_each",
+    "it",
+    "jit",
+    "utf8"
+  ],
+  "diagnostics.disable": [
+    "undefined-field",
+    "inject-field",
+    "deprecated",
+    "luadoc-miss-module-name",
+    "undefined-doc-name"
+  ],
+  "runtime.version": "LuaJIT",
   "workspace.checkThirdParty": "Disable"
 }

README.md

@@ -39,7 +39,7 @@ It use offline github actions to weekly collect and update the most popular Vim/
 >
 > with below conditions:
 >
-> 1. Github stars ≥ 500 (default config only enables stars ≥ 800, please modify the `filter` option to choose any colors (see [Configuration](#-configuration))).
+> 1. Github stars ≥ 500 (default config only enable ≥ 800, please modify the `filter` option to choose any colors, see [Configuration](#-configuration)).
 > 2. Last git commit in 3 years.
 > 3. For multiple plugins that contain the same color name, choose the one in following rules:
 >    1. **Awesome-neovim** wins **vimcolorsheme**, since they usually has modern Neovim features (lua, lsp, treesitter) and support more third-party plugins.
@@ -197,12 +197,13 @@ You can use command `Colorbox` to control the player with below subcommands:
 
 ```lua
 require('colorbox').setup({
-    -- Disable those colors you don't want from the candidates list.
+    -- Only enable those colors you want from the candidates list.
+    -- Enable color when the (all of those) filter returns `true`.
     -- By default only enable primary colorscheme and GitHub stars >= 800.
     filter = {
         "primary",
         function(color, spec)
-            return spec.github_stars < 800
+            return spec.github_stars >= 800
         end,
     },
 
@@ -247,7 +248,7 @@ require('colorbox').setup({
 
 When choosing a colorscheme, this plugin will run following steps:
 
-- Run the filter, disable those colors you don't want from candidates list. See [Filter](#filter).
+- Run the filter, only enable those colors you want from candidates list. See [Filter](#filter).
 - Run the policy at a proper timing, and choose a colorscheme. See [Timing & Policy](#timing--policy).
 - Refresh the `background` option. See [Background](#background).
 - Run the `colorscheme` command to actually change to the colorscheme.
@@ -277,8 +278,8 @@ There're 3 types of filter configs:
   >
   > Returns:
   >
-  > - To disable a color, returns `true`.
-  > - To enable a color, returns `false`.
+  > - To enable a color, returns `true`.
+  > - To disable a color, returns `false`.
   >
   > ```lua
   > --- @class colorbox.ColorSpec
@@ -295,7 +296,7 @@ There're 3 types of filter configs:
   > --- @field full_pack_path string "Users/linrongbin16/github/linrongbin16/colorbox.nvim/pack/colorbox/start/folke-tokyonight.nvim"
   > ```
 
-- List filters: A lua list that contains multiple other filters. A color will be disabled if any of those filters returns true.
+- List filters: A lua list that contains multiple other filters. A color will only be enabled if **_all_** of those filters returns true.
 
 ### Timing & Policy
 

lua/colorbox.lua

@@ -32,18 +32,18 @@ local Defaults = {
     -- builtin filter
     --- @alias colorbox.BuiltinFilterConfig "primary"
     ---
-    -- function-based filter, disabled if function return true.
+    -- function-based filter, enabled if function returns true.
     --- @alias colorbox.FunctionFilterConfig fun(color:string, spec:colorbox.ColorSpec):boolean
     ---
-    ---list-based filter, disabled if any of filter hit the conditions.
-    --- @alias colorbox.AnyFilterConfig (colorbox.BuiltinFilterConfig|colorbox.FunctionFilterConfig)[]
+    -- list-based all of filter, a color is enabled if all of inside filters returns true.
+    --- @alias colorbox.AllFilterConfig (colorbox.BuiltinFilterConfig|colorbox.FunctionFilterConfig)[]
     ---
-    --- @alias colorbox.FilterConfig colorbox.BuiltinFilterConfig|colorbox.FunctionFilterConfig|colorbox.AnyFilterConfig
+    --- @alias colorbox.FilterConfig colorbox.BuiltinFilterConfig|colorbox.FunctionFilterConfig|colorbox.AllFilterConfig
     --- @type colorbox.FilterConfig?
     filter = {
         "primary",
         function(color, spec)
-            return spec.github_stars < 800
+            return spec.github_stars >= 800
         end,
     },
 
@@ -99,25 +99,69 @@ end
 
 --- @param color_name string
 --- @param spec colorbox.ColorSpec
---- @return boolean
-local function _builtin_filter_primary(color_name, spec)
+--- @return integer
+local function _primary_score(color_name, spec)
     local logger = logging.get("colorbox") --[[@as commons.logging.Logger]]
+
+    -- unique
     local unique = #spec.color_names <= 1
+
+    -- shortest
     local current_name_len = string.len(color_name)
     local minimal_name_len = _minimal_color_name_len(spec)
     local shortest = current_name_len == minimal_name_len
+
+    -- match
     local handle_splits = strings.split(spec.handle, "/")
-    local matched = handle_splits[1]:lower() == color_name:lower()
-        or handle_splits[2]:lower() == color_name:lower()
+    local handle1 = handle_splits[1]:gsub("%-", "_")
+    local handle2 = handle_splits[2]:gsub("%-", "_")
+    local normalized_color = color_name:gsub("%-", "_")
+    local matched = strings.startswith(
+        handle1,
+        normalized_color,
+        { ignorecase = true }
+    ) or strings.startswith(
+        handle2,
+        normalized_color,
+        { ignorecase = true }
+    ) or strings.endswith(handle1, normalized_color, { ignorecase = true }) or strings.endswith(
+        handle2,
+        normalized_color,
+        { ignorecase = true }
+    )
     logger:debug(
-        "|_builtin_filter_primary| unique:%s, shortest:%s (current:%s, minimal:%s), matched:%s",
+        "|_primary_score| unique:%s, shortest:%s (current:%s, minimal:%s), matched:%s",
         vim.inspect(unique),
         vim.inspect(shortest),
         vim.inspect(current_name_len),
         vim.inspect(minimal_name_len),
         vim.inspect(matched)
     )
-    return not unique and not shortest and not matched
+    local n = 0
+    if unique then
+        n = n + 3
+    end
+    if matched then
+        n = n + 2
+    end
+    if shortest then
+        n = n + 1
+    end
+    return n
+end
+
+--- @param color_name string
+--- @param spec colorbox.ColorSpec
+--- @return boolean
+local function _builtin_filter_primary(color_name, spec)
+    local color_score = _primary_score(color_name, spec)
+    for _, other_color in ipairs(spec.color_names) do
+        local other_score = _primary_score(other_color, spec)
+        if color_score < other_score then
+            return false
+        end
+    end
+    return true
 end
 
 --- @param f colorbox.BuiltinFilterConfig
@@ -143,35 +187,35 @@ local function _function_filter(f, color_name, spec)
         else
             logging
                 .get("colorbox")
-                :warn(
+                :err(
                     "failed to invoke function filter, please check your config!"
                 )
         end
     end
     return false
 end
 
---- @param f colorbox.AnyFilterConfig
+--- @param f colorbox.AllFilterConfig
 --- @param color_name string
 --- @param spec colorbox.ColorSpec
 --- @return boolean
-local function _any_filter(f, color_name, spec)
+local function _all_filter(f, color_name, spec)
     if type(f) == "table" then
         for _, f1 in ipairs(f) do
             if type(f1) == "string" then
                 local result = _builtin_filter(f1, color_name, spec)
-                if result then
+                if not result then
                     return result
                 end
             elseif type(f1) == "function" then
                 local result = _function_filter(f1, color_name, spec)
-                if result then
+                if not result then
                     return result
                 end
             end
         end
     end
-    return false
+    return true
 end
 
 --- @param color_name string
@@ -183,7 +227,7 @@ local function _filter(color_name, spec)
     elseif type(Configs.filter) == "function" then
         return _function_filter(Configs.filter, color_name, spec)
     elseif type(Configs.filter) == "table" then
-        return _any_filter(Configs.filter, color_name, spec)
+        return _all_filter(Configs.filter, color_name, spec)
     end
     return false
 end
@@ -211,7 +255,7 @@ local function _init()
     for _, color_name in pairs(ColorNamesList) do
         local spec = ColorNameToColorSpecsMap[color_name]
         local pack_exist = uv.fs_stat(spec.full_pack_path) ~= nil
-        if not _filter(color_name, spec) and pack_exist then
+        if _filter(color_name, spec) and pack_exist then
             table.insert(FilteredColorNamesList, color_name)
         end
     end
@@ -669,6 +713,12 @@ local function _info(args)
     apis.set_buf_option(bufnr, "bufhidden", "wipe")
     apis.set_buf_option(bufnr, "buflisted", false)
     apis.set_buf_option(bufnr, "filetype", "markdown")
+    vim.keymap.set(
+        { "n" },
+        "q",
+        ":\\<C-U>quit<CR>",
+        { silent = true, buffer = bufnr }
+    )
     local winnr = vim.api.nvim_open_win(bufnr, true, win_config)
 
     local HandleToColorSpecsMap =
@@ -702,7 +752,7 @@ local function _info(args)
 
     vim.api.nvim_buf_set_lines(bufnr, 0, 0, true, {
         string.format(
-            "# ColorSchemes List (total(colors/plugins): %d/%d, enabled(colors/plugins): %d/%d)",
+            "# ColorSchemes List, total: %d(colors)/%d(plugins), enabled: %d(colors)/%d(plugins)",
             total_colors,
             total_plugins,
             enabled_colors,
@@ -872,7 +922,7 @@ local M = {
     _builtin_filter_primary = _builtin_filter_primary,
     _builtin_filter = _builtin_filter,
     _function_filter = _function_filter,
-    _any_filter = _any_filter,
+    _all_filter = _all_filter,
     _filter = _filter,
 
     -- misc