{"id":18265957,"url":"https://github.com/knapsackpro/knapsack-pro-js","last_synced_at":"2025-04-04T21:32:19.829Z","repository":{"id":171585833,"uuid":"646129221","full_name":"KnapsackPro/knapsack-pro-js","owner":"KnapsackPro","description":"Run your 1-hour test suite in 2 minutes with optimal parallelisation on your existing CI infrastructure","archived":false,"fork":false,"pushed_at":"2024-05-22T16:48:46.000Z","size":4720,"stargazers_count":3,"open_issues_count":12,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-05-23T01:05:31.641Z","etag":null,"topics":["cypress","cypress-io","javascript","jest","jest-plugin","knapsack-pro","parallelism","parallelization","test-automation","testing","testing-tools","typescript"],"latest_commit_sha":null,"homepage":"https://knapsackpro.com","language":"TypeScript","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/KnapsackPro.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-27T11:32:20.000Z","updated_at":"2024-06-19T00:08:21.957Z","dependencies_parsed_at":"2023-12-18T18:44:34.681Z","dependency_job_id":"41fbe661-f59c-4364-8bb3-5d6515ce7125","html_url":"https://github.com/KnapsackPro/knapsack-pro-js","commit_stats":null,"previous_names":["knapsackpro/whatever"],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KnapsackPro%2Fknapsack-pro-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KnapsackPro%2Fknapsack-pro-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KnapsackPro%2Fknapsack-pro-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KnapsackPro%2Fknapsack-pro-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KnapsackPro","download_url":"https://codeload.github.com/KnapsackPro/knapsack-pro-js/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247252453,"owners_count":20908695,"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":["cypress","cypress-io","javascript","jest","jest-plugin","knapsack-pro","parallelism","parallelization","test-automation","testing","testing-tools","typescript"],"created_at":"2024-11-05T11:20:54.089Z","updated_at":"2025-04-04T21:32:19.820Z","avatar_url":"https://github.com/KnapsackPro.png","language":"TypeScript","readme":"# Knapsack Pro JS\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://knapsackpro.com?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=knapsack-pro-js\u0026utm_content=hero_logo\"\u003e\n    \u003cimg alt=\"Knapsack Pro\" src=\"./.github/assets/knapsack.png\" width=\"300\" height=\"300\" style=\"max-width: 100%;\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003eSpeed up your tests\u003c/h3\u003e\n\u003cp align=\"center\"\u003eRun your 1-hour test suite in 2 minutes with optimal parallelisation on your existing CI infrastructure\u003c/p\u003e\n\n---\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://circleci.com/gh/KnapsackPro/knapsack-pro-js\"\u003e\n    \u003cimg alt=\"Circle CI\" src=\"https://circleci.com/gh/KnapsackPro/knapsack-pro-js.svg?style=svg\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\nKnapsack Pro wraps your [current test runner(s)](https://docs.knapsackpro.com/) and works with your existing CI infrastructure to parallelize tests optimally:\n\n- Dynamically splits your tests based on up-to-date test execution data\n- Is designed from the ground up for CI and supports all of them\n- Tracks your CI builds to detect bottlenecks\n- Does not have access to your source code and collects minimal test data\n- Enables you to export historical metrics about your CI builds\n- Replaces local dependencies like Redis with an API and runs your tests regardless of network problems\n\n## Installation\n\nSee the [docs](https://docs.knapsackpro.com/) to get started:\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://docs.knapsackpro.com/\"\u003e\n    \u003cimg alt=\"Install button\" src=\"./.github/assets/install-button.png\" width=\"116\" height=\"50\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n## Contributing\n\n### Requirements\n\n```\n\u003e= Node 18.13.0 LTS\n```\n\nYou can use [NVM](https://github.com/nvm-sh/nvm) to manage Node versions in development.\n\n### Setup\n\n```bash\nnpm install\nnpm run build\n# Need a second install to run:\n#   - npx @knapsack-pro/jest\n#   - npx @knapsack-pro/vitest\n#   - npx @knapsack-pro/cypress\n# See https://github.com/npm/cli/issues/4591#issuecomment-1111557730\nnpm install\n```\n\n### Testing\n\n```\nnpm run test:core:coverage\nnpm run test:jest\nnpm run test:vitest\nnpm run test:cypress\nnpm run test:cra\n```\n\nYou can find more example scripts in the nested `packages/`.\n\n### IDE (VSCode)\n\nInstall the following plugins:\n\n- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)\n- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)\n- [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)\n\nIn `File \u003e Preferences \u003e Settings \u003e Text Editor \u003e Formatting`, enable the `Format On Save` checkbox.\n\n### Publishing\n\n#### Core\n\n```bash\n# merge PR and pull or edit code\n# if new files that should be part of the released npm package were added, please ensure they are included in the `files` array in `package.json`\n# update CHANGELOG to move *unreleased* into the proper *version*\n# LEVEL specifies the type of version increment: major, minor, patch\nnpm version LEVEL -w packages/core\ngit add --all\ngit commit -m \"chore: prepare release\"\ngit tag @knapsack-pro/core@x.x.x\n```\n\n```bash\ngit push origin main --tags\n```\n\n```bash\ncd packages/core\nnpm run build\nnpm adduser # sign in to npm\nnpm publish\n```\n\n#### Jest, Vitest and/or Cypress\n\nReplace PACKAGE with `jest`, `vitest` or `cypress`. If core changed you'll need to update all of them.\n\n```bash\n# merge PR and pull or edit code\n# if new files that should be part of the released npm package were added, please ensure they are included in the `files` array in `package.json`\n# update CHANGELOG(s) to move *unreleased* into the proper *version*\n# LEVEL specifies the type of version increment: major, minor, patch\nnpm version LEVEL -w packages/PACKAGE\n\nnpm install @knapsack-pro/core -w packages/jest\n# make sure @knapsack-pro/core was updated in packages/jest/package.json (you can retry specifying the version package@x.x.x)\n\nnpm install @knapsack-pro/core -w packages/vitest\n# make sure @knapsack-pro/core was updated in packages/vitest/package.json (you can retry specifying the version package@x.x.x)\n\nnpm install @knapsack-pro/core -w packages/cypress\n# make sure @knapsack-pro/core was updated in packages/cypress/package.json (you can retry specifying the version package@x.x.x)\n\ngit add --all\ngit commit -m \"chore: prepare release\"\ngit tag @knapsack-pro/PACKAGE@x.x.x # can be multiple tags\n```\n\n```bash\ngit push origin main --tags\n```\n\n```bash\ncd packages/PACKAGE\nnpm run build\nnpm adduser # sign in to npm\nnpm publish\n```\n\n```bash\nnpm install -D @knapsack-pro/jest -w packages/jest-example-test-suite\n# make sure @knapsack-pro/jest was updated in packages/jest-example-test-suite/package.json (you can retry specifying the version package@x.x.x)\nnpm run test:jest\n\nnpm install -D @knapsack-pro/vitest -w packages/vitest-example-test-suite\n# make sure @knapsack-pro/vitest was updated in packages/vitest-example-test-suite/package.json (you can retry specifying the version package@x.x.x)\nnpm run test:vitest\n\nnpm install -D @knapsack-pro/cypress -w packages/cypress-example-test-suite\n# make sure @knapsack-pro/cypress was updated in packages/cypress-example-test-suite/package.json\nnpm run test:cypress\n\n# since create-react-app-example is not a workspace (for now)\ncd packages/create-react-app-example\nnpm install -D @knapsack-pro/jest\n# make sure @knapsack-pro/jest was updated in packages/create-react-app-example/package.json\nnpm run test:cra\n\ngit add --all\ngit commit -m \"deps(examples): update @knapsack-pro\"\n```\n\nRemember to update `TestSuiteClientVersionChecker` for the Knapsack Pro API repository.\n\n## Packages\n\nRead the READMEs inside the nested `packages/`:\n\n- [core](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/core)\n- [jest](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/jest)\n- [vitest](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/vitest)\n- [cypress](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/cypress)\n- [jest-example-test-suite](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/jest-example-test-suite)\n- [vitest-example-test-suite](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/vitest-example-test-suite)\n- [cypress-example-test-suite](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/cypress-example-test-suite)\n- [create-react-app-example](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/create-react-app-example)\n\n## Legacy Repositories\n\nBefore merging the Knapsack Pro packages into this monorepo, each one was hosted in a separate repository:\n\n- [core](https://github.com/KnapsackPro/knapsack-pro-core-js)\n- [jest](https://github.com/KnapsackPro/knapsack-pro-jest)\n- [cypress](https://github.com/KnapsackPro/knapsack-pro-cypress)\n- [jest-example-test-suite](https://github.com/KnapsackPro/jest-example-test-suite)\n- [cypress-example-test-suite](https://github.com/KnapsackPro/cypress-example-test-suite)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknapsackpro%2Fknapsack-pro-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fknapsackpro%2Fknapsack-pro-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknapsackpro%2Fknapsack-pro-js/lists"}