test: add new pre-commit hooks (#706)

Author: morremeyer

.pre-commit-config.yaml

@@ -7,6 +7,11 @@ repos:
         stages: [commit-msg]
         additional_dependencies: ["@commitlint/config-conventional"]
 
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.9.0.5
+    hooks:
+      - id: shellcheck
+
   - repo: https://github.com/dnephin/pre-commit-golang
     rev: v0.5.1
     hooks:
@@ -20,6 +25,13 @@ repos:
     hooks:
       - id: prettier
 
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: end-of-file-fixer
+        exclude: ^api
+      - id: trailing-whitespace
+
   - repo: local
     hooks:
       - id: swag fmt
@@ -35,3 +47,14 @@ repos:
         pass_filenames: false
         entry: swag init --parseDependency --output ./api
         files: ^pkg/.*
+
+      # Taken from https://github.com/rstcheck/rstcheck/blob/178e8c1001aebe2dcbf006e7e6980246704d2315/.pre-commit-config.yaml#L141
+      #
+      # Find FIXME:|BUG: comments in all files
+      # Inline skip: `#i#` directly after the colon after the tag-word
+      - id: find-todos
+        name: "Find FIXME:|BUG: comments"
+        description: "Check for FIXME:|BUG: comments in all files"
+        language: pygrep
+        entry: '(^|//!?|#|<!--|;|/\*(\*|!)?|\.\.)\s*(FIXME:|BUG:)(?!#i#)'
+        exclude: CONTRIBUTING.md

CONTRIBUTING.md

@@ -18,6 +18,11 @@ Once those are installed, run `make setup` to perform the repository setup.
 - `make coverage` runs all tests and opens the coverage report in your browser
 - `make build` builds the software with production configuration
 
+## Comments
+
+- Use `// FIXME: What to fix` or `// BUG: what is broken` to make pre-commit fail as a reminder to fix something before opening a PR
+- Use `// TODO: What needs to be done` for things that need to be changed at a later point in time
+
 ## Commit messages
 
 This project uses [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)

pkg/models/budget.go

@@ -238,7 +238,7 @@ func (b Budget) Month(db *gorm.DB, month types.Month) (Month, error) {
 			categoryEnvelopes.Spent = categoryEnvelopes.Spent.Add(envelopeMonth.Spent)
 			categoryEnvelopes.Allocation = categoryEnvelopes.Allocation.Add(envelopeMonth.Allocation)
 
-			// FIXME: The remove this with the integration of allocations into MonthConfigs.
+			// TODO: The remove this with the integration of allocations into MonthConfigs.
 			url := db.Statement.Context.Value(database.ContextURL)
 
 			// Set the allocation link. If there is no allocation, we send the collection endpoint.

testdata/importer/Budget.yfull

@@ -3515,4 +3515,4 @@
 			"name": "Checking"
 		}
 	]
-}
+}

testdata/importer/ynab-import/comdirect-ynap.csv

@@ -1,4 +1,4 @@
 Date,Payee,Memo,Outflow,Inflow
 04/01/2019,,Test,59.97,
 04/01/2019,,ISHSII-MSCI EUR.SRI EOACC WPKNR: A1H7ZS ISIN: IE00B52VJ196,119.98,
-04/01/2019,Leo Bernard,Lastschrift Sparplan 1,,180.00
+04/01/2019,Leo Bernard,Lastschrift Sparplan 1,,180.00