perf(collector): improve colorschemes list (#66)

perf(config): by default only enable 'primary' colors

Author: linrongbin16

.github/workflows/collect.yml

@@ -1,4 +1,4 @@
-name: Color Collector
+name: Collector
 on:
   schedule:
     - cron: "53 0 * * 1"

COLORSCHEMES.md

@@ -2,28 +2,28 @@
 ColorSchemes List
 =================
 
-- [folke/tokyonight.nvim](https://github.com/folke/tokyonight.nvim)  
-- [catppuccin/nvim](https://github.com/catppuccin/nvim)  
-- [rebelot/kanagawa.nvim](https://github.com/rebelot/kanagawa.nvim)  
-- [nlknguyen/papercolor-theme](https://github.com/nlknguyen/papercolor-theme)  
-- [nordtheme/vim](https://github.com/nordtheme/vim)  
-- [sainnhe/everforest](https://github.com/sainnhe/everforest)  
-- [cocopon/iceberg.vim](https://github.com/cocopon/iceberg.vim)  
-- [rakr/vim-one](https://github.com/rakr/vim-one)  
-- [junegunn/seoul256.vim](https://github.com/junegunn/seoul256.vim)  
-- [sainnhe/gruvbox-material](https://github.com/sainnhe/gruvbox-material)  
-- [rose-pine/neovim](https://github.com/rose-pine/neovim)  
-- [ku1ik/vim-monokai](https://github.com/ku1ik/vim-monokai)  
-- [sainnhe/sonokai](https://github.com/sainnhe/sonokai)  
-- [dracula/vim](https://github.com/dracula/vim)  
-- [navarasu/onedark.nvim](https://github.com/navarasu/onedark.nvim)  
-- [jacoborus/tender.vim](https://github.com/jacoborus/tender.vim)  
-- [lifepillar/vim-solarized8](https://github.com/lifepillar/vim-solarized8)  
-- [mhartington/oceanic-next](https://github.com/mhartington/oceanic-next)  
-- [projekt0n/github-nvim-theme](https://github.com/projekt0n/github-nvim-theme)  
-- [ellisonleao/gruvbox.nvim](https://github.com/ellisonleao/gruvbox.nvim)  
-- [tomasiser/vim-code-dark](https://github.com/tomasiser/vim-code-dark)  
-- [jnurmine/zenburn](https://github.com/jnurmine/zenburn)  
-- [romainl/apprentice](https://github.com/romainl/apprentice)  
-- [marko-cerovac/material.nvim](https://github.com/marko-cerovac/material.nvim)  
-- [nyoom-engineering/oxocarbon.nvim](https://github.com/nyoom-engineering/oxocarbon.nvim)
+- [folke/tokyonight.nvim](https://github.com/folke/tokyonight.nvim) (stars: 4400, last update: 2023-10-25): 'tokyonight-moon', 'tokyonight-night', 'tokyonight-day', 'tokyonight-storm', 'tokyonight'  
+- [catppuccin/nvim](https://github.com/catppuccin/nvim) (stars: 3700, last update: 2023-11-29): 'catppuccin', 'catppuccin-frappe', 'catppuccin-macchiato', 'catppuccin-mocha', 'catppuccin-latte'  
+- [rebelot/kanagawa.nvim](https://github.com/rebelot/kanagawa.nvim) (stars: 3000, last update: 2023-10-02): 'kanagawa-wave', 'kanagawa', 'kanagawa-lotus', 'kanagawa-dragon'  
+- [nlknguyen/papercolor-theme](https://github.com/nlknguyen/papercolor-theme) (stars: 2564, last update: 2022-06-09): 'PaperColor'  
+- [nordtheme/vim](https://github.com/nordtheme/vim) (stars: 2451, last update: 2023-05-04): 'nord'  
+- [sainnhe/everforest](https://github.com/sainnhe/everforest) (stars: 2200, last update: 2023-10-25): 'everforest'  
+- [cocopon/iceberg.vim](https://github.com/cocopon/iceberg.vim) (stars: 2072, last update: 2022-11-23): 'iceberg'  
+- [rakr/vim-one](https://github.com/rakr/vim-one) (stars: 1968, last update: 2020-12-15): 'one'  
+- [junegunn/seoul256.vim](https://github.com/junegunn/seoul256.vim) (stars: 1604, last update: 2023-05-03): 'seoul256-light', 'seoul256'  
+- [sainnhe/gruvbox-material](https://github.com/sainnhe/gruvbox-material) (stars: 1500, last update: 2023-11-22): 'gruvbox-material'  
+- [rose-pine/neovim](https://github.com/rose-pine/neovim) (stars: 1400, last update: 2023-10-26): 'rose-pine-moon', 'rose-pine-dawn', 'rose-pine', 'rose-pine-main'  
+- [ku1ik/vim-monokai](https://github.com/ku1ik/vim-monokai) (stars: 1420, last update: 2022-02-09): 'monokai'  
+- [sainnhe/sonokai](https://github.com/sainnhe/sonokai) (stars: 1400, last update: 2023-10-25): 'sonokai'  
+- [dracula/vim](https://github.com/dracula/vim) (stars: 1300, last update: 2023-10-29): 'dracula'  
+- [navarasu/onedark.nvim](https://github.com/navarasu/onedark.nvim) (stars: 1200, last update: 2023-11-23): 'onedark'  
+- [jacoborus/tender.vim](https://github.com/jacoborus/tender.vim) (stars: 1072, last update: 2021-05-24): 'tender'  
+- [lifepillar/vim-solarized8](https://github.com/lifepillar/vim-solarized8) (stars: 951, last update: 2023-08-13): 'solarized8', 'solarized8_flat', 'solarized8_high', 'solarized8_low'  
+- [mhartington/oceanic-next](https://github.com/mhartington/oceanic-next) (stars: 1100, last update: 2023-05-01): 'OceanicNext', 'OceanicNextLight'  
+- [projekt0n/github-nvim-theme](https://github.com/projekt0n/github-nvim-theme) (stars: 1800, last update: 2023-11-26): 'github_light_high_contrast', 'github_light_tritanopia', 'github_light', 'github_dark_tritanopia', 'github_light_colorblind', 'github_dark_colorblind', 'github_light_default', 'github_dark_dimmed', 'github_dark', 'github_dark_default', 'github_dark_high_contrast', 'github_dimmed'  
+- [ellisonleao/gruvbox.nvim](https://github.com/ellisonleao/gruvbox.nvim) (stars: 1300, last update: 2023-11-30): 'gruvbox'  
+- [tomasiser/vim-code-dark](https://github.com/tomasiser/vim-code-dark) (stars: 877, last update: 2023-11-12): 'codedark'  
+- [jnurmine/zenburn](https://github.com/jnurmine/zenburn) (stars: 862, last update: 2022-08-09): 'zenburn'  
+- [romainl/apprentice](https://github.com/romainl/apprentice) (stars: 854, last update: 2023-02-15): 'apprentice'  
+- [marko-cerovac/material.nvim](https://github.com/marko-cerovac/material.nvim) (stars: 843, last update: 2023-11-24): 'material', 'material-deep-ocean', 'material-darker', 'material-palenight', 'material-lighter', 'material-oceanic'  
+- [nyoom-engineering/oxocarbon.nvim](https://github.com/nyoom-engineering/oxocarbon.nvim) (stars: 808, last update: 2023-11-28): 'oxocarbon'

README.md

@@ -14,7 +14,7 @@ I'm greedy that I want all the **most popular** Neovim colorschemes than only on
 
 Let's load all the ultra colorschemes into your Neovim player!
 
-![shuffle-per-seconds-v1](https://github.com/linrongbin16/colorbox.nvim/assets/6496887/74cc205f-fbf6-4edb-abdd-72aaea27b50b)
+https://github.com/linrongbin16/colorbox.nvim/assets/6496887/8fff55ea-749d-4064-90b8-a3799519898d
 
 <details>
 <summary><i>Click here to see how to configure</i></summary>
@@ -32,8 +32,8 @@ It use offline github actions to weekly collect and update the most popular Vim/
 
 > The **most popular** colorschemes are picked from below websites:
 >
-> - [vimcolorscheme.com/top](https://vimcolorschemes.com/top)
-> - [www.trackawesomelist.com/rockerBOO/awesome-neovim](https://www.trackawesomelist.com/rockerBOO/awesome-neovim/readme/#colorscheme)
+> - [vimcolorschemes.com/top](https://vimcolorschemes.com/top)
+> - [rockerBOO/awesome-neovim](https://www.trackawesomelist.com/rockerBOO/awesome-neovim/readme/#colorscheme)
 >
 > with below conditions:
 >
@@ -177,27 +177,37 @@ You can use command `Colorbox` to control the colorschemes player:
 
 ```lua
 require('colorbox').setup({
-    -- by filetype policy: filetype => color name
-    --- @alias ByFileTypePolicyConfigFileType string
-    --- @alias ByFileTypePolicyConfigColorName string
-    --- @alias ByFileTypePolicyConfig {name:"filetype",mapping:table<ByFileTypePolicyConfigFileType, ByFileTypePolicyConfigColorName>}
+    -- builtin policy
+    --- @alias colorbox.BuiltinPolicyConfig "shuffle"|"in_order"|"reverse_order"|"single_cycle"
+    ---
+    -- by filetype policy: buffer filetype => color name
+    --- @alias colorbox.ByFileTypePolicyConfig {implement:colorbox.BuiltinPolicyConfig|table<string, string>}
     ---
     -- fixed interval seconds
-    --- @alias FixedIntervalPolicyConfig {name:"interval",seconds:integer,implement:"shuffle"|"in_order"|"reverse_order"|"single"}
+    --- @alias colorbox.FixedIntervalPolicyConfig {seconds:integer,implement:colorbox.BuiltinPolicyConfig}
     ---
-    --- @alias PolicyConfig "shuffle"|"in_order"|"reverse_order"|"single"|ByFileTypePolicyConfig|FixedIntervalPolicyConfig
-    --- @type PolicyConfig
+    --- @alias colorbox.PolicyConfig colorbox.BuiltinPolicyConfig|colorbox.ByFileTypePolicyConfig|colorbox.FixedIntervalPolicyConfig
+    --- @type colorbox.PolicyConfig
     policy = "shuffle",
 
     --- @type "startup"|"interval"|"filetype"
     timing = "startup",
 
-    -- (Optional) filter color by color name. For now there're two types of filters:
-    -- 1. the "primary" filter: only the primary colors will be selected, other variants will be skip.
-    -- 2. the function filter: colors will be filtered if function return true.
+    -- (Optional) filters that disable some colors that you don't want.
+    -- By default only enable primary color, e.g. only 'tokyonight' is picked, others ('tokyonight-day', 'tokyonight-moon', 'tokyonight-night', 'tokyonight-storm') are excluded.
     --
-    --- @type "primary"|fun(color:string,spec:colorbox.ColorSpec):boolean|nil
-    filter = nil,
+    -- builtin filter
+    --- @alias colorbox.BuiltinFilterConfig "primary"
+    ---
+    -- function-based filter, disabled if function return 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)[]
+    ---
+    --- @alias colorbox.FilterConfig colorbox.BuiltinFilterConfig|colorbox.FunctionFilterConfig|colorbox.AnyFilterConfig
+    --- @type colorbox.FilterConfig?
+    filter = "primary",
 
     -- (Optional) setup plugin before running `colorscheme {color}`.
     --- @type table<string, function>

collect.py

@@ -28,6 +28,7 @@
     "mini.nvim#minischeme",
     "mini.nvim#colorschemes",
     "olimorris/onedarkpro.nvim",
+    "text-to-colorscheme",
 ]
 
 
@@ -37,6 +38,7 @@
 
 # git object
 DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S"
+DATE_FORMAT = "%Y-%m-%d"
 CANDIDATE_DIR = "candidate"
 
 
@@ -102,6 +104,10 @@ def datetime_tostring(
     )
 
 
+def date_tostring(value: typing.Optional[datetime.datetime]) -> typing.Optional[str]:
+    return value.strftime(DATE_FORMAT) if isinstance(value, datetime.datetime) else None
+
+
 def datetime_fromstring(
     value: typing.Optional[str],
 ) -> typing.Optional[datetime.datetime]:
@@ -277,7 +283,7 @@ def all() -> list:
         except:
             return []
 
-    def download_git_object(self) -> None:
+    def download_git_object(self) -> bool:
         try:
             clone_cmd = None
             if isinstance(self.git_branch, str):
@@ -293,8 +299,10 @@ def download_git_object(self) -> None:
             else:
                 logging.debug(clone_cmd)
                 os.system(clone_cmd)
+            return True
         except Exception as e:
             logging.exception(f"failed to download git object: {self.url}", e)
+            return False
 
     def get_vim_color_names(self) -> list[str]:
         colors_dir = pathlib.Path(f"{self.candidate_path}/colors")
@@ -379,7 +387,7 @@ def _parse_spec(self, element: WebElement) -> ColorSpec:
             github_stars,
             last_git_commit=last_git_commit,
             priority=0,
-            source="https://vimcolorschemes.com/top",
+            source="vimcolorschemes",
         )
 
     def fetch(self) -> list[ColorSpec]:
@@ -391,6 +399,9 @@ def fetch(self) -> list[ColorSpec]:
                 for element in find_elements(driver, "//article[@class='card']"):
                     spec = self._parse_spec(element)
                     logging.debug(f"vsc repo:{spec}")
+                    if len(spec.handle.split("/")) != 2:
+                        logging.info(f"skip for invalid handle - (vcs) spec:{spec}")
+                        continue
                     if spec.github_stars < GITHUB_STARS:
                         logging.info(f"skip for lower stars - (vcs) spec:{spec}")
                         continue
@@ -415,7 +426,7 @@ def _parse_spec(self, element: WebElement) -> ColorSpec:
             github_stars,
             last_git_commit=None,
             priority=100,
-            source="https://www.trackawesomelist.com/rockerBOO/awesome-neovim/readme/#colorscheme",
+            source="awesome-neovim",
         )
 
     def _parse_colors_list(self, driver: Chrome, tag_id: str) -> list[ColorSpec]:
@@ -426,6 +437,12 @@ def _parse_colors_list(self, driver: Chrome, tag_id: str) -> list[ColorSpec]:
         )
         for e in colors_group.find_elements(By.XPATH, "./li"):
             spec = self._parse_spec(e)
+            if len(spec.handle.split("/")) != 2:
+                logging.info(f"skip for invalid handle - (asn) spec:{spec}")
+                continue
+            if spec.github_stars < GITHUB_STARS:
+                logging.info(f"skip for lower stars - (asn) spec:{spec}")
+                continue
             logging.info(f"get (asn) repo:{spec}")
             repos.append(spec)
         return repos
@@ -454,14 +471,15 @@ def blacklist(sp: ColorSpec) -> bool:
     filtered_specs: list[ColorSpec] = []
     for sp in specs:
         logging.debug(f"process filtering on spec:{sp}")
-        if blacklist(sp):
-            logging.info(f"skip for blacklist - spec:{sp}")
-            need_remove_specs.append(sp)
-            continue
         if sp.github_stars < GITHUB_STARS:
             logging.info(f"skip for lower stars - spec:{sp}")
+            continue
+        if blacklist(sp):
+            logging.info(f"skip for blacklist - spec:{sp}")
             need_remove_specs.append(sp)
             continue
+        else:
+            logging.debug(f"no-skip for blacklist - spec:{sp}")
         filtered_specs.append(sp)
 
     logging.debug(f"after filter:{[str(s) for s in specs]}")
@@ -554,7 +572,11 @@ def build(self) -> None:
 
         md = MdUtils(file_name="COLORSCHEMES", title="ColorSchemes List")
         for spec in ColorSpec.all():
-            md.new_line("- " + md.new_inline_link(link=spec.url, text=spec.handle))
+            color_names = spec.get_vim_color_names()
+            color_names = ", ".join([f"'{c}'" for c in color_names])
+            md.new_line(
+                f"- {md.new_inline_link(link=spec.url, text=spec.handle)} (stars: {spec.github_stars}, last update: {date_tostring(spec.last_git_commit)}): {color_names}"
+            )
         md.create_md_file()