{"_id":"@artemv/dont-break","_rev":"16-45ba00cbf6c22e5fe1a64e7ac9a91710","name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","dist-tags":{"latest":"1.13.4-pre.1","pre":"1.12.2-pre.5","artembeta":"1.13.5-pre.1"},"versions":{"1.11.0-pre":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.11.0-pre","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.11.0","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.0","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.4","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.3.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.16.0","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"gitHead":"5c2b0cb86321e8b75d2cb3c83390d704a76ae8fa","_id":"@artemv/dont-break@1.11.0-pre","_shasum":"d18cb2b2e4ed741cf249de1c2bc84018131efc28","_from":".","_npmVersion":"4.1.2","_nodeVersion":"7.5.0","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"shasum":"d18cb2b2e4ed741cf249de1c2bc84018131efc28","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.11.0-pre.tgz","integrity":"sha512-H9KPFjJ7B8taH6ibZrZ3SpUpcOsvn9kxku/vvNmBHoC3qMZyW6Vz/VTbk0DAw5OeTKx3TKIiOQcGrUDOwkNplg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDeI2HJZLNNkNb5yJ5Ohhm2CaRRGnlLSiNvi3fcieIcDAIhALkA6lLOaePXzU7niBnDZbjmgT2F3ZsFwqZjlJIVUisg"}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break-1.11.0-pre.tgz_1510695303412_0.029122785199433565"},"directories":{}},"1.11.0-pre.1":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.11.0-pre.1","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.11.0","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.0","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.4","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.3.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.16.0","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"gitHead":"5c2b0cb86321e8b75d2cb3c83390d704a76ae8fa","_id":"@artemv/dont-break@1.11.0-pre.1","_shasum":"a000db2e45695e7eaed5199fe213f894b8bd0e22","_from":".","_npmVersion":"4.1.2","_nodeVersion":"7.5.0","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"shasum":"a000db2e45695e7eaed5199fe213f894b8bd0e22","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.11.0-pre.1.tgz","integrity":"sha512-PXWND+21FafD/CnVAQ4i++qqUfMGabMOM8lRk1yvoCf9OOJYrI+5G2QSyQgC2E2iJnGKB6I1/v1kMGrE3oSRlA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBDafZ5acQR1yGa+dfNQdItoJZafcebAuDzm9WFyy1sWAiBh4EmAfDKKYgoilJg4mKSL4GJThQF2axcTMjvTx+aF/A=="}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break-1.11.0-pre.1.tgz_1510696172468_0.5399730545468628"},"directories":{}},"1.11.0-pre.2":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.11.0-pre.2","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.11.0","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.0","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.4","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.3.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.16.0","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"gitHead":"afa7a3366a6396c4bf3e3d471c8bf24659854155","_id":"@artemv/dont-break@1.11.0-pre.2","_shasum":"b22a54077bbd61009d753b8f9f19dff0ede83093","_from":".","_npmVersion":"4.1.2","_nodeVersion":"7.5.0","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"shasum":"b22a54077bbd61009d753b8f9f19dff0ede83093","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.11.0-pre.2.tgz","integrity":"sha512-Lm1qdmgzamdajYb9yC8VvoBnma0+lSDSxh8+eHGrhoLJCq8PUW5US3EXuxwPTXrqZ1UqwwBu55YposW0dFKu6g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIE6J4NXG5Tt/S3bvxY6HVAW2/F2Kgdtje3Di9qnOAWSyAiEA+mTd5GE3IBELo2IZgqil9bhxUr/Lm3GKdFkRBPTkgTI="}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break-1.11.0-pre.2.tgz_1510699307667_0.9803926376625896"},"directories":{}},"1.13.0":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.13.0","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.14.1","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.2","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.5","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.3.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.17.0","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"gitHead":"ee25e646dde0aad871f21344ac078b36bd3c1549","_id":"@artemv/dont-break@1.13.0","_npmVersion":"5.6.0","_nodeVersion":"8.9.3","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"integrity":"sha512-IL/TPJMmJDlbC+UkTkOstiz7vaawdUVdm+G0OnuxIyLHStCLDhsahWdtsvKzLzHsyK79CWJj3dZb3VkOgduS0w==","shasum":"f8b8dde911e8d41524d57bc8065bc17898700b1e","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.13.0.tgz","fileCount":11,"unpackedSize":32045,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDwoEoduiN38b/r0zxbTob7aiZpj+8crExXYaX2lNQ8JgIgTnCfEQ0XyQw4+MQOlYf7yZ7VfunJriURn+0iF7F4Bsc="}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break_1.13.0_1519252656928_0.9305118215042132"},"_hasShrinkwrap":false},"1.12.2-pre.1":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.12.2-pre.1","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.14.1","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.2","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.5","mkdirp":"^0.5.1","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.3.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.17.0","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"readme":"# dont-break\n\nChecks if the node module in the current folder breaks unit tests for specified dependent projects.\n\n[Relevant discussion at npm](https://github.com/npm/npm/issues/6510),\n[Do not break dependant modules](http://glebbahmutov.com/blog/do-not-break-dependant-modules/).\n\n[![Build status][dont-break-ci-image] ][dont-break-ci-url]\n[![npm][dont-break-npm-image]](dont-break-npm-url)\n[![semantic-release][semantic-image] ][semantic-url]\n[![next-update-travis badge][nut-badge]][nut-readme]\n\n[dont-break-icon]: https://nodei.co/npm/dont-break.svg?downloads=true\n[dont-break-url]: https://npmjs.org/package/dont-break\n[dont-break-ci-image]: https://travis-ci.org/bahmutov/dont-break.svg?branch=master\n[dont-break-ci-url]: https://travis-ci.org/bahmutov/dont-break\n[dont-break-npm-url]: https://img.shields.io/npm/dm/dont-break\n[dont-break-npm-image]: https://img.shields.io/npm/dm/dont-break.svg?maxAge=2592000\n[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-url]: https://github.com/semantic-release/semantic-release\n[nut-badge]: https://img.shields.io/badge/next--update--travis-weekly-green.svg\n[nut-readme]: https://github.com/bahmutov/next-update-travis#readme\n\n## Install\n```\nnpm install -g dont-break\n```\n\n## Use\n\n* Create `.dont-break.json` file in the root of your package,\n  list module names that you would like to test as an array.\n* Run `dont-break` any time to test latest version of each dependent module\n  against the curent code\n\n## Example\n\n2 projects.\n\n1. First project `foo` only exports single variable `module.exports = 'foo';`\n2. Second project `foo-user` depends on `foo`.\n\n`foo-user` only works if it gets string `foo` from the module it depends on, like this:\n```js\nvar str = require('foo');\nconsole.assert(str === 'foo', 'value of foo should be \"foo\", but is ' + str);\n```\n`foo` has only a single release 0.1.0 that works for `foo-user` project.\n\nThe author of `foo` changes code to be `module.exports = 'bar';` and releases it as 0.2.0.\n`foo-user` wants to use the latest `foo` so it updates its dependency, not expecting anything\nbad - foo's minor version number has been upgraded. In semantic versioning it means no breaking API\nchanges.\n\n`foo-user` is now broken!\n\nInstead, before publishing new version to NPM, project `foo` can create a file in its\nproject folder `.dont-break.json` with names of dependent projects to test\n```bash\necho '[\"foo-user\"]' > .dont-break.json\n```\nYou can check if the current code breaks listed dependent project by running\n\n```bash\ndont-break\n```\n\nThis will install each dependent project from `.dont-break.json` file into `/tmp/dont-break...` folder,\nwill run the dependent's unit tests using `npm test` to make sure they work initially, then\nwill copy the current project into the temp folder, overwriting the previous working version.\nThen it will run the tests again, throwing an exception if they stopped working.\n\nIn the example case, it will report something like this\n```bash\n$ dont-break\ndependents [ 'foo-user' ]\ntesting foo-user\n  installing foo-user\ninstalled into /tmp/foo@0.0.0-against-foo-user\n  npm test\ntests work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncopied /Users/gleb/git/foo/* to /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user/node_modules/foo\n  npm test\nnpm test returned 1\ntest errors:\nAssertionError: value of foo should be \"foo\", but is bar\nnpm ERR! Test failed.  See above for more details.\nnpm ERR! not ok code 0\ntests did not work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncode 1\nFAIL: Current version break dependents\n```\nThe message clearly tells you that the dependent projects as they are right now cannot\nupgrade to the version you are about to release.\n\n## Dependencies\n\nYou can specify GitHub repos as dependencies, because they most likely will\nhave tests. For example in `.dont-break.json`\n\n```js\n// you can use JavaScript comments in this file .dont-break.json\n[\n  \"https://github.com/bahmutov/dont-break-bar\"\n]\n```\n\nPicking projects to test manually is a judgement call.\nDont-break can fetch top N most downloaded\nor most starred dependent modules and save the list.\n* run `dont-break --top-downloads <N>` to find top N most downloaded dependent modules,\nsave to `.dont-break.json` and check.\n* run `dont-break --top-starred <N>` to find top N most starred dependent modules,\nsave to `.dont-break.json` and check.\n\nThe above commands overwrite `.dont-break.json` file.\n\n## Configuration options\n\n### Global vs. project-level configuration\nYou can specify different configuration options on global level or on project level. Following configs are equivalent.\nProject level:\n```\n[\n  {\n    \"name\": \"project-a\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-b\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-c\",\n    \"test\": \"npm test:special\"\n  }\n]\n```\nGlobal level:\n```\n{\n  \"test\": \"grunt test\",\n  \"projects\": [\n    \"project-a\", \n    \"project-b\", \n    {\n      \"name\": \"project-c\",\n      \"test\": \"npm test:special\"\n    }\n  ]\n}\n```\nGlobal level will simplify dont-break config if dependent projects share the same options. Also, options can be \noverriden on project level as in case of \"project-c\" here.\n  \n### Execution flow overview\nDont-break performs folowing steps for each dependent project:\n* Install the dependent project into temporary dir using the [specified command](#install-command)\n* Run [post-install](#post-install-command) command\n* [Pre-test](#pre-testing-with-previous-package-version) it if this is not disabled\n* [Install current module](#current-module-installation-method) into the dependent project\n* Run [post-install](#post-install-command) command\n* [Test](#test-command) the dependent project\n\nSections below describe how you can customize these steps.\n\n### Test command\n\nYou can specify a custom test command per dependent module. For example, to run `grunt test` for `foo-module-name`,\nbut default command for module `bar-name`, list in `.dont-break.json` the following:\n\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\"\n  },\n  \"bar-name\"\n]\n```\n\n### Install command\n\nYou can specify a custom install command per dependent module. By default it's `npm install`. For example, this will use\n`yarn add` for `foo-module-name`, but keep default `npm install` for module `bar-name`:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"install\": \"yarn add\"\n  },\n  \"bar-name\"\n]\n```\nThe name of dependent module will be added to given command, e.g. for above it will run `yarn add foo-module-name`. \n\n### Post-install command\n\nBefore testing the dependent package dont-break installs its dev dependencies via `npm install` command run from the\ndependency directory. If you need something more you can specify it via \"postinstall\" config parameter like this:\n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"npm run update\"\n  }, {\n    \"name\": \"packageB\"\n  }\n]\n```\nIf specified this command will run first before pretesting the old version of lib (if pretest isn't disabled), then \nafter installing current version of lib to dependent package. You can use {{CURRENT_MODULE_DIR}} variable here which \nwill be replaced with a path to current module: \n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"{{CURRENT_MODULE_DIR}}/install-all-deps.sh\",\n  }\n]\n```\n\n### Pre-testing with previous package version\nBy default dont-break first tests dependent module with its published version of current module, to make sure that it \nwas working before the update. If this sounds excessive to you you can disable it with {\"pretest\": false} option: \n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": false\n  }\n]\n```\nHere \"foo-module-name\" module will be tested only once, and \"bar-name\" twise: first with its published version of \ncurrent module, and then with the updated version.   \n\nThe \"pretest\" property can also accept custom script to run for pretesting:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": \"grunt test && ./ci/after-pretesting-by-dont-break\"\n  }\n]\n```\nBy default it equals to \"test\" command.\n\n### Current module installation method\n\nTo test dependent package dont-break installs current module inside the dependent package directory. By default it uses\n`cd $DEPENDENT_PACKAGE_DIR && npm install $CURRENT_MODULE_DIR`. Other options are \n[npm-link](https://docs.npmjs.com/cli/link) and [yarn-link](https://yarnpkg.com/lang/en/docs/cli/link/). They can be \nhelpful in some cases, e.g. if you need to use `npm install` or `yarn` in postinstall command. To use `npm link` method \nspecify {\"currentModuleInstall\": \"npm-link\"}: \n```\n{\n  \"currentModuleInstall\": \"npm-link\",\n  \"projects\": [\"packageA\", \"packageB\"]\n}\n```\nDefault value is {\"currentModuleInstall\": \"npm-install\"}. \n \n### Installation timeout\nYou can specify a longer installation time out, in seconds, using CLI option\n\n```\ndont-break --timeout 30\n```\n\n## Related\n\n*dont-break* is the opposite of [next-update](https://github.com/bahmutov/next-update)\nthat one can use to safely upgrade dependencies.\n\n## Setting up second CI for dont-break\n\nI prefer to use a separate CI service specifically to test the current code\nagainst the dependent projects using `dont-break`. For example, the project\n[boggle](https://www.npmjs.com/package/boggle) is setup this way. The unit tests\nare run on [TravisCI](https://travis-ci.org/bahmutov/boggle) using\npretty standard [.travis.yml](https://github.com/bahmutov/boggle/blob/master/.travis.yml) file\n\n```yml\nlanguage: node_js\nnode_js:\n  - \"0.12\"\n  - \"4\"\nbranches:\n  only:\n    - master\nbefore_script:\n  - npm install -g grunt-cli\n```\n\nThen I setup a separate build service on [CircleCi](https://circleci.com/gh/bahmutov/boggle)\njust to run the `npm run dont-break` command from the `package.json`\n\n```json\n\"scripts\": {\n    \"dont-break\": \"dont-break --timeout 30\"\n}\n```\n\nWe are assuming a global installation of `dont-break`, and the project lists\nthe projects to check in the\n[.dont-break](https://github.com/bahmutov/boggle/blob/master/.dont-break) file.\nAt the present there is only a single dependent project\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo run `dont-break` on CircleCI, I created the\n[circle.yml](https://github.com/bahmutov/boggle/blob/master/circle.yml) file.\nIt should be clear what it does - installs `dont-break`, and runs the npm script command.\n\n```yml\nmachine:\n  node:\n    version: \"0.12\"\ndependencies:\n  post:\n    - npm install -g dont-break\ntest:\n  override:\n    - npm run dont-break\n```\n\nTo make the status visible, I included the CircleCI badges in the README file.\n\n```md\n[![Dont-break][circle-ci-image] ][circle-ci-url]\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n```\n\nwhich produces the following:\n\nBreaking dependencies? [![Dont-break][circle-ci-image] ][circle-ci-url] using\n[dont-break](https://github.com/bahmutov/dont-break)\n\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n\n## Development and testing\n\nThis project is tested end to end using two small projects:\n[boggle](https://www.npmjs.com/package/boggle) and its dependent\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo see open github issues, use command `npm run issues`\n\nTo see verbose log message, run with `DEBUG=dont-break ...` environment\nvariable.\n\n### Small print\n\nAuthor: Gleb Bahmutov &copy; 2014\n\n* [@bahmutov](https://twitter.com/bahmutov)\n* [glebbahmutov.com](http://glebbahmutov.com)\n* [blog](http://glebbahmutov.com/blog)\n\nLicense: MIT - do anything with the code, but don't blame me if it does not work.\n\nSpread the word: tweet, star on github, etc.\n\nSupport: if you find any problems with this module, email / tweet /\n[open issue](https://github.com/bahmutov/dont-break/issues?state=open) on Github\n\nImplemented using [npm-registry](https://github.com/3rd-Eden/npmjs),\n[lazy-ass](https://github.com/bahmutov/lazy-ass) and [npm-utils](https://github.com/bahmutov/npm-utils).\n\n## MIT License\n\nCopyright (c) 2014 Gleb Bahmutov\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n","readmeFilename":"README.md","gitHead":"d376dda35c2e17107048bffa09daedb0ec4a47e3","_id":"@artemv/dont-break@1.12.2-pre.1","_npmVersion":"5.6.0","_nodeVersion":"8.9.4","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"integrity":"sha512-XXRU1fwb/gNOeI0Wqk2fZBGEwsAI1awy4exDMkwBNwPNSemImn9mkEmzcOVpL5iTloRt+1MJsZBSVwxSlm4+xQ==","shasum":"059194261e74023fdc8d9e845a665fbf509f40eb","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.12.2-pre.1.tgz","fileCount":11,"unpackedSize":32622,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDTQR5udH9eoVIr8Y0GW7r+KnglQJHsLmno8LZotq31rAiEAhBjHpUkCZcRs2fnx2jb2nSc3eHj5i8qv6o8fHDFhArQ="}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break_1.12.2-pre.1_1519836688405_0.04978864411876338"},"_hasShrinkwrap":false},"1.12.2-pre.2":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.12.2-pre.2","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.14.1","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.2","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.5","mkdirp":"^0.5.1","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.3.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.17.0","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"readme":"# dont-break\n\nChecks if the node module in the current folder breaks unit tests for specified dependent projects.\n\n[Relevant discussion at npm](https://github.com/npm/npm/issues/6510),\n[Do not break dependant modules](http://glebbahmutov.com/blog/do-not-break-dependant-modules/).\n\n[![Build status][dont-break-ci-image] ][dont-break-ci-url]\n[![npm][dont-break-npm-image]](dont-break-npm-url)\n[![semantic-release][semantic-image] ][semantic-url]\n[![next-update-travis badge][nut-badge]][nut-readme]\n\n[dont-break-icon]: https://nodei.co/npm/dont-break.svg?downloads=true\n[dont-break-url]: https://npmjs.org/package/dont-break\n[dont-break-ci-image]: https://travis-ci.org/bahmutov/dont-break.svg?branch=master\n[dont-break-ci-url]: https://travis-ci.org/bahmutov/dont-break\n[dont-break-npm-url]: https://img.shields.io/npm/dm/dont-break\n[dont-break-npm-image]: https://img.shields.io/npm/dm/dont-break.svg?maxAge=2592000\n[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-url]: https://github.com/semantic-release/semantic-release\n[nut-badge]: https://img.shields.io/badge/next--update--travis-weekly-green.svg\n[nut-readme]: https://github.com/bahmutov/next-update-travis#readme\n\n## Install\n```\nnpm install -g dont-break\n```\n\n## Use\n\n* Create `.dont-break.json` file in the root of your package,\n  list module names that you would like to test as an array.\n* Run `dont-break` any time to test latest version of each dependent module\n  against the curent code\n\n## Example\n\n2 projects.\n\n1. First project `foo` only exports single variable `module.exports = 'foo';`\n2. Second project `foo-user` depends on `foo`.\n\n`foo-user` only works if it gets string `foo` from the module it depends on, like this:\n```js\nvar str = require('foo');\nconsole.assert(str === 'foo', 'value of foo should be \"foo\", but is ' + str);\n```\n`foo` has only a single release 0.1.0 that works for `foo-user` project.\n\nThe author of `foo` changes code to be `module.exports = 'bar';` and releases it as 0.2.0.\n`foo-user` wants to use the latest `foo` so it updates its dependency, not expecting anything\nbad - foo's minor version number has been upgraded. In semantic versioning it means no breaking API\nchanges.\n\n`foo-user` is now broken!\n\nInstead, before publishing new version to NPM, project `foo` can create a file in its\nproject folder `.dont-break.json` with names of dependent projects to test\n```bash\necho '[\"foo-user\"]' > .dont-break.json\n```\nYou can check if the current code breaks listed dependent project by running\n\n```bash\ndont-break\n```\n\nThis will install each dependent project from `.dont-break.json` file into `/tmp/dont-break...` folder,\nwill run the dependent's unit tests using `npm test` to make sure they work initially, then\nwill copy the current project into the temp folder, overwriting the previous working version.\nThen it will run the tests again, throwing an exception if they stopped working.\n\nIn the example case, it will report something like this\n```bash\n$ dont-break\ndependents [ 'foo-user' ]\ntesting foo-user\n  installing foo-user\ninstalled into /tmp/foo@0.0.0-against-foo-user\n  npm test\ntests work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncopied /Users/gleb/git/foo/* to /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user/node_modules/foo\n  npm test\nnpm test returned 1\ntest errors:\nAssertionError: value of foo should be \"foo\", but is bar\nnpm ERR! Test failed.  See above for more details.\nnpm ERR! not ok code 0\ntests did not work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncode 1\nFAIL: Current version break dependents\n```\nThe message clearly tells you that the dependent projects as they are right now cannot\nupgrade to the version you are about to release.\n\n## Dependencies\n\nYou can specify GitHub repos as dependencies, because they most likely will\nhave tests. For example in `.dont-break.json`\n\n```js\n// you can use JavaScript comments in this file .dont-break.json\n[\n  \"https://github.com/bahmutov/dont-break-bar\"\n]\n```\n\nPicking projects to test manually is a judgement call.\nDont-break can fetch top N most downloaded\nor most starred dependent modules and save the list.\n* run `dont-break --top-downloads <N>` to find top N most downloaded dependent modules,\nsave to `.dont-break.json` and check.\n* run `dont-break --top-starred <N>` to find top N most starred dependent modules,\nsave to `.dont-break.json` and check.\n\nThe above commands overwrite `.dont-break.json` file.\n\n## Configuration options\n\n### Global vs. project-level configuration\nYou can specify different configuration options on global level or on project level. Following configs are equivalent.\nProject level:\n```\n[\n  {\n    \"name\": \"project-a\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-b\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-c\",\n    \"test\": \"npm test:special\"\n  }\n]\n```\nGlobal level:\n```\n{\n  \"test\": \"grunt test\",\n  \"projects\": [\n    \"project-a\", \n    \"project-b\", \n    {\n      \"name\": \"project-c\",\n      \"test\": \"npm test:special\"\n    }\n  ]\n}\n```\nGlobal level will simplify dont-break config if dependent projects share the same options. Also, options can be \noverriden on project level as in case of \"project-c\" here.\n  \n### Execution flow overview\nDont-break performs folowing steps for each dependent project:\n* Install the dependent project into temporary dir using the [specified command](#install-command)\n* Run [post-install](#post-install-command) command\n* [Pre-test](#pre-testing-with-previous-package-version) it if this is not disabled\n* [Install current module](#current-module-installation-method) into the dependent project\n* Run [post-install](#post-install-command) command\n* [Test](#test-command) the dependent project\n\nSections below describe how you can customize these steps.\n\n### Test command\n\nYou can specify a custom test command per dependent module. For example, to run `grunt test` for `foo-module-name`,\nbut default command for module `bar-name`, list in `.dont-break.json` the following:\n\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\"\n  },\n  \"bar-name\"\n]\n```\n\n### Install command\n\nYou can specify a custom install command per dependent module. By default it's `npm install`. For example, this will use\n`yarn add` for `foo-module-name`, but keep default `npm install` for module `bar-name`:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"install\": \"yarn add\"\n  },\n  \"bar-name\"\n]\n```\nThe name of dependent module will be added to given command, e.g. for above it will run `yarn add foo-module-name`. \n\n### Post-install command\n\nBefore testing the dependent package dont-break installs its dev dependencies via `npm install` command run from the\ndependency directory. If you need something more you can specify it via \"postinstall\" config parameter like this:\n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"npm run update\"\n  }, {\n    \"name\": \"packageB\"\n  }\n]\n```\nIf specified this command will run first before pretesting the old version of lib (if pretest isn't disabled), then \nafter installing current version of lib to dependent package. You can use {{CURRENT_MODULE_DIR}} variable here which \nwill be replaced with a path to current module: \n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"{{CURRENT_MODULE_DIR}}/install-all-deps.sh\",\n  }\n]\n```\n\n### Pre-testing with previous package version\nBy default dont-break first tests dependent module with its published version of current module, to make sure that it \nwas working before the update. If this sounds excessive to you you can disable it with {\"pretest\": false} option: \n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": false\n  }\n]\n```\nHere \"foo-module-name\" module will be tested only once, and \"bar-name\" twise: first with its published version of \ncurrent module, and then with the updated version.   \n\nThe \"pretest\" property can also accept custom script to run for pretesting:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": \"grunt test && ./ci/after-pretesting-by-dont-break\"\n  }\n]\n```\nBy default it equals to \"test\" command.\n\n### Current module installation method\n\nTo test dependent package dont-break installs current module inside the dependent package directory. By default it uses\n`cd $DEPENDENT_PACKAGE_DIR && npm install $CURRENT_MODULE_DIR`. Other options are \n[npm-link](https://docs.npmjs.com/cli/link) and [yarn-link](https://yarnpkg.com/lang/en/docs/cli/link/). They can be \nhelpful in some cases, e.g. if you need to use `npm install` or `yarn` in postinstall command. To use `npm link` method \nspecify {\"currentModuleInstall\": \"npm-link\"}: \n```\n{\n  \"currentModuleInstall\": \"npm-link\",\n  \"projects\": [\"packageA\", \"packageB\"]\n}\n```\nDefault value is {\"currentModuleInstall\": \"npm-install\"}. \n \n### Installation timeout\nYou can specify a longer installation time out, in seconds, using CLI option\n\n```\ndont-break --timeout 30\n```\n\n## Related\n\n*dont-break* is the opposite of [next-update](https://github.com/bahmutov/next-update)\nthat one can use to safely upgrade dependencies.\n\n## Setting up second CI for dont-break\n\nI prefer to use a separate CI service specifically to test the current code\nagainst the dependent projects using `dont-break`. For example, the project\n[boggle](https://www.npmjs.com/package/boggle) is setup this way. The unit tests\nare run on [TravisCI](https://travis-ci.org/bahmutov/boggle) using\npretty standard [.travis.yml](https://github.com/bahmutov/boggle/blob/master/.travis.yml) file\n\n```yml\nlanguage: node_js\nnode_js:\n  - \"0.12\"\n  - \"4\"\nbranches:\n  only:\n    - master\nbefore_script:\n  - npm install -g grunt-cli\n```\n\nThen I setup a separate build service on [CircleCi](https://circleci.com/gh/bahmutov/boggle)\njust to run the `npm run dont-break` command from the `package.json`\n\n```json\n\"scripts\": {\n    \"dont-break\": \"dont-break --timeout 30\"\n}\n```\n\nWe are assuming a global installation of `dont-break`, and the project lists\nthe projects to check in the\n[.dont-break](https://github.com/bahmutov/boggle/blob/master/.dont-break) file.\nAt the present there is only a single dependent project\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo run `dont-break` on CircleCI, I created the\n[circle.yml](https://github.com/bahmutov/boggle/blob/master/circle.yml) file.\nIt should be clear what it does - installs `dont-break`, and runs the npm script command.\n\n```yml\nmachine:\n  node:\n    version: \"0.12\"\ndependencies:\n  post:\n    - npm install -g dont-break\ntest:\n  override:\n    - npm run dont-break\n```\n\nTo make the status visible, I included the CircleCI badges in the README file.\n\n```md\n[![Dont-break][circle-ci-image] ][circle-ci-url]\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n```\n\nwhich produces the following:\n\nBreaking dependencies? [![Dont-break][circle-ci-image] ][circle-ci-url] using\n[dont-break](https://github.com/bahmutov/dont-break)\n\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n\n## Development and testing\n\nThis project is tested end to end using two small projects:\n[boggle](https://www.npmjs.com/package/boggle) and its dependent\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo see open github issues, use command `npm run issues`\n\nTo see verbose log message, run with `DEBUG=dont-break ...` environment\nvariable.\n\n### Small print\n\nAuthor: Gleb Bahmutov &copy; 2014\n\n* [@bahmutov](https://twitter.com/bahmutov)\n* [glebbahmutov.com](http://glebbahmutov.com)\n* [blog](http://glebbahmutov.com/blog)\n\nLicense: MIT - do anything with the code, but don't blame me if it does not work.\n\nSpread the word: tweet, star on github, etc.\n\nSupport: if you find any problems with this module, email / tweet /\n[open issue](https://github.com/bahmutov/dont-break/issues?state=open) on Github\n\nImplemented using [npm-registry](https://github.com/3rd-Eden/npmjs),\n[lazy-ass](https://github.com/bahmutov/lazy-ass) and [npm-utils](https://github.com/bahmutov/npm-utils).\n\n## MIT License\n\nCopyright (c) 2014 Gleb Bahmutov\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n","readmeFilename":"README.md","gitHead":"3de0948785da55a5938104dccbb865ba7ac86835","_id":"@artemv/dont-break@1.12.2-pre.2","_npmVersion":"5.6.0","_nodeVersion":"8.9.4","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"integrity":"sha512-REKU7buHC1s3g3Itb0lbrJ5se2MIFyLILmNK5RhWFsk6gaGaX4UuoNQvMHeVLNTuBPjQGH5O2Wz3k7gCU7WeNw==","shasum":"ea2f1e25c8f2d02ac08f45f8d5e0d71385c6f00a","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.12.2-pre.2.tgz","fileCount":11,"unpackedSize":32639,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD436ZNtNm+yo6vH68TPK8xWKA15DHogpGDhDW3dDeBugIgEGnbpgDcQp9BXrI2yDufsw4FiQnEgVuZe7oztFeQVS4="}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break_1.12.2-pre.2_1519837541741_0.20198426793882485"},"_hasShrinkwrap":false},"1.12.2-pre.3":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.12.2-pre.3","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.14.1","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.2","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.5","mkdirp":"^0.5.1","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.3.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.17.0","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"readme":"# dont-break\n\nChecks if the node module in the current folder breaks unit tests for specified dependent projects.\n\n[Relevant discussion at npm](https://github.com/npm/npm/issues/6510),\n[Do not break dependant modules](http://glebbahmutov.com/blog/do-not-break-dependant-modules/).\n\n[![Build status][dont-break-ci-image] ][dont-break-ci-url]\n[![npm][dont-break-npm-image]](dont-break-npm-url)\n[![semantic-release][semantic-image] ][semantic-url]\n[![next-update-travis badge][nut-badge]][nut-readme]\n\n[dont-break-icon]: https://nodei.co/npm/dont-break.svg?downloads=true\n[dont-break-url]: https://npmjs.org/package/dont-break\n[dont-break-ci-image]: https://travis-ci.org/bahmutov/dont-break.svg?branch=master\n[dont-break-ci-url]: https://travis-ci.org/bahmutov/dont-break\n[dont-break-npm-url]: https://img.shields.io/npm/dm/dont-break\n[dont-break-npm-image]: https://img.shields.io/npm/dm/dont-break.svg?maxAge=2592000\n[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-url]: https://github.com/semantic-release/semantic-release\n[nut-badge]: https://img.shields.io/badge/next--update--travis-weekly-green.svg\n[nut-readme]: https://github.com/bahmutov/next-update-travis#readme\n\n## Install\n```\nnpm install -g dont-break\n```\n\n## Use\n\n* Create `.dont-break.json` file in the root of your package,\n  list module names that you would like to test as an array.\n* Run `dont-break` any time to test latest version of each dependent module\n  against the curent code\n\n## Example\n\n2 projects.\n\n1. First project `foo` only exports single variable `module.exports = 'foo';`\n2. Second project `foo-user` depends on `foo`.\n\n`foo-user` only works if it gets string `foo` from the module it depends on, like this:\n```js\nvar str = require('foo');\nconsole.assert(str === 'foo', 'value of foo should be \"foo\", but is ' + str);\n```\n`foo` has only a single release 0.1.0 that works for `foo-user` project.\n\nThe author of `foo` changes code to be `module.exports = 'bar';` and releases it as 0.2.0.\n`foo-user` wants to use the latest `foo` so it updates its dependency, not expecting anything\nbad - foo's minor version number has been upgraded. In semantic versioning it means no breaking API\nchanges.\n\n`foo-user` is now broken!\n\nInstead, before publishing new version to NPM, project `foo` can create a file in its\nproject folder `.dont-break.json` with names of dependent projects to test\n```bash\necho '[\"foo-user\"]' > .dont-break.json\n```\nYou can check if the current code breaks listed dependent project by running\n\n```bash\ndont-break\n```\n\nThis will install each dependent project from `.dont-break.json` file into `/tmp/dont-break...` folder,\nwill run the dependent's unit tests using `npm test` to make sure they work initially, then\nwill copy the current project into the temp folder, overwriting the previous working version.\nThen it will run the tests again, throwing an exception if they stopped working.\n\nIn the example case, it will report something like this\n```bash\n$ dont-break\ndependents [ 'foo-user' ]\ntesting foo-user\n  installing foo-user\ninstalled into /tmp/foo@0.0.0-against-foo-user\n  npm test\ntests work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncopied /Users/gleb/git/foo/* to /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user/node_modules/foo\n  npm test\nnpm test returned 1\ntest errors:\nAssertionError: value of foo should be \"foo\", but is bar\nnpm ERR! Test failed.  See above for more details.\nnpm ERR! not ok code 0\ntests did not work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncode 1\nFAIL: Current version break dependents\n```\nThe message clearly tells you that the dependent projects as they are right now cannot\nupgrade to the version you are about to release.\n\n## Dependencies\n\nYou can specify GitHub repos as dependencies, because they most likely will\nhave tests. For example in `.dont-break.json`\n\n```js\n// you can use JavaScript comments in this file .dont-break.json\n[\n  \"https://github.com/bahmutov/dont-break-bar\"\n]\n```\n\nPicking projects to test manually is a judgement call.\nDont-break can fetch top N most downloaded\nor most starred dependent modules and save the list.\n* run `dont-break --top-downloads <N>` to find top N most downloaded dependent modules,\nsave to `.dont-break.json` and check.\n* run `dont-break --top-starred <N>` to find top N most starred dependent modules,\nsave to `.dont-break.json` and check.\n\nThe above commands overwrite `.dont-break.json` file.\n\n## Configuration options\n\n### Global vs. project-level configuration\nYou can specify different configuration options on global level or on project level. Following configs are equivalent.\nProject level:\n```\n[\n  {\n    \"name\": \"project-a\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-b\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-c\",\n    \"test\": \"npm test:special\"\n  }\n]\n```\nGlobal level:\n```\n{\n  \"test\": \"grunt test\",\n  \"projects\": [\n    \"project-a\", \n    \"project-b\", \n    {\n      \"name\": \"project-c\",\n      \"test\": \"npm test:special\"\n    }\n  ]\n}\n```\nGlobal level will simplify dont-break config if dependent projects share the same options. Also, options can be \noverriden on project level as in case of \"project-c\" here.\n  \n### Execution flow overview\nDont-break performs folowing steps for each dependent project:\n* Install the dependent project into temporary dir using the [specified command](#install-command)\n* Run [post-install](#post-install-command) command\n* [Pre-test](#pre-testing-with-previous-package-version) it if this is not disabled\n* [Install current module](#current-module-installation-method) into the dependent project\n* Run [post-install](#post-install-command) command\n* [Test](#test-command) the dependent project\n\nSections below describe how you can customize these steps.\n\n### Test command\n\nYou can specify a custom test command per dependent module. For example, to run `grunt test` for `foo-module-name`,\nbut default command for module `bar-name`, list in `.dont-break.json` the following:\n\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\"\n  },\n  \"bar-name\"\n]\n```\n\n### Install command\n\nYou can specify a custom install command per dependent module. By default it's `npm install`. For example, this will use\n`yarn add` for `foo-module-name`, but keep default `npm install` for module `bar-name`:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"install\": \"yarn add\"\n  },\n  \"bar-name\"\n]\n```\nThe name of dependent module will be added to given command, e.g. for above it will run `yarn add foo-module-name`. \n\n### Post-install command\n\nBefore testing the dependent package dont-break installs its dev dependencies via `npm install` command run from the\ndependency directory. If you need something more you can specify it via \"postinstall\" config parameter like this:\n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"npm run update\"\n  }, {\n    \"name\": \"packageB\"\n  }\n]\n```\nIf specified this command will run first before pretesting the old version of lib (if pretest isn't disabled), then \nafter installing current version of lib to dependent package. You can use {{CURRENT_MODULE_DIR}} variable here which \nwill be replaced with a path to current module: \n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"{{CURRENT_MODULE_DIR}}/install-all-deps.sh\",\n  }\n]\n```\n\n### Pre-testing with previous package version\nBy default dont-break first tests dependent module with its published version of current module, to make sure that it \nwas working before the update. If this sounds excessive to you you can disable it with {\"pretest\": false} option: \n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": false\n  }\n]\n```\nHere \"foo-module-name\" module will be tested only once, and \"bar-name\" twise: first with its published version of \ncurrent module, and then with the updated version.   \n\nThe \"pretest\" property can also accept custom script to run for pretesting:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": \"grunt test && ./ci/after-pretesting-by-dont-break\"\n  }\n]\n```\nBy default it equals to \"test\" command.\n\n### Current module installation method\n\nTo test dependent package dont-break installs current module inside the dependent package directory. By default it uses\n`cd $DEPENDENT_PACKAGE_DIR && npm install $CURRENT_MODULE_DIR`. Other options are \n[npm-link](https://docs.npmjs.com/cli/link) and [yarn-link](https://yarnpkg.com/lang/en/docs/cli/link/). They can be \nhelpful in some cases, e.g. if you need to use `npm install` or `yarn` in postinstall command. To use `npm link` method \nspecify {\"currentModuleInstall\": \"npm-link\"}: \n```\n{\n  \"currentModuleInstall\": \"npm-link\",\n  \"projects\": [\"packageA\", \"packageB\"]\n}\n```\nDefault value is {\"currentModuleInstall\": \"npm-install\"}. \n \n### Installation timeout\nYou can specify a longer installation time out, in seconds, using CLI option\n\n```\ndont-break --timeout 30\n```\n\n## Related\n\n*dont-break* is the opposite of [next-update](https://github.com/bahmutov/next-update)\nthat one can use to safely upgrade dependencies.\n\n## Setting up second CI for dont-break\n\nI prefer to use a separate CI service specifically to test the current code\nagainst the dependent projects using `dont-break`. For example, the project\n[boggle](https://www.npmjs.com/package/boggle) is setup this way. The unit tests\nare run on [TravisCI](https://travis-ci.org/bahmutov/boggle) using\npretty standard [.travis.yml](https://github.com/bahmutov/boggle/blob/master/.travis.yml) file\n\n```yml\nlanguage: node_js\nnode_js:\n  - \"0.12\"\n  - \"4\"\nbranches:\n  only:\n    - master\nbefore_script:\n  - npm install -g grunt-cli\n```\n\nThen I setup a separate build service on [CircleCi](https://circleci.com/gh/bahmutov/boggle)\njust to run the `npm run dont-break` command from the `package.json`\n\n```json\n\"scripts\": {\n    \"dont-break\": \"dont-break --timeout 30\"\n}\n```\n\nWe are assuming a global installation of `dont-break`, and the project lists\nthe projects to check in the\n[.dont-break](https://github.com/bahmutov/boggle/blob/master/.dont-break) file.\nAt the present there is only a single dependent project\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo run `dont-break` on CircleCI, I created the\n[circle.yml](https://github.com/bahmutov/boggle/blob/master/circle.yml) file.\nIt should be clear what it does - installs `dont-break`, and runs the npm script command.\n\n```yml\nmachine:\n  node:\n    version: \"0.12\"\ndependencies:\n  post:\n    - npm install -g dont-break\ntest:\n  override:\n    - npm run dont-break\n```\n\nTo make the status visible, I included the CircleCI badges in the README file.\n\n```md\n[![Dont-break][circle-ci-image] ][circle-ci-url]\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n```\n\nwhich produces the following:\n\nBreaking dependencies? [![Dont-break][circle-ci-image] ][circle-ci-url] using\n[dont-break](https://github.com/bahmutov/dont-break)\n\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n\n## Development and testing\n\nThis project is tested end to end using two small projects:\n[boggle](https://www.npmjs.com/package/boggle) and its dependent\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo see open github issues, use command `npm run issues`\n\nTo see verbose log message, run with `DEBUG=dont-break ...` environment\nvariable.\n\n### Small print\n\nAuthor: Gleb Bahmutov &copy; 2014\n\n* [@bahmutov](https://twitter.com/bahmutov)\n* [glebbahmutov.com](http://glebbahmutov.com)\n* [blog](http://glebbahmutov.com/blog)\n\nLicense: MIT - do anything with the code, but don't blame me if it does not work.\n\nSpread the word: tweet, star on github, etc.\n\nSupport: if you find any problems with this module, email / tweet /\n[open issue](https://github.com/bahmutov/dont-break/issues?state=open) on Github\n\nImplemented using [npm-registry](https://github.com/3rd-Eden/npmjs),\n[lazy-ass](https://github.com/bahmutov/lazy-ass) and [npm-utils](https://github.com/bahmutov/npm-utils).\n\n## MIT License\n\nCopyright (c) 2014 Gleb Bahmutov\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n","readmeFilename":"README.md","gitHead":"3de0948785da55a5938104dccbb865ba7ac86835","_id":"@artemv/dont-break@1.12.2-pre.3","_npmVersion":"5.6.0","_nodeVersion":"8.9.4","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"integrity":"sha512-3Jr7vjqg2ngEGWzeUsc3s1+W7fcNkK1gaONoC3L3Nrt5FpKPbf/kGcJ4C+h2++pQ4Na+LMjDYLjcx/jzBB/USw==","shasum":"9d26b495dbcc2519eace55a286f2aa10ea54cb2d","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.12.2-pre.3.tgz","fileCount":11,"unpackedSize":32489,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDMMDFblTJGwGlbXQXhlpcXhUyrIG+EzOBvCBn1U5zLdAIhAKfRtPz3gUFJUQJdTII230WI6kzW/ShiGCnh7t8I5lHp"}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break_1.12.2-pre.3_1519838010340_0.9066302943400648"},"_hasShrinkwrap":false},"1.12.2-pre.4":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.12.2-pre.4","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.14.1","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.2","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.5","mkdirp":"^0.5.1","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.3.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.17.0","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"readme":"# dont-break\n\nChecks if the node module in the current folder breaks unit tests for specified dependent projects.\n\n[Relevant discussion at npm](https://github.com/npm/npm/issues/6510),\n[Do not break dependant modules](http://glebbahmutov.com/blog/do-not-break-dependant-modules/).\n\n[![Build status][dont-break-ci-image] ][dont-break-ci-url]\n[![npm][dont-break-npm-image]](dont-break-npm-url)\n[![semantic-release][semantic-image] ][semantic-url]\n[![next-update-travis badge][nut-badge]][nut-readme]\n\n[dont-break-icon]: https://nodei.co/npm/dont-break.svg?downloads=true\n[dont-break-url]: https://npmjs.org/package/dont-break\n[dont-break-ci-image]: https://travis-ci.org/bahmutov/dont-break.svg?branch=master\n[dont-break-ci-url]: https://travis-ci.org/bahmutov/dont-break\n[dont-break-npm-url]: https://img.shields.io/npm/dm/dont-break\n[dont-break-npm-image]: https://img.shields.io/npm/dm/dont-break.svg?maxAge=2592000\n[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-url]: https://github.com/semantic-release/semantic-release\n[nut-badge]: https://img.shields.io/badge/next--update--travis-weekly-green.svg\n[nut-readme]: https://github.com/bahmutov/next-update-travis#readme\n\n## Install\n```\nnpm install -g dont-break\n```\n\n## Use\n\n* Create `.dont-break.json` file in the root of your package,\n  list module names that you would like to test as an array.\n* Run `dont-break` any time to test latest version of each dependent module\n  against the curent code\n\n## Example\n\n2 projects.\n\n1. First project `foo` only exports single variable `module.exports = 'foo';`\n2. Second project `foo-user` depends on `foo`.\n\n`foo-user` only works if it gets string `foo` from the module it depends on, like this:\n```js\nvar str = require('foo');\nconsole.assert(str === 'foo', 'value of foo should be \"foo\", but is ' + str);\n```\n`foo` has only a single release 0.1.0 that works for `foo-user` project.\n\nThe author of `foo` changes code to be `module.exports = 'bar';` and releases it as 0.2.0.\n`foo-user` wants to use the latest `foo` so it updates its dependency, not expecting anything\nbad - foo's minor version number has been upgraded. In semantic versioning it means no breaking API\nchanges.\n\n`foo-user` is now broken!\n\nInstead, before publishing new version to NPM, project `foo` can create a file in its\nproject folder `.dont-break.json` with names of dependent projects to test\n```bash\necho '[\"foo-user\"]' > .dont-break.json\n```\nYou can check if the current code breaks listed dependent project by running\n\n```bash\ndont-break\n```\n\nThis will install each dependent project from `.dont-break.json` file into `/tmp/dont-break...` folder,\nwill run the dependent's unit tests using `npm test` to make sure they work initially, then\nwill copy the current project into the temp folder, overwriting the previous working version.\nThen it will run the tests again, throwing an exception if they stopped working.\n\nIn the example case, it will report something like this\n```bash\n$ dont-break\ndependents [ 'foo-user' ]\ntesting foo-user\n  installing foo-user\ninstalled into /tmp/foo@0.0.0-against-foo-user\n  npm test\ntests work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncopied /Users/gleb/git/foo/* to /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user/node_modules/foo\n  npm test\nnpm test returned 1\ntest errors:\nAssertionError: value of foo should be \"foo\", but is bar\nnpm ERR! Test failed.  See above for more details.\nnpm ERR! not ok code 0\ntests did not work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncode 1\nFAIL: Current version break dependents\n```\nThe message clearly tells you that the dependent projects as they are right now cannot\nupgrade to the version you are about to release.\n\n## Dependencies\n\nYou can specify GitHub repos as dependencies, because they most likely will\nhave tests. For example in `.dont-break.json`\n\n```js\n// you can use JavaScript comments in this file .dont-break.json\n[\n  \"https://github.com/bahmutov/dont-break-bar\"\n]\n```\n\nPicking projects to test manually is a judgement call.\nDont-break can fetch top N most downloaded\nor most starred dependent modules and save the list.\n* run `dont-break --top-downloads <N>` to find top N most downloaded dependent modules,\nsave to `.dont-break.json` and check.\n* run `dont-break --top-starred <N>` to find top N most starred dependent modules,\nsave to `.dont-break.json` and check.\n\nThe above commands overwrite `.dont-break.json` file.\n\n## Configuration options\n\n### Global vs. project-level configuration\nYou can specify different configuration options on global level or on project level. Following configs are equivalent.\nProject level:\n```\n[\n  {\n    \"name\": \"project-a\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-b\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-c\",\n    \"test\": \"npm test:special\"\n  }\n]\n```\nGlobal level:\n```\n{\n  \"test\": \"grunt test\",\n  \"projects\": [\n    \"project-a\", \n    \"project-b\", \n    {\n      \"name\": \"project-c\",\n      \"test\": \"npm test:special\"\n    }\n  ]\n}\n```\nGlobal level will simplify dont-break config if dependent projects share the same options. Also, options can be \noverriden on project level as in case of \"project-c\" here.\n  \n### Execution flow overview\nDont-break performs folowing steps for each dependent project:\n* Install the dependent project into temporary dir using the [specified command](#install-command)\n* Run [post-install](#post-install-command) command if [pre-test](#pre-testing-with-previous-package-version) is not disabled\n* [Pre-test](#pre-testing-with-previous-package-version) the dependent project if this is not disabled\n* [Install current module](#current-module-installation-method) into the dependent project\n* Run [post-install](#post-install-command) command\n* [Test](#test-command) the dependent project\n\nSections below describe how you can customize these steps.\n\n### Test command\n\nYou can specify a custom test command per dependent module. For example, to run `grunt test` for `foo-module-name`,\nbut default command for module `bar-name`, list in `.dont-break.json` the following:\n\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\"\n  },\n  \"bar-name\"\n]\n```\n\n### Install command\n\nYou can specify a custom install command per dependent module. By default it's `npm install`. For example, this will use\n`yarn add` for `foo-module-name`, but keep default `npm install` for module `bar-name`:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"install\": \"yarn add\"\n  },\n  \"bar-name\"\n]\n```\nThe name of dependent module will be added to given command, e.g. for above it will run `yarn add foo-module-name`. \n\n### Post-install command\n\nBefore testing the dependent package dont-break installs its dev dependencies via `npm install` command run from the\ndependency directory. If you need something more you can specify it via \"postinstall\" config parameter like this:\n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"npm run update\"\n  }, {\n    \"name\": \"packageB\"\n  }\n]\n```\nIf specified this command will run first before pretesting the old version of lib (if pretest isn't disabled), then \nafter installing current version of lib to dependent package. You can use {{CURRENT_MODULE_DIR}} variable here which \nwill be replaced with a path to current module: \n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"{{CURRENT_MODULE_DIR}}/install-all-deps.sh\",\n  }\n]\n```\n\n### Pre-testing with previous package version\nBy default dont-break first tests dependent module with its published version of current module, to make sure that it \nwas working before the update. If this sounds excessive to you you can disable it with {\"pretest\": false} option: \n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": false\n  }\n]\n```\nHere \"foo-module-name\" module will be tested only once, and \"bar-name\" twise: first with its published version of \ncurrent module, and then with the updated version.   \n\nThe \"pretest\" property can also accept custom script to run for pretesting:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": \"grunt test && ./ci/after-pretesting-by-dont-break\"\n  }\n]\n```\nBy default it equals to \"test\" command.\n\n### Current module installation method\n\nTo test dependent package dont-break installs current module inside the dependent package directory. By default it uses\n`cd $DEPENDENT_PACKAGE_DIR && npm install $CURRENT_MODULE_DIR`. Other options are \n[npm-link](https://docs.npmjs.com/cli/link) and [yarn-link](https://yarnpkg.com/lang/en/docs/cli/link/). They can be \nhelpful in some cases, e.g. if you need to use `npm install` or `yarn` in postinstall command. To use `npm link` method \nspecify {\"currentModuleInstall\": \"npm-link\"}: \n```\n{\n  \"currentModuleInstall\": \"npm-link\",\n  \"projects\": [\"packageA\", \"packageB\"]\n}\n```\nDefault value is {\"currentModuleInstall\": \"npm-install\"}. \n \n### Installation timeout\nYou can specify a longer installation time out, in seconds, using CLI option\n\n```\ndont-break --timeout 30\n```\n\n## Related\n\n*dont-break* is the opposite of [next-update](https://github.com/bahmutov/next-update)\nthat one can use to safely upgrade dependencies.\n\n## Setting up second CI for dont-break\n\nI prefer to use a separate CI service specifically to test the current code\nagainst the dependent projects using `dont-break`. For example, the project\n[boggle](https://www.npmjs.com/package/boggle) is setup this way. The unit tests\nare run on [TravisCI](https://travis-ci.org/bahmutov/boggle) using\npretty standard [.travis.yml](https://github.com/bahmutov/boggle/blob/master/.travis.yml) file\n\n```yml\nlanguage: node_js\nnode_js:\n  - \"0.12\"\n  - \"4\"\nbranches:\n  only:\n    - master\nbefore_script:\n  - npm install -g grunt-cli\n```\n\nThen I setup a separate build service on [CircleCi](https://circleci.com/gh/bahmutov/boggle)\njust to run the `npm run dont-break` command from the `package.json`\n\n```json\n\"scripts\": {\n    \"dont-break\": \"dont-break --timeout 30\"\n}\n```\n\nWe are assuming a global installation of `dont-break`, and the project lists\nthe projects to check in the\n[.dont-break](https://github.com/bahmutov/boggle/blob/master/.dont-break) file.\nAt the present there is only a single dependent project\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo run `dont-break` on CircleCI, I created the\n[circle.yml](https://github.com/bahmutov/boggle/blob/master/circle.yml) file.\nIt should be clear what it does - installs `dont-break`, and runs the npm script command.\n\n```yml\nmachine:\n  node:\n    version: \"0.12\"\ndependencies:\n  post:\n    - npm install -g dont-break\ntest:\n  override:\n    - npm run dont-break\n```\n\nTo make the status visible, I included the CircleCI badges in the README file.\n\n```md\n[![Dont-break][circle-ci-image] ][circle-ci-url]\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n```\n\nwhich produces the following:\n\nBreaking dependencies? [![Dont-break][circle-ci-image] ][circle-ci-url] using\n[dont-break](https://github.com/bahmutov/dont-break)\n\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n\n## Development and testing\n\nThis project is tested end to end using two small projects:\n[boggle](https://www.npmjs.com/package/boggle) and its dependent\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo see open github issues, use command `npm run issues`\n\nTo see verbose log message, run with `DEBUG=dont-break ...` environment\nvariable.\n\n### Small print\n\nAuthor: Gleb Bahmutov &copy; 2014\n\n* [@bahmutov](https://twitter.com/bahmutov)\n* [glebbahmutov.com](http://glebbahmutov.com)\n* [blog](http://glebbahmutov.com/blog)\n\nLicense: MIT - do anything with the code, but don't blame me if it does not work.\n\nSpread the word: tweet, star on github, etc.\n\nSupport: if you find any problems with this module, email / tweet /\n[open issue](https://github.com/bahmutov/dont-break/issues?state=open) on Github\n\nImplemented using [npm-registry](https://github.com/3rd-Eden/npmjs),\n[lazy-ass](https://github.com/bahmutov/lazy-ass) and [npm-utils](https://github.com/bahmutov/npm-utils).\n\n## MIT License\n\nCopyright (c) 2014 Gleb Bahmutov\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n","readmeFilename":"README.md","gitHead":"607ba8562e59c8a65224c5dc7f80a38436143bf8","_id":"@artemv/dont-break@1.12.2-pre.4","_npmVersion":"5.6.0","_nodeVersion":"8.9.4","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"integrity":"sha512-qcpoUgvVQ9swq+OKfyHONUB+3hjMlnvLKQLPxAlhFrU+d9S/PG07k8riVjcJ2EvJnP1YgSvdpqNDhAtOCK2rag==","shasum":"e0d15e624a50261aaeb1507af151a5044bb5b1ad","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.12.2-pre.4.tgz","fileCount":11,"unpackedSize":32557,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHzbtKeI9yreflZheZMh4EfRVrkSnve61KAY/xw4/zsQAiEA3J+6FFov5W6Prp1fzJhWEAF4Z1FgPxe0s4rEtSVjcrA="}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break_1.12.2-pre.4_1519840253584_0.9446899050642041"},"_hasShrinkwrap":false},"1.12.2-pre.5":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.12.2-pre.5","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.14.1","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.2","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.5","mkdirp":"^0.5.1","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.3.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.17.0","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"readme":"# dont-break\n\nChecks if the node module in the current folder breaks unit tests for specified dependent projects.\n\n[Relevant discussion at npm](https://github.com/npm/npm/issues/6510),\n[Do not break dependant modules](http://glebbahmutov.com/blog/do-not-break-dependant-modules/).\n\n[![Build status][dont-break-ci-image] ][dont-break-ci-url]\n[![npm][dont-break-npm-image]](dont-break-npm-url)\n[![semantic-release][semantic-image] ][semantic-url]\n[![next-update-travis badge][nut-badge]][nut-readme]\n\n[dont-break-icon]: https://nodei.co/npm/dont-break.svg?downloads=true\n[dont-break-url]: https://npmjs.org/package/dont-break\n[dont-break-ci-image]: https://travis-ci.org/bahmutov/dont-break.svg?branch=master\n[dont-break-ci-url]: https://travis-ci.org/bahmutov/dont-break\n[dont-break-npm-url]: https://img.shields.io/npm/dm/dont-break\n[dont-break-npm-image]: https://img.shields.io/npm/dm/dont-break.svg?maxAge=2592000\n[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-url]: https://github.com/semantic-release/semantic-release\n[nut-badge]: https://img.shields.io/badge/next--update--travis-weekly-green.svg\n[nut-readme]: https://github.com/bahmutov/next-update-travis#readme\n\n## Install\n```\nnpm install -g dont-break\n```\n\n## Use\n\n* Create `.dont-break.json` file in the root of your package,\n  list module names that you would like to test as an array.\n* Run `dont-break` any time to test latest version of each dependent module\n  against the curent code\n\n## Example\n\n2 projects.\n\n1. First project `foo` only exports single variable `module.exports = 'foo';`\n2. Second project `foo-user` depends on `foo`.\n\n`foo-user` only works if it gets string `foo` from the module it depends on, like this:\n```js\nvar str = require('foo');\nconsole.assert(str === 'foo', 'value of foo should be \"foo\", but is ' + str);\n```\n`foo` has only a single release 0.1.0 that works for `foo-user` project.\n\nThe author of `foo` changes code to be `module.exports = 'bar';` and releases it as 0.2.0.\n`foo-user` wants to use the latest `foo` so it updates its dependency, not expecting anything\nbad - foo's minor version number has been upgraded. In semantic versioning it means no breaking API\nchanges.\n\n`foo-user` is now broken!\n\nInstead, before publishing new version to NPM, project `foo` can create a file in its\nproject folder `.dont-break.json` with names of dependent projects to test\n```bash\necho '[\"foo-user\"]' > .dont-break.json\n```\nYou can check if the current code breaks listed dependent project by running\n\n```bash\ndont-break\n```\n\nThis will install each dependent project from `.dont-break.json` file into `/tmp/dont-break...` folder,\nwill run the dependent's unit tests using `npm test` to make sure they work initially, then\nwill copy the current project into the temp folder, overwriting the previous working version.\nThen it will run the tests again, throwing an exception if they stopped working.\n\nIn the example case, it will report something like this\n```bash\n$ dont-break\ndependents [ 'foo-user' ]\ntesting foo-user\n  installing foo-user\ninstalled into /tmp/foo@0.0.0-against-foo-user\n  npm test\ntests work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncopied /Users/gleb/git/foo/* to /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user/node_modules/foo\n  npm test\nnpm test returned 1\ntest errors:\nAssertionError: value of foo should be \"foo\", but is bar\nnpm ERR! Test failed.  See above for more details.\nnpm ERR! not ok code 0\ntests did not work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncode 1\nFAIL: Current version break dependents\n```\nThe message clearly tells you that the dependent projects as they are right now cannot\nupgrade to the version you are about to release.\n\n## Dependencies\n\nYou can specify GitHub repos as dependencies, because they most likely will\nhave tests. For example in `.dont-break.json`\n\n```js\n// you can use JavaScript comments in this file .dont-break.json\n[\n  \"https://github.com/bahmutov/dont-break-bar\"\n]\n```\n\nPicking projects to test manually is a judgement call.\nDont-break can fetch top N most downloaded\nor most starred dependent modules and save the list.\n* run `dont-break --top-downloads <N>` to find top N most downloaded dependent modules,\nsave to `.dont-break.json` and check.\n* run `dont-break --top-starred <N>` to find top N most starred dependent modules,\nsave to `.dont-break.json` and check.\n\nThe above commands overwrite `.dont-break.json` file.\n\n## Configuration options\n\n### Global vs. project-level configuration\nYou can specify different configuration options on global level or on project level. Following configs are equivalent.\nProject level:\n```\n[\n  {\n    \"name\": \"project-a\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-b\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-c\",\n    \"test\": \"npm test:special\"\n  }\n]\n```\nGlobal level:\n```\n{\n  \"test\": \"grunt test\",\n  \"projects\": [\n    \"project-a\", \n    \"project-b\", \n    {\n      \"name\": \"project-c\",\n      \"test\": \"npm test:special\"\n    }\n  ]\n}\n```\nGlobal level will simplify dont-break config if dependent projects share the same options. Also, options can be \noverriden on project level as in case of \"project-c\" here.\n  \n### Execution flow overview\nDont-break performs folowing steps for each dependent project:\n* Install the dependent project into temporary dir using the [specified command](#install-command)\n* Run [post-install](#post-install-command) command if [pre-test](#pre-testing-with-previous-package-version) is not disabled\n* [Pre-test](#pre-testing-with-previous-package-version) the dependent project if this is not disabled\n* [Install current module](#current-module-installation-method) into the dependent project\n* Run [post-install](#post-install-command) command\n* [Test](#test-command) the dependent project\n\nSections below describe how you can customize these steps.\n\n### Test command\n\nYou can specify a custom test command per dependent module. For example, to run `grunt test` for `foo-module-name`,\nbut default command for module `bar-name`, list in `.dont-break.json` the following:\n\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\"\n  },\n  \"bar-name\"\n]\n```\n\n### Install command\n\nYou can specify a custom install command per dependent module. By default it's `npm install`. For example, this will use\n`yarn add` for `foo-module-name`, but keep default `npm install` for module `bar-name`:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"install\": \"yarn add\"\n  },\n  \"bar-name\"\n]\n```\nThe name of dependent module will be added to given command, e.g. for above it will run `yarn add foo-module-name`. \n\n### Post-install command\n\nBefore testing the dependent package dont-break installs its dev dependencies via `npm install` command run from the\ndependency directory. If you need something more you can specify it via \"postinstall\" config parameter like this:\n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"npm run update\"\n  }, {\n    \"name\": \"packageB\"\n  }\n]\n```\nIf specified this command will run first before pretesting the old version of lib (if pretest isn't disabled), then \nafter installing current version of lib to dependent package. You can use $CURRENT_MODULE_DIR variable here which \nwill be replaced with a path to current module: \n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"$CURRENT_MODULE_DIR/install-all-deps.sh\",\n  }\n]\n```\n\n### Pre-testing with previous package version\nBy default dont-break first tests dependent module with its published version of current module, to make sure that it \nwas working before the update. If this sounds excessive to you you can disable it with {\"pretest\": false} option: \n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": false\n  }\n]\n```\nHere \"foo-module-name\" module will be tested only once, and \"bar-name\" twise: first with its published version of \ncurrent module, and then with the updated version.   \n\nThe \"pretest\" property can also accept custom script to run for pretesting:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": \"grunt test && ./ci/after-pretesting-by-dont-break\"\n  }\n]\n```\nBy default it equals to \"test\" command.\n\n### Current module installation method\n\nTo test dependent package dont-break installs current module inside the dependent package directory. By default it uses\n`cd $DEPENDENT_PACKAGE_DIR && npm install $CURRENT_MODULE_DIR`. Other options are \n[npm-link](https://docs.npmjs.com/cli/link) and [yarn-link](https://yarnpkg.com/lang/en/docs/cli/link/). They can be \nhelpful in some cases, e.g. if you need to use `npm install` or `yarn` in postinstall command. To use `npm link` method \nspecify {\"currentModuleInstall\": \"npm-link\"}: \n```\n{\n  \"currentModuleInstall\": \"npm-link\",\n  \"projects\": [\"packageA\", \"packageB\"]\n}\n```\nDefault value is {\"currentModuleInstall\": \"npm-install\"}.\n\n### Env vars exported to called scripts\nFollowing env vars are available for use in scripts called by executed steps: \n* `$CURRENT_MODULE_DIR` - directory of current module  \n* `$CURRENT_MODULE_NAME` - name of current module as stated in its package.json\n \n### Installation timeout\nYou can specify a longer installation time out, in seconds, using CLI option\n\n```\ndont-break --timeout 30\n```\n\n## Related\n\n*dont-break* is the opposite of [next-update](https://github.com/bahmutov/next-update)\nthat one can use to safely upgrade dependencies.\n\n## Setting up second CI for dont-break\n\nI prefer to use a separate CI service specifically to test the current code\nagainst the dependent projects using `dont-break`. For example, the project\n[boggle](https://www.npmjs.com/package/boggle) is setup this way. The unit tests\nare run on [TravisCI](https://travis-ci.org/bahmutov/boggle) using\npretty standard [.travis.yml](https://github.com/bahmutov/boggle/blob/master/.travis.yml) file\n\n```yml\nlanguage: node_js\nnode_js:\n  - \"0.12\"\n  - \"4\"\nbranches:\n  only:\n    - master\nbefore_script:\n  - npm install -g grunt-cli\n```\n\nThen I setup a separate build service on [CircleCi](https://circleci.com/gh/bahmutov/boggle)\njust to run the `npm run dont-break` command from the `package.json`\n\n```json\n\"scripts\": {\n    \"dont-break\": \"dont-break --timeout 30\"\n}\n```\n\nWe are assuming a global installation of `dont-break`, and the project lists\nthe projects to check in the\n[.dont-break](https://github.com/bahmutov/boggle/blob/master/.dont-break) file.\nAt the present there is only a single dependent project\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo run `dont-break` on CircleCI, I created the\n[circle.yml](https://github.com/bahmutov/boggle/blob/master/circle.yml) file.\nIt should be clear what it does - installs `dont-break`, and runs the npm script command.\n\n```yml\nmachine:\n  node:\n    version: \"0.12\"\ndependencies:\n  post:\n    - npm install -g dont-break\ntest:\n  override:\n    - npm run dont-break\n```\n\nTo make the status visible, I included the CircleCI badges in the README file.\n\n```md\n[![Dont-break][circle-ci-image] ][circle-ci-url]\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n```\n\nwhich produces the following:\n\nBreaking dependencies? [![Dont-break][circle-ci-image] ][circle-ci-url] using\n[dont-break](https://github.com/bahmutov/dont-break)\n\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n\n## Development and testing\n\nThis project is tested end to end using two small projects:\n[boggle](https://www.npmjs.com/package/boggle) and its dependent\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo see open github issues, use command `npm run issues`\n\nTo see verbose log message, run with `DEBUG=dont-break ...` environment\nvariable.\n\n### Small print\n\nAuthor: Gleb Bahmutov &copy; 2014\n\n* [@bahmutov](https://twitter.com/bahmutov)\n* [glebbahmutov.com](http://glebbahmutov.com)\n* [blog](http://glebbahmutov.com/blog)\n\nLicense: MIT - do anything with the code, but don't blame me if it does not work.\n\nSpread the word: tweet, star on github, etc.\n\nSupport: if you find any problems with this module, email / tweet /\n[open issue](https://github.com/bahmutov/dont-break/issues?state=open) on Github\n\nImplemented using [npm-registry](https://github.com/3rd-Eden/npmjs),\n[lazy-ass](https://github.com/bahmutov/lazy-ass) and [npm-utils](https://github.com/bahmutov/npm-utils).\n\n## MIT License\n\nCopyright (c) 2014 Gleb Bahmutov\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n","readmeFilename":"README.md","gitHead":"607ba8562e59c8a65224c5dc7f80a38436143bf8","_id":"@artemv/dont-break@1.12.2-pre.5","_npmVersion":"5.6.0","_nodeVersion":"8.9.4","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"integrity":"sha512-bWUK/RTnWQ9WIkK9ggop8L3kCQBRNMkGpNQTWdRbslFYTCJzegh+RjPnCVJO+s9xn++3CROFVQnMaP/LACgDbA==","shasum":"ede3974f1bc9a320d7893684871eff9feb0324cc","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.12.2-pre.5.tgz","fileCount":11,"unpackedSize":32890,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAPjazm4HMCxvcS1kTCxB8d1neDTE8qnimNsweKuwyaEAiEAqzqjKHwdzk9usSodfibWRV/brrtfF+crtSQiC1cEEZc="}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break_1.12.2-pre.5_1519843007616_0.8034840323908794"},"_hasShrinkwrap":false},"1.13.2-pre.1":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.13.2-pre.1","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.15.1","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.2","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.10","mkdirp":"^0.5.1","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.5.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.17.1","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"gitHead":"166a9dfad9f406a7bd7ed4190eecf45fafa8bffb","_id":"@artemv/dont-break@1.13.2-pre.1","_npmVersion":"5.6.0","_nodeVersion":"8.10.0","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"integrity":"sha512-heL+VN1hdOmtth4WjcdzbVKsHor1c4JC519wV3qQb60uqoiKWRNvZsFazjJvMe6PTr06DyfEGSTktMubWoZ7Yw==","shasum":"6c18638bbf9cb0479bc95272ffb8d1e43a05d854","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.13.2-pre.1.tgz","fileCount":11,"unpackedSize":33217,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa9cwbCRA9TVsSAnZWagAA7noP/R9Hk1+BOnbrouAx+rUQ\nLi7oGznie5V5XmTv9nJ5o1JXqIm9uxdpTz81JghAb/CBqHttZ47xZMDCHpAe\nRkrzBaVkmdn6LKLobfJV1nNg7m2oCKuoLBKTcxFNSxTvkZLXfi9EeybGsgty\nR4GwLATQewJ5Ku9APJGUTLLiFm+iJyKmfMDTPZ11tsde6agObSIlfQTGaVFG\ndvs0fFbiPEg2dZifs2yGKazy5yBgfgrt8J5kjmLSRYAMePzkg3tlbSpBR9Xk\nXdn4u9Vjkodclu2yUQVbW+97jwy2m2gowfRFLorIVPpp0hkyuypGrFO1WvUO\n63ppbiqDQyvwrhb3mMYMIayhFnqfMp3HuZ3utWeqKfsH2l3ghnKUpg/QIUAM\ny35HWGX22Rjc/pG2PycEoNKe4exw3h7E8qd6jO+m5FcH7AxMjhfmAgKCgJ7I\n0BkHw9L5a5sMDzMx/vQHfMs74ywyZStReHckNkot8jnONf9CWcAlc60EEdda\nxr1xogWOp8kZhFN5ajUXnIVq+rAI+nyuZslAWtjGgux+qFuYNlGrT6LY3m6J\nyT2ITDi5bhg42TjHpNg3rn6nRIZLPgwxz99G20e+2BQmYIvuUWzGYpmpuFF2\nt1cZBm4wHl+fA8t5ZVmk4/tsq6egUEh1La6AmCpVQoGWRZqozN1GM1ywgwgP\nfbHN\r\n=Ijbq\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDGWthDt34Qf3xJxKHKHAvdoBpR8hsog03AIn4I9PlFXQIgTCQQgAWaAGRNhZsgEpNtH2/QKaf5PeK7p2FxrJIy3Gc="}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break_1.13.2-pre.1_1526058010511_0.9392236138376524"},"_hasShrinkwrap":false},"1.13.3-pre.1":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.13.3-pre.1","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.15.1","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.2","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.10","mkdirp":"^0.5.1","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.5.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.17.1","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"gitHead":"a38025af31e23c4eb3942e2a3ebd7edc36bc0012","_id":"@artemv/dont-break@1.13.3-pre.1","_npmVersion":"5.6.0","_nodeVersion":"8.10.0","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"integrity":"sha512-odTG/9zQIB0VdEC/j9eoltMjtP2y2nUPFatjv40ihOj6mdH5AqQaZpIjfGEix9n3aJX4Ewm++vnAQPPeVabdSg==","shasum":"7a0a8e8ce1dfe936581ffe9598b7d1098f7b748d","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.13.3-pre.1.tgz","fileCount":11,"unpackedSize":33233,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa9dQQCRA9TVsSAnZWagAAPvgP/08dq3sNFs8/7kP7Wz4L\nTRakXnfdLsfVEEhFfvyUiluiOesNXK8PKIg5Se8IVYIRSefNRIg2/qMtifO+\n9f+JVFdvcN87JnN9xtELlNMZNRF40kAmOdoh5/eY9Znf34mC4lUH8ryOuxBs\nWOT2yCta/4BDB9ku8Jn+H1aEtsGyc4n/bZNBzcZBRDpJQYBvOgsiPmf/wibG\nnmGf9mtFFGByt5mtxRJ7ArcoGqPSA6QgLoKlhm5gLrNOYhTv/xMRSKhIgdXS\nFtxw8j8iyrzCzVjIpIsVTzyMbiTtxUgVAL2UKkvZFjgGuj1BWxUz58zEV1q4\n9iRxncwligjfg1bVBwsCZLyvuWiJCAO5ulDLHfKn4HmQ3lrXTra6hkbrOorU\ngAJyl80DoZI/L/h2o1ePwV5UsNYPqMjX6Gk3QA8pxpC2gfWTmYipTFGFn7hG\nrlfVoyuz1MrllR181OzyJYk5UKnIrJRktpu1Y6vxDrociF3GG9bCdVY1T7AO\n59Pg3Cs0iSvejhlzqnK2hV1k8HxX1ts1My+4mVY/JBGUGfw6K6bo5LlPeYR+\nz7q1K+pnsN4KxnwjxMXSnoIP2ol3x8vzoGcfwACiolmBXgsWQx6TqiiICDAS\nBk8vTZi0y+Qf8q7eGa+4hUwxLDj0fI/PKQHX71bBLyYXbfngbwvIRLfETP5g\nDrP1\r\n=NSWg\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBx/EcTpYdrjOqjpFY+Zer2udvYqq4hmFQOd9f+Pa3UJAiAT0EmhvhPiraluG+nG7z4BGf4RjsIUbUCEeooXoQma1A=="}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break_1.13.3-pre.1_1526060045981_0.4849006505722451"},"_hasShrinkwrap":false},"1.13.4-pre.1":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.13.4-pre.1","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.15.1","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.2","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.10","mkdirp":"^0.5.1","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.5.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.17.1","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"gitHead":"d2b47598d75e053812065d7707e6d8665eae31a1","_id":"@artemv/dont-break@1.13.4-pre.1","_npmVersion":"5.6.0","_nodeVersion":"8.10.0","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"integrity":"sha512-OfkoHudigadoSG067ielgEF62PIkmHC/wW7rDyY2c89a2dKGVNbL6vPsIjXGF8+UXuduRn/0Pf810R0sPVWAAA==","shasum":"13fe880bf180fceaf4e4d8a36dff0e010766fabb","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.13.4-pre.1.tgz","fileCount":11,"unpackedSize":33221,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa9dsaCRA9TVsSAnZWagAAyT8P/iCB7oTzd4k0kl1IMfF/\nz96pvhN4NskDPgs3EVv0AdOlfv9/I2wbkeWi6LgT2NORyfpxgliSCHN/xfkX\ne2DGnTUT8pNGc3MlI41i88vqLIzycEWd67Ap+0w+mcys/bhnNzKuzxNdtmo2\nUHlV3SQ3OHcbBMsMR3UcTV+HdmBp7DaXcBPhOMQmStqEUBz5y+6MmtdLEVTn\niFyvBwLAgC1mvg2Bm/vX0NWQ/7BxTNkS6jwtCs8hyrz2eZ/7vGDk2l29I0C5\nohn/20LQR4VX9oHbAIQMhDP3Zhj5+cAiNIeDftKvtrsEWO8oLxXD+J/rBhwR\nQsDKkibdnCwfG2gg83M7JpejjJdhfqyQXBIadCmGdhZKjG8JxB1G8Nj6tRnI\nOh0cawKHOEB78EtYpqKRIksR2kwMWY6V1U6vPzgEYnE0Ey4brWyp4H9aJ380\nkZdvU3uX5I+mmo7LjxlmqgRCnnZQ1uzKmHS2iIjiFeapaetaB+G2FO2xAbnm\nOJOorA9AFtphF8og1IlSf3msaXFOdW71zBoU2pMg9WwT/EYDO+gt+5ySPmJF\nnNEv/rVXAF8lS6GvuchyvfAPtzK/F8o2DgCWnQfGI3RrD78vP8rBPMmyBEc4\n4CvOxPERMGAn5U+qX+OMOZYpV6BMMPFZkWvviurfQuJGgPuEr3yYE/NUflH0\nfWkq\r\n=q2aN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICB3MhVBGYBD3gqhU7XQ/0VI0iahqRwWXn8CjFMZyAzEAiA9pXyRBJR1I7Gy+OhS+uk0rwBYG/VAOXyeTSedOe4YAg=="}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break_1.13.4-pre.1_1526061848380_0.9019194628640654"},"_hasShrinkwrap":false},"1.13.5-pre.1":{"name":"@artemv/dont-break","description":"Checks if the current version of your package would break dependent projects","version":"1.13.5-pre.1","author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bin":{"dont-break":"./bin/dont-break"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"config":{"pre-git":{"commit-msg":"simple","pre-commit":["npm run mocha","npm test"],"pre-push":["npm run e2e","npm run size"],"post-merge":[]}},"contributors":[],"dependencies":{"chdir-promise":"0.6.2","check-more-types":"2.24.0","commander":"2.17.1","debug":"3.1.0","fs-extra":"^3.0.1","ggit":"2.4.2","hr":"0.1.3","lazy-ass":"1.6.0","lodash":"4.17.10","mkdirp":"^0.5.1","npm-registry":"0.1.13","npm-utils":"1.14.1","os-tmpdir":"1.0.2","q":"2.0.3","quote":"0.4.0","rimraf":"2.6.2","strip-json-comments":"2.0.1","top-dependents":"1.0.0","update-notifier":"2.5.0"},"devDependencies":{"git-issues":"1.3.1","github-post-release":"1.13.1","if-node-version":"^1.1.1","matchdep":"1.0.1","mocha":"3.5.3","next-update-travis":"^1.7.1","pre-git":"3.17.1","semantic-release":"^6.3.6","simple-commit-message":"3.3.2","standard":"10.0.3"},"engines":{"node":">= 0.12.0","npm":">= 3.0.0"},"files":["bin","index.js","src/*.js","!src/*-spec.js"],"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"license":"MIT","main":"index.js","repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"scripts":{"issues":"git-issues","lint":"standard --verbose --fix bin/*.js src/*.js","mocha":"mocha src/**/*-spec.js","pretest":"npm run lint","semantic-release":"semantic-release pre && npm publish && semantic-release post","show-help":"./bin/dont-break --help","size":"t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";","test":"npm run show-help","test-empty":"node src/test/run-dont-break.js","e2e":"./test/e2e.sh"},"release":{"analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"readme":"# dont-break\n\nChecks if the node module in the current folder breaks unit tests for specified dependent projects.\n\n[Relevant discussion at npm](https://github.com/npm/npm/issues/6510),\n[Do not break dependant modules](http://glebbahmutov.com/blog/do-not-break-dependant-modules/).\n\n[![Build status][dont-break-ci-image] ][dont-break-ci-url]\n[![npm][dont-break-npm-image]](dont-break-npm-url)\n[![semantic-release][semantic-image] ][semantic-url]\n[![next-update-travis badge][nut-badge]][nut-readme]\n\n[dont-break-icon]: https://nodei.co/npm/dont-break.svg?downloads=true\n[dont-break-url]: https://npmjs.org/package/dont-break\n[dont-break-ci-image]: https://travis-ci.org/bahmutov/dont-break.svg?branch=master\n[dont-break-ci-url]: https://travis-ci.org/bahmutov/dont-break\n[dont-break-npm-url]: https://img.shields.io/npm/dm/dont-break\n[dont-break-npm-image]: https://img.shields.io/npm/dm/dont-break.svg?maxAge=2592000\n[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-url]: https://github.com/semantic-release/semantic-release\n[nut-badge]: https://img.shields.io/badge/next--update--travis-weekly-green.svg\n[nut-readme]: https://github.com/bahmutov/next-update-travis#readme\n\n## Install\n```\nnpm install -g dont-break\n```\n\n## Use\n\n* Create `.dont-break.json` file in the root of your package,\n  list module names that you would like to test as an array.\n* Run `dont-break` any time to test latest version of each dependent module\n  against the curent code\n\n## Example\n\n2 projects.\n\n1. First project `foo` only exports single variable `module.exports = 'foo';`\n2. Second project `foo-user` depends on `foo`.\n\n`foo-user` only works if it gets string `foo` from the module it depends on, like this:\n```js\nvar str = require('foo');\nconsole.assert(str === 'foo', 'value of foo should be \"foo\", but is ' + str);\n```\n`foo` has only a single release 0.1.0 that works for `foo-user` project.\n\nThe author of `foo` changes code to be `module.exports = 'bar';` and releases it as 0.2.0.\n`foo-user` wants to use the latest `foo` so it updates its dependency, not expecting anything\nbad - foo's minor version number has been upgraded. In semantic versioning it means no breaking API\nchanges.\n\n`foo-user` is now broken!\n\nInstead, before publishing new version to NPM, project `foo` can create a file in its\nproject folder `.dont-break.json` with names of dependent projects to test\n```bash\necho '[\"foo-user\"]' > .dont-break.json\n```\nYou can check if the current code breaks listed dependent project by running\n\n```bash\ndont-break\n```\n\nThis will install each dependent project from `.dont-break.json` file into `/tmp/dont-break...` folder,\nwill run the dependent's unit tests using `npm test` to make sure they work initially, then\nwill copy the current project into the temp folder, overwriting the previous working version.\nThen it will run the tests again, throwing an exception if they stopped working.\n\nIn the example case, it will report something like this\n```bash\n$ dont-break\ndependents [ 'foo-user' ]\ntesting foo-user\n  installing foo-user\ninstalled into /tmp/foo@0.0.0-against-foo-user\n  npm test\ntests work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncopied /Users/gleb/git/foo/* to /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user/node_modules/foo\n  npm test\nnpm test returned 1\ntest errors:\nAssertionError: value of foo should be \"foo\", but is bar\nnpm ERR! Test failed.  See above for more details.\nnpm ERR! not ok code 0\ntests did not work in /tmp/foo@0.0.0-against-foo-user/lib/node_modules/foo-user\ncode 1\nFAIL: Current version break dependents\n```\nThe message clearly tells you that the dependent projects as they are right now cannot\nupgrade to the version you are about to release.\n\n## Dependencies\n\nYou can specify GitHub repos as dependencies, because they most likely will\nhave tests. For example in `.dont-break.json`\n\n```js\n// you can use JavaScript comments in this file .dont-break.json\n[\n  \"https://github.com/bahmutov/dont-break-bar\"\n]\n```\n\nPicking projects to test manually is a judgement call.\nDont-break can fetch top N most downloaded\nor most starred dependent modules and save the list.\n* run `dont-break --top-downloads <N>` to find top N most downloaded dependent modules,\nsave to `.dont-break.json` and check.\n* run `dont-break --top-starred <N>` to find top N most starred dependent modules,\nsave to `.dont-break.json` and check.\n\nThe above commands overwrite `.dont-break.json` file.\n\n## Configuration options\n\n### Global vs. project-level configuration\nYou can specify different configuration options on global level or on project level. Following configs are equivalent.\nProject level:\n```\n[\n  {\n    \"name\": \"project-a\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-b\",\n    \"test\": \"grunt test\"\n  },\n  {\n    \"name\": \"project-c\",\n    \"test\": \"npm test:special\"\n  }\n]\n```\nGlobal level:\n```\n{\n  \"test\": \"grunt test\",\n  \"projects\": [\n    \"project-a\", \n    \"project-b\", \n    {\n      \"name\": \"project-c\",\n      \"test\": \"npm test:special\"\n    }\n  ]\n}\n```\nGlobal level will simplify dont-break config if dependent projects share the same options. Also, options can be \noverriden on project level as in case of \"project-c\" here.\n  \n### Execution flow overview\nDont-break performs folowing steps for each dependent project:\n* Clone the dependent project repo into temporary dir using `git clone`, if dependent project is a Github repo url\n* Install the dependent project in temporary dir using the [specified command](#install-command)\n* Run [post-install](#post-install-command) command if [pre-test](#pre-testing-with-previous-package-version) is not disabled\n* [Pre-test](#pre-testing-with-previous-package-version) the dependent project if this is not disabled\n* [Install current module](#current-module-installation-method) into the dependent project\n* Run [post-install](#post-install-command) command\n* [Test](#test-command) the dependent project\n\nSections below describe how you can customize these steps.\n\n### Test command\n\nYou can specify a custom test command per dependent module. For example, to run `grunt test` for `foo-module-name`,\nbut default command for module `bar-name`, list in `.dont-break.json` the following:\n\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\"\n  },\n  \"bar-name\"\n]\n```\n\n### Install command\n\nYou can specify a custom install command per dependent module. By default it's `npm install`. For example, this will use\n`yarn add` for `foo-module-name`, but keep default `npm install` for module `bar-name`:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"install\": \"yarn add\"\n  },\n  \"bar-name\"\n]\n```\nThe name of dependent module will be added to given command, e.g. for above it will run `yarn add foo-module-name`.\nYou can specify desired version range of dependent module, too, like this:\n```\n[\n  {\n    \"name\": \"foo-module-name@^1.0.1-pre.1\"\n  },\n  \"bar-name\"\n]\n``` \n\n### Post-install command\n\nBefore testing the dependent package dont-break installs its dev dependencies via `npm install` command run from the\ndependency directory. If you need something more you can specify it via \"postinstall\" config parameter like this:\n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"npm run update\"\n  }, {\n    \"name\": \"packageB\"\n  }\n]\n```\nIf specified this command will run first before pretesting the old version of lib (if pretest isn't disabled), then \nafter installing current version of lib to dependent package. You can use $CURRENT_MODULE_DIR variable here which \nwill be replaced with a path to current module: \n```\n[\n  {\n    \"name\": \"packageA\",\n    \"postinstall\": \"$CURRENT_MODULE_DIR/install-all-deps.sh\",\n  }\n]\n```\n\n### Pre-testing with previous package version\nBy default dont-break first tests dependent module with its published version of current module, to make sure that it \nwas working before the update. If this sounds excessive to you you can disable it with {\"pretest\": false} option: \n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": false\n  }\n]\n```\nHere \"foo-module-name\" module will be tested only once, and \"bar-name\" twise: first with its published version of \ncurrent module, and then with the updated version.   \n\nThe \"pretest\" property can also accept custom script to run for pretesting:\n```\n[\n  {\n    \"name\": \"foo-module-name\",\n    \"test\": \"grunt test\",\n    \"pretest\": \"grunt test && ./ci/after-pretesting-by-dont-break\"\n  }\n]\n```\nBy default it equals to \"test\" command.\n\n### Current module installation method\n\nTo test dependent package dont-break installs current module inside the dependent package directory. By default it uses\n`npm install $CURRENT_MODULE_DIR`. You can enter your command there, e.g. `yarn add $CURRENT_MODULE_DIR`. There are \nalso pre-configured options [npm-link](https://docs.npmjs.com/cli/link) and \n[yarn-link](https://yarnpkg.com/lang/en/docs/cli/link/). They can be helpful in some cases, e.g. if you need to use \n`npm install` or `yarn` in postinstall command. To use `npm link` method specify {\"currentModuleInstall\": \"npm-link\"}: \n```\n{\n  \"currentModuleInstall\": \"npm-link\",\n  \"projects\": [\"packageA\", \"packageB\"]\n}\n```\n\n### Env vars exported to called scripts\nFollowing env vars are available for use in scripts called by executed steps: \n* `$CURRENT_MODULE_DIR` - directory of current module  \n* `$CURRENT_MODULE_NAME` - name of current module as stated in its package.json\n \n### Installation timeout\nYou can specify a longer installation time out, in seconds, using CLI option\n\n```\ndont-break --timeout 30\n```\n\n## Related\n\n*dont-break* is the opposite of [next-update](https://github.com/bahmutov/next-update)\nthat one can use to safely upgrade dependencies.\n\n## Setting up second CI for dont-break\n\nI prefer to use a separate CI service specifically to test the current code\nagainst the dependent projects using `dont-break`. For example, the project\n[boggle](https://www.npmjs.com/package/boggle) is setup this way. The unit tests\nare run on [TravisCI](https://travis-ci.org/bahmutov/boggle) using\npretty standard [.travis.yml](https://github.com/bahmutov/boggle/blob/master/.travis.yml) file\n\n```yml\nlanguage: node_js\nnode_js:\n  - \"0.12\"\n  - \"4\"\nbranches:\n  only:\n    - master\nbefore_script:\n  - npm install -g grunt-cli\n```\n\nThen I setup a separate build service on [CircleCi](https://circleci.com/gh/bahmutov/boggle)\njust to run the `npm run dont-break` command from the `package.json`\n\n```json\n\"scripts\": {\n    \"dont-break\": \"dont-break --timeout 30\"\n}\n```\n\nWe are assuming a global installation of `dont-break`, and the project lists\nthe projects to check in the\n[.dont-break](https://github.com/bahmutov/boggle/blob/master/.dont-break) file.\nAt the present there is only a single dependent project\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo run `dont-break` on CircleCI, I created the\n[circle.yml](https://github.com/bahmutov/boggle/blob/master/circle.yml) file.\nIt should be clear what it does - installs `dont-break`, and runs the npm script command.\n\n```yml\nmachine:\n  node:\n    version: \"0.12\"\ndependencies:\n  post:\n    - npm install -g dont-break\ntest:\n  override:\n    - npm run dont-break\n```\n\nTo make the status visible, I included the CircleCI badges in the README file.\n\n```md\n[![Dont-break][circle-ci-image] ][circle-ci-url]\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n```\n\nwhich produces the following:\n\nBreaking dependencies? [![Dont-break][circle-ci-image] ][circle-ci-url] using\n[dont-break](https://github.com/bahmutov/dont-break)\n\n[circle-ci-image]: https://circleci.com/gh/bahmutov/boggle.svg?style=svg\n[circle-ci-url]: https://circleci.com/gh/bahmutov/boggle\n\n## Development and testing\n\nThis project is tested end to end using two small projects:\n[boggle](https://www.npmjs.com/package/boggle) and its dependent\n[boggle-connect](https://www.npmjs.com/package/boggle-connect).\n\nTo see open github issues, use command `npm run issues`\n\nTo see verbose log message, run with `DEBUG=dont-break ...` environment\nvariable.\n\n### Small print\n\nAuthor: Gleb Bahmutov &copy; 2014\n\n* [@bahmutov](https://twitter.com/bahmutov)\n* [glebbahmutov.com](http://glebbahmutov.com)\n* [blog](http://glebbahmutov.com/blog)\n\nLicense: MIT - do anything with the code, but don't blame me if it does not work.\n\nSpread the word: tweet, star on github, etc.\n\nSupport: if you find any problems with this module, email / tweet /\n[open issue](https://github.com/bahmutov/dont-break/issues?state=open) on Github\n\nImplemented using [npm-registry](https://github.com/3rd-Eden/npmjs),\n[lazy-ass](https://github.com/bahmutov/lazy-ass) and [npm-utils](https://github.com/bahmutov/npm-utils).\n\n## MIT License\n\nCopyright (c) 2014 Gleb Bahmutov\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n","readmeFilename":"README.md","gitHead":"1f87f55b388d15f00a4fbb8cec90e2b11bdd96a8","_id":"@artemv/dont-break@1.13.5-pre.1","_npmVersion":"5.6.0","_nodeVersion":"8.11.1","_npmUser":{"name":"artemv","email":"artem.job@gmail.com"},"dist":{"integrity":"sha512-Y8WL/fZ+e4+QAhsqvifPXoL7rusFQZ9Q0SgSmCUw+AzQzLZI1bW/HWeUqagEWAEF8dIu306NVf1qMA8OI47MfQ==","shasum":"c89968d084c569e64324c15609e5f2244ba25586","tarball":"https://registry.npmjs.org/@artemv/dont-break/-/dont-break-1.13.5-pre.1.tgz","fileCount":11,"unpackedSize":33553,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbcsqhCRA9TVsSAnZWagAArTgP/0DSYwKCmdEh/DQDK7we\n0QRCyHNv5VXZLuoYlBnq4LeCz/+gLe53oh9nKwqh170wdv0E0IEEG0cLNaIt\nLh9LdSIjnE0Ldor55aL/cqLERuWEii1waU4LXVjRn+IKZ7r7tnQWTkihK1iD\nyNkLIrYyexx7R4Q1EwvCSNilhVSufuwHMQ6WrZwh/Sl2FA4t+tKTNFIM1lZU\no2PsxLs9zgQAiOrr4To/jTTKtE6SYrGV3MIjEanoO37VyT0K+vGZL1If2jMM\nuzOiVJLzUqdXkTS9La0MLmEzT7aomVmGJpHPd+VRV+a3EYdPq9z1sMwtOlCq\n//Wyf931fBW2U7JtMLP9MxF3xG34AidSMGQ1wdPE9zTKuX0x75FeDZloHJTB\ntCrtuePG3opG3GQaR3S06/dmSvd01+eNwmJIEjGcZ7VFDpEywJ2Iueb1YhdI\n7pygvkG/RCbAShijlMzihD6kCy8AL9yYxbLs7HWWrsRWjpknvd5hEX88eaOX\n4KXmhJ/h1piitBE5cBTP5VqeUTDmpVU/p1RmjNhc3kiKycDaP+bTgQaU15sE\nEOsNWhLL57zm2oGC6xNgZyGAWK2X+4RlqepqPevm5SXw9jfJcsfvR1011tZ5\n/nkO/X8zyEpHRdFkZ4MHuWoMIoZuvKeb0rXg3JL5eParCvlMqlK5wXiQfhmt\n/bRY\r\n=Clhu\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIF0r/WA/NREf/XaGrSqqI8uZiSy2n3SRdqP8lBeVJGeUAiA/GCIZMeRTR1168RrlhCBzcFC33Q+7+nB13NCdR0kCSA=="}]},"maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dont-break_1.13.5-pre.1_1534249632727_0.6099472801616228"},"_hasShrinkwrap":false}},"readme":"","maintainers":[{"name":"artemv","email":"artem.job@gmail.com"}],"time":{"modified":"2022-06-12T14:48:35.608Z","created":"2017-11-14T21:35:04.449Z","1.11.0-pre":"2017-11-14T21:35:04.449Z","1.11.0-pre.1":"2017-11-14T21:49:33.547Z","1.11.0-pre.2":"2017-11-14T22:41:48.642Z","1.13.0":"2018-02-21T22:37:37.005Z","1.12.2-pre.1":"2018-02-28T16:51:28.487Z","1.12.2-pre.2":"2018-02-28T17:05:41.815Z","1.12.2-pre.3":"2018-02-28T17:13:30.389Z","1.12.2-pre.4":"2018-02-28T17:50:53.690Z","1.12.2-pre.5":"2018-02-28T18:36:47.666Z","1.13.2-pre.1":"2018-05-11T17:00:10.613Z","1.13.3-pre.1":"2018-05-11T17:34:06.146Z","1.13.4-pre.1":"2018-05-11T18:04:09.261Z","1.13.5-pre.1":"2018-08-14T12:27:12.803Z"},"homepage":"https://github.com/bahmutov/dont-break","keywords":["check","dependency","semver","test","update"],"repository":{"type":"git","url":"git+https://github.com/bahmutov/dont-break.git"},"contributors":[],"author":{"name":"Gleb Bahmutov","email":"gleb.bahmutov@gmail.com"},"bugs":{"url":"https://github.com/bahmutov/dont-break/issues"},"license":"MIT","readmeFilename":""}