perf(commons): migrate to commons library (#129)

Author: linrongbin16

.github/workflows/ci.yml

@@ -15,61 +15,56 @@ jobs:
     if: ${{ github.ref != 'refs/heads/main' }}
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
       - uses: ytanikin/[email protected]
         with:
           task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert","break"]'
   luacheck:
     name: Lua check
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Luacheck
-        uses: lunarmodules/luacheck@v1
+      - uses: actions/checkout@v4
+      - uses: lunarmodules/luacheck@v1
         with:
           args: lua --config .luacheckrc
-      - name: Stylua
-        uses: JohnnyMorganz/stylua-action@v3
+      - 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
+          cd ./lua/colorbox/commons
+          find . -type f -name '*.lua' -exec sed -i 's/require("commons/require("colorbox.commons/g' {} \;
+      - uses: JohnnyMorganz/stylua-action@v3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           version: latest
-          args: --config-path .stylua.toml ./lua
-      - name: Add json.lua
+          args: --config-path .stylua.toml ./lua ./test
+      - uses: stefanzweifel/git-auto-commit-action@v4
         if: ${{ github.ref != 'refs/heads/main' }}
-        shell: bash
-        run: |
-          echo "pwd"
-          echo $PWD
-          git clone --depth=1 https://github.com/actboy168/json.lua.git ~/.json.lua
-          cp ~/.json.lua/json.lua ./lua/colorbox/actboy168_json.lua
-      - name: Auto Commit
-        if: ${{ github.ref != 'refs/heads/main' }}
-        uses: stefanzweifel/git-auto-commit-action@v4
         with:
           commit_message: "chore(pr): auto-commit"
   unit_test:
     name: Unit Test
+    needs:
+      - luacheck
     strategy:
       matrix:
         nvim_version: [stable, nightly, v0.8.0]
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Install neovim
-        uses: rhysd/action-setup-vim@v1
+      - uses: actions/checkout@v4
+      - uses: rhysd/action-setup-vim@v1
         id: vim
         with:
           neovim: true
           version: ${{ matrix.nvim_version }}
-      - name: Install luajit
-        uses: leafo/gh-actions-lua@v10
+      - uses: leafo/gh-actions-lua@v10
         with:
           luaVersion: "luajit-2.1.0-beta3"
-      - name: Install luarocks
-        uses: leafo/gh-actions-luarocks@v4
+      - uses: leafo/gh-actions-luarocks@v4
       - name: Run test cases
         shell: bash
         run: |
@@ -89,8 +84,7 @@ jobs:
           ls -l .
           echo "cat ./luacov.report.out"
           cat ./luacov.report.out
-      - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v3
         with:
           files: luacov.report.out
         env:
@@ -99,7 +93,6 @@ jobs:
     name: Release
     if: ${{ github.ref == 'refs/heads/main' }}
     needs:
-      - luacheck
       - unit_test
     runs-on: ubuntu-latest
     steps:
@@ -116,14 +109,13 @@ jobs:
           message: "Current stable release: ${{ steps.release.outputs.tag_name }}"
           tag_exists_error: false
           force_push_tag: true
-      - name: LuaRocks Upload
+      - name: Upload LuaRocks
         uses: nvim-neorocks/luarocks-tag-release@v5
         if: ${{ steps.release.outputs.release_created }}
         env:
           LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}
         with:
           version: ${{ steps.release.outputs.tag_name }}
-          summary: "Load all the ultra colorschemes into your Neovim player!"
           labels: |
             vim
             neovim

.luacheckrc

@@ -2,3 +2,4 @@ globals = { "vim", "describe", "before_each", "it", "assert" }
 max_line_length = 200
 unused = false
 unused_args = false
+exclude_files = { "lua/colorbox/commons/*.lua" }

.luacov

@@ -3,6 +3,6 @@ modules = {
     ["colorbox.*"] = "lua",
 }
 exclude = {
-    "lua/colorbox/rxi_json.lua",
+    "lua/colorbox/commons/*.lua",
 }
 

.luarc.json

@@ -1,4 +1,4 @@
 {
-  "diagnostics.globals": ["vim", "describe", "before_each", "it"],
+  "diagnostics.globals": ["vim", "describe", "before_each", "it", "jit"],
   "workspace.checkThirdParty": "Disable"
 }

.styluaignore

