lychee/Makefile
dependabot[bot] 0a2cd324d5
Bump typed-builder from 0.11.0 to 0.12.0 (#934)
* Bump typed-builder from 0.11.0 to 0.12.0

Bumps [typed-builder](https://github.com/idanarye/rust-typed-builder) from 0.11.0 to 0.12.0.
- [Release notes](https://github.com/idanarye/rust-typed-builder/releases)
- [Changelog](https://github.com/idanarye/rust-typed-builder/blob/master/CHANGELOG.md)
- [Commits](https://github.com/idanarye/rust-typed-builder/commits)

---
updated-dependencies:
- dependency-name: typed-builder
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Remove custom builder method docs.

We use the default again, which offers the same amount of information.

* Add `make` target to show docs

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Matthias <matthias-endler@gmx.net>
Co-authored-by: Matthias Endler <matthias@endler.dev>
2023-01-30 15:12:20 +01:00

51 lines
No EOL
1.2 KiB
Makefile

# Needed SHELL since I'm using zsh
SHELL := /bin/bash
IMAGE_NAME := "lycheeverse/lychee"
.PHONY: help
help: ## This help message
@echo -e "$$(grep -hE '^\S+:.*##' $(MAKEFILE_LIST) | sed -e 's/:.*##\s*/:/' -e 's/^\(.\+\):\(.*\)/\\x1b[36m\1\\x1b[m:\2/' | column -c2 -t -s :)"
.PHONY: docker-build
docker-build: ## Build Docker image
docker build -t $(IMAGE_NAME) .
.PHONY: docker-run
docker-run: ## Run Docker image
docker run $(IMAGE_NAME)
.PHONY: docker-push
docker-push: ## Push image to Docker Hub
docker push $(IMAGE_NAME)
.PHONY: build
build: ## Build Rust code locally
cargo build
.PHONY: install
install: ## Install project locally
cargo install --path lychee-bin --locked
.PHONY: run
run: ## Run project locally
cargo run
.PHONY: docs
docs: ## Generate and show documentation
cargo doc --open
.PHONY: lint
lint: ## Run linter
cargo clippy --all-targets --all-features -- -D warnings
.PHONY: test
test: ## Run tests
cargo test --all-targets --all-features
.PHONY: doc
doc: ## Open documentation
cargo doc --open
.PHONY: screencast
screencast: ## Create a screencast for the docs
svg-term --command 'assets/screencast.sh' --out 'assets/screencast.svg' --width 100 --padding 10 --window