commit-sentry

library0.1.12jsnpmunverified

Zero-config Git hooks that work consistently across Windows, macOS, and Linux. Version 0.1.12 auto-wires pre-commit, commit-msg, and pre-push hooks on npm install without manual husky setup. Ships with prettier and lint-staged, offers optional ESLint scaffolding via `setup-eslint`, includes a `rm-console` tag to strip console.log calls, and runs commit-time builds with Windows lock detection. Released bi-weekly, it focuses on solving cross-platform hook failures and fresh-clone readiness where husky alone falls short.

devops testing

npm install commit-sentry

package ↗

INSTALL

IMPORT

SIG · COMMIT-SENTRY

commit-sentry

devopsjavascriptv0.1.12

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default (package install)

✓ npm install --save-dev commit-sentry

✗ npm install commit-sentry (without --save-dev)

Must be a devDependency; hooks are installed via postinstall script.

setup-eslint command

✓ npx commit-sentry setup-eslint

✗ npx commit-sentry --eslint

Command is `setup-eslint`, not a flag. Use `--force` to overwrite existing ESLint config.

update command

✓ npx commit-sentry update

✗ npx commit-sentry overwrite

Overwrites .husky/ contents with package defaults while preserving existing hooks.

Installs commit-sentry, auto-wires Git hooks, and shows how to verify, add ESLint, and bypass hooks for one-off commits.

npm install --save-dev commit-sentry # Hooks are installed automatically. # To verify: git add . git commit -m "test: verify hooks work" # To add ESLint (optional): npx commit-sentry setup-eslint # To bypass hooks for a single commit: HUSKY=0 git commit -m "wip"

Debug

Known issues

gotchaExisting .husky/ files are preserved on install. Use 'npx commit-sentry update' to overwrite them.

fix

Run 'npx commit-sentry update' after install if you want the default hooks.

affects: >=0.1.0

gotchaWindows CRLF can cause 'bash: $'\r': command not found' errors. commit-sentry auto-heals this, but if you manually edit hooks, re-run the update command.

fix

Run 'npx commit-sentry update' or ensure hook files are saved with LF line endings.

affects: >=0.1.0

gotchaThe 'rm-console' tag in commit messages only works on staged files; console.log in unstaged or untracked files is not affected.

fix

Stage the files with console.log before committing with 'rm-console' in the message.

affects: >=0.1.0

Errors

Common errors & fixes

bash: $'\r': command not found

Git hook files have Windows CRLF line endings on a Unix-based system

fix

Run 'npx commit-sentry update' to regenerate hooks with correct LF endings.

Husky fails: 'git config core.hooksPath' not set

Manual husky install needed; commit-sentry sets it automatically but may fail in restricted environments

fix

Ensure .husky/ directory exists and re-run 'npm install' or 'npx commit-sentry update'.

Upgrade

Version history

0.1.12latest on npm

Audit

Dependencies

prettierrequiredAuto-installed for file formatting on commit

lint-stagedrequiredAuto-installed to run linters on staged files

Agent activity

14 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://www.npmjs.com/package/commit-sentry ↗