@@ -0,0 +1 @@
+lua/colorbox/commons/*.lua

README.md

@@ -3,11 +3,11 @@
 <!-- query a github file last update timestamp: https://stackoverflow.com/a/50204589/4438921 -->
 
 <p align="center">
-<a href="https://github.com/neovim/neovim/releases/v0.8.0"><img alt="Neovim" src="https://img.shields.io/badge/Neovim-v0.8-57A143?logo=neovim&logoColor=57A143" /></a>
-<a href="https://luarocks.org/modules/linrongbin16/colorbox.nvim"><img alt="luarocks" src="https://custom-icon-badges.demolab.com/luarocks/v/linrongbin16/colorbox.nvim?label=LuaRocks&labelColor=063B70&logo=tag&logoColor=fff&color=008B8B" /></a>
+<a href="https://github.com/neovim/neovim/releases/v0.8.0"><img alt="Neovim" src="https://img.shields.io/badge/Neovim-v0.8+-57A143?logo=neovim&logoColor=57A143" /></a>
+<a href="https://github.com/linrongbin16/commons.nvim"><img alt="commons.nvim" src="https://custom-icon-badges.demolab.com/badge/Powered_by-commons.nvim-teal?logo=heart&logoColor=fff&labelColor=red" /></a>
+<a href="https://luarocks.org/modules/linrongbin16/colorbox.nvim"><img alt="luarocks" src="https://custom-icon-badges.demolab.com/luarocks/v/linrongbin16/colorbox.nvim?label=LuaRocks&labelColor=2C2D72&logo=tag&logoColor=fff&color=blue" /></a>
 <a href="https://github.com/linrongbin16/gitlinker.nvim/actions/workflows/ci.yml"><img alt="ci.yml" src="https://img.shields.io/github/actions/workflow/status/linrongbin16/colorbox.nvim/ci.yml?label=GitHub%20CI&labelColor=181717&logo=github&logoColor=fff" /></a>
 <a href="https://app.codecov.io/github/linrongbin16/colorbox.nvim"><img alt="codecov" src="https://img.shields.io/codecov/c/github/linrongbin16/colorbox.nvim?logo=codecov&logoColor=F01F7A&label=Codecov" /></a>
-<a href="https://github.com/linrongbin16/gitlinker.nvim/actions/workflows/collect.yml"><img alt="collect.yml" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Flinrongbin16%2Fcolorbox.nvim%2Fcommits%3Fpath%3Dcollect.py.log%26page%3D1%26per_page%3D1&query=%24%5B0%5D.commit.committer.date&logo=githubactions&logoColor=fff&label=Last%20Update&labelColor=2F4F4F" /></a>
 </p>
 
 I'm greedy that I want all the **most popular** Neovim colorschemes than only one, I'm playful that I want to change colorscheme from time to time. Are you like me?

codecov.yml

@@ -7,4 +7,4 @@ coverage:
       default:
         threshold: 90%
 ignore:
-  - "lua/colorbox/rxi_json.lua"
+  - "lua/colorbox/commons/*.lua"

collect.py

@@ -295,7 +295,7 @@ def download_git_object(self) -> bool:
                 f"{candidate_dir} exist: {candidate_dir.exists()}, isdir: {candidate_dir.is_dir()}"
             )
             if candidate_dir.exists() and candidate_dir.is_dir():
-                logging.info(f"{candidate_dir} already exist, skip...")
+                logging.debug(f"{candidate_dir} already exist, skip...")
             else:
                 logging.debug(clone_cmd)
                 os.system(clone_cmd)
@@ -399,16 +399,16 @@ def fetch(self) -> None:
                     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}")
+                        logging.debug(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}")
+                        logging.debug(f"skip for lower stars - (vcs) spec:{spec}")
                         continue
-                    logging.info(f"get (vcs) spec:{spec}")
+                    logging.debug(f"get (vcs) spec:{spec}")
                     need_more_scan = True
                     spec.save()
                 if not need_more_scan:
-                    logging.info(f"no more enough github stars, exit...")
+                    logging.debug(f"no more enough github stars, exit...")
                     break
 
 
@@ -436,12 +436,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}")
+                logging.debug(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}")
+                logging.debug(f"skip for lower stars - (asn) spec:{spec}")
                 continue
-            logging.info(f"get (asn) repo:{spec}")
+            logging.debug(f"get (asn) repo:{spec}")
             repos.append(spec)
         return repos
 
@@ -469,11 +469,11 @@ def blacklist(sp: ColorSpec) -> bool:
     for spec in ColorSpec.all():
         logging.debug(f"process filtering on spec:{spec}")
         if spec.github_stars < GITHUB_STARS:
-            logging.info(f"skip for lower stars - spec:{spec}")
+            logging.debug(f"skip for lower stars - spec:{spec}")
             spec.remove()
             continue
         if blacklist(spec):
-            logging.info(f"skip for blacklist - spec:{spec}")
+            logging.debug(f"skip for blacklist - spec:{spec}")
             spec.remove()
             continue
         else:
@@ -505,13 +505,13 @@ def _download(self) -> None:
                 spec.last_git_commit.timestamp() + LAST_GIT_COMMIT
                 < datetime.datetime.now().timestamp()
             ):
-                logging.info(f"skip for too old git commit - spec:{spec}")
+                logging.debug(f"skip for too old git commit - spec:{spec}")
                 spec.remove()
                 continue
             color_names = spec.get_vim_color_names()
             spec.update_color_names(color_names)
             if len(color_names) == 0:
-                logging.info(f"skip for no color files (.vim,.lua) - spec:{spec}")
+                logging.debug(f"skip for no color files (.vim,.lua) - spec:{spec}")
                 spec.remove()
                 continue
 
@@ -535,12 +535,12 @@ def greater_than(a: ColorSpec, b: ColorSpec) -> bool:
                 # detect duplicated color
                 if color in specs_map:
                     old_spec = specs_map[color]
-                    logging.info(
+                    logging.debug(
                         f"detect duplicated color({color}), new:{spec}, old:{old_spec}"
                     )
                     # replace old repo if new repo has higher priority
                     if greater_than(spec, old_spec):
-                        logging.info(f"replace old repo({old_spec}) with new({spec})")
+                        logging.debug(f"replace old repo({old_spec}) with new({spec})")
                         specs_map[color] = spec
                         specs_set.add(spec)
                         specs_set.remove(old_spec)
@@ -558,11 +558,12 @@ def build(self) -> None:
 
         for spec in ColorSpec.all():
             if not spec in deduped_specs:
-                logging.info(f"remove for duplicate - repo:{spec}")
+                logging.debug(f"remove for duplicate - repo:{spec}")
                 spec.remove()
 
         md = MdUtils(file_name="COLORSCHEMES", title="ColorSchemes List")
         for spec in ColorSpec.all():
+            logging.info(f"collect spec:{spec}")
             color_names = spec.get_vim_color_names()
             color_names = sorted(color_names)
             md.new_line(