This repository was archived by the owner on Jun 3, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 10
adds npm install for husky #14
Open
seVladimirs
wants to merge
3
commits into
SAP-archive:main
Choose a base branch
from
seVladimirs:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,10 +6,18 @@ With [Husky](https://typicode.github.io/husky/#/), you can add any number of com | |
|
|
||
| ## Setting up Husky | ||
| Setting up Husky is incredibly easy as Husky provides a command that will install, initialize, and create all files needed for Husky to start working. There is a manual process if the single set up command doesn't work so if you run into problems, you can try the set up step by step. | ||
|
|
||
| ### Yarn | ||
| ``` | ||
| npx husky-init && yarn | ||
| ``` | ||
|
|
||
| ### NPM | ||
| ``` | ||
| npx husky-init && npm install | ||
| ``` | ||
|
|
||
|
|
||
| ## Setting up Formatting | ||
| To set up [Prettier](https://prettier.io/), and [pretty-quick](https://github.com/azz/pretty-quick). If Prettier has already been set up in the repo, the only necessary package that should be added is pretty-quick. | ||
|
|
||
|
|
@@ -22,26 +30,26 @@ yarn add --dev prettier pretty-quick | |
| npm install --save-dev prettier pretty-quick | ||
| ``` | ||
|
|
||
| This is just what I needed to set up Prettier in my repo as it was being added fresh. It can be added manually as well. | ||
| This is just what I needed to set up Prettier in my repo as it was being added fresh. It can be added manually as well. | ||
|
|
||
| **Mac Command** | ||
| ``` | ||
| echo '{"singleQuote": true}'> .prettierrc.json && echo '# Ignore artifacts: | ||
| echo '{"singleQuote": true}'> .prettierrc.json && echo '# Ignore artifacts: | ||
| build | ||
| coverage'> .prettierignore | ||
| ``` | ||
|
|
||
| ## Hooks | ||
| The hooks I used to set up the formatting and unit tests being run before every commit. Important to note that if you set up unit tests to run it should abort at the end. I ran into an issue where the command was watching for the tests to change and this caused my commit to never fail or succeed so it ran indefinitely. | ||
| This sets up the formatter. Notice how it uses `set` over `add` as the second command does. This is because this was the first hook I was adding. The `set` command will overwrite all commands in the file. I also had the files format first and the unit tests run second. This is because regardless of if the unit tests pass or fail, I want my files to be formatted. If any of the commands error out, the commit will be aborted and no other hooks will be run, therefore, my unit tests are run last. | ||
| This sets up the formatter. Notice how it uses `set` over `add` as the second command does. This is because this was the first hook I was adding. The `set` command will overwrite all commands in the file. I also had the files format first and the unit tests run second. This is because regardless of if the unit tests pass or fail, I want my files to be formatted. If any of the commands error out, the commit will be aborted and no other hooks will be run, therefore, my unit tests are run last. | ||
| ### Yarn | ||
| ``` | ||
| yarn husky set ./husky/pre-commit "npx pretty-quick --staged" | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. if you execute this line it will fail as path to husky folder is wrong, it should be .husky instead. |
||
| yarn husky set .husky/pre-commit "npx pretty-quick --staged" | ||
| yarn husky add .husky/pre-commit "yarn test --watchAll=false" | ||
| ``` | ||
|
|
||
| ### NPM | ||
| ``` | ||
| npx husky set ./husky/pre-commit "npx pretty-quick --staged" | ||
| npx husky set .husky/pre-commit "npx pretty-quick --staged" | ||
| npx husky add .husky/pre-commit "npm test --watchAll=false" | ||
| ``` | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've simple tried to execute instruction step by step without having yarn installed and failed. this fix will include also instructions for NPM