{"id":19359775,"url":"https://github.com/codacy/codacy-gorevive","last_synced_at":"2025-04-23T11:32:56.934Z","repository":{"id":38360915,"uuid":"231628819","full_name":"codacy/codacy-gorevive","owner":"codacy","description":"Codacy Tool for Golang Revive","archived":false,"fork":false,"pushed_at":"2025-04-16T22:57:09.000Z","size":3995,"stargazers_count":3,"open_issues_count":2,"forks_count":1,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-20T11:43:53.965Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codacy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-03T16:53:48.000Z","updated_at":"2025-03-18T15:11:19.000Z","dependencies_parsed_at":"2023-01-31T22:00:44.002Z","dependency_job_id":"e558165c-d24b-42dc-ab21-1b4db645d029","html_url":"https://github.com/codacy/codacy-gorevive","commit_stats":null,"previous_names":[],"tags_count":60,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-gorevive","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-gorevive/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-gorevive/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-gorevive/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codacy","download_url":"https://codeload.github.com/codacy/codacy-gorevive/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250425593,"owners_count":21428584,"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":[],"created_at":"2024-11-10T07:16:06.526Z","updated_at":"2025-04-23T11:32:56.382Z","avatar_url":"https://github.com/codacy.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Codacy Revive\n\nCodacy tool to add support for [revive](https://github.com/mgechev/revive).\n\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/eac3dec12b244a1390f1f414246d0d6d)](https://app.codacy.com/gh/codacy/codacy-gorevive/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n[![CircleCI](https://circleci.com/gh/codacy/codacy-gorevive.svg?style=svg)](https://circleci.com/gh/codacy/codacy-gorevive)\n\n# Usage\n\nYou can create the docker by doing:\n\n```bash\nmake docker\n```\n\nThe docker is ran with the following command:\n\n```bash\ndocker run -it -v $srcDir:/src \u003cDOCKER_NAME\u003e:\u003cDOCKER_VERSION\u003e\n```\n\nTo run the tool using a custom configuration file, run docker with the following command:\n\n```bash\ndocker run -it -v $srcDir:/src -v $codacyrcConfig:/.codacyrc \u003cDOCKER_NAME\u003e:\u003cDOCKER_VERSION\u003e\n```\n\n## Tool Developer Documentation\n\n[Tool Developer Guide](https://support.codacy.com/hc/en-us/articles/207994725-Tool-Developer-Guide)\n\n\n[Tool Developer Guide - Using Scala](https://support.codacy.com/hc/en-us/articles/207280379-Tool-Developer-Guide-Using-Scala)\n\n\n## Structure\n\n-   To run the tool we provide the configuration file, `/.codacyrc`, with the language to run and optional parameters your tool might need.\n-   The source code to be analysed will be located in `/src`, meaning that when provided in the configuration, the file paths are relative to `/src`.\n\nCheck more information [here](https://github.com/codacy/codacy-example-tool#structure)\n\n#### Tool documentation\n\nAt Codacy we strive to provide the best value to our users and, to accomplish that, we document our patterns so that the user can better understand the problem and fix it.\n\nThe documentation for the tool must always be updated before submitting the docker.\n\nTo get more information on the tool documentation, check [here](https://github.com/codacy/codacy-example-tool#tool-documentation)\n\n#### Generate documentation\n\nThis documentation should be generated automatically by using the Documentation Generator tool:\n\n```bash\nmake build-docs\n```\n\n#### Bumping the version\n-   update the .tool_version file with the latest revive version\n-   upgrade dependencies\n ```bash\n  go get -u -t\n  go install\n  go fix\n  go mod tidy\n ```\n-   generate documentation\n-   if rules change add/edit related parameters in `toolparameters/parameter.go`.\n\n##### Common errors\n###### missing go.sum entry for module providing package\n```bash\ngo mod tidy\n```\n###### zsyscall_darwin_arm64 (Apple m1)\n```bash\ngo get -u golang.org/x/sys\n```\n###### \"pandoc\": executable file not found in $PATH\n```bash\nbrew install pandoc\n```\n\n#### Test\n\nFollow the instructions at [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test).\n\n\n## What is Codacy\n\n[Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors\nyour technical debt, helps you improve your code quality, teaches best practices\nto your developers, and helps you save time in Code Reviews.\n\n### Among Codacy’s features\n\n-   Identify new Static Analysis issues\n-   Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)\n-   Auto-comments on Commits and Pull Requests\n-   Integrations with Slack, HipChat, Jira, YouTrack\n-   Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories\n\nCodacy also helps keep track of Code Coverage, Code Duplication, and Code\nComplexity.\n\nCodacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.\n\n### Free for Open Source\n\nCodacy is free for Open Source projects.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodacy%2Fcodacy-gorevive","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodacy%2Fcodacy-gorevive","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodacy%2Fcodacy-gorevive/lists"}