{"id":16805445,"url":"https://github.com/dewski/vscode-simplecov","last_synced_at":"2025-03-23T15:31:22.013Z","repository":{"id":216022375,"uuid":"740260080","full_name":"dewski/vscode-simplecov","owner":"dewski","description":"Code coverage highlighter \u0026 statistics for Ruby projects using SimpleCov.","archived":false,"fork":false,"pushed_at":"2024-11-01T18:58:38.000Z","size":1027,"stargazers_count":5,"open_issues_count":5,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-02T01:55:26.823Z","etag":null,"topics":["simplecov","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=dewski.simplecov","language":"TypeScript","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/dewski.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2024-01-08T00:58:25.000Z","updated_at":"2024-11-26T10:52:43.000Z","dependencies_parsed_at":"2024-07-16T08:18:04.403Z","dependency_job_id":"2f620212-f77c-4496-a0ed-5e4ded081b01","html_url":"https://github.com/dewski/vscode-simplecov","commit_stats":null,"previous_names":["dewski/vscode-simplecov"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dewski%2Fvscode-simplecov","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dewski%2Fvscode-simplecov/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dewski%2Fvscode-simplecov/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dewski%2Fvscode-simplecov/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dewski","download_url":"https://codeload.github.com/dewski/vscode-simplecov/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244312807,"owners_count":20432970,"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":["simplecov","vscode-extension"],"created_at":"2024-10-13T09:48:14.868Z","updated_at":"2025-03-23T15:31:22.004Z","avatar_url":"https://github.com/dewski.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SimpleCov - VS Code Coverage Highlighter\n\nThis extension provides a way to view your test coverage inline while in VS Code. After generating your test coverage report with SimpleCov, VS Code SimpleCov will parse the report and display the coverage inline in your editor:\n\n![Editor](./images/editor.png)\n\nThe coverage is also displayed as a percentage in the editor's status bar:\n\n![Status Bar Item](./images/status-bar-item.png)\n\n\u003e [!IMPORTANT]\n\u003e Initially ported from \u0026 heavily inspired by [vscode-go](https://github.com/golang/vscode-go) which I believe provides the best experience for viewing test coverage inline.\n\n## Features\n\n- View your test coverage inline while in VS Code.\n- View your test coverage in the editor's gutter.\n- View your test coverage percentage in the editor's status bar.\n- SimpleCov's [Branch coverage](https://github.com/simplecov-ruby/simplecov?tab=readme-ov-file#branch-coverage-ruby--25) is supported.\n\n## Configuration options\n\n- `simplecov.coverShowCounts`: When generating code coverage, should hit \u0026 branch coverage counts be shown inline. Defaults to `false`.\n- `simplecov.coverageOptions`: Use these options to control whether only covered or only uncovered code or both should be highlighted after generating a coverage report. Defaults to `showBothCoveredAndUncoveredCode`.\n- `simplecov.coverageDirectory`: The path to the coverage directory. This is relative to the workspace root. Defaults to `coverage`.\n- `simplecov.coverageDecorator`: This option lets you style the way code coverage is displayed. Choose either to highlight the complete line or to show an indicator in the gutter.\n  - `type`: Choose between `highlight` and `gutter`. Defaults to `highlight`.\n  - `coveredHighlightColor`: The highlight color to use for highlighting covered code.\n  - `coveredGutterStyle`: The style to use for the gutter indicator for covered code.\n  - `uncoveredHighlightColor`: The highlight color to use for highlighting uncovered code.\n  - `uncoveredGutterStyle`: The style to use for the gutter indicator for uncovered code.\n  - `uncoveredBranchHighlightColor`: The highlight color to use for highlighting uncovered branches.\n  - `uncoveredBranchGutterStyle`: The style to use for the gutter indicator for uncovered branches.\n\n## Commands\n\n- `simplecov.coverage.toggle`: Toggle the display of code coverage.\n- `simplecov.coverage.apply`: Apply the coverage to the currently active file.\n- `simplecov.coverage.remove`: Remove the coverage from the currently active file.\n\n## Requirements\n\nThis VS Code extension requires that your Ruby project uses [SimpleCov](https://github.com/simplecov-ruby/simplecov) to generate your test coverage report.\n\nIf you are conditionally running SimpleCov, you will need to ensure that it is always run when VS Code is running.\n\n```ruby\nrequire \"simplecov\"\n\nif ENV[\"CI\"].present? || ENV[\"COVERAGE\"].present? || ENV[\"REMOTE_CONTAINERS\"].present?\n  SimpleCov.start \"rails\" do\n    enable_coverage :branch\n    add_group \"Components\", \"app/components\"\n    add_group \"Mailboxes\", \"app/mailboxes\"\n  end\nend\n```\n\nThe extension will look for the SimpleCov profile at the following locations (and in this order):\n\n- `coverage/.resultset.json`\n- `coverage/coverage.json`\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdewski%2Fvscode-simplecov","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdewski%2Fvscode-simplecov","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdewski%2Fvscode-simplecov/lists"}