Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knapsackpro/knapsack-pro-js
Run your 1-hour test suite in 2 minutes with optimal parallelisation on your existing CI infrastructure
https://github.com/knapsackpro/knapsack-pro-js
cypress cypress-io javascript jest jest-plugin knapsack-pro parallelism parallelization test-automation testing testing-tools typescript
Last synced: 10 days ago
JSON representation
Run your 1-hour test suite in 2 minutes with optimal parallelisation on your existing CI infrastructure
- Host: GitHub
- URL: https://github.com/knapsackpro/knapsack-pro-js
- Owner: KnapsackPro
- License: mit
- Created: 2023-05-27T11:32:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T16:48:46.000Z (6 months ago)
- Last Synced: 2024-05-23T01:05:31.641Z (6 months ago)
- Topics: cypress, cypress-io, javascript, jest, jest-plugin, knapsack-pro, parallelism, parallelization, test-automation, testing, testing-tools, typescript
- Language: TypeScript
- Homepage: https://knapsackpro.com
- Size: 4.5 MB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Knapsack Pro JS
Speed up your tests
Run your 1-hour test suite in 2 minutes with optimal parallelisation on your existing CI infrastructure
---
Knapsack Pro wraps your [current test runner(s)](https://docs.knapsackpro.com/) and works with your existing CI infrastructure to parallelize tests optimally:
- Dynamically splits your tests based on up-to-date test execution data
- Is designed from the ground up for CI and supports all of them
- Tracks your CI builds to detect bottlenecks
- Does not have access to your source code and collects minimal test data
- Enables you to export historical metrics about your CI builds
- Replaces local dependencies like Redis with an API and runs your tests regardless of network problems
## Installation
See the [docs](https://docs.knapsackpro.com/) to get started:
## Contributing
### Requirements
```
>= Node 18.13.0 LTS
```
You can use [NVM](https://github.com/nvm-sh/nvm) to manage Node versions in development.
### Setup
```bash
npm install
npm run build
# Need a second install to run:
# - npx @knapsack-pro/jest
# - npx @knapsack-pro/cypress
# See https://github.com/npm/cli/issues/4591#issuecomment-1111557730
npm install
```
### Testing
```
npm run test:core:coverage
npm run test:jest
npm run test:cypress
npm run test:cra
```
You can find more example scripts in the nested `packages/`.
### IDE (VSCode)
Install the following plugins:
- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
In `File > Preferences > Settings > Text Editor > Formatting`, enable the `Format On Save` checkbox.
### Publishing
#### Core
```bash
# merge PR and pull or edit code
# 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`
# update CHANGELOG to move *unreleased* into the proper *version*
npm version LEVEL -w packages/core
git add --all
git commit -m "chore: prepare release"
git tag @knapsack-pro/[email protected]
```
```bash
git push origin main --tags
```
```bash
cd packages/core
npm run build
npm adduser # sign in to npm
npm publish
```
#### Jest and/or Cypress
Replace PACKAGE with `jest`, or `cypress`. If core changed you'll need to update both.
```bash
# merge PR and pull or edit code
# 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`
# update CHANGELOG(s) to move *unreleased* into the proper *version*
npm version LEVEL -w packages/PACKAGE
npm install @knapsack-pro/core -w packages/jest
# make sure @knapsack-pro/core was updated in packages/jest/package.json (you can retry specifying the version [email protected])
npm install @knapsack-pro/core -w packages/cypress
# make sure @knapsack-pro/core was updated in packages/cypress/package.json (you can retry specifying the version [email protected])
git add --all
git commit -m "chore: prepare release"
git tag @knapsack-pro/[email protected] # can be multiple tags
```
```bash
git push origin main --tags
```
```bash
cd packages/PACKAGE
npm run build
npm adduser # sign in to npm
npm publish
```
```bash
npm install -D @knapsack-pro/jest -w packages/jest-example-test-suite
# make sure @knapsack-pro/jest was updated in packages/jest-example-test-suite/package.json (you can retry specifying the version [email protected])
npm run test:jest
npm install -D @knapsack-pro/cypress -w packages/cypress-example-test-suite
# make sure @knapsack-pro/cypress was updated in packages/cypress-example-test-suite/package.json
npm run test:cypress
# since create-react-app-example is not a workspace (for now)
cd packages/create-react-app-example
npm install -D @knapsack-pro/jest
# make sure @knapsack-pro/jest was updated in packages/create-react-app-example/package.json
npm run test:cra
git add --all
git commit -m "deps(examples): update @knapsack-pro"
```
Remember to update `TestSuiteClientVersionChecker` for the Knapsack Pro API repository.
## Packages
Read the READMEs inside the nested `packages/`:
- [core](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/core)
- [jest](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/jest)
- [cypress](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/cypress)
- [jest-example-test-suite](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/jest-example-test-suite)
- [cypress-example-test-suite](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/cypress-example-test-suite)
- [create-react-app-example](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/create-react-app-example)
## Legacy Repositories
Before merging the Knapsack Pro packages into this monorepo, each one was hosted in a separate repository:
- [core](https://github.com/KnapsackPro/knapsack-pro-core-js)
- [jest](https://github.com/KnapsackPro/knapsack-pro-jest)
- [cypress](https://github.com/KnapsackPro/knapsack-pro-cypress)
- [jest-example-test-suite](https://github.com/KnapsackPro/jest-example-test-suite)
- [cypress-example-test-suite](https://github.com/KnapsackPro/cypress-example-test-suite)