{"_id":"@coderspirit/husky-fork","_rev":"1-54f748a2cd7264c025a44abf56a0d565","name":"@coderspirit/husky-fork","dist-tags":{"latest":"4.3.0"},"versions":{"4.3.0":{"name":"@coderspirit/husky-fork","version":"4.3.0","description":"Prevents bad commit or push (git hooks, pre-commit/precommit, pre-push/prepush, post-merge/postmerge and all that stuff...)","bin":{"husky-run":"bin/run.js","husky-upgrade":"lib/upgrader/bin.js"},"engines":{"node":">=10"},"scripts":{"test":"npm run lint && jest","install":"node husky install","preuninstall":"node husky uninstall","build":"del-cli lib && tsc","version":"jest -u && git add -A src/installer/__tests__/__snapshots__","postversion":"git push && git push --tags","prepublishOnly":"npm run test && npm run build && pinst --enable && pkg-ok","postpublish":"pinst --disable","lint":"eslint . --ext .js,.ts --ignore-path .gitignore","fix":"npm run lint -- --fix","doc":"markdown-toc -i README.md","postinstall":"opencollective-postinstall || exit 0"},"repository":{"type":"git","url":"git+https://github.com/castarco/husky.git"},"keywords":["git","hook","hooks","pre-commit","precommit","post-commit","postcommit","pre-push","prepush","post-merge","postmerge","test","lint"],"author":{"name":"Typicode","email":"typicode@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/typicode/husky/issues"},"homepage":"https://github.com/typicode/husky#readme","dependencies":{"chalk":"^4.1.0","ci-info":"^2.0.0","compare-versions":"^3.6.0","cosmiconfig":"^6.0.0","find-versions":"^3.2.0","opencollective-postinstall":"^2.0.3","pkg-dir":"^4.2.0","please-upgrade-node":"^3.2.0","slash":"^3.0.0","which-pm-runs":"^1.0.0"},"devDependencies":{"@types/ci-info":"^2.0.0","@types/cosmiconfig":"^6.0.0","@types/jest":"^25.2.3","@types/mkdirp":"^1.0.1","@types/node":"^13.13.15","@typescript-eslint/eslint-plugin":"^2.34.0","@typescript-eslint/parser":"^2.34.0","cross-env":"^7.0.2","del":"^5.1.0","del-cli":"^3.0.1","eslint":"^6.8.0","eslint-config-prettier":"^6.11.0","eslint-config-xo-space":"^0.24.0","eslint-plugin-prettier":"^3.1.4","formatree":"^1.0.2","jest":"^25.5.4","markdown-toc":"^1.2.0","mkdirp":"^1.0.4","pinst":"^2.0.0","pkg-ok":"^2.3.1","prettier":"^2.0.5","tempy":"^0.5.0","ts-jest":"^25.5.1","type-fest":"^0.13.1","typescript":"^3.9.7"},"jest":{"transform":{"^.+\\.tsx?$":"ts-jest"},"testRegex":"(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$","testPathIgnorePatterns":["node_modules","__env__.ts"],"moduleFileExtensions":["ts","js","json","node"]},"collective":{"type":"opencollective","url":"https://opencollective.com/husky"},"funding":{"type":"opencollective","url":"https://opencollective.com/husky"},"gitHead":"001839536eded60b80392defe22573f1eb7a7982","_id":"@coderspirit/husky-fork@4.3.0","_nodeVersion":"14.6.0","_npmVersion":"6.14.7","dist":{"integrity":"sha512-pxCdsEDMsFsRr9YPvBOfGHeFQ4Jqo1q8y15vpi9JYNtGX0F9PnYLOW4df8bwVaDh6OTK6R58OQgH0HBXrIBOeg==","shasum":"f0616448a5fdd40cc02ffe2ca4ab74e9cd60e318","tarball":"https://registry.npmjs.org/@coderspirit/husky-fork/-/husky-fork-4.3.0.tgz","fileCount":24,"unpackedSize":52315,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfIFwGCRA9TVsSAnZWagAAZT0P/1RSsemkPzKTdJLmNXva\n2A0drH/mM60uiuVAroU5/+kVT+kbEG+uZLQ2xspvLpfiz6eOpQXGRam/lF7v\nwS6AlGDc/AseOgEYZZv2N4+CZOfgl/dw0Op5pKUOhpb/jKJrkRbmVju9xYjp\nXxJq0hwRUZzAXlzoszhPR8hSNDW2vi8izE5IdIiEfAopiKEcY7AF5V/GwgTS\nVbctHUw/ZpU5cFmH5Yud1SdODgMvgvmhMxkTUVJlAljXR4S92Nl/DRLR/f3L\n6xlDM5TJueOvAjZY6l9tVd9WxQdWyT6OhtheanEIQPoMT9zW886UFCW1Fdrx\nRkhDId0SUrA9m/NJOpIHsSyFpY0fPKNEeI2ei6egskj9tD/sJ2PsYjcnhSsZ\nk4JBxvZMDtjVUzZ2ScSSE0zHOnePkr+PioLKJaUASJcSb7Z5CuY8cvNL5H4x\nimN/E9yVRtau0rX/rJzw4KoIFypHm3HRO6D1MVDaEgtVcDCPsKGlmJNQ9G+A\nMMNkDrIsX9Z8i1u8+HDxAB3okhL4CRtrL7sx49JeqSy85AT8VZRqPGbsFytE\n2VcPI4VH8COBZ6FJEAXqS5whxRbKG4Q9z2513bpGwwECsuhyxI8Edw5cHBGf\nypgQ3VnErkoiy2MWviZ9Yn99tNr1n4uIhFBu07caxVCFnVEh+KHg02JYTuX3\nmUgy\r\n=xvQ5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAcfwBXb9VPBOZOOGNlr3wH/PT2fkvnpYGxDkx+e1HtYAiAWVzOY1ItmwE8eZYkwpzifEUlwnlGQ8Gqo9+g1JCiHaw=="}]},"maintainers":[{"name":"castarco","email":"castarco@gmail.com"}],"_npmUser":{"name":"castarco","email":"castarco@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/husky-fork_4.3.0_1595956229692_0.5398306817280221"},"_hasShrinkwrap":false}},"time":{"created":"2020-07-28T17:10:29.475Z","4.3.0":"2020-07-28T17:10:29.818Z","modified":"2022-04-05T00:05:52.461Z"},"maintainers":[{"name":"castarco","email":"castarco@gmail.com"}],"description":"Prevents bad commit or push (git hooks, pre-commit/precommit, pre-push/prepush, post-merge/postmerge and all that stuff...)","homepage":"https://github.com/typicode/husky#readme","keywords":["git","hook","hooks","pre-commit","precommit","post-commit","postcommit","pre-push","prepush","post-merge","postmerge","test","lint"],"repository":{"type":"git","url":"git+https://github.com/castarco/husky.git"},"author":{"name":"Typicode","email":"typicode@gmail.com"},"bugs":{"url":"https://github.com/typicode/husky/issues"},"license":"MIT","readme":"# Husky\n\n**NOTICE:**: Temporary fork, until the PR [#747](https://github.com/typicode/husky/pull/747) gets merged.\n\n[![Financial Contributors on Open Collective](https://opencollective.com/husky/all/badge.svg?label=financial+contributors)](https://opencollective.com/husky) [![](https://img.shields.io/npm/dm/husky.svg?style=flat)](https://www.npmjs.org/package/husky) [![Mac/Linux Build Status](https://img.shields.io/travis/typicode/husky/master.svg?label=Mac%20OSX%20%26%20Linux)](https://travis-ci.org/typicode/husky) [![Windows Build status](https://img.shields.io/appveyor/ci/typicode/husky/master.svg?label=Windows)](https://ci.appveyor.com/project/typicode/husky)\n\n> Git hooks made easy\n\nHusky can prevent bad `git commit`, `git push` and more šŸ¶ _woof!_\n\n## Install\n\n```sh\nnpm install husky --save-dev\n```\n\n```js\n// package.json\n{\n \"husky\": {\n \"hooks\": {\n \"pre-commit\": \"npm test\",\n \"pre-push\": \"npm test\",\n \"...\": \"...\"\n }\n }\n}\n```\n\n```sh\ngit commit -m 'Keep calm and commit'\n```\n\n_Existing hooks are kept. Requires Node `>= 10` and Git `>= 2.13.0`._\n\n## Reinstall\n\nIf Husky is already in your `node_modules` or `pnp.js` (Yarn 2) and you want to reinstall hooks, you can run `npm rebuild` or `yarn rebuild`.\n\n## Uninstall\n\n```sh\nnpm uninstall husky\n```\n\n_Git hooks installed by husky will be removed._\n\n## Financial Contributors\n\nBecome a financial contributor and help us sustain our community ā¤ļø [[Contribute](https://opencollective.com/husky/contribute)]\n\n### Organizations\n\nSupport this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/husky/contribute)]\n\n\n#### Gold Sponsors ($500+ / month)\n\n\n\n\n\n\n\n\n\n\n\n\n#### Silver Sponsors ($250+ / month)\n\n\n\n\n\n\n\n\n\n\n\n\n#### Bronze Sponsors ($100+ / month)\n\n\n\n\n\n\n\n\n\n\n\n\n\n### Individuals\n\n\n\n## Used by\n\n* [webpack](https://github.com/webpack/webpack)\n* [babel](https://github.com/babel/babel)\n* [create-react-app](https://github.com/facebookincubator/create-react-app)\n* ... and many other awesome projects\n\n## Guides\n\n\n\n * [Upgrading from 0.14](#upgrading-from-014)\n * [Supported hooks](#supported-hooks)\n * [Access Git params and stdin](#access-git-params-and-stdin)\n * [Skip all hooks (rebase)](#skip-all-hooks-rebase)\n * [Disable auto-install](#disable-auto-install)\n * [CI servers](#ci-servers)\n * [Monorepos](#monorepos)\n * [Node version managers](#node-version-managers)\n * [Local commands (~/.huskyrc)](#local-commands-huskyrc)\n * [Per-project commands (/project/dir/.huskyhook)](#per-project-commands-projectdirhuskyhook)\n * [Multiple commands](#multiple-commands)\n * [Troubleshoot](#troubleshoot)\n + [Debug messages](#debug-messages)\n + [Hooks aren't running](#hooks-arent-running)\n + [Commits aren't blocked](#commits-arent-blocked)\n + [Commits are slow](#commits-are-slow)\n + [Testing husky in a new repo](#testing-husky-in-a-new-repo)\n + [ENOENT error 'node_modules/husky/.git/hooks'](#enoent-error-node_moduleshuskygithooks)\n\n\n\n### Upgrading from 0.14\n\nRun `husky-upgrade` to automatically upgrade your configuration:\n\n```\nnpx --no-install husky-upgrade\n```\n\nYou can also do it manually. Move your existing hooks to `husky.hooks` field and use raw Git hooks names. Also, if you were using `GIT_PARAMS` env variable, rename it to `HUSKY_GIT_PARAMS`.\n\n```diff\n{\n \"scripts\": {\n- \"precommit\": \"npm test\",\n- \"commitmsg\": \"commitlint -E GIT_PARAMS\"\n },\n+ \"husky\": {\n+ \"hooks\": {\n+ \"pre-commit\": \"npm test\",\n+ \"commit-msg\": \"commitlint -E HUSKY_GIT_PARAMS\"\n+ }\n+ }\n}\n```\n\nStarting with `1.0.0`, husky can be configured using `.huskyrc`, `.huskyrc.json`, `.huskyrc.yaml`, `huskyrc.yml`, `.huskyrc.js` or `husky.config.js` file.\n\n```js\n// .huskyrc\n{\n \"hooks\": {\n \"pre-commit\": \"npm test\"\n }\n}\n```\n\n### Supported hooks\n\nHusky supports all Git hooks defined [here](https://git-scm.com/docs/githooks). Server-side hooks (`pre-receive`, `update` and `post-receive`) aren't supported.\n\n### Access Git params and stdin\n\nGit hooks can get parameters via command-line arguments and stdin. Husky makes them accessible via `HUSKY_GIT_PARAMS` and `HUSKY_GIT_STDIN` environment variables.\n\n```\n\"commit-msg\": \"echo $HUSKY_GIT_PARAMS\"\n```\n\n### Skip all hooks (rebase)\n\nDuring a rebase you may want to skip all hooks, you can use `HUSKY_SKIP_HOOKS` environment variable.\n\n```sh\nHUSKY_SKIP_HOOKS=1 git rebase ...\n```\n\n### Disable auto-install\n\nIf you don't want husky to automatically install Git hooks, simply set `HUSKY_SKIP_INSTALL` environment variable.\n\n```sh\nHUSKY_SKIP_INSTALL=1 npm install\n```\n\n### CI servers\n\nBy default, Husky won't install on CI servers.\n\n### Monorepos\n\nIf you have a multi-package repository, it's __recommended__ to use tools like [lerna](https://github.com/lerna/lerna) and have husky installed ONLY in the root `package.json` to act as the source of truth.\n\nGenerally speaking, you should AVOID defining husky in multiple `package.json`, as each package would overwrite previous husky installation.\n\n```sh\n.\nā””ā”€ā”€ root\n ā”œā”€ā”€ .git\n ā”œā”€ā”€ package.json šŸ¶ # Add husky here\n ā””ā”€ā”€ packages\n ā”œā”€ā”€ A\n ā”‚ ā””ā”€ā”€ package.json\n ā”œā”€ā”€ B\n ā”‚ ā””ā”€ā”€ package.json\n ā””ā”€ā”€ C\n ā””ā”€ā”€ package.json\n```\n\n```js\n// root/package.json\n{\n \"private\": true,\n \"devDependencies\": {\n \"husky\": \"...\"\n },\n \"husky\": {\n \"hooks\": {\n \"pre-commit\": \"lerna run test\"\n }\n }\n}\n```\n\n### Node version managers\n\nIf you're on Windows, husky will simply use the version installed globally on your system.\n\nFor macOS and Linux users:\n- if you're running `git` commands in the terminal, husky will use the version defined in your shell `PATH`. In other words, if you're a `nvm` user, husky will use the version that you've set with `nvm`.\n- if you're using a GUI client and `nvm`, it may have a different `PATH` and not load `nvm`, in this case the highest `node` version installed by `nvm` will usually be picked. You can also check `~/.node_path` to see which version is used by GUIs and edit if you want to use something else.\n\n### Local commands (~/.huskyrc)\n\nHusky will source `~/.huskyrc` file if it exists before running hook scripts.\nYou can use it, for example, to load a node version manager or run some `shell` commands before hooks.\n\n```sh\n# ~/.huskyrc\nexport NVM_DIR=\"$HOME/.nvm\"\n[ -s \"$NVM_DIR/nvm.sh\" ] && \\. \"$NVM_DIR/nvm.sh\"\n```\n\n### Per-project commands (/project/dir/.huskyhook)\n\nHusky will source `/project/dir/.huskyhook` file if it exists before running hook scripts (also before the local command\ndefined in `~/.huskyrc`). You can use it the same way you use `~/.huskyrc`, but being able to track the script with\n`git` and share it with your project colleagues.\n\n### Multiple commands\n\nBy design and just like `scripts` defined in `package.json`, husky will run hook scripts as a single command. \n\n```json\n\"pre-commit\": \"cmd && cmd\"\n```\n\nThat said, if you prefer to use an array, the recommended approach is to define them in `.huskyrc.js` or `husky.config.js`.\n\n```js\nconst tasks = arr => arr.join(' && ')\n\nmodule.exports = {\n 'hooks': {\n 'pre-commit': tasks([\n 'cmd',\n 'cmd'\n ])\n }\n}\n```\n\nTools like [npm-run-all](https://github.com/mysticatea/npm-run-all) can help too.\n\n### Troubleshoot\n\n#### Debug messages\n\n`HUSKY_DEBUG=1` can provide additional information when running commands.\n\n```\nHUSKY_DEBUG=1 npm install husky --save-dev\nHUSKY_DEBUG=1 git commit ...\n```\n\n#### Hooks aren't running\n\nCheck if hooks were installed. Verify that `.git/hooks/pre-commit` exists and have husky code. It should start with:\n\n```sh\n#!/bin/sh\n# husky...\n```\n\nIf not, you may have another Git hooks manager defined in your `package.json` overwriting husky's hooks. Check also the output during install, you should see:\n\n```\nhusky > Setting up git hooks\nhusky > Done\n```\n\n#### Commits aren't blocked\n\nFor a commit to be blocked, `pre-commit` script must exit with a non-zero exit code. If you commit isn't blocked, check your script exit code.\n\n#### Commits are slow\n\nHusky is fast and only adds a few tenth of seconds to commits (`~0.3s` on a low-end PC). So it's most probably related to how many things are done during `pre-commit`. You can often improve this by using cache on your tools (babel, eslint, ...) and using [lint-staged](https://github.com/okonet/lint-staged).\n\n#### Testing husky in a new repo\n\nTo isolate your issue, you can also create a new repo:\n\n```sh\nmkdir foo && cd foo\ngit init && npm init -y\nnpm install husky --save-dev\n\n# Add a failing pre-commit hook to your package.json:\n# \"pre-commit\": \"echo \\\"this should fail\\\" && exit 1\"\n\n# Make a commit\n```\n\n#### ENOENT error 'node_modules/husky/.git/hooks'\n\nVerify that your version of Git is `>=2.13.0`.\n\n## See also\n\n* [pkg-ok](https://github.com/typicode/pkg-ok) - Prevents publishing a module with bad paths or incorrect line endings\n* [please-upgrade-node](https://github.com/typicode/please-upgrade-node) - Show a message to upgrade Node instead of a stacktrace in your CLIs\n* [pinst](https://github.com/typicode/pinst) - dev only postinstall hook\n\n## Patreon\n\nPeople and companies supporting via Patreon: [thanks](https://thanks.typicode.com)\n\n## License\n\nMIT\n","readmeFilename":"README.md"}