Skip to content

Update Readme/Docs on how to setup Java #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update Readme/Docs on how to setup Java #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb55315
Update README.md to include java instructions
Cypressxyx Feb 20, 2025
9771112
Update with hava instructions
Cypressxyx Feb 20, 2025
fc06025
Merge remote-tracking branch 'origin/patch-1'
Cypressxyx Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Branch (partial) coverage support:
| C# | :x: |
| Dart | :heavy_check_mark: (untested) |
| Go | :x: |
| Java | :heavy_check_mark: |
| Javascript/Typescript | :heavy_check_mark: |
| Julia | :heavy_check_mark: (untested) |
| Python | :heavy_check_mark: |
Expand Down Expand Up @@ -89,6 +90,25 @@ Using lazyvim:
},
```

### Using Java
In order to use the java coverage file, please ensure you include "nvim-neotest/neotest" as a dependency
i.e
```
{
"andythigpen/nvim-coverage",
dependencies = {
"nvim-neotest/neotest".
},
version = "*",
config = function()
require("coverage").setup({
auto_reload = true,
})
end,
},
```


## Configuration

See [docs](https://github.com/andythigpen/nvim-coverage/blob/main/doc/nvim-coverage.txt) for more info.
Expand Down
9 changes: 9 additions & 0 deletions doc/nvim-coverage.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,15 @@ Go supports the following configuration options:
coverage_file: ~
File that the plugin will try to read coverage from.
Defaults to: `"coverage.out"`
*nvim-coverage-java*
Go supports the following configuration options:

coverage_file: ~
File that the plugin will try to read coverage from.
Defaults to: `"build/reports/jacoco/test/jacocoTestReport.xml"`
dir_prefix: ~
Java files directory prefix.
Defaults to: `"src/main/java"`

*nvim-coverage-javascript*
*nvim-coverage-typescript*
Expand Down