Skip to content

docs(README.md): updated docs to reflect new npm set scripts methods #5

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.

Sign up for GitHub

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

Open
FreakinWard wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(README.md): updated docs to reflect new npm set scripts methods #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
825da43
docs(README.md): updated docs to reflect new npm set scripts methods
FreakinWard Sep 8, 2022
2fc90e1
build(package.json): updated npm dependencies
FreakinWard Sep 8, 2022
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,20 @@ module.exports = {

Install husky, create prepare script which installs husky
1. `npm i -D husky`
1. `npm set-script prepare "husky install"`
1. `npm pkg set scripts.prepare "husky install"`
1. `npm run prepare`

# Setup commitizen
1. `npm i -D commitizen cz-conventional-changelog`
1. `commitizen init cz-conventional-changelog`
1. `npm set-script pre-commit "exec < /dev/tty && git cz --hook || true\n"`
1. `npm pkg set scripts.pre-commit "exec < /dev/tty && git cz --hook || true\n"`
1. `npx husky add .husky/pre-commit "npm run pre-commit" && git add .husky/pre-commit`

[more details](https://schalkneethling.medium.com/automate-package-releases-with-semantic-release-and-commitizen-d7d4c337f04f#4f24)

# Setup commitlint
1. `npm i -D @commitlint/{cli,config-conventional}`
1. `npm set-script commit-msg "npx --no-install commitlint --edit $1"`
1. `npm pkg set scripts.commit-msg "npx --no-install commitlint --edit $1"`
1. `npx husky add .husky/commit-msg "npm run commit-msg" && git add .husky/commit-msg`

```javascript
Expand Down
Loading