Skip to content

added husky and configured it for required workflow #162

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

Merged
Neelterminusdb merged 3 commits into from
Apr 4, 2022
Merged

added husky and configured it for required workflow #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
91daf23
added husky and configured it
Neelterminusdb Mar 25, 2022
2f31114
Update README.md
Neelterminusdb Mar 28, 2022
b9ca896
generated docs
Neelterminusdb Mar 28, 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
15 changes: 15 additions & 0 deletions .husky/pre-commit
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

# Lint
npm run lint:check;

# Test
npm test;

# Build
npm run build

# Check changes in docs
npm run mkdocs;
git diff --exit-code
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,8 @@ If you encounter other questions, you can ask in our [Discord Server](https://di

## Contribute

> :memo: This project uses [Husky](https://www.npmjs.com/package/husky) which automatically runs lint, tests, and other scripts when you try to commit any changes to the repository. This helps us to improve each commit done to the repo and is automatically installed and configured when you do `npm install`

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

Please check [Contributing.md](Contributing.md) for more information.
Expand Down
2 changes: 2 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,8 @@ If you encounter other questions, you can ask in our [Discord Server](https://di

## Contribute

> :memo: This project uses [Husky](https://www.npmjs.com/package/husky) which automatically runs lint, tests, and other scripts when you try to commit any changes to the repository. This helps us to improve each commit done to the repo and is automatically installed and configured when you do `npm install`

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

Please check [Contributing.md](Contributing.md) for more information.
Expand Down
22 changes: 22 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
"eslint-plugin-import": "^2.25.4",
"eslint-plugin-prettier": "3.1.3",
"html-webpack-plugin": "^5.3.1",
"husky": "^7.0.4",
"jsdoc-to-markdown": "^7.1.0",
"mocha": "^9.1.3",
"nyc": "^15.1.0",
Expand Down Expand Up @@ -75,7 +76,8 @@
"npm:publish": "npm publish --access public",
"test-single": "mocha $1",
"woql-test": "mocha test/woqlTripleBuilder.spec.js test/woql.spec.js test/woqlTripleBuilder01.spec.js test/woqlExtra.spec.js",
"git-tag": "git tag $npm_package_version"
"git-tag": "git tag $npm_package_version",
"prepare": "husky install"
},
"repository": {
"type": "git",
Expand Down