Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Only tracking pre-commit hooks in git, allowing for personal s… #1349

Merged
merged 1 commit into from
Nov 8, 2024

Conversation

alexdigdir
Copy link
Collaborator

@alexdigdir alexdigdir commented Nov 7, 2024

…etup

Hva er endret?

Dokumentasjon / Storybook / testdekning

  • Dokumentasjon er oppdatert eller ikke relevant / nødvendig.
  • Ny komponent har en eller flere stories i Storybook, eller så er ikke dette relevant.
  • Det er blitt lagt til nye tester / eksiterende tester er blitt utvidet, eller tester er ikke relevant.

Skjermbilder eller GIFs (valgfritt)

Summary by CodeRabbit

  • Chores
    • Updated .gitignore to ignore all files in the .hooks directory while keeping the pre-commit file tracked.
    • Added a comment in the .hooks/pre-commit file for clarity, with no changes to its existing functionality.

@alexdigdir alexdigdir requested a review from a team as a code owner November 7, 2024 11:57
Copy link

coderabbitai bot commented Nov 7, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the .gitignore file by adding an entry to ignore all files in the .hooks directory while excluding the pre-commit file from being ignored. Additionally, a comment has been added to the .hooks/pre-commit file, but the existing command functionality remains unchanged. These changes aim to refine the management of hook files in version control.

Changes

File Change Summary
.gitignore Added .hooks/* to ignore all files in the .hooks directory, and !.hooks/pre-commit to exclude the pre-commit file from being ignored.
.hooks/pre-commit Added a comment #Test without altering the existing command functionality.

Possibly related PRs


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
.gitignore (1)

11-12: Consider removing one empty line.

There are two consecutive empty lines here. While spacing in .gitignore helps visually separate rule groups, a single empty line is sufficient.

 .hooks/*
 !.hooks/pre-commit
-
 
 # Created by https://www.toptal.com/developers/gitignore/api/macos,windows,linux,visualstudiocode,vim,webstorm+all,node,yarn
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e15c158 and 9e8a7c6.

📒 Files selected for processing (2)
  • .gitignore (1 hunks)
  • .hooks/pre-commit (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .hooks/pre-commit
🔇 Additional comments (1)
.gitignore (1)

9-10: LGTM! Clean implementation of hook management.

The implementation correctly:

  • Ignores all files in .hooks/ directory
  • Explicitly tracks only the pre-commit hook
  • Allows for personal hook configurations

This is a good practice that balances team consistency (tracked pre-commit hook) with developer flexibility (untracked personal configurations).

Let's verify the hook setup:

✅ Verification successful

Pre-commit hook setup verified and working as intended

The verification confirms:

  • Pre-commit hook exists at .hooks/pre-commit
  • Pre-commit hook is properly tracked in git
  • No other hooks are tracked, allowing for untracked personal configurations
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify pre-commit hook exists and is tracked

# Test 1: Verify pre-commit hook exists
if [ -f ".hooks/pre-commit" ]; then
  echo "✓ pre-commit hook exists"
else
  echo "✗ pre-commit hook missing"
  exit 1
fi

# Test 2: Verify pre-commit hook is tracked
if git ls-files --error-unmatch .hooks/pre-commit >/dev/null 2>&1; then
  echo "✓ pre-commit hook is tracked in git"
else
  echo "✗ pre-commit hook is not tracked in git"
  exit 1
fi

# Test 3: Check for any other tracked files in .hooks
other_hooks=$(git ls-files .hooks/ | grep -v "pre-commit" || true)
if [ -z "$other_hooks" ]; then
  echo "✓ No other hooks are tracked"
else
  echo "✗ Unexpected tracked hooks found:"
  echo "$other_hooks"
  exit 1
fi

Length of output: 371

@alexdigdir alexdigdir merged commit 30ed67c into main Nov 8, 2024
21 checks passed
@alexdigdir alexdigdir deleted the chore/husky branch November 8, 2024 10:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants