{"id":36444896,"url":"https://github.com/iimos/go-check-err-chains","last_synced_at":"2026-01-11T22:04:04.169Z","repository":{"id":136888427,"uuid":"365036634","full_name":"iimos/go-check-err-chains","owner":"iimos","description":"Go linter that checks that the error text contains a prefix indicating the package/function/method where the error occurred","archived":false,"fork":false,"pushed_at":"2024-01-28T15:16:11.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-06-20T15:00:38.683Z","etag":null,"topics":["error","go","go-error-handling","go-errors","go-linter","golang","linter","logging"],"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/iimos.png","metadata":{"files":{"readme":"README-ru.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}},"created_at":"2021-05-06T21:02:41.000Z","updated_at":"2024-01-28T15:35:26.000Z","dependencies_parsed_at":"2024-01-06T16:35:27.152Z","dependency_job_id":"77a9bb49-005a-47e0-91f0-119f97a4ff5f","html_url":"https://github.com/iimos/go-check-err-chains","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/iimos/go-check-err-chains","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iimos%2Fgo-check-err-chains","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iimos%2Fgo-check-err-chains/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iimos%2Fgo-check-err-chains/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iimos%2Fgo-check-err-chains/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iimos","download_url":"https://codeload.github.com/iimos/go-check-err-chains/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iimos%2Fgo-check-err-chains/sbom","scorecard":{"id":483297,"data":{"date":"2025-08-11","repo":{"name":"github.com/iimos/go-check-err-chains","commit":"687c20533675e867af07560bd015967476993049"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/6 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/go.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/iimos/go-check-err-chains/go.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/go.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/iimos/go-check-err-chains/go.yml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/go.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T17:09:37.998Z","repository_id":136888427,"created_at":"2025-08-19T17:09:37.998Z","updated_at":"2025-08-19T17:09:37.998Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28324855,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T18:42:50.174Z","status":"ssl_error","status_checked_at":"2026-01-11T18:39:13.842Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["error","go","go-error-handling","go-errors","go-linter","golang","linter","logging"],"created_at":"2026-01-11T22:04:04.096Z","updated_at":"2026-01-11T22:04:04.159Z","avatar_url":"https://github.com/iimos.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# go-check-err-chains\n\nЛинтер проверяет что текст ошибок содержит префикс указывающий на пакет/функцию/метод в котором произошла ошибка.\n\nПроверка проводится только для экспортируемых функций.\n\nПример:\n```go\npackage pkg\n\nfunc Get(key string) error {\n    id, err := strconv.Atoi(key)\n    if err != nil {\n        return errors.New(\"pkg.Get: %w; key=%s\", err, key) // good\n    }\n    if empty {\n        return sql.ErrNoRows // bad\n    }\n    return nil\n}\n```\n\n\n## Зачем\n\nЭтот линтер – попытка навести порядок влогах.\n\nПо логам часто не понятно где произошла проблема.\n\nУ этой проблемы уже есть есть пара решений, но все имеют существенные недостатки:\n\n1. Использовать логер снабжающий записи указанием на файл и строку где лог был написан.\n\n    Файл и номер строки логер указать может, но это будет место где вызвали log.Error, \n    а не место в котором произошла ошибка.\n    \n    Это значит что ошибки нужно логировать прямо там где они произошли.\n    В итоге логи начинают писать повсюду и с большой избыточностью.\n\n    Одна ошибка генерирует несколько похожих сообщений про одну и ту же ошибку \n    и в каждом сообщении немного свой контекст и чтобы увидеть полный контекст \n    необходимо собрать все эти записи.\n\n2. Использовать для ошибок сторонние библиотеки типа [pkg/errors](https://github.com/pkg/errors)\n\n    Есть множество библиотек которые сохраянют стек вызовов при создания ошибки.\n\n    Это не плохой подход, но есть ряд минусов:\n    - повсюду нужно использовать одну определенную библиотеку для ошибок\n    - плохо сочетается с нативным [врапингом через %w](https://go.dev/blog/go1.13-errors)\n\n\nНа данный момент оптимальным компромисом кажется идти идиоматическим путем принятым \nв стандартной библиотеке:\n\nПримеры ошибок из стандартной библиотеки:\n- strconv.Atoi: parsing \"x\": invalid syntax\n- plugin.Open(\"file.so\"): realpath failed\n- bytes.Buffer: too large\n- open file.go: no such file or directory\n- strings.Builder.Grow: negative count\n\nВидно что строгой схемы нет, но паттерн прослеживается: вначале имя пакета/метода/функции, затем двоеточие и далее подробности.\n\n```go\npackage pkg\n\nfunc Get(key string) error {\n    id, err := strconv.Atoi(key)\n    if err != nil {\n        return errors.New(\"pkg.Get: %w; key=%s\", err, key)\n    }\n    // ...\n}\n```\n\n`pkg.Get(\"abc\")` дает ошибку: \n```\npkg.Get: strconv.Atoi: parsing \"abc\": invalid syntax; key=abc\n```\n\nУ такого подхода ряд плюсов:\n\n- Хорошо стыкуется с ошибками стандартной библиотеки\n\n- Дружит с врапингом\n\n- Писать текст ошибки проще:\n\n  `failed to get package cause key abc is not valid ...` vs `pkg.Get: strconv.Atoi: parsing \"abc\": invalid syntax`.\n  \n  Второй вариант инженеру проще и читать и писать.\n\n- Логи удобно грепать\n\n\nА главный минус подхода в том что нужно следить за согласованностью имени пакета/функции \nи текста ошибок/логов, ведь при переименовании функции нужно не забыть поменять \nвсе ошибки/логи. \n\nИменнно эту проблему и решает этот линтер.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiimos%2Fgo-check-err-chains","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiimos%2Fgo-check-err-chains","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiimos%2Fgo-check-err-chains/lists"}