{"id":17419664,"url":"https://github.com/bendrucker/test-peer-range","last_synced_at":"2026-02-23T19:09:22.347Z","repository":{"id":31309267,"uuid":"34871561","full_name":"bendrucker/test-peer-range","owner":"bendrucker","description":"Test a plugin against the full range of major supported versions of its parent","archived":false,"fork":false,"pushed_at":"2022-08-02T00:05:18.000Z","size":60,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T08:14:08.438Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bendrucker.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-30T19:05:06.000Z","updated_at":"2022-08-02T00:01:51.000Z","dependencies_parsed_at":"2022-08-27T09:23:03.790Z","dependency_job_id":null,"html_url":"https://github.com/bendrucker/test-peer-range","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Ftest-peer-range","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Ftest-peer-range/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Ftest-peer-range/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Ftest-peer-range/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bendrucker","download_url":"https://codeload.github.com/bendrucker/test-peer-range/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248981263,"owners_count":21193145,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-17T02:28:57.405Z","updated_at":"2026-02-23T19:09:17.326Z","avatar_url":"https://github.com/bendrucker.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# test-peer-range\n\n\u003e Test a package against the full range of major supported versions of a peer dependency\n\n## Install\n\n```\nnpm install --save-dev test-peer-range\n```\n\n## Usage\n\n```sh\ntest-peer-range browserify\n```\n\nIn `package.json`:\n\n```json\n{\n  \"name\": \"transformify\",\n  \"description\": \"A browserify transform\",\n  \"scripts\": {\n    \"test\": \"test-peer-range browserify\",\n    \"test-main\": \"node test.js\"\n  },\n  \"devDependencies\": {\n    \"browserify\": \"16\",\n    \"test-peer-range\": \"*\"\n  },\n  \"peerDependencies\": {\n    \"browserify\": \"\u003e= 14\"\n  }\n}\n```\n\nThe program will execute `test-main` for each major version (e.g. 14, 15, 16) of the peer. This is useful for maintaining backward compatibility for plugins. As long as the peer dependency follows [semver](https://semver.org/), you can be confident that your code works on old versions while developing against a more recent line.\n\nArguments are passed through, so running `npm test -- --inspect` would result in `node test.js --inspect` as your test command.\n\n## CLI\n\n#### `test-peer-range \u003cname\u003e`\n\n##### name\n\n*Required*  \nType: `string`\n\nThe package name of the peer.\n\n##### --versions\n\nType: `array[string]`  \nAlias: `-v`  \nDefault: `test-main`\n\nAdditional versions to test, on top of major versions specified in `peerDependencies`. Repeat this flag to specify multiple versions, e.g. `-v 1.2.3 -v 4.5.6`.\n\n##### --command\n\nType: `string`  \nAlias: `-c`  \nDefault: `test-main`\n\nA command to run for each version. By default this is expected to be an npm script.\n\n##### --npm\n\nType: `boolean`  \nDefault: `true`\n\nDisable npm to run the `--command` directly.\n\n##### --bail\n\nType: `boolean`  \nDefault: `false`\n\nExit immediately when any test fails. \n\n## API\n\n#### `run(name, range, [options], callback)`\n\n##### name\n\n*Required*  \nType: `string`\n\nThe name of the peer to test against.\n\n##### range\n\n*Required*  \nType: `string`\n\nThe semver range of the peer versions to use for testing.\n\n##### options\n\n###### command\n\nType: `string`  \nDefault: `test-main`\n\nThe test command to run.\n\n###### arguments\n\nType: `array[string]`  \nDefault: `[]`\n\nAdditional command line arguments to pass to the command. For npm scripts, these will be passed to the script itself, not `npm run`.\n\n###### npm\n\nType: `boolean`  \nDefault: `true`\n\nRun the command as an npm script.\n\n###### bail\n\nType: `boolean`  \nDefault: `true`\n\nImmediately end the run when a test fails.\n\n##### callback\n\n*Required*  \nType: `function`\nArguments: `err, results[{version, passed}]`\n\nThe callback to call when done. Receives an array of objects with version (`string`) and passed (`integer`) properties.\n\n## License\n\nMIT © [Ben Drucker](http://bendrucker.me)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbendrucker%2Ftest-peer-range","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbendrucker%2Ftest-peer-range","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbendrucker%2Ftest-peer-range/lists"}