Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrz1836/go-sanitize
:bathtub: Golang library of simple to use sanitation functions
https://github.com/mrz1836/go-sanitize
golang golang-package gomod gomodule sanitization sanitizer strings strings-manipulation
Last synced: 12 days ago
JSON representation
:bathtub: Golang library of simple to use sanitation functions
- Host: GitHub
- URL: https://github.com/mrz1836/go-sanitize
- Owner: mrz1836
- License: apache-2.0
- Created: 2018-12-01T19:38:15.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-23T20:52:27.000Z (about 1 month ago)
- Last Synced: 2025-01-16T22:06:56.256Z (19 days ago)
- Topics: golang, golang-package, gomod, gomodule, sanitization, sanitizer, strings, strings-manipulation
- Language: Go
- Homepage:
- Size: 298 KB
- Stars: 32
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# go-sanitize
> Simple library of sanitation methods for data sanitation and reduction
[](https://github.com/mrz1836/go-sanitize/releases)
[](https://github.com/mrz1836/go-sanitize/actions)
[](https://goreportcard.com/report/github.com/mrz1836/go-sanitize)
[](https://codecov.io/gh/mrz1836/go-sanitize)
[](https://golang.org/)
[](https://github.com/sponsors/mrz1836)
[](https://mrz1818.com/?tab=tips&utm_source=github&utm_medium=sponsor-link&utm_campaign=go-sanitize&utm_term=go-sanitize&utm_content=go-sanitize)
## Table of Contents
- [Installation](#installation)
- [Documentation](#documentation)
- [Examples & Tests](#examples--tests)
- [Benchmarks](#benchmarks)
- [Code Standards](#code-standards)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Installation
**go-sanitize** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```shell script
go get -u github.com/mrz1836/go-sanitize
```
## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/mrz1836/go-sanitize?tab=doc)
[](https://pkg.go.dev/github.com/mrz1836/go-sanitize?tab=doc)
Library Deployment
[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to GitHub and can be installed via: `brew install goreleaser`.
The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).
Use `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.
Makefile Commands
View all `makefile` commands
```shell script
make help
```
List of all current commands:
```text
all Runs multiple commands
clean Remove previous builds and any test cache data
clean-mods Remove all the Go mod cache
coverage Shows the test coverage
godocs Sync the latest tag with GoDocs
help Show this help message
install Install the application
install-go Install the application (Using Native Go)
lint Run the golangci-lint application (install if not found)
release Full production release (creates release in Github)
release Runs common.release then runs godocs
release-snap Test the full release (build binaries)
release-test Full production test release (everything except deploy)
replace-version Replaces the version in HTML/JS (pre-deploy)
tag Generate a new tag and push (tag version=0.0.0)
tag-remove Remove a tag if found (tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (tag-update version=0.0.0)
test Runs vet, lint and ALL tests
test-ci Runs all tests via CI (exports coverage)
test-ci-no-race Runs all tests via CI (no race) (exports coverage)
test-ci-short Runs unit tests via CI (exports coverage)
test-short Runs vet, lint and tests (excludes integration tests)
uninstall Uninstall the application (and remove files)
update-linter Update the golangci-lint package (macOS only)
vet Run the Go vet application
```
## Examples & Tests
All unit tests and [examples](examples) run via [GitHub Actions](https://github.com/mrz1836/go-sanitize/actions) and
uses [Go version 1.18.x](https://golang.org/doc/go1.18). View the [configuration file](.github/workflows/run-tests.yml).
Run all tests (including any integration tests)
```shell script
make test
```
## Benchmarks
Run the Go [benchmarks](sanitize_test.go):
```shell script
make bench
```
## Code Standards
Read more about this Go project's [code standards](.github/CODE_STANDARDS.md).
## Usage
- View the [examples](examples)
- View the [benchmarks](sanitize_test.go)
- View the [tests](sanitize_test.go)
## Maintainers
| [
](https://github.com/mrz1836) |
|:------------------------------------------------------------------------------------------------:|
| [MrZ](https://github.com/mrz1836) |
## Contributing
View the [contributing guidelines](.github/CONTRIBUTING.md) and please follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
### How can I help?
All kinds of contributions are welcome :raised_hands:!
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:.
You can also support this project by [becoming a sponsor on GitHub](https://github.com/sponsors/mrz1836) :clap:
or by making a [**bitcoin donation**](https://mrz1818.com/?tab=tips&utm_source=github&utm_medium=sponsor-link&utm_campaign=go-sanitize&utm_term=go-sanitize&utm_content=go-sanitize) to ensure this journey continues indefinitely! :rocket:
## License
[](LICENSE)