Added precommit hook

[Samridhi-98]

Description

Added pre-commit hook .pre-commit-config.yaml

Fixes #62

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[Samridhi-98]

@Manvityagi Please review my PR.

[abdus]

hey @Samridhi-98, did you test these changes locally before making a Pull Request? from what I can see, you have installed husky@6 for this project. But the way you have implemented it .. works with husky@4. so, the pre-commit hooks never actually get triggered.

following are the changes I want you to make:

1. remove `.pre-commit-config.yaml. this is required only if you are using pre-commit framework
2. migrate the implementation to husky@6. resources: installation · migration
3. update readme with relevant information (for example, if there's any additional commands user required to run while setting up the project locally)

Let me know if you need any help. And please test your code locally before making PRs.

[Samridhi-98]

hey @Samridhi-98, did you test these changes locally before making a Pull Request? from what I can see, you have installed husky@6 for this project. But the way you have implemented it .. works with husky@4. so, the pre-commit hooks never actually get triggered.

following are the changes I want you to make:

1. remove `.pre-commit-config.yaml. this is required only if you are using pre-commit framework
2. migrate the implementation to husky@6. resources: installation · migration
3. update readme with relevant information (for example, if there's any additional commands user required to run while setting up the project locally)

Let me know if you need any help. And please test your code locally before making PRs.

Okay, will update as you suggested.

[Samridhi-98]

@abdus Please review I have updated as you suggested and also tested my code locally.

Screenshot

[abdus]

The changes you have made aren't working as expected. Files that were changed since the last commit, should be formatted automatically using prettier before commit.

Also, by "test your code locally", I meant to say that whatever code you have changed, is working as expected. For example, here you are working on formatting code with the pre-commit hook. check that whether the changed files were formatted or not.

I wrote a how-to on writing a pre-commit hook using husky@6. please check it out and see if this could be of any help.

[abdus]

pre-commit hook should run automatically before committing the changes.

[abdus]

you need to install prettier and pretty-quick as well.

[Samridhi-98]

@abdus Please review. Also while running this npx husky add .husky/pre-commit './node_modules/.bin/pretty-quick --staged' got an error so I have created the file using npx husky add .husky/pre-commit first and then added this './node_modules/.bin/pretty-quick --staged' manually and its working, please let me know if I did anything wrong.

Screenshot

[Samridhi-98]

@abdus @Manvityagi please add the appropriate label and GSSOC tag.