From 1874d6ececd9d56fd477afc4a787a16e23236024 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Sat, 12 Aug 2023 11:06:05 +0200 Subject: [PATCH] Implemented the "help-docc-plugin" target in the Makefile file. --- Makefile | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/Makefile b/Makefile index 2144d34..89ebd69 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -# --- IMPORTS --- +# --- IMPORTS --- # # Imports environment variables. environment_vars ?= .env @@ -6,7 +6,7 @@ environment_vars ?= .env include $(environment_vars) export $(shell sed 's/=.*//' $(environment_vars)) -# --- ARGUMENTS --- +# --- ARGUMENTS --- # override docker?=${CLI_USE_DOCKER} override tag?=${DOCKER_IMAGE_TAG} @@ -14,7 +14,7 @@ override platform?=${DOCKER_IMAGE_PLATFORM} override config?=${SWIFT_BUILD_CONFIGURATION} override clean?=${DOCKER_IMAGE_CLEAN} -# --- IDE --- +# --- IDE --- # xcode: ## Open this package in Xcode. @open -a Xcode Package.swift @@ -22,7 +22,7 @@ xcode: ## Open this package in Xcode. vscode: ## Open this package with Visual Studio Code. @code . -# --- DEPENDENCIES --- +# --- DEPENDENCIES --- # outdated: ## List the package dependencies that can be updated. @swift package update --dry-run @@ -30,7 +30,7 @@ outdated: ## List the package dependencies that can be updated. update: ## Update the package dependencies defined in the project. @swift package update -# --- DEVELOPMENT --- +# --- DEVELOPMENT --- # build: ## Build this package with Swift either locally or in a Docker image. ifeq ($(docker),yes) @@ -48,7 +48,7 @@ else @swift build --configuration ${config} endif -# --- TESTING --- +# --- TESTING --- # test: ## Test this package with Swift either locally or in a Docker image. ifeq ($(docker),yes) @@ -66,7 +66,11 @@ else @swift test --configuration ${config} endif -# --- HOUSE-KEEPING --- +# --- DOCUMENTAION --- # + + + +# --- HOUSE-KEEPING --- # clean: ## Clean the build artifacts of the package. @swift package clean @@ -87,4 +91,7 @@ flush-images: ## Flush all outstanding Swift docker images. help: ## Prints the written documentation for all the defined tasks. @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) +help-docc-plugin: ## Prints the help for the Swift-DocC plugin. + @swift package plugin generate-documentation --help + .DEFAULT_GOAL := help