Add swag-init Hook

- Define script to be run for swag-init
- Add documentation for swag-init hook

Author: muya

Diff for: .pre-commit-hooks.yaml

@@ -5,5 +5,15 @@
   always_run: false
   fail_fast: false
   verbose: false
-  description: 'Run swag fmt to format Swaggo comments in your code'
+  description: 'Run swag fmt to format Swag annotations in your code.'
+  args: []
+
+- id: swag-init
+  name: swag-init
+  entry: run-swag-init.sh
+  language: script
+  always_run: false
+  fail_fast: false
+  verbose: false
+  description: 'Run swag init to generate Swagger docs from Swag annotations, and generate the required files.'
   args: []

Diff for: README.md

@@ -13,11 +13,19 @@ repos:
     rev: "main"
     hooks:
       - id: swag-fmt
+      - id: swag-init
 ```
 
 Arguments to `swag` can be passed as `args`.
 
-For example, to pass the `--exclude` flag to `swag fmt`:
+The example below shows:
+
+- How to pass the `--exclude` flag to `swag fmt`
+- How to run the equivalent of `swag init` with these flags:
+
+```
+swag init --parseInternal --requiredByDefault --parseDependency --dir "./cmd/api/" --generalInfo routes.go --output ./cmd/api/docs/
+```
 
 ```yaml
 repos:
@@ -27,7 +35,15 @@ repos:
     hooks:
       - id: swag-fmt
         args:
-          - --exclude ./a/special/file.go
+          - --exclude=./a/special/file.go
+      - id: swag-init
+        args:
+          - --parseInternal
+          - --requiredByDefault
+          - --parseDependency
+          - --dir=./cmd/api/
+          - --generalInfo=routes.go
+          - --output=./cmd/api/docs/
 ```
 
 ## Available Hooks
@@ -36,3 +52,5 @@ All of these hooks require [swaggo/swag](https://github.com/swaggo/swag#getting-
 in your `$PATH`.
 
 - `swag-fmt` - Runs `swag fmt` on all files in the project.
+- `swag-init` - Runs `swag init` on the project. Please
+  reference [available CLI flags in the documentation](https://github.com/swaggo/swag#swag-cli).

Diff for: run-swag-fmt.sh

@@ -6,4 +6,4 @@ then
     exit 1
 fi
 
-swag fmt $@
+swag fmt "$@"

Diff for: run-swag-init.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+if ! which swag &> /dev/null
+then
+    echo "swag could not be found. Please ensure it is installed and available on your PATH."
+    exit 1
+fi
+
+swag init "$@"