Merge branch 'master' into v3

Author: SerhiiCho

.github/workflows/go.yml

@@ -2,24 +2,29 @@ name: Go
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go_version: ['1.16', '1.17', '1.18', '1.19', '1.20', '1.21', '1.22', '1.23', '1.24']
+        go_version: [1.16, 1.17, 1.18, 1.19, 1.20, 1.21, 1.22, 1.23, 1.24, 1.25]
 
     steps:
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v1
+      - uses: actions/checkout@v3
 
-    - name: Setup the correct timezone
-      run: sudo cp -f /usr/share/zoneinfo/Europe/Kiev /etc/localtime
+      - name: Setup the correct timezone
+        run: sudo cp -f /usr/share/zoneinfo/Europe/Kiev /etc/localtime
 
-    - name: Run tests
-      run: make
+      - name: Set up Go
+        uses: actions/setup-go@v4
+
+      - name: Install golangci-lint
+        run: curl -sSfL https://golangci-lint.run/install.sh | sh -s -- -b $(go env GOPATH)/bin v2.8.0
+
+      - name: Run checks
+        run: make check

CHANGELOG.md

@@ -1,40 +1,53 @@
 # Release Notes v3
 
+## v3.3.2 (2026-02-08)
+
+- 🧑 Added linting and formatting check for GitHub actions.
+- 🧑 Code refactoring and improvements for better readability and maintainability.
+
 ## v3.3.1 (2025-06-20)
-- Added Docker to the project
+
+- 🧑 Added Container Engines like Docker and Podman to the project.
 
 ## v3.3.0 (2025-06-16)
-- Now you can parse different times of timestamps, such as `string`, `int64`, `uint`, `uint64`, `int32`, `uint32`
+
+- ✨ Now you can parse different times of timestamps, such as `string`, `int64`, `uint`, `uint64`, `int32`, `uint32`.
 
 ## v3.2.2 (2025-06-04)
-- Change so that all JSON files are included in the final binary by using `go:embed` functionality
-- Remove support for go version 1.13, 1.14, 1.15 because they do not have `go:embed`
+
+- ✨ Change so that all JSON files are included in the final binary by using `go:embed` functionality.
+- ⚠️ Remove support for go version 1.13, 1.14, 1.15 because they do not have `go:embed`.
 
 ## v3.2.1 (2024-12-06)
-- Bug fix with incorrect Russian, Ukrainian, and Belarusian languages rules
-- Added more tests for Russian, Ukrainian, and Belarusian languages for testing seconds
+
+- 🐛 Bug fix with incorrect Russian, Ukrainian, and Belarusian languages rules.
+- 🧑 Added more tests for Russian, Ukrainian, and Belarusian languages for testing seconds.
 
 ## v3.2.0 (2024-11-27)
-- Added support for Belarusian language 🇧🇾
-- Added support for Spanish language 🇪🇸
-- Added support for Japanese language 🇯🇵
-- Added support for French language 🇫🇷
-- Code refactoring and improvements for better readability and maintainability
+
+- ✨ Added support for Belarusian language 🇧🇾.
+- ✨ Added support for Spanish language 🇪🇸.
+- ✨ Added support for Japanese language 🇯🇵.
+- ✨ Added support for French language 🇫🇷.
+- 🧑 Code refactoring and improvements for better readability and maintainability.
 
 ## v3.1.0 (2024-11-25)
