ci(test): migrate 'vusted' tests to 'plenary.busted', and drop code coverage report (#272)

Author: linrongbin16

.github/workflows/ci.yml

@@ -69,59 +69,13 @@ jobs:
         with:
           neovim: true
           version: ${{ matrix.nvim_version }}
-      - uses: leafo/gh-actions-lua@v11
-        with:
-          luaVersion: "luajit-2.1"
-          # luaVersion: "luajit-openresty"
-      - uses: leafo/gh-actions-luarocks@v5
       - name: Run Test Cases
-        shell: bash
-        run: |
-          luarocks --lua-version=5.1 install vusted
-          vusted ./spec
-  code_coverage:
-    name: Code Coverage
-    needs:
-      - lint
-    strategy:
-      matrix:
-        nvim_version: [stable]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v5
-      - uses: rhysd/action-setup-vim@v1
-        with:
-          neovim: true
-          version: ${{ matrix.nvim_version }}
-      - uses: leafo/gh-actions-lua@v10
-        with:
-          luaVersion: "luajit-2.1"
-      - uses: leafo/gh-actions-luarocks@v5
-      - name: Generate Coverage Reports
-        run: |
-          luarocks install luacov
-          luarocks install luacov-reporter-lcov
-          luarocks --lua-version=5.1 install vusted
-          vusted --coverage ./spec
-          echo "ls -l ."
-          ls -l .
-          echo "luacov -r lcov"
-          luacov -r lcov
-          echo "ls -l ."
-          ls -l .
-          echo "tail ./luacov.report.out"
-          tail -n 10 ./luacov.report.out
-      - uses: codecov/codecov-action@v4
-        with:
-          files: luacov.report.out
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        run: make test
   release:
     name: Release
     if: ${{ github.ref == 'refs/heads/master' }}
     needs:
       - unit_test
-      - code_coverage
     runs-on: ubuntu-latest
     steps:
       - uses: google-github-actions/release-please-action@v3

Makefile

@@ -0,0 +1,11 @@
+TESTS_INIT=spec_init.lua
+TESTS_DIR=spec/
+
+.PHONY: test
+
+test:
+	@nvim \
+		--headless \
+		--noplugin \
+		-u ${TESTS_INIT} \
+		-c "PlenaryBustedDirectory ${TESTS_DIR} { minimal_init = '${TESTS_INIT}' }"

README.md

@@ -5,7 +5,6 @@
 <a href="https://github.com/linrongbin16/commons.nvim"><img alt="commons.nvim" src="https://img.shields.io/badge/power_by-commons.nvim-pink" /></a>
 <a href="https://luarocks.org/modules/linrongbin16/gitlinker.nvim"><img alt="luarocks" src="https://img.shields.io/luarocks/v/linrongbin16/gitlinker.nvim" /></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/gitlinker.nvim/ci.yml?label=ci" /></a>
-<a href="https://app.codecov.io/github/linrongbin16/gitlinker.nvim"><img alt="codecov" src="https://img.shields.io/codecov/c/github/linrongbin16/gitlinker.nvim/main?label=codecov" /></a>
 </p>
 
 > Maintained fork of [ruifm's gitlinker](https://github.com/ruifm/gitlinker.nvim), refactored with bug fixes, ssh host alias, blame support and other improvements.
@@ -199,9 +198,7 @@ require("gitlinker").link(opts)
 **Parameters:**
 
 - `opts`: (Optional) lua table that contains below fields:
-
   - `router_type`: Which router type should use. By default is `browse` when not specified. It has below options:
-
     - `browse`
     - `blame`
     - `default_branch`
@@ -214,7 +211,6 @@ require("gitlinker").link(opts)
     > Once set this field, you will get full control of generating the url, and `router_type` field will no longer take effect.
 
   - `action`: What action should do. By default it will copy the generated link to clipboard. It has below options, please see [`gitlinker.Action`](#gitlinkeraction) for more details.
-
     - `require("gitlinker.actions").clipboard`: Copy url to clipboard.
     - `require("gitlinker.actions").system`: Open url in browser.
 
@@ -646,11 +642,7 @@ To develop the project and make PR, please setup with:
 - [stylua](https://github.com/JohnnyMorganz/StyLua).
 - [selene](https://github.com/Kampfkarren/selene).
 
-To run unit tests, please install below dependencies:
-
-- [vusted](https://github.com/notomo/vusted).
-
-Then test with `vusted ./spec`.
+To run unit tests, please use `make test`.
 
 ## Contribute