diff --git a/README.md b/README.md index 64f9d3b..c7c1361 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,10 @@ Whether your test outputs format, Utsukushii helps you present your results with ## 🚀 Features +- **Dev mode**: Run test from UI ! - **JUnit Format Support**: Convert JUnit outputs into a unified, beautiful report. - **Dotnet trx logger Support**: Convert dotnet trx logger report into a unified, beautiful report. - **Go-Test Format Support**: Convert Go test outputs into a unified, beautiful report. -- **Dev modes**: Run tests and look at their result in 1 command - **Merge reports**: Union multiple reports into single. ## 📥 Installation @@ -26,24 +26,36 @@ go install github.com/yurvon-screamo/utsukushii@latest ## 📚 Usage -### Golang dev +### Dev mode -Run test, gen content and serve: +![dev_mode](dev_mode.png) -```bash -go test -v --json ./... | utsukushii go-dev -``` +1) Create config file `utsukushii-dev.yaml`: -### Dotnet dev + ```yaml + # Required part + # The command to run the tests + cmd: go test -v --json ./... + # Your solution language, oneof - 'go', '.net' + lang: go -Run test, gen content and serve: + # Optional part + # title: my report title + # coverage: 46 + # addr: ':8080' + # ignore_open: true + ``` -```bash -dotnet test --logger trx | utsukushii dotnet-dev -``` +2) Start it: + + ```bash + utsukushii dev + ``` ### Generate and Serve Reports +![gen_serve](gen_serve.png) + 1. **Generate Content**: ```bash @@ -56,6 +68,12 @@ dotnet test --logger trx | utsukushii dotnet-dev utsukushii serve --content my-utsukushii.json ``` +Support: + +- go test json +- dotnet test trx +- junit reports + By default, the report is served at `http://localhost:8080`. ## 🛠️ Development and Design Goals diff --git a/dev_mode.png b/dev_mode.png new file mode 100644 index 0000000..35ff1df Binary files /dev/null and b/dev_mode.png differ diff --git a/gen_serve.png b/gen_serve.png new file mode 100644 index 0000000..6aebb69 Binary files /dev/null and b/gen_serve.png differ diff --git a/utsukushii-dev.yaml b/utsukushii-dev.yaml index 18b7962..b3f7a21 100644 --- a/utsukushii-dev.yaml +++ b/utsukushii-dev.yaml @@ -1,2 +1,11 @@ +# Required part +# The command to run the tests cmd: go test -v --json ./... +# Your solution language, oneof - 'go', '.net' lang: go + +# Optional part +# title: my report title +# coverage: 46 +# addr: ':8080' +# ignore_open: true