Skip to content

Commit ef9dc1e

Browse files
committed
Add help to Makefile
1 parent a307c1a commit ef9dc1e

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

Makefile

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ifneq (,$(wildcard /usr/share/bash-completion/completions/))
77
targets += /usr/share/bash-completion/completions/$(pkgname)
88
endif
99

10-
all: build/$(pkgname) build/completions/bash build/completions/zsh build/completions/fish
10+
all: build/$(pkgname) build/completions/bash build/completions/zsh build/completions/fish ## All targets
1111

1212
build/$(pkgname): cmd/*.go | build/
1313
go build -o $@
@@ -27,28 +27,35 @@ build/completions/%: build/$(pkgname) | build/completions/
2727
mkdir -p $@
2828

2929
.PHONY: clean
30-
clean:
30+
clean: ## Remove generated files
3131
$(RM) -r build
3232

3333
.PHONY: uninstall
34-
uninstall:
34+
uninstall: ## Remove local installation
3535
$(RM) $(targets)
3636

3737
.PHONY: test
38-
test:
38+
test: ## Run the go tests
3939
go test ./... -v
4040

4141
.PHONY: docker-build
4242
docker-build:
4343
docker build -t mermaid-ascii:latest .
4444

4545
.PHONY: docker-test
46-
docker-test:
46+
docker-test: docker-build ## Run the go tests in docker
4747
docker build --target test -t mermaid-ascii:test -f Dockerfile.test .
4848

4949
.PHONY: docker-run
50-
docker-run:
50+
docker-run: docker-build
5151
docker run -i mermaid-ascii:latest
5252

5353
dev:
5454
air
55+
56+
.PHONY: help
57+
help:
58+
@awk 'BEGIN {FS = ":.*?## "} /^[0-9a-zA-Z._-]+:.*?## / {printf "\033[36m%s\033[0m : %s\n", $$1, $$2}' $(MAKEFILE_LIST) | \
59+
sort | \
60+
column -s ':' -t
61+

0 commit comments

Comments
 (0)