{"id":17173550,"url":"https://github.com/fsamin/go-dump","last_synced_at":"2025-04-11T18:07:56.747Z","repository":{"id":17373745,"uuid":"81717845","full_name":"fsamin/go-dump","owner":"fsamin","description":"Go-Dump is a Golang package which helps you to dump a struct.","archived":false,"fork":false,"pushed_at":"2024-04-22T06:24:04.000Z","size":166,"stargazers_count":35,"open_issues_count":2,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-11T18:07:33.595Z","etag":null,"topics":["formatter","go","golang","testing","tests"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fsamin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-12T10:18:34.000Z","updated_at":"2024-11-20T15:07:12.000Z","dependencies_parsed_at":"2024-03-04T15:30:33.345Z","dependency_job_id":"3494ee5f-5d5f-4202-a16e-0e9ebb614527","html_url":"https://github.com/fsamin/go-dump","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fsamin%2Fgo-dump","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fsamin%2Fgo-dump/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fsamin%2Fgo-dump/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fsamin%2Fgo-dump/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fsamin","download_url":"https://codeload.github.com/fsamin/go-dump/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248456369,"owners_count":21106603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["formatter","go","golang","testing","tests"],"created_at":"2024-10-14T23:51:45.753Z","updated_at":"2025-04-11T18:07:56.713Z","avatar_url":"https://github.com/fsamin.png","language":"Go","funding_links":[],"categories":["Utilities"],"sub_categories":["HTTP Clients"],"readme":"# Go-Dump\n\nGo-Dump is a package which helps you to dump a struct to `SdtOut`, any `io.Writer`, or a `map[string]string`.\n\n[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/fsamin/go-dump)\n\n## Sample usage\n\n````golang\ntype T struct {\n    A int\n    B string\n}\n\na := T{23, \"foo bar\"}\n\ndump.Fdump(out, a)\n````\n\nWill print\n\n````bash\nT.A: 23\nT.B: foo bar\n````\n\n## Usage with a map\n\n```golang\ntype T struct {\n    A int\n    B string\n}\n\na := T{23, \"foo bar\"}\n\nm, _ := dump.ToMap(a)\n```\n\nWill return such a map:\n\n| KEY           | Value         |\n| ------------- | ------------- |\n| T.A           | 23            |\n| T.B           | foo bar       |\n\n## Formatting keys\n\n```golang\n    dump.ToMap(a, dump.WithDefaultLowerCaseFormatter())\n```\n\n## Using go-dump to manage environment variables and using spf13/viper\n```golang\n    \n    type MyStruct struct {\n        A string\n        B struct {\n            InsideB string\n        }\n    }\n\n    var myStruct MyStruct\n    myStruct.A = \"value A\"\n    myStruct.B.InsideB = \"value B\"\n    \n\n    dumper := dump.NewDefaultEncoder()\n    dumper.DisableTypePrefix = true\n    dumper.Separator = \"_\"\n    dumper.Prefix = \"MYSTRUCT\"\n    dumper.Formatters = []dump.KeyFormatterFunc{dump.WithDefaultUpperCaseFormatter()}\n\n    envs, _ := dumper.ToStringMap(\u0026myStruct) // envs is the map of the dumped MyStruct \n```\n\nWill return such a map:\n\n| KEY                    | Value         |\n| ---------------------- | ------------- |\n| MYSTRUCT_A             | value A       |\n| MYSTRUCT_B_INSIDEB     | value B       |\n\nThe environement variables can be handled by **viper** [spf13/viper](https://github.com/spf13/viper).\n\n```golang\n    ...\n    for k := range envs {\n        viper.BindEnv(dumper.ViperKey(k), k)\n    }\n    \n    ...\n\n    viperSettings := viper.AllSettings()\n    for k, v := range viperSettings {\n        fmt.Println(k, v)\n    }\n    ...\n```\n\n## More examples\n\nSee [unit tests](dump_test.go) for more examples.\n\n## Dependencies\n\nGo-Dump needs Go \u003e= 1.8\n\nNo external dependencies :)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffsamin%2Fgo-dump","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffsamin%2Fgo-dump","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffsamin%2Fgo-dump/lists"}