Add precommit for license info (#31)

C-Loftus · web-flow · commit 9b18ae019c6e · 2025-11-07T12:25:09.000-05:00
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1,2 +1,5 @@
+# Copyright 2025 Colton Loftus
+# SPDX-License-Identifier: AGPL-3.0-only
+
 github: [c-loftus]
-custom: ["https://www.paypal.com/paypalme/coltonloftus"]
+custom: ["https://www.paypal.com/paypalme/coltonloftus"]
diff --git a/.github/workflows/docker_build.yml b/.github/workflows/docker_build.yml
@@ -1,3 +1,6 @@
+# Copyright 2025 Colton Loftus
+# SPDX-License-Identifier: AGPL-3.0-only
+
 on:
   push:
 
diff --git a/.github/workflows/go_lint.yml b/.github/workflows/go_lint.yml
@@ -1,3 +1,6 @@
+# Copyright 2025 Colton Loftus
+# SPDX-License-Identifier: AGPL-3.0-only
+
 name: Go Lint
 
 on: [push]
diff --git a/.github/workflows/go_tests.yml b/.github/workflows/go_tests.yml
@@ -1,3 +1,6 @@
+# Copyright 2025 Colton Loftus
+# SPDX-License-Identifier: AGPL-3.0-only
+
 name: Go Test
 
 on: 
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,3 +1,6 @@
+# Copyright 2025 Colton Loftus
+# SPDX-License-Identifier: AGPL-3.0-only
+
 on:
   # always trigger a draft release
   push:
diff --git a/.gitignore b/.gitignore
@@ -15,4 +15,4 @@ QuickPiperAudiobook
 
 __debug*
 
-dec.epub
+dec.epub
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,36 @@
+# Copyright 2025 Colton Loftus
+# SPDX-License-Identifier: AGPL-3.0-only
+
+minimum_pre_commit_version: "2.9.0"
+ci:
+  autoupdate_schedule: monthly
+repos:
+  - repo: meta
+    hooks:
+      - id: check-useless-excludes
+  - repo: local
+    hooks:
+      - id: forbid-symlinks
+        name: Forbid symlinks
+        entry: Forbid symlinks
+        language: fail
+        types: [symlink]
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.5
+    hooks:
+      - id: forbid-crlf
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: destroyed-symlinks
+      - id: detect-private-key
+        exclude_types: [svg]
+  - repo: https://github.com/google/addlicense
+    rev: "55a521bf81c24480094950caa3566548fa63875e"
+    hooks:
+      - id: addlicense
+        args: ["-s=only", -l, "AGPL-3.0-only", -c, "Colton Loftus"]
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -30,4 +30,4 @@
             "args": ["internal/testdata/titlepage_and_2_chapters.epub"],
         },
     ]
-}
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,4 +1,4 @@
 {
     "editor.formatOnType": true,
     "explorer.excludeGitIgnore": false,
-}
+}
diff --git a/Dockerfile b/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright 2025 Colton Loftus
+# SPDX-License-Identifier: AGPL-3.0-only
+
 # This dockerfile can be used to build a binary for use with the QuickPiperAudiobook command. 
 # You can use it for testing, or other architectures that don't have a piper build.
 # docker build -t quickpiperaudiobook .
