New function GetHyperLinkCells has been added

- Update unit tests
- Run publish job when a tag is pushed

Author: xuri

.github/workflows/publish.yml

@@ -3,6 +3,8 @@ on:
   push:
     branches:
       - main
+    tags:
+      - v*
 jobs:
 
   build:
@@ -77,6 +79,7 @@ jobs:
 
   publish:
     needs: build
+    if: startsWith(github.ref, 'refs/tags/')
     runs-on: ubuntu-24.04
     environment: production
     permissions:

cmd/main.go

@@ -384,6 +384,7 @@ func regInteropFunc(f *excelize.File, fn map[string]interface{}) interface{} {
 		"GetDefinedName":              GetDefinedName(f),
 		"GetDocProps":                 GetDocProps(f),
 		"GetFormControls":             GetFormControls(f),
+		"GetHyperLinkCells":           GetHyperLinkCells(f),
 		"GetHeaderFooter":             GetHeaderFooter(f),
 		"GetMergeCells":               GetMergeCells(f),
 		"GetPageLayout":               GetPageLayout(f),
@@ -2298,6 +2299,34 @@ func GetFormControls(f *excelize.File) func(this js.Value, args []js.Value) inte
 	}
 }
 
+// GetHyperLinkCells returns cell references which contain hyperlinks in a
+// given worksheet name and link type. The optional parameter 'linkType' use for
+// specific link type, the optional values are "External" for website links,
+// "Location" for moving to one of cell in this workbook, "None" for no links.
+// If linkType is empty, it will return all hyperlinks in the worksheet.
+func GetHyperLinkCells(f *excelize.File) func(this js.Value, args []js.Value) interface{} {
+	return func(this js.Value, args []js.Value) interface{} {
+		ret := map[string]interface{}{"result": js.ValueOf([]interface{}{}), "error": nil}
+		if err := prepareArgs(args, []argsRule{
+			{types: []js.Type{js.TypeString}},
+			{types: []js.Type{js.TypeString}},
+		}); err != nil {
+			ret["error"] = err.Error()
+			return js.ValueOf(ret)
+		}
+		result, err := f.GetHyperLinkCells(args[0].String(), args[1].String())
+		if err != nil {
+			ret["error"] = err.Error()
+		}
+		excepted := make([]interface{}, len(result))
+		for i, cell := range result {
+			excepted[i] = cell
+		}
+		ret["result"] = excepted
+		return js.ValueOf(ret)
+	}
+}
+
 // GetHeaderFooter provides a function to get worksheet header and footer by
 // given worksheet name.
 func GetHeaderFooter(f *excelize.File) func(this js.Value, args []js.Value) interface{} {

cmd/main_test.go

@@ -2113,7 +2113,7 @@ func TestSetCellFormula(t *testing.T) {
 	assert.Equal(t, errArgType.Error(), ret.Get("error").String())
 }
 
-func TestSetCellHyperLink(t *testing.T) {
+func TestCellHyperLink(t *testing.T) {
 	f := NewFile(js.Value{}, []js.Value{})
 	assert.True(t, f.(js.Value).Get("error").IsNull())
 
@@ -2122,6 +2122,23 @@ func TestSetCellHyperLink(t *testing.T) {
 	ret := f.(js.Value).Call("SetCellHyperLink", js.ValueOf("Sheet1"), js.ValueOf("A3"), js.ValueOf(display), js.ValueOf("External"), js.ValueOf(map[string]interface{}{"Display": display, "Tooltip": tooltip}))
 	assert.True(t, ret.Get("error").IsNull())
 
+	ret = f.(js.Value).Call("GetHyperLinkCells", js.ValueOf("Sheet1"), js.ValueOf(""))
+	assert.True(t, ret.Get("error").IsNull())
+	assert.Equal(t, 1, ret.Get("result").Length())
+	assert.Equal(t, "A3", ret.Get("result").Index(0).String())
+
+	ret = f.(js.Value).Call("GetHyperLinkCells", js.ValueOf("Sheet1"), js.ValueOf("External"))
+	assert.True(t, ret.Get("error").IsNull())
+	assert.Equal(t, 1, ret.Get("result").Length())
+
+	ret = f.(js.Value).Call("GetHyperLinkCells", js.ValueOf("Sheet1"), js.ValueOf("Location"))
+	assert.True(t, ret.Get("error").IsNull())
+	assert.Equal(t, 0, ret.Get("result").Length())
+
+	ret = f.(js.Value).Call("GetHyperLinkCells", js.ValueOf("Sheet1"), js.ValueOf("None"))
+	assert.True(t, ret.Get("error").IsNull())
+	assert.Equal(t, 0, ret.Get("result").Length())
+
 	ret = f.(js.Value).Call("SetCellHyperLink")
 	assert.EqualError(t, errArgNum, ret.Get("error").String())
 
@@ -2130,6 +2147,15 @@ func TestSetCellHyperLink(t *testing.T) {
 
 	ret = f.(js.Value).Call("SetCellHyperLink", js.ValueOf("Sheet1"), js.ValueOf("A3"), js.ValueOf(display), js.ValueOf("External"), js.ValueOf(map[string]interface{}{"Display": true, "Tooltip": tooltip}))
 	assert.Equal(t, errArgType.Error(), ret.Get("error").String())
+
+	ret = f.(js.Value).Call("GetHyperLinkCells")
+	assert.EqualError(t, errArgNum, ret.Get("error").String())
+
+	ret = f.(js.Value).Call("GetHyperLinkCells", js.ValueOf("SheetN"), js.ValueOf(""))
+	assert.Equal(t, "sheet SheetN does not exist", ret.Get("error").String())
+
+	ret = f.(js.Value).Call("GetHyperLinkCells", js.ValueOf("Sheet1"), js.ValueOf(nil))
+	assert.Equal(t, errArgType.Error(), ret.Get("error").String())
 }
 
 func TestSetCellInt(t *testing.T) {

src/index.d.ts

@@ -2477,6 +2477,18 @@ declare module 'excelize-wasm' {
      */
     GetFormControls(sheet: string): { formControls: FormControl[], error: string | null }
 
+    /**
+     * GetHyperLinkCells returns cell references which contain hyperlinks in a
+     * given worksheet name and link type. The optional parameter 'linkType' use
+     * for specific link type, the optional values are "External" for website
+     * links, "Location" for moving to one of cell in this workbook, "None" for
+     * no links. If linkType is empty, it will return all hyperlinks in the
+     * worksheet.
+     * @param sheet The worksheet name
+     * @param linkType The cell hyperlink type
+     */
+    GetHyperLinkCells(sheet: string, linkType: string): { result: string[], error: string | null }
+
     /**
      * GetHeaderFooter provides a function to get worksheet header and footer by
      * given worksheet name.