{"id":15935850,"url":"https://github.com/qawatake/dwrap","last_synced_at":"2025-04-03T19:28:44.156Z","repository":{"id":202734707,"uuid":"707970847","full_name":"qawatake/dwrap","owner":"qawatake","description":"Linter: dwrap forces every public function to begin with an deferring call of a error wrapping function like derrors.Wrap.","archived":false,"fork":false,"pushed_at":"2023-10-29T04:38:01.000Z","size":49,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-09T07:41:13.532Z","etag":null,"topics":["go","golang","linter","staticanalysis"],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/github.com/qawatake/dwrap","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qawatake.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-10-21T06:08:28.000Z","updated_at":"2023-10-28T04:26:29.000Z","dependencies_parsed_at":"2024-10-29T12:21:14.891Z","dependency_job_id":null,"html_url":"https://github.com/qawatake/dwrap","commit_stats":{"total_commits":37,"total_committers":1,"mean_commits":37.0,"dds":0.0,"last_synced_commit":"a447e2d35e100e23719694c3102a1de73a228ee9"},"previous_names":["qawatake/derrfirst","qawatake/dwrap"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qawatake%2Fdwrap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qawatake%2Fdwrap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qawatake%2Fdwrap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qawatake%2Fdwrap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qawatake","download_url":"https://codeload.github.com/qawatake/dwrap/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247064616,"owners_count":20877624,"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":["go","golang","linter","staticanalysis"],"created_at":"2024-10-07T04:02:28.641Z","updated_at":"2025-04-03T19:28:44.136Z","avatar_url":"https://github.com/qawatake.png","language":"Go","readme":"# dwrap\n\n[![Go Reference](https://pkg.go.dev/badge/github.com/qawatake/dwrap.svg)](https://pkg.go.dev/github.com/qawatake/dwrap)\n[![test](https://github.com/qawatake/dwrap/actions/workflows/test.yaml/badge.svg)](https://github.com/qawatake/dwrap/actions/workflows/test.yaml)\n[![codecov](https://codecov.io/gh/qawatake/dwrap/graph/badge.svg?token=er2K6likVZ)](https://codecov.io/gh/qawatake/dwrap)\n\nLinter `dwrap` forces every public function to begin with a deferring call of an error wrapping function like [derrors.Wrap](https://github.com/golang/pkgsite/blob/5f0513d53cff8382238b5f8c78e8317d2b4ad06d/internal/derrors/derrors.go#L240).\nBy using `dwrap`, you can prevent functions from returning without wrapping errors.\n\n```go\nfunc Good() (err error) {\n  defer derrors.Wrap(\u0026err, \"Good\")\n  doStuff()\n  return nil\n}\n\nfunc Bad() error { // \u003c-  should call defer derrors.Wrap fist.\n  doOtherStuff()\n  return nil\n}\n\n//lint:ignore dwrap this is because ...\nfunc Ignored() error {\n  doOtherStuff()\n  return nil\n}\n```\n\n## How to use\n\nBuild your `dwrap` binary by writing `main.go` like below.\n\n```go\npackage main\n\nimport (\n  \"github.com/qawatake/dwrap\"\n  \"golang.org/x/tools/go/analysis/unitchecker\"\n)\n\nfunc main() {\n  unitchecker.Main(\n    dwrap.NewAnalyzer(\"your/derrors/pkg\", \"Wrap\"),\n  )\n}\n```\n\nThen, run `go vet` with your `dwrap` binary.\n\n```sh\ngo vet -vettool=/path/to/your/dwrap ./...\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqawatake%2Fdwrap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqawatake%2Fdwrap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqawatake%2Fdwrap/lists"}