fix(funcs,docs,docs-src): fix the reviewing issues

Author: wuhuizuo

docs-src/content/functions/semver.yaml renamed to docs-src/content/functions/semver.yml

@@ -24,7 +24,7 @@ funcs:
       - |
         $ gomplate -i 'the pre release version is {{ ("v1.1.1" | semver.Semver).SetPrerelease "beta.1" }}'
         the pre release version is 1.1.1-beta.1
-  - name: semver.MatchConstraint
+  - name: semver.CheckConstraint
     description: |
       Test whether the input version matchs the constraint.
 
@@ -39,11 +39,11 @@ funcs:
         description: The input semantic version string to test.
     examples:
       - |
-        $ gomplate -i '{{ semver.MatchConstraint "> 1.0" "v1.1.1" }}'
+        $ gomplate -i '{{ semver.CheckConstraint "> 1.0" "v1.1.1" }}'
         true
       - |
-        $ gomplate -i '{{ semver.MatchConstraint "> 1.0, <1.1" "v1.1.1" }}'
+        $ gomplate -i '{{ semver.CheckConstraint "> 1.0, <1.1" "v1.1.1" }}'
         false        
       - |
-        $ gomplate -i '{{ "v1.1.1" | semver.MatchConstraint "> 1.0" }}'
+        $ gomplate -i '{{ "v1.1.1" | semver.CheckConstraint "> 1.0" }}'
         true

docs/content/functions/semver.md

@@ -0,0 +1,85 @@
+---
+title: semver functions
+menu:
+  main:
+    parent: functions
+---
+
+These functions allow user you to parse a [semantic version](http://semver.org/) string or test it with constraint.
+
+It's implemented with the https://github.com/Masterminds/semver library.
+
+## `semver.Semver`_(unreleased)_
+**Unreleased:** _This function is in development, and not yet available in released builds of gomplate._
+
+Returns a semantic version struct holding the `input` version string.
+
+The returned struct are defined at: [`semver.Version`](https://pkg.go.dev/github.com/Masterminds/semver/v3#Version).
+
+### Usage
+
+```
+semver.Semver input
+```
+```
+input | semver.Semver
+```
+
+### Arguments
+
+| name | description |
+|------|-------------|
+| `input` | _(required)_ The input to parse |
+
+### Examples
+
+```console
+$ gomplate -i '{{ semver.Semver "v1.1.1"}}'
+1.1.1
+```
+```console
+$ gomplate -i '{{ (semver.Semver "v1.1.1").Major }}'
+1
+```
+```console
+$ gomplate -i 'the pre release version is {{ ("v1.1.1" | semver.Semver).SetPrerelease "beta.1" }}'
+the pre release version is 1.1.1-beta.1
+```
+
+## `semver.CheckConstraint`_(unreleased)_
+**Unreleased:** _This function is in development, and not yet available in released builds of gomplate._
+
+Test whether the input version matchs the constraint.
+
+Ref: https://github.com/Masterminds/semver#checking-version-constraints
+
+### Usage
+
+```
+semver.CheckConstraint constraint input
+```
+```
+input | semver.CheckConstraint constraint
+```
+
+### Arguments
+
+| name | description |
+|------|-------------|
+| `constraint` | _(required)_ The constraints expression to test. |
+| `input` | _(required)_ The input semantic version string to test. |
+
+### Examples
+
+```console
+$ gomplate -i '{{ semver.CheckConstraint "> 1.0" "v1.1.1" }}'
+true
+```
+```console
+$ gomplate -i '{{ semver.CheckConstraint "> 1.0, <1.1" "v1.1.1" }}'
+false
+```
+```console
+$ gomplate -i '{{ "v1.1.1" | semver.CheckConstraint "> 1.0" }}'
+true
+```

funcs/semver.go

@@ -24,8 +24,8 @@ func (SemverFuncs) Semver(version string) (*semver.Version, error) {
 	return semver.NewVersion(version)
 }
 
-// MatchConstraint -
-func (SemverFuncs) MatchConstraint(constraint, in string) (bool, error) {
+// CheckConstraint -
+func (SemverFuncs) CheckConstraint(constraint, in string) (bool, error) {
 	c, err := semver.NewConstraint(constraint)
 	if err != nil {
 		return false, err

funcs/semver_test.go

@@ -3,6 +3,8 @@ package funcs
 import (
 	"context"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestSemverFuncs_MatchConstraint(t *testing.T) {
@@ -45,16 +47,16 @@ func TestSemverFuncs_MatchConstraint(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			s := SemverFuncs{
-				ctx: context.TODO(),
-			}
-			got, err := s.MatchConstraint(tt.constraint, tt.in)
-			if (err != nil) != tt.wantErr {
-				t.Errorf("SemverFuncs.MatchConstraint() error = %v, wantErr %v", err, tt.wantErr)
-				return
+				ctx: context.Background(),
 			}
-			if got != tt.want {
-				t.Errorf("SemverFuncs.MatchConstraint() = %v, want %v", got, tt.want)
+			got, err := s.CheckConstraint(tt.constraint, tt.in)
+			if tt.wantErr {
+				assert.Errorf(t, err, "SemverFuncs.CheckConstraint() error = %v, wantErr %v", err, tt.wantErr)
+			} else {
+				assert.NoErrorf(t, err, "SemverFuncs.CheckConstraint() error = %v, wantErr %v", err, tt.wantErr)
 			}
+
+			assert.Equal(t, tt.want, got)
 		})
 	}
 }