Skip to content

Commit 3ddd309

Browse files
Add pre-commit hook for Snyk and Talisman scans; update .gitignore and package.json
1 parent 9a4e790 commit 3ddd309

File tree

5 files changed

+107
-13
lines changed

5 files changed

+107
-13
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ playground
1313
newQueryBuilder.ts
1414
query-builder.ts
1515
dist
16+
17+
# pre-commit scans
18+
talisman_output.log
19+
snyk_output.log

.husky/pre-commit

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
#!/usr/bin/env sh
2+
# Pre-commit hook to run Snyk and Talisman scans, completing both before deciding to commit
3+
4+
# Function to check if a command exists
5+
command_exists() {
6+
command -v "$1" >/dev/null 2>&1
7+
}
8+
9+
# Check if Snyk is installed
10+
if ! command_exists snyk; then
11+
echo "Error: Snyk is not installed. Please install it and try again."
12+
exit 1
13+
fi
14+
15+
# Check if Talisman is installed
16+
if ! command_exists talisman; then
17+
echo "Error: Talisman is not installed. Please install it and try again."
18+
exit 1
19+
fi
20+
21+
# Allow bypassing the hook with an environment variable
22+
if [ "$SKIP_HOOK" = "1" ]; then
23+
echo "Skipping Snyk and Talisman scans (SKIP_HOOK=1)."
24+
exit 0
25+
fi
26+
27+
# Initialize variables to track scan results
28+
snyk_failed=false
29+
talisman_failed=false
30+
31+
# Run Snyk vulnerability scan
32+
echo "Running Snyk vulnerability scan..."
33+
snyk test --all-projects > snyk_output.log 2>&1
34+
snyk_exit_code=$?
35+
36+
if [ $snyk_exit_code -eq 0 ]; then
37+
echo "Snyk scan passed: No vulnerabilities found."
38+
elif [ $snyk_exit_code -eq 1 ]; then
39+
echo "Snyk found vulnerabilities. See snyk_output.log for details."
40+
snyk_failed=true
41+
else
42+
echo "Snyk scan failed with error (exit code $snyk_exit_code). See snyk_output.log for details."
43+
snyk_failed=true
44+
fi
45+
46+
# Run Talisman secret scan (continues even if Snyk failed)
47+
echo "Running Talisman secret scan..."
48+
talisman --githook pre-commit > talisman_output.log 2>&1
49+
talisman_exit_code=$?
50+
51+
if [ $talisman_exit_code -eq 0 ]; then
52+
echo "Talisman scan passed: No secrets found."
53+
else
54+
echo "Talisman scan failed (exit code $talisman_exit_code). See talisman_output.log for details."
55+
talisman_failed=true
56+
fi
57+
58+
# Evaluate results after both scans
59+
if [ "$snyk_failed" = true ] || [ "$talisman_failed" = true ]; then
60+
echo "Commit aborted due to issues found in one or both scans."
61+
[ "$snyk_failed" = true ] && echo "- Snyk issues: Check snyk_output.log"
62+
[ "$talisman_failed" = true ] && echo "- Talisman issues: Check talisman_output.log"
63+
exit 1
64+
fi
65+
66+
# If both scans pass, allow the commit
67+
echo "All scans passed. Proceeding with commit.cd ."
68+
rm -f snyk_output.log talisman_output.log
69+
exit 0

.talismanrc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
fileignoreconfig:
22
- filename: package-lock.json
3-
checksum: a618ae6c113021eef425f224f1dfd7066b15af1a45249ea063a193517ce5a92f
4-
version: ""
3+
checksum: 37742c5c56859fdfed906c14e97881c4a10e0a52464fda489e4eb8154298fde4
4+
- filename: .husky/pre-commit
5+
checksum: 5baabd7d2c391648163f9371f0e5e9484f8fb90fa2284cfc378732ec3192c193
6+
version: ""
7+
base64_entropy: false

package-lock.json

Lines changed: 26 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"main": "dist/index.js",
77
"scripts": {
88
"clean": "rimraf dist typings coverage",
9-
"build-ts": "npm run clean && tsc",
9+
"build-ts": "npm run clean && tsc && husky && chmod +x .husky/pre-commit",
1010
"build-doc": "npm run build-ts && ./node_modules/.bin/jsdoc dist/ -r -R README.md -d docs",
1111
"watch-ts": "npm run clean && tsc -w",
1212
"compile": "tsc",
@@ -19,14 +19,15 @@
1919
"dependencies": {
2020
"lodash": "^4.17.21",
2121
"mongodb": "^6.12.0",
22-
"sift": "^17.1.3"
22+
"sift": "^17.1.3"
2323
},
2424
"devDependencies": {
2525
"@types/jest": "29.5.14",
2626
"@types/lodash": "4.17.14",
2727
"@types/node": "10.17.60",
2828
"@types/rimraf": "4.0.5",
2929
"debug": "^4.4.0",
30+
"husky": "^9.1.7",
3031
"jest": "^29.7.0",
3132
"jsdoc": "^4.0.4",
3233
"node-notifier": "^10.0.1",

0 commit comments

Comments
 (0)