chore: prepare comparator as a stdlib-only open-source Go library - #1
Merged
Merged
Conversation
Drop the github.com/aizon-shared/ds-utils/pkg/testutils import so the module depends only on the Go standard library, replacing its single use with clearly-marked inline test values. Modernize the benchmarks to the Go 1.24+ `for b.Loop()` form, which also removes the redundant b.ResetTimer() calls. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Match the conventional single doc.go filename used by idiomatic Go libraries for package-level documentation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add runnable Example functions covering Equal, DeepEqual, GetJSONPatch, GetUnifiedDiff, GetVisualDiff, FormatDiff, and the configuration options (float precision, field/unexported ignoring, empty/NaN equality, custom comparators, and time layout). All render on pkg.go.dev and are verified by `go test`. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Rewrite the README with CI/reference/report/license/release badges, emoji section headers, `go get` install/update instructions, and the correct github.com/slashdevops/comparator module path. Add a docs/ folder with getting-started, configuration, diffing, output-formats, json-patch, custom-comparators, performance, and FAQ guides, all linked from the README. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add the standard scaffolding for a public Go library: Apache-2.0 LICENSE, SECURITY.md, .gitignore, golangci-lint config, editor settings, and GitHub metadata (Dependabot, release notes, copilot instructions). Add GitHub Actions for main, pull requests, tagged releases, and CodeQL security analysis. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool. What Enabling Code Scanning Means:
For more information about GitHub Code Scanning, check out the documentation. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Prepares
comparatorto be published as a proper open-source Go library, modeled on the structure ofslashdevops/e5t. The library targets Go 1.26 and now depends on the Go standard library only — no third-party modules.Changes
🧹 Stdlib-only + best practices
github.com/aizon-shared/ds-utils/pkg/testutilsdependency (its single use is replaced with clearly-marked inline test values). Verified withgo list -deps— zero external dependencies.for b.Loop()form, dropping redundantb.ResetTimer()calls.any, small focused funcs, documented API).📖 Documentation
docs.go→doc.go(conventional package-doc filename).README.md: CI / Go Reference / Go Report Card / license / release badges, emoji section headers,go getinstall & update instructions, correctgithub.com/slashdevops/comparatormodule path, and links into the docs.docs/folder: getting-started, configuration, diffing, output-formats, json-patch, custom-comparators, performance, and FAQ.Examplefunctions for the options and package-level API (comparator_options_examples_test.go), all verified bygo test.⚙️ Open-source scaffolding & CI/CD
LICENSE,SECURITY.md,.gitignore,.golangci.yaml,.vscode/settings.json..github/metadata: Dependabot, release-notes config, Copilot instructions, CodeQL config.main.yml,pr.yml,release.yml, andcodeql.yml.Verification
🤖 Generated with Claude Code