Remove Husky and pre-commit hooks from the project templates #505
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The lint-staged configuration was removed as it was introducing unnecessary friction for developers.
…fy project dependencies
The husky.sh file and pre-commit hook have been removed from the project. These files were no longer needed and were causing unnecessary complexity in the project setup. Removing them simplifies the project structure and reduces the potential for conflicts or issues related to these files.
MartinMinkov
approved these changes
Oct 20, 2023
The "prepare" script was removed from the package.json file as it was no longer needed. This script was used to install Husky, but since Husky is already installed as a dev dependency, the script was redundant.
…removing Husky and pre-commit hooks to improve developer experience
|
Maybe we should have been giving an option for users whether to use Husky or not during the project generation (no by default)? Even though it might complicate things. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes #504
Problem
The Husky pre-commit hooks were originally added to the
zkApp-cliproject templates to enforce linting best practices before a developer commits their code to Github. While the intention was good, these hooks have created unnecessary complexity and friction for developers to iterate quickly. See the internal discussion.This PR removes Husky and the pre-commit hooks from the project templates to remove friction and create a better DX when building zkApps. The pre-commit hooks were left as is when contributing to the
zkApp-clirepository.Tested
This was tested by manually generated projects and verifying the pre-commit hooks where removed.