{"id":22148372,"url":"https://github.com/dburriss/hotspot","last_synced_at":"2025-10-12T14:32:04.106Z","repository":{"id":53798449,"uuid":"305460494","full_name":"dburriss/hotspot","owner":"dburriss","description":"A dotnet command-line tool for analysing code risks like high complexity, size, and bus factor.","archived":false,"fork":false,"pushed_at":"2021-03-30T06:16:12.000Z","size":3119,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-23T10:03:33.863Z","etag":null,"topics":["analysis","command-line-tool","complexity","dotnet"],"latest_commit_sha":null,"homepage":"","language":"F#","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/dburriss.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-19T17:22:03.000Z","updated_at":"2021-03-13T14:01:56.000Z","dependencies_parsed_at":"2022-08-28T08:41:29.991Z","dependency_job_id":null,"html_url":"https://github.com/dburriss/hotspot","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dburriss%2Fhotspot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dburriss%2Fhotspot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dburriss%2Fhotspot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dburriss%2Fhotspot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dburriss","download_url":"https://codeload.github.com/dburriss/hotspot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236229819,"owners_count":19115710,"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":["analysis","command-line-tool","complexity","dotnet"],"created_at":"2024-12-01T23:27:25.293Z","updated_at":"2025-10-12T14:31:59.075Z","avatar_url":"https://github.com/dburriss.png","language":"F#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hotspot\n\nHotspot is a CLI tool for inspecting source code in a git repository for possible hotpots you may want to look into to decrease maintenance and potential risk.  \n\n![Run of hotspot recommend](/docs/static/images/recommend-run1.png)\n\nSupport of multiple languages\n\n## Installation\n\nPrerequisite: [dotnet sdk](https://dotnet.microsoft.com/download)\n\n`dotnet tool install -g hotspot`\n\n## Basic Usage\n\nNavigate to your git repository and run:  \n`hotspot recommend`\n\nFor help, run:  \n`hotspot --help`\n\nYou can also install it locally. See the [dotnet tool docs](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install)\n\nSometimes Hotspot will have some trouble finding your git binary. It needs access to this to run the commands on your git repository to get history to inspect.\nThis is easy enough to fix. Just add an ENVIRONMENT variable: `HOTSPOT_GIT_EXECUTABLE` = *path/to/git/binary/file*.\n\n## Features\n\n- [x] Recommendations based on git changes \u0026 complexity\n- [x] Consumption of [SCC](https://github.com/boyter/scc) to contribute metrics for analysis\n- [ ] Integrate test coverage report in analysis\n- [ ] Detailed control of the files that are included in the analysis\n- [ ] Multiple supported output channels (console, API?, file) and formats (text, markdown, html, json)\n- [ ] Multiple metric sources: SCC, Visual Studio's Metric.exe, SonarQube\n\n## Using SCC\n\n[SCC](https://github.com/boyter/scc) is an awesome cli tool for getting info like LoC and cyclomatic complexity for many different code programming languages.\nYou can use it as follows to generate a file that can then be used by Hotspot.\n\n`scc --by-file --format json \u003e scc_out.json`\n### Usage\n\n`dotnet hotspot recommend -r /GitRepo --scc-file /scc_out.json`\n## Language support\n\nIf using SCC, all [languages supported by SCC](https://github.com/boyter/scc/blob/master/LANGUAGES.md) are supported. If an SCC file is not used, Hotspot will count lines of code, attempting to ignore comments. The comment ignore is currently very rudimentary. See [Limitations](/limitations.html) for a more in-depth description.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdburriss%2Fhotspot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdburriss%2Fhotspot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdburriss%2Fhotspot/lists"}