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: update Husky configuration and remove deprecated prepare script #3214

Merged

Conversation

abbi4code
Copy link
Contributor

@abbi4code abbi4code commented Jan 8, 2025

What kind of change does this PR introduce?

  • Updates Husky configuration to remove deprecated settings
  • updated npm prepare script to use current Husky syntax

Issue Number:

Fixes #3168

  1. Update the prepare script in your package.json:

Before

   "prepare": "husky install"

Screenshot from 2025-01-09 00-53-30

After

   "prepare": "husky"

Screenshot from 2025-01-08 22-48-45

Explaination:-

  1. Remove deprecated lines from your .husky/pre-commit file

Before
Screenshot from 2025-01-09 00-30-31

After
Screenshot from 2025-01-09 00-35-00

Explaination:-

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
  • These are actually deprecated after version 9.1.1 so now we don't require shebang line(#!/usr/bin/env sh) and the sourcing of _/.husky.sh.

refs:-

Summary by CodeRabbit

  • Chores
    • Updated Husky configuration to modify pre-commit hook initialization process.
    • Simplified package preparation script for development environment setup.

Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

Walkthrough

This pull request modifies the Husky configuration in the project by updating the .husky/pre-commit script and the package.json script. The changes involve removing the Husky initialization line and updating the prepare script command from husky install to simply husky, addressing potential deprecation warnings in the Husky CLI configuration.

Changes

File Change Summary
.husky/pre-commit Removed Husky script initialization line
package.json Updated prepare script from "husky install" to "husky"

Assessment against linked issues

Objective Addressed Explanation
Stop using deprecated Husky commands [#3168]

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 Husky hooks, a gentle change so light,
Updating scripts with technical might,
No more deprecation, clean and neat,
A rabbit's code dance, now complete!
Hop along, configuration bright! 🚀


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 68d6193 and 4bd58db.

📒 Files selected for processing (2)
  • .husky/pre-commit (0 hunks)
  • package.json (1 hunks)
💤 Files with no reviewable changes (1)
  • .husky/pre-commit
🧰 Additional context used
🪛 GitHub Actions: PR Workflow
package.json

[error] Unauthorized modification or deletion of sensitive file. Apply 'ignore-sensitive-files-pr' label to override.

🔇 Additional comments (2)
package.json (2)

Line range hint 1-199: Pipeline failure needs to be addressed.

The PR has triggered a pipeline failure due to unauthorized modification of a sensitive file (package.json). This is a security measure to protect critical configuration files.

To proceed with the changes:

  1. Request a maintainer to apply the 'ignore-sensitive-files-pr' label to the PR
  2. This will override the protection and allow the pipeline to proceed

Note: This protection is in place to ensure that changes to critical files are properly reviewed and authorized.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[error] Unauthorized modification or deletion of sensitive file. Apply 'ignore-sensitive-files-pr' label to override.


90-90: LGTM! The prepare script update aligns with Husky v9 requirements.

The change from "prepare": "husky install" to "prepare": "husky" is correct for Husky v9.1.6.

Let's verify the Husky hook installation:

✅ Verification successful

✅ Husky v9 setup verified successfully

The prepare script change works correctly, evidenced by:

  • Properly installed hooks in .husky directory with correct permissions
  • Valid pre-commit hook with formatting, linting, and type checking
  • Working post-merge hook for dependency management
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify Husky hook installation and configuration

# Check if .husky directory exists and contains necessary files
if [ -d ".husky" ]; then
  echo "Husky directory exists"
  ls -la .husky/
else
  echo "Husky directory missing"
fi

# Check pre-commit hook permissions
if [ -f ".husky/pre-commit" ]; then
  ls -l .husky/pre-commit
else
  echo "pre-commit hook missing"
fi

Length of output: 445


Script:

#!/bin/bash
# Verify hook contents
echo "=== pre-commit hook contents ==="
cat .husky/pre-commit
echo -e "\n=== post-merge hook contents ==="
cat .husky/post-merge

Length of output: 417

🧰 Tools
🪛 GitHub Actions: PR Workflow

[error] Unauthorized modification or deletion of sensitive file. Apply 'ignore-sensitive-files-pr' label to override.

Finishing Touches

  • 📝 Generate Docstrings

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

github-actions bot commented Jan 8, 2025

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

Copy link
Contributor

@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: 1

🧹 Nitpick comments (1)
package.json (1)

Line range hint 186-189: Consider updating the lint-staged file patterns.

The current patterns have spaces after commas which might cause issues:

"lint-staged": {
  "**/*.{ts, tsx, json, scss, css}": [
    "prettier --write"
  ],
  "**/*.{ts, tsx, json}": "eslint --fix"
}

Remove spaces after commas in the file patterns:

 "lint-staged": {
-  "**/*.{ts, tsx, json, scss, css}": [
+  "**/*.{ts,tsx,json,scss,css}": [
     "prettier --write"
   ],
-  "**/*.{ts, tsx, json}": "eslint --fix"
+  "**/*.{ts,tsx,json}": "eslint --fix"
 }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 68d6193 and c5f1486.

📒 Files selected for processing (2)
  • .husky/pre-commit (0 hunks)
  • package.json (1 hunks)
💤 Files with no reviewable changes (1)
  • .husky/pre-commit
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Test Application
  • GitHub Check: Analyse Code With CodeQL (javascript)

package.json Show resolved Hide resolved
Copy link

codecov bot commented Jan 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.85%. Comparing base (bcfb41f) to head (4bd58db).
Report is 11 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3214       +/-   ##
=====================================================
+ Coverage             16.54%   89.85%   +73.31%     
=====================================================
  Files                   308      329       +21     
  Lines                  7810     8526      +716     
  Branches               1701     1913      +212     
=====================================================
+ Hits                   1292     7661     +6369     
+ Misses                 6429      633     -5796     
- Partials                 89      232      +143     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@abbi4code
Copy link
Contributor Author

@coderabbitai full review

Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

✅ Actions performed

Full review triggered.

@palisadoes palisadoes added the ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files label Jan 9, 2025
@abbi4code
Copy link
Contributor Author

@coderabbitai full review

Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

✅ Actions performed

Full review triggered.

@palisadoes palisadoes merged commit 5893198 into PalisadoesFoundation:develop-postgres Jan 9, 2025
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants