jQuery DataTables API for Go with Gorm

Author: ZihxS

.editorconfig

@@ -0,0 +1,21 @@
+root = true
+
+[*]
+insert_final_newline = true
+charset = utf-8
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+[{Makefile,go.mod,go.sum,*.go,.gitmodules}]
+indent_style = tab
+indent_size = 4
+
+[*.md]
+indent_size = 2
+trim_trailing_whitespace = false
+
+eclint_indent_style = unset
+
+[Dockerfile]
+indent_size = 4

.gitignore

@@ -0,0 +1,25 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Muhammad Saleh Solahudin (m.saleh.solahudin@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,41 @@
+all: help
+
+lint:
+	@echo "Running linter..."
+	golangci-lint run ./
+
+test:
+	@echo "Running tests..."
+	go test ./ -gcflags=all=-l --race -v -short -coverprofile=coverage.out
+
+test-coverage:
+	@echo "Generating test coverage report..."
+	go test -coverprofile=coverage.out ./
+	@echo "Test coverage profile generated: coverage.out"
+	@echo "Use 'make view-coverage' to view the HTML report."
+
+view-coverage: test-coverage
+	@echo "Opening test coverage report in browser..."
+	go tool cover -html=coverage.out
+
+deps:
+	@echo "Installing dependencies..."
+	go mod tidy
+
+clean:
+	@echo "Cleaning up..."
+	rm -rf coverage.out
+
+help:
+	@echo "--------------------------------------------------------------"
+	@echo "Available targets:"
+	@echo "  deps            - Install dependencies (run 'go mod tidy')"
+	@echo "  lint            - Run linter (requires golangci-lint)"
+	@echo "  test            - Run tests with race detection and coverage"
+	@echo "  test-coverage   - Generate test coverage report"
+	@echo "  view-coverage   - Open test coverage report in browser"
+	@echo "  clean           - Remove generated files (coverage.out)"
+	@echo "  help            - Show this help message"
+	@echo "--------------------------------------------------------------"
+	@echo "Credits: Muhammad Saleh Solahudin <https://github.com/ZihxS>"
+	@echo "--------------------------------------------------------------"

README.md

@@ -0,0 +1,122 @@
+# jQuery DataTables API for Go with Gorm
+
+The golang-gorm-datatables package is a Go library which provides support for jQuery DataTables server-side processing using Gorm. It contains functions for generating SQL queries for filtering, sorting and pagination, as well as functions for counting the total and filtered records.
+
+## Requirements
+
+- Go 1.24 or higher
+- Gorm 1.26 or higher
+
+## Installation
+
+To install the Request package, run the following command:
+
+```bash
+go get github.com/ZihxS/golang-gorm-datatables
+```
+
+## Simple Usage
+
+```go
+package main
+
+import (
+  // ...
+
+  "github.com/ZihxS/golang-gorm-datatables" // [👉🏼 FOCUS HERE]
+
+  // ...
+)
+
+func main() {
+  // ...
+
+  type User struct {
+    ID   int
+    Name string
+    Age  int
+  }
+
+  // ...
+
+  // example using mux router
+  r.HandleFunc("/users", func(w http.ResponseWriter, r *http.Request) {
+    req, err := datatables.ParseRequest(r) // parse the request [👉🏼 FOCUS HERE]
+    if err != nil {
+      http.Error(w, fmt.Sprintf("Error processing request: %v", err), http.StatusInternalServerError)
+      return
+    }
+
+    tx := db.Model(&User{}) // gorm query [👉🏼 FOCUS HERE]
+    response, err := datatables.New(tx).Req(*req).Make() // make datatables [👉🏼 FOCUS HERE]
+    if err != nil {
+      http.Error(w, fmt.Sprintf("Error processing request: %v", err), http.StatusInternalServerError)
+      return
+    }
+
+    w.Header().Set("Content-Type", "application/json")
+    _ = json.NewEncoder(w).Encode(response)
+  })
+}
+
+// ...
+```
+
+## More Example & Documentation
+
+You can visit this link to see more example and documentation:
+- Documentation: ?
+- Example on Server Side: ?
+- Example on Client Side: ?
+
+## Contributing
+
+Contributions are welcome! If you'd like to contribute to the Request package, please follow these steps:
+
+1. Fork the repository to your own GitHub account.
+2. Clone the repository to your local machine.
+3. Run `make deps` to install dependencies.
+4. Make changes to the code, following the guidelines below.
+5. Run `make test` to ensure your changes pass the test suite.
+6. Run `make fmt` to ensure your code is formatted correctly.
+7. Run `make lint` to ensure your code lint is clean.
+8. Commit your changes with a meaningful commit message.
+9. Push your changes to your forked repository.
+10. Submit a pull request to the original repository.
+
+### Makefile Commands
+
+The Makefile provides several commands to help with development and testing:
+
+* `make deps`: Installs dependencies for the package.
+* `make test`: Runs the test suite for the package.
+* `make test-coverage`: Runs the test suite with code coverage analysis.
+* `make view-coverage`: Opens the test coverage report in your web browser.
+* `make fmt`: Formats the code according to the Go standard.
+* `make lint`: Runs the linter to check for coding style issues.
+* `make build`: Builds the package and its dependencies.
+* `make clean`: Removes any build artifacts and temporary files.
+
+### Guidelines
+
+When contributing to the Request package, please follow these guidelines:
+
+* Use the Go standard coding style.
+* Write comprehensive tests for any new functionality.
+* Keep commits small and focused on a single change.
+* Use meaningful commit messages that describe the change.
+
+## License
+
+The Request package is licensed under the MIT License.
+
+## Authors
+
+* [Muhammad Saleh Solahudin](https://github.com/ZihxS)
+
+## Contributors
+
+## Credits
+
+- [DataTables](https://datatables.net)
+- [Gorm](https://gorm.io)