diff --git a/cmd/ls.go b/cmd/ls.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package cmd
 
 import (
diff --git a/cmd/root.go b/cmd/root.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package cmd
 
 import (
diff --git a/cmd/root_test.go b/cmd/root_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package cmd
 
 import (
diff --git a/examples/config.yaml b/examples/config.yaml
@@ -1,3 +1,6 @@
+# Copyright 2025 Colton Loftus
+# SPDX-License-Identifier: AGPL-3.0-only
+
 # An example for `~/.config/QuickPiperAudiobook/config.yml`
 # Values take priority of 
 # 1. cli args 
@@ -24,4 +27,4 @@ chapters: false
 threads: 4
 
 # Output debug logs 
-verbose: false 
+verbose: false 
diff --git a/internal/binarymanagers/client.go b/internal/binarymanagers/client.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package binarymanagers
 
 import (
diff --git a/internal/binarymanagers/client_test.go b/internal/binarymanagers/client_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package binarymanagers
 
 import (
diff --git a/internal/binarymanagers/ebookConvert/client.go b/internal/binarymanagers/ebookConvert/client.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package ebookconvert
 
 import (
diff --git a/internal/binarymanagers/ebookConvert/client_test.go b/internal/binarymanagers/ebookConvert/client_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package ebookconvert
 
 import (
diff --git a/internal/binarymanagers/ffmpeg/concat.go b/internal/binarymanagers/ffmpeg/concat.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package ffmpeg
 
 import (
diff --git a/internal/binarymanagers/ffmpeg/concat_test.go b/internal/binarymanagers/ffmpeg/concat_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package ffmpeg
 
 import (
diff --git a/internal/binarymanagers/ffmpeg/fromPiper.go b/internal/binarymanagers/ffmpeg/fromPiper.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package ffmpeg
 
 import (
diff --git a/internal/binarymanagers/ffmpeg/fromPiper_test.go b/internal/binarymanagers/ffmpeg/fromPiper_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package ffmpeg
 
 import (
diff --git a/internal/binarymanagers/ffmpeg/lib.go b/internal/binarymanagers/ffmpeg/lib.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package ffmpeg
 
 import (
diff --git a/internal/binarymanagers/ffmpeg/lib_test.go b/internal/binarymanagers/ffmpeg/lib_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package ffmpeg
 
 import (
diff --git a/internal/binarymanagers/iconv/client.go b/internal/binarymanagers/iconv/client.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package iconv
 
 import (
diff --git a/internal/binarymanagers/iconv/client_test.go b/internal/binarymanagers/iconv/client_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package iconv
 
 import (
diff --git a/internal/binarymanagers/piper/client.go b/internal/binarymanagers/piper/client.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package piper
 
 import (
diff --git a/internal/binarymanagers/piper/client_test.go b/internal/binarymanagers/piper/client_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package piper
 
 import (
diff --git a/internal/binarymanagers/piper/models.go b/internal/binarymanagers/piper/models.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package piper
 
 import (
diff --git a/internal/binarymanagers/piper/models_test.go b/internal/binarymanagers/piper/models_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package piper
 
 import (
diff --git a/internal/binarymanagers/readme.md b/internal/binarymanagers/readme.md
@@ -1 +1 @@
-Every directory in `binarymanagers` is a binary like `piper` or `ffmpeg` that we can chain together in order to create an audiobook. `client.go` contains the top level runners that handle stdin / stdout and are generic across binaries.
+Every directory in `binarymanagers` is a binary like `piper` or `ffmpeg` that we can chain together in order to create an audiobook. `client.go` contains the top level runners that handle stdin / stdout and are generic across binaries.
diff --git a/internal/expand.go b/internal/expand.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package internal
 
 import (
diff --git a/internal/lib/downloads.go b/internal/lib/downloads.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package lib
 
 import (
diff --git a/internal/lib/downloads_test.go b/internal/lib/downloads_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package lib
 
 import (
diff --git a/internal/parsers/epub/README.md b/internal/parsers/epub/README.md
@@ -1,3 +1,3 @@
-This directory contains a vendored and forked version of https://github.com/kapmahc/epub used under the MIT License
+This directory contains a vendored and forked version of https://github.com/kapmahc/epub used under the MIT License. 
 
-It has been expanded and modified to support the needs of this project
+It has been expanded and modified to support the needs of this project. This library as with all other code in this project is subject to the main license of QuickPiperAudiobook.
diff --git a/internal/parsers/epub/book.go b/internal/parsers/epub/book.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package epub
 
 import (
diff --git a/internal/parsers/epub/book_test.go b/internal/parsers/epub/book_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package epub
 
 import (
diff --git a/internal/parsers/epub/client.go b/internal/parsers/epub/client.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package epub
 
 import (
diff --git a/internal/parsers/epub/client_test.go b/internal/parsers/epub/client_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package epub
 
 import (
diff --git a/internal/parsers/epub/container.go b/internal/parsers/epub/container.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package epub
 
 // Representation of the container.xml at the root of the book
diff --git a/internal/parsers/epub/ncx.go b/internal/parsers/epub/ncx.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package epub
 
 // Ncx OPS/toc.ncx
diff --git a/internal/parsers/epub/opf.go b/internal/parsers/epub/opf.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package epub
 
 /*
diff --git a/internal/root.go b/internal/root.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package internal
 
 import (
diff --git a/internal/root_test.go b/internal/root_test.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package internal
 
 import (
diff --git a/main.go b/main.go
@@ -1,3 +1,6 @@
+// Copyright 2025 Colton Loftus
+// SPDX-License-Identifier: AGPL-3.0-only
+
 package main
 
 import (
diff --git a/makefile b/makefile
@@ -10,4 +10,4 @@ release:
 	@read -p "Enter tag name: " tag; \
 	read -p "Enter tag message: " msg; \
 	git tag -a $$tag -m "$$msg"; \
-	git push origin $$tag
+	git push origin $$tag

-Original file line number
+Diff line change
@@ @@ -1,3 +1,6 @@ @@
 +# Copyright 2025 Colton Loftus
 +# SPDX-License-Identifier: AGPL-3.0-only
++
 on:
   push:
Original file line number	Diff line number	Diff line change
`@@ -15,4 +15,4 @@ QuickPiperAudiobook`
`15`	`15`
`16`	`16`	`__debug*`
`17`	`17`
`18`		`-dec.epub`
	`18`	`+dec.epub`
Original file line number	Diff line number	Diff line change
`@@ -30,4 +30,4 @@`
`30`	`30`	`"args": ["internal/testdata/titlepage_and_2_chapters.epub"],`
`31`	`31`	`},`
`32`	`32`	`]`
`33`		`-}`
	`33`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"editor.formatOnType": true,`
`3`	`3`	`"explorer.excludeGitIgnore": false,`
`4`		`-}`
	`4`	`+}`