feat: add AddYear and IsLeapYear

datetime/datetime.go

@@ -69,6 +69,11 @@ func AddDay(t time.Time, day int64) time.Time {
 	return t.Add(24 * time.Hour * time.Duration(day))
 }
 
+// AddYear add or sub year to the time.
+func AddYear(t time.Time, year int64) time.Time {
+	return t.Add(365 * 24 * time.Hour * time.Duration(year))
+}
+
 // GetNowDate return format yyyy-mm-dd of current date
 func GetNowDate() string {
 	return time.Now().Format("2006-01-02")
@@ -180,3 +185,8 @@ func BeginOfYear(t time.Time) time.Time {
 func EndOfYear(t time.Time) time.Time {
 	return BeginOfYear(t).AddDate(1, 0, 0).Add(-time.Nanosecond)
 }
+
+// IsLeapYear check if param year is leap year or not.
+func IsLeapYear(year int) bool {
+	return year%4 == 0 && (year%100 != 0 || year%400 == 0)
+}

datetime/datetime_test.go

@@ -46,6 +46,19 @@ func TestAddMinute(t *testing.T) {
 	assert.Equal(float64(-2), diff2.Minutes())
 }
 
+func TestAddYear(t *testing.T) {
+	assert := internal.NewAssert(t, "TestAddDay")
+
+	now := time.Now()
+	after2Years := AddYear(now, 1)
+	diff1 := after2Years.Sub(now)
+	assert.Equal(float64(8760), diff1.Hours())
+
+	before2Years := AddYear(now, -1)
+	diff2 := before2Years.Sub(now)
+	assert.Equal(float64(-8760), diff2.Hours())
+}
+
 func TestGetNowDate(t *testing.T) {
 	assert := internal.NewAssert(t, "TestGetNowDate")
 	expected := time.Now().Format("2006-01-02")
@@ -231,3 +244,13 @@ func TestEndOfYear(t *testing.T) {
 
 	assert.Equal(expected, actual)
 }
+
+func TestIsLeapYear(t *testing.T) {
+	assert := internal.NewAssert(t, "TestEndOfYear")
+
+	result1 := IsLeapYear(2000)
+	result2 := IsLeapYear(2001)
+
+	assert.Equal(true, result1)
+	assert.Equal(false, result2)
+}

docs/datetime.md

@@ -25,6 +25,7 @@ import (
 -   [AddDay](#AddDay)
 -   [AddHour](#AddHour)
 -   [AddMinute](#AddMinute)
+-   [AddYear](#AddYear)
 -   [BeginOfMinute](#BeginOfMinute)
 -   [BeginOfHour](#BeginOfHour)
 -   [BeginOfDay](#BeginOfDay)
@@ -52,6 +53,7 @@ import (
 -   [ToFormat](#ToFormat)
 -   [ToFormatForTpl](#ToFormatForTpl)
 -   [ToIso8601](#ToIso8601)
+-   [IsLeapYear](#IsLeapYear)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -170,6 +172,45 @@ func main() {
 }
 ```
 
+### <span id="AddYear">AddYear</span>
+
+<p>Add or sub year to the time.</p>
+
+<b>Signature:</b>
+
+```go
+func AddYear(t time.Time, year int64) time.Time
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "time"
+    "github.com/duke-git/lancet/datetime"
+)
+
+func main() {
+    now := time.Now()
+
+	after1Year := datetime.AddYear(now, 1)
+	diff1 := after1Year.Sub(now)
+
+	before1Year := datetime.AddYear(now, -1)
+	diff2 := before1Year.Sub(now)
+
+	fmt.Println(diff1)
+	fmt.Println(diff2)
+
+	// Output:
+	// 8760h0m0s
+	// -8760h0m0s
+}
+```
+
 ### <span id="BeginOfMinute">BeginOfMinute</span>
 
 <p>Return beginning minute time of day.</p>
@@ -921,3 +962,36 @@ func main() {
     fmt.Println(ts) //"2006-01-02T23:04:05+08:00"
 }
 ```
+
+### <span id="IsLeapYear">IsLeapYear</span>
+
+<p>check if param `year` is leap year or not.</p>
+
+<b>Signature:</b>
+
+```go
+func IsLeapYear(year int) bool
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/datetime"
+)
+
+func main() {
+    result1 := datetime.IsLeapYear(2000)
+    result2 := datetime.IsLeapYear(2001)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // true
+    // false
+}
+```

docs/datetime_zh-CN.md

@@ -25,6 +25,7 @@ import (
 -   [AddDay](#AddDay)
 -   [AddHour](#AddHour)
 -   [AddMinute](#AddMinute)
+-   [AddYear](#AddYear)
 -   [BeginOfMinute](#BeginOfMinute)
 -   [BeginOfHour](#BeginOfHour)
 -   [BeginOfDay](#BeginOfDay)
@@ -52,6 +53,7 @@ import (
 -   [ToFormat](#ToFormat)
 -   [ToFormatForTpl](#ToFormatForTpl)
 -   [ToIso8601](#ToIso8601)
+-   [IsLeapYear](#IsLeapYear)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -170,6 +172,45 @@ func main() {
 }
 ```
 
+### <span id="AddYear">AddYear</span>
+
+<p>将日期加/减年数。</p>
+
+<b>函数签名:</b>
+
+```go
+func AddYear(t time.Time, year int64) time.Time
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "time"
+    "github.com/duke-git/lancet/datetime"
+)
+
+func main() {
+    now := time.Now()
+
+	after1Year := datetime.AddYear(now, 1)
+	diff1 := after1Year.Sub(now)
+
+	before1Year := datetime.AddYear(now, -1)
+	diff2 := before1Year.Sub(now)
+
+	fmt.Println(diff1)
+	fmt.Println(diff2)
+
+	// Output:
+	// 8760h0m0s
+	// -8760h0m0s
+}
+```
+
 ### <span id="BeginOfMinute">BeginOfMinute</span>
 
 <p>返回指定时间的分钟开始时间</p>
@@ -921,3 +962,36 @@ func main() {
     fmt.Println(ts) //"2006-01-02T23:04:05+08:00"
 }
 ```
+
+### <span id="IsLeapYear">IsLeapYear</span>
+
+<p>验证是否是闰年。</p>
+
+<b>函数签名:</b>
+
+```go
+func IsLeapYear(year int) bool
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/datetime"
+)
+
+func main() {
+    result1 := datetime.IsLeapYear(2000)
+    result2 := datetime.IsLeapYear(2001)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // true
+    // false
+}
+```