Skip to content
This repository has been archived by the owner on Aug 16, 2023. It is now read-only.

Adding husky and pre-commit hooks #55

Merged
merged 3 commits into from
Oct 30, 2020
Merged

Adding husky and pre-commit hooks #55

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
064cda3
Adding husky and pre-commit hooks
redg-indeed Oct 30, 2020
acd0cc4
Updating README based on PR feedback
redg-indeed Oct 30, 2020
8128df4
Minor tweaks to README
redg-indeed Oct 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Run `npm run build` to compile the code to Javascript.

Run `node dist/examples/runFasterCode.js` (to use GraphQL) or `node dist/examples/runOldCode.ts` (to use REST calls), to run the example program. It requires internet access, since it calls the GitHub API. It will take a couple minutes to complete. Some of the output includes the word "ERROR", so don't panic.

Husky now runs linting checks pre-commit. Either manually fix the errors or run `npm run lint:fix` to automatically fix any errors.
Ensure to lint your code by running `npm run lint` before submitting any code for review. Either manually fix the errors or run `npm run lint:fix` to automatically fix any errors. Husky set up to run linting checks pre-commit which should prevent being able to commit linting errors; however, There is an [bug](https://github.com/typicode/husky/issues/639) in husky where occasionally the hooks won't run in an IDE.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@redgardner This looks great. Just a couple minor requests:

  • I think the third sentence should say "Husky is set up" (insert the "is").
  • It should probably be "a [bug]" rather than "an [bug]".
  • In markdown, I have recently developed a preference to split a long paragraph like this into multiple lines, to simplify future diffs. (If that's too much of a pain, I'm wiling to merge it with the current formatting.)

Thanks!

Copy link
Author

@redgardner redgardner Oct 30, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤦 Sorry for the bad grammar this morning. All fixed up and I think the split paragraphs looks nicer now


## Local testing of the npm packaging

Expand Down