flutter_husky 0.1.3

Production-grade Git hooks for Flutter and Dart projects.

Flutter Husky

Git hooks for Flutter & Dart projects.

flutter_husky helps you automatically check code quality before every commit and push.

It keeps your codebase clean by running formatter, analyzer, tests, spell checking, and detecting bad practices like debug prints or hardcoded secrets.

---

---

Demo

---

Links

• 🌐 Website: https://huskey-landing-page.onrender.com/
• 📦 pub.dev: https://pub.dev/packages/flutter_husky
• 💻 GitHub: https://github.com/atulproject99/flutter_husky

Features

Pre-commit checks

Before every commit, Flutter Husky automatically:

• ✅ Runs dart fix --apply
• ✅ Formats code using dart format
• ✅ Runs flutter analyze
• ✅ Detects print() statements
• ✅ Detects TODO/FIXME comments
• ✅ Detects possible hardcoded secrets
• ✅ Runs spell checking using cspell
• ✅ Re-stages fixed files automatically

---

Pre-push checks

Before every push, Flutter Husky automatically:

• ✅ Runs Flutter tests
• ✅ Runs integration tests (if available)
• ✅ Verifies Flutter build
• ✅ Checks dependency status
• ✅ Detects merge conflict markers

---

Why Flutter Husky?

Flutter Husky helps teams avoid committing:

• Debug code
• Unformatted code
• Analyzer issues
• Hardcoded secrets
• Broken tests
• Bad practices

This improves code quality and keeps repositories production-ready.

---

Installation

Add as dev dependency:

flutter pub add --dev flutter_husky

or

dart pub add --dev flutter_husky

---

Initialize Flutter Husky

Run:

dart run flutter_husky:flutter_husky init

This automatically creates:

.git/hooks/pre-commit
.git/hooks/pre-push

---

Global Installation (Optional)

Install globally:

dart pub global activate flutter_husky

Then run directly:

flutter_husky:init

---

Example

Initialize Git

git init

---

Install Flutter Husky

flutter pub add --dev flutter_husky

---

Generate Hooks

dart run flutter_husky:flutter_husky init

Expected output:

✔ pre-commit hook installed
✔ pre-push hook installed

Flutter Husky initialized successfully

---

How Pre-commit Works

When you run:

git commit -m "your message"

Flutter Husky automatically runs:

dart fix --apply
dart format .
flutter analyze

It also checks for:

• print()
• TODO comments
• hardcoded secrets
• spelling mistakes

If any issue is found, commit will be blocked.

---

Example: Block Debug Print

If your code contains:

print("debug");

Commit will fail:

❌ Remove print statements before commit

---

Example: Block Hardcoded Secret

If your code contains:

const API_KEY = "123";

Commit will fail:

❌ Possible hardcoded secret detected

---

Terminal Preview

---

How Pre-push Works

When you run:

git push

Flutter Husky automatically runs:

flutter test
flutter build apk --debug

If tests or build fail, push will be blocked.

---

Skip Tests During Push

Sometimes you may want to skip tests temporarily.

Use:

SKIP_TESTS=true git push

---

Skip All Hooks

Git provides a built-in bypass option.

Skip commit hooks:

git commit --no-verify

Skip push hooks:

git push --no-verify

---

Automatic cspell Installation

Flutter Husky automatically installs cspell if it is not available.

Used for:

• spelling checks
• typo detection
• comment validation

---

Recommended Lint Rules

For best results, use strict linting.

Install:

flutter pub add --dev very_good_analysis

Then create:

analysis_options.yaml

include: package:very_good_analysis/analysis_options.yaml

This improves:

• linting
• unused import detection
• naming conventions
• code quality

---

Generated Hooks

Pre-commit

Checks:

• formatter
• analyzer
• debug prints
• spelling
• secrets
• TODOs

---

Pre-push

Checks:

• tests
• integration tests
• build verification
• merge conflicts

---

Requirements

• Flutter SDK
• Dart SDK >= 3.0.0
• Git installed
• Node.js (for cspell)

---

Supported Platforms

• macOS
• Linux
• Windows (Git Bash recommended)

---

Troubleshooting

Hooks are not running

Make sure Git is initialized:

git init

---

Permission denied

Run:

chmod +x .git/hooks/pre-commit
chmod +x .git/hooks/pre-push

---

Flutter command not found

Check Flutter installation:

flutter doctor

---

Roadmap

Upcoming features:

• YAML configuration support
• Custom commands
• Run checks only on staged files
• Conventional commit validation
• Melos support
• CI/CD integration
• Interactive setup wizard

---

Contributing

Contributions are welcome.

Feel free to open issues or submit pull requests.

---

License

MIT License