-- Updated the `LICENSE.md` file
-- Refactored codebase to make it more readable and maintainable
-- Added [OnlineThreshold](https://time-ago.github.io/v3/configurations.html#thresholds) parameter to the configurations to set the threshold for the "Online" status
-- Added [JustNowThreshold](https://time-ago.github.io/v3/configurations.html#thresholds) parameter to the configurations to set the threshold for the "Just now" status
-- Added support for Chinese Simplified language 🇨🇳
-- **POTENTIAL BREAK**. Might break your code if you were using the `Option` type or option constants directly. Which wasn't documented for public use.
-    - Rename `Option` type to `opt` making it unexported
-    - Add prefix to option constants `Opt` to make them like `OptOnline`, `OptNoSuffix`, etc.
+
+- 📝 Updated the `LICENSE.md` file
+- 🧑 Refactored codebase to make it more readable and maintainable
+- ✨ Added [OnlineThreshold](https://time-ago.github.io/v3/configurations.html#thresholds) parameter to the configurations to set the threshold for the "Online" status
+- ✨ Added [JustNowThreshold](https://time-ago.github.io/v3/configurations.html#thresholds) parameter to the configurations to set the threshold for the "Just now" status
+- ✨ Added support for Chinese Simplified language 🇨🇳
+- ⚠️ **POTENTIAL BREAK**. Might break your code if you were using the `Option` type or option constants directly. Which wasn't documented for public use.
+  - Rename `Option` type to `opt` making it unexported
+  - Add prefix to option constants `Opt` to make them like `OptOnline`, `OptNoSuffix`, etc.
 
 ## v3.0.0 (2024-11-22)
+
 > BREAKING CHANGES!
 
 [Upgrade Guide from v2 to v3](https://time-ago.github.io/v3/upgrade.html)
+
 - **Improved error handling**. The `Parse` function now returns an error as the second returned value
 - **Update package namespace**. Changed package namespace to `github.com/SerhiiCho/timeago/v3`
 - **Rename a function**. Renamed `SetConfig` function to `Configure` to make it better fit into Go naming conventions
@@ -44,6 +57,6 @@
 
 > Follow the [Upgrade Guide](https://time-ago.github.io/upgrade.html) from v2 to v3
 
-
 ## [Release Notes v2](.github/CHANGELOGV2.md)
+
 ## [Release Notes v1](.github/CHANGELOGV1.md)

Makefile

@@ -1,18 +1,33 @@
 .PHONY: test
 test:
-	go test -cover -timeout 10s ./...
-	go vet ./...
+	@clear || true
+	go test ./...
+	@echo "✅ All tests passed!"
 
 .PHONY: cover
 cover:
 	go test -coverprofile=coverage.out
 	go tool cover -html=coverage.out
 	rm coverage.out
 
-.PHONY: push
-push:
-	make test
-	git pull origin HEAD
-	git push origin HEAD
+.PHONY: fmt
+fmt:
+	@go fmt ./...
+	@echo "✅ Code formatted!"
+
+.PHONY: lint
+lint:
+	@golangci-lint run
+	@echo "✅ Linting passed!"
+
+.PHONY: todo
+todo:
+	@if grep -I --exclude="Makefile" --exclude-dir=".git" -r TODO .; then \
+		echo "❌ Found TODOs" >&2; \
+		exit 1; \
+	fi
+
+.PHONY: check
+check: test fmt lint todo
 
 .DEFAULT_GOAL := test

README.md

@@ -1,4 +1,4 @@
-![golang](https://serhii.io/storage/other/timeago.png)
+![golang](https://serhiicho.com/storage/other/timeago.png)
 
 [![Go](https://github.com/SerhiiCho/timeago/actions/workflows/go.yml/badge.svg)](https://github.com/SerhiiCho/timeago/actions/workflows/go.yml)
 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FSerhiiCho%2Ftimeago%2Fbadge%3Fref%3Dmaster&style=flat)](https://actions-badge.atrox.dev/SerhiiCho/timeago/goto?ref=master)
@@ -25,22 +25,36 @@ Here are some of the naming conventions used in the codebase and their meanings
 - **suffix** - the suffix `ago` in the final output like `1 minute ago`, `2 minutes ago`, `3 minutes ago`, etc.
 - **time since** - the final output result like `2 minutes`, `3 minutes ago`, `Just now`, `Online`, `3 years ago` etc.
 
+## Star History
+[![Star History Chart](https://api.star-history.com/svg?repos=SerhiiCho/timeago&type=Date)](https://www.star-history.com/#SerhiiCho/timeago&Date)
+
 ## License
 This project is open-sourced software licensed under the [MIT license](https://github.com/SerhiiCho/timeago/blob/master/LICENSE.md).
 
-## Development
-### Without Docker
-You'll need to have Go installed on your machine. Also, if you want to run Makefile commands, you'll need to have `make` installed as well.
+## Contribute
+### With Container Engine
+#### Build an Image
+To build an image, navigate to the root of the project and run this command.
+
+With Podman:
+```bash
+podman-compose build
+```
 
-### With Docker
-#### Build an image
-To build an image, navigate to the root of the project that contains `Dockerfile` and run this command:
+With Docker:
 ```bash
 docker compose build
 ```
 
-#### Run the container
-To run a container, navigate to the root of the project that contains `Dockerfile` and run this command to enter the Linux container with Go installed:
+#### Run the Container
+To run a container, navigate to the root of the project and run this command to enter the Linux container with Go installed.
+
+With Podman:
+```bash
+podman-compose run --rm app
+```
+
+With Docker:
 ```bash
 docker compose run --rm app
 ```

docker-compose.yml compose.ymldocker-compose.yml renamed to compose.yml

@@ -3,7 +3,6 @@ name: serhii-timeago
 services:
     app:
         image: serhii-timeago
-        build:
-            context: .
+        build: .
         volumes:
-            - .:/app
+            - .:/app:z

config_test.go

@@ -37,8 +37,8 @@ func TestIsLocationProvided(t *testing.T) {
 
 	for _, tc := range cases {
 		t.Run(tc.name, func(t *testing.T) {
-			c := NewConfig("en", tc.loc, []LangSet{}, 60, 60)
-			actual := c.isLocationProvided()
+			conf := NewConfig("en", tc.loc, []LangSet{}, 60, 60)
+			actual := conf.isLocationProvided()
 
 			if actual != tc.expect {
 				t.Fatalf("Expected %v, but got %v", tc.expect, actual)
@@ -92,7 +92,6 @@ func TestCustomTranslations(t *testing.T) {
 			})
 
 			date := utils.UnixFromPastDate(tc.time)
-
 			if res, _ := Parse(date); res != tc.expect {
 				t.Errorf("Result must be %q, but got %q instead", tc.expect, res)
 			}

langset.go

@@ -27,7 +27,6 @@ type LangSet struct {
 
 func newLangSet() (*LangSet, error) {
 	filePath := fmt.Sprintf("langs/%s.json", conf.Language)
-
 	if cache, ok := cachedJsonRes[filePath]; ok {
 		return cache, nil
 	}

option.go

@@ -26,19 +26,19 @@ const (
 	OptNoSuffix opt = "noSuffix"
 )
 
-func enableOption(o opt) {
-	options = append(options, o)
+func enableOption(opt opt) {
+	options = append(options, opt)
 }
 
 func enableOptions(opts []opt) {
-	for _, opt := range opts {
-		enableOption(opt)
+	for i := range opts {
+		enableOption(opts[i])
 	}
 }
 
-func optionIsEnabled(o opt) bool {
-	for _, option := range options {
-		if option == o {
+func optionIsEnabled(opt opt) bool {
+	for i := range options {
+		if options[i] == opt {
 			return true
 		}
 	}

rules.go

@@ -45,7 +45,6 @@ var grammarRules = func(num int) map[string]*Rule {
 
 func identifyGrammarRules(num int, lang string) (*Rule, error) {
 	rules := grammarRules(num)
-
 	if v, ok := rules[lang]; ok {
 		return v, nil
 	}
@@ -56,5 +55,5 @@ func identifyGrammarRules(num int, lang string) (*Rule, error) {
 		}
 	}
 
-	return nil, utils.Errorf("Language '" + lang + "' not found")
+	return nil, utils.Errorf("Language '%s' not found", lang)
 }

timeago.go

@@ -251,7 +251,6 @@ func findLangForms(timeInSec int) (LangForms, int) {
 		if nums.Months == 0 {
 			nums.Months = 1
 		}
-
 		return langSet.Month, nums.Months
 	}
 
@@ -262,7 +261,6 @@ func computeSuffix() string {
 	if optionIsEnabled(OptNoSuffix) || optionIsEnabled(OptUpcoming) {
 		return ""
 	}
-
 	return langSet.Ago
 }