Merge pull request #20 from nao1215/feat/coverage-tree

Introduce coverage tree

Author: nao1215

.gitignore

@@ -19,7 +19,7 @@
 
 # Go workspace file
 go.work
-cover.*
+/cover.*
 data
 localstack
 /s3hub

CHANGELOG.md

@@ -1,5 +1,8 @@
-## [](https://github.com/nao1215/rainbow/compare/77bdf974281a...) (2024-01-01)
+## [](https://github.com/nao1215/rainbow/compare/77bdf974281a...) (2024-01-03)
 
+* Add s3hub cp sub command [#16](https://github.com/nao1215/rainbow/pull/16) ([nao1215](https://github.com/nao1215))
+* Add feature that list up S3 Objects [#15](https://github.com/nao1215/rainbow/pull/15) ([nao1215](https://github.com/nao1215))
+* Add specification document for cfn command [#14](https://github.com/nao1215/rainbow/pull/14) ([nao1215](https://github.com/nao1215))
 * Introduce spare command [#13](https://github.com/nao1215/rainbow/pull/13) ([nao1215](https://github.com/nao1215))
 * build(deps): bump golang.org/x/sync from 0.1.0 to 0.5.0 [#12](https://github.com/nao1215/rainbow/pull/12) ([dependabot[bot]](https://github.com/apps/dependabot))
 * Update document for s3hub with gif image [#11](https://github.com/nao1215/rainbow/pull/11) ([nao1215](https://github.com/nao1215))

Makefile

@@ -1,4 +1,4 @@
-.PHONY: build test clean changelog tools help docker generate gif
+.PHONY: build test clean changelog tools help docker generate gif coverage-tree
 
 S3HUB       = s3hub
 SPARE       = spare
@@ -26,6 +26,9 @@ test: ## Start unit test
 	env GOOS=$(GOOS) $(GO_TEST) -cover $(GO_PKGROOT) -coverprofile=cover.out
 	$(GO_TOOL) cover -html=cover.out -o cover.html
 
+coverage-tree: test ## Generate coverage tree
+	go-cover-treemap -coverprofile cover.out > doc/img/cover.svg
+
 changelog: ## Generate changelog
 	ghch --format markdown > CHANGELOG.md
 
@@ -34,6 +37,7 @@ tools: ## Install dependency tools
 	$(GO_INSTALL) github.com/nao1215/hottest@latest
 	$(GO_INSTALL) github.com/google/wire/cmd/wire@latest
 	$(GO_INSTALL) github.com/charmbracelet/vhs@latest
+	$(GO_INSTALL) github.com/nikolaydubina/go-cover-treemap@latest
 
 generate: ## Generate code from templates
 	$(GO) generate ./...

README.md

@@ -63,6 +63,9 @@ This project incurs costs on AWS, and financial support from you would make it e
 GitHub Star is motivation for me. If you like this project, please star it.
 [![Star History Chart](https://api.star-history.com/svg?repos=nao1215/rainbow&type=Date)](https://star-history.com/#nao1215/rainbow&Date)
 
+## Unit Test Coverage Treemap
+![Coverage Treemap](./doc/img/cover.svg)
+
 ## Special Thanks
 ![localstack](./doc/img/localstack-readme-banner.svg)
 [LocalStack](https://www.localstack.cloud/) is a service that mocks AWS, covering a wide range of AWS services. It is not easy to set up an AWS infrastructure for personal development, but LocalStack has lowered the barrier for server application development.

doc/common/developers.md

@@ -90,4 +90,16 @@ curl -s "http://127.0.0.1:4566/health" | jq .
   },
   "version": "2.1.1.dev"
 }
-```
+```
+
+### Generate CHANGELOG
+```shell
+make changelog
+```
+
+### Generate coverage map
+```shell
+make coverage-tree
+```
+
+![coverage-image](../img/cover.svg)