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

Implement Husky Precommit Hook to Run Test Suite Before Committing Changes #27

Open
4 tasks
Savio629 opened this issue May 11, 2024 · 0 comments
Open
4 tasks
Labels

Comments

@Savio629
Copy link
Collaborator

Description

Currently, our project lacks a mechanism to ensure that all changes adhere to our testing standards before they are committed. This issue aims to address this by implementing a Husky precommit hook that automatically runs the test suite before allowing commits to be made. By enforcing this practice, we can maintain code quality and prevent regressions by catching potential issues early in the development process.

Objective

The primary objective of this issue is to update the Husky precommit hook to execute the test suite automatically before allowing any commits to proceed. Right now, it uses lint-staged via npx to execute linting tasks on staged files before allowing commits.
Ref: https://github.com/SamagraX-Stencil/stencil-cli/blob/master/.husky/pre-commit

Goals

  • Configure a Husky precommit hook to run the test suite before allowing commits.
  • Ensure that the precommit hook is triggered automatically when attempting to commit changes.
  • Provide informative feedback to the user in case of test failures, indicating the need to address them before committing.
  • Document the setup process and guidelines for developers on utilizing the precommit hook effectively.

Complexity: Easy

Product Name

Stencil-cli

Organisation Name

SamagraX

Domain

Bash

Tech Skills Needed

Bash, Husky

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant