@knapsack-pro/jest 6.1.0 → 6.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -77
- package/lib/knapsack-pro-jest.js +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
---
|
|
13
13
|
|
|
14
14
|
<div align="center">
|
|
15
|
-
<a href="https://circleci.com/gh/KnapsackPro/knapsack-pro-
|
|
16
|
-
<img alt="Circle CI" src="https://circleci.com/gh/KnapsackPro/knapsack-pro-
|
|
15
|
+
<a href="https://circleci.com/gh/KnapsackPro/knapsack-pro-core-js">
|
|
16
|
+
<img alt="Circle CI" src="https://circleci.com/gh/KnapsackPro/knapsack-pro-core-js.svg?style=svg" />
|
|
17
17
|
</a>
|
|
18
18
|
</div>
|
|
19
19
|
|
|
@@ -39,83 +39,31 @@ See the [docs](https://docs.knapsackpro.com/jest/guide/) to get started:
|
|
|
39
39
|
</a>
|
|
40
40
|
</div>
|
|
41
41
|
|
|
42
|
-
##
|
|
43
|
-
|
|
44
|
-
### Requirements
|
|
45
|
-
|
|
46
|
-
```
|
|
47
|
-
>= Node 18.13.0 LTS
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
You can use [NVM](https://github.com/nvm-sh/nvm) to manage Node versions in development.
|
|
51
|
-
|
|
52
|
-
### Dependencies
|
|
53
|
-
|
|
54
|
-
- [@knapsack-pro/core](https://github.com/KnapsackPro/knapsack-pro-core-js)
|
|
55
|
-
|
|
56
|
-
### Setup
|
|
57
|
-
|
|
58
|
-
1. Setup the [@knapsack-pro/core](https://github.com/KnapsackPro/knapsack-pro-core-js) project.
|
|
59
|
-
|
|
60
|
-
**Follow the steps below or use the `bin/setup_development` script to take care of steps 2-5.**
|
|
61
|
-
|
|
62
|
-
1. Install the dependencies:
|
|
63
|
-
|
|
64
|
-
```bash
|
|
65
|
-
npm install
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
1. In order to use the local version of `@knapsack-pro/core` run:
|
|
69
|
-
|
|
70
|
-
```bash
|
|
71
|
-
npm link @knapsack-pro/core
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
1. Compile the TypeScript code to the `lib` directory by running:
|
|
42
|
+
## Dependencies
|
|
75
43
|
|
|
76
|
-
|
|
77
|
-
npm start
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
1. Register the `@knapsack-pro/jest` package globally in your local system. This way we will be able to develop other npm packages dependent on it:
|
|
81
|
-
|
|
82
|
-
```bash
|
|
83
|
-
npm link
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
1. Set up your IDE:
|
|
87
|
-
|
|
88
|
-
- Visual Studio Code
|
|
89
|
-
|
|
90
|
-
- Install the following plugins:
|
|
91
|
-
|
|
92
|
-
- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
|
|
93
|
-
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
94
|
-
- [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
|
|
44
|
+
- [@knapsack-pro/core](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/core)
|
|
95
45
|
|
|
96
|
-
|
|
46
|
+
## Contributing
|
|
97
47
|
|
|
98
|
-
|
|
48
|
+
Follow the steps in the [root README.md](https://github.com/KnapsackPro/knapsack-pro-js#contributing) to set up the project.
|
|
99
49
|
|
|
100
|
-
|
|
50
|
+
You can compile TypeScript in watch mode from the root folder with:
|
|
101
51
|
|
|
102
|
-
|
|
52
|
+
```bash
|
|
53
|
+
npm start -w packages/jest
|
|
54
|
+
```
|
|
103
55
|
|
|
104
56
|
### Testing
|
|
105
57
|
|
|
106
|
-
#### CI
|
|
107
|
-
|
|
108
|
-
If your feature requires code changes in [@knapsack-pro/core](https://github.com/KnapsackPro/knapsack-pro-core-js), please push the `@knapsack-pro/core` to GitHub first. Then you can push changes for `@knapsack-pro/jest` to ensure the CI will use the latest `@knapsack-pro/core`.
|
|
109
|
-
|
|
110
|
-
#### Example Jest test suite
|
|
111
|
-
|
|
112
58
|
To test `@knapsack-pro/jest` against a real test suite we use:
|
|
113
59
|
|
|
114
|
-
- [jest-example-test-suite](https://github.com/KnapsackPro/jest-example-test-suite)
|
|
60
|
+
- [jest-example-test-suite](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/jest-example-test-suite)
|
|
115
61
|
- (deprecated) [react](https://github.com/KnapsackPro/react)
|
|
116
62
|
|
|
117
63
|
### Publishing
|
|
118
64
|
|
|
65
|
+
1. `cd packages/jest`
|
|
66
|
+
|
|
119
67
|
1. Sign in to the npm registry with:
|
|
120
68
|
|
|
121
69
|
```bash
|
|
@@ -132,7 +80,7 @@ To test `@knapsack-pro/jest` against a real test suite we use:
|
|
|
132
80
|
}
|
|
133
81
|
```
|
|
134
82
|
|
|
135
|
-
|
|
83
|
+
and run `npm install`.
|
|
136
84
|
|
|
137
85
|
Commit the updated `package.json` and `package-lock.json`:
|
|
138
86
|
|
|
@@ -146,9 +94,9 @@ To test `@knapsack-pro/jest` against a real test suite we use:
|
|
|
146
94
|
gem install github_changelog_generator
|
|
147
95
|
|
|
148
96
|
# generate CHANGELOG.md
|
|
149
|
-
github_changelog_generator --user KnapsackPro --project knapsack-pro-jest
|
|
97
|
+
github_changelog_generator --user KnapsackPro --project knapsack-pro-js --pr-wo-labels --issues-wo-labels --include-labels @knapsack-pro/jest --since-tag @knapsack-pro/jest@6.1.0 --exclude-tags-regex "@knapsack-pro\/(core|cypress)@.*"
|
|
150
98
|
git commit -am "Update CHANGELOG.md"
|
|
151
|
-
git push origin
|
|
99
|
+
git push origin main
|
|
152
100
|
```
|
|
153
101
|
|
|
154
102
|
1. If you have added new files to the repository, and they should be part of the released npm package, please ensure they are included in the `files` array in `package.json`.
|
|
@@ -156,9 +104,6 @@ To test `@knapsack-pro/jest` against a real test suite we use:
|
|
|
156
104
|
1. Compile the project:
|
|
157
105
|
|
|
158
106
|
```bash
|
|
159
|
-
# Ensure you use local version of @knapsack-pro/core
|
|
160
|
-
npm link @knapsack-pro/core
|
|
161
|
-
|
|
162
107
|
npm run build
|
|
163
108
|
```
|
|
164
109
|
|
|
@@ -166,24 +111,29 @@ To test `@knapsack-pro/jest` against a real test suite we use:
|
|
|
166
111
|
|
|
167
112
|
```bash
|
|
168
113
|
# Bump patch version 0.0.x
|
|
169
|
-
npm version patch
|
|
114
|
+
npm version patch --no-commit-hooks --tag-version-prefix=@knapsack-pro/jest@
|
|
170
115
|
|
|
171
116
|
# Bump minor version 0.x.0
|
|
172
|
-
npm version minor
|
|
117
|
+
npm version minor --no-commit-hooks --tag-version-prefix=@knapsack-pro/jest@
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
git commit -am x.x.x
|
|
122
|
+
git tag @knapsack-pro/jest@x.x.x
|
|
173
123
|
```
|
|
174
124
|
|
|
175
125
|
1. Push the commit and tag:
|
|
176
126
|
|
|
177
127
|
```bash
|
|
178
|
-
git push origin
|
|
128
|
+
git push origin main --tags
|
|
179
129
|
```
|
|
180
130
|
|
|
181
131
|
1. When the git tag is on Github, you can update `CHANGELOG.md`:
|
|
182
132
|
|
|
183
133
|
```bash
|
|
184
|
-
github_changelog_generator --user KnapsackPro --project knapsack-pro-jest
|
|
134
|
+
github_changelog_generator --user KnapsackPro --project knapsack-pro-js --pr-wo-labels --issues-wo-labels --include-labels @knapsack-pro/jest --since-tag @knapsack-pro/jest@6.1.0 --exclude-tags-regex "@knapsack-pro\/(core|cypress)@.*"
|
|
185
135
|
git commit -am "Update CHANGELOG.md"
|
|
186
|
-
git push origin
|
|
136
|
+
git push origin main
|
|
187
137
|
```
|
|
188
138
|
|
|
189
139
|
1. Publish the package to the npm registry:
|
|
@@ -195,4 +145,4 @@ To test `@knapsack-pro/jest` against a real test suite we use:
|
|
|
195
145
|
1. Update the latest available library version in:
|
|
196
146
|
|
|
197
147
|
- `TestSuiteClientVersionChecker` for the Knapsack Pro API repository.
|
|
198
|
-
- [jest-example-test-suite](https://github.com/KnapsackPro/jest-example-test-suite)
|
|
148
|
+
- [jest-example-test-suite](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/jest-example-test-suite)
|
package/lib/knapsack-pro-jest.js
CHANGED
|
@@ -26,7 +26,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
26
26
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
27
27
|
function step(op) {
|
|
28
28
|
if (f) throw new TypeError("Generator is already executing.");
|
|
29
|
-
while (_) try {
|
|
29
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
30
30
|
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
31
31
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
32
32
|
switch (op[0]) {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@knapsack-pro/jest",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.2.0",
|
|
4
4
|
"description": "Knapsack Pro Jest splits Jest tests across CI nodes and makes sure that tests will run in optimal time on each CI node.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"knapsack",
|
|
@@ -34,8 +34,8 @@
|
|
|
34
34
|
"lint": "npm run eslint:check && npm run prettier:check",
|
|
35
35
|
"eslint:check": "eslint . --ext .ts",
|
|
36
36
|
"eslint:format": "eslint . --ext .ts --fix",
|
|
37
|
-
"prettier:check": "prettier --check .",
|
|
38
|
-
"prettier:format": "prettier --config .prettierrc.json
|
|
37
|
+
"prettier:check": "prettier --config .prettierrc.json --check .",
|
|
38
|
+
"prettier:format": "prettier --config .prettierrc.json --write ."
|
|
39
39
|
},
|
|
40
40
|
"files": [
|
|
41
41
|
"/lib"
|
|
@@ -43,16 +43,16 @@
|
|
|
43
43
|
"homepage": "https://knapsackpro.com",
|
|
44
44
|
"repository": {
|
|
45
45
|
"type": "git",
|
|
46
|
-
"url": "https://github.com/KnapsackPro/knapsack-pro-
|
|
46
|
+
"url": "https://github.com/KnapsackPro/knapsack-pro-js.git"
|
|
47
47
|
},
|
|
48
48
|
"bugs": {
|
|
49
|
-
"url": "https://github.com/KnapsackPro/knapsack-pro-
|
|
49
|
+
"url": "https://github.com/KnapsackPro/knapsack-pro-js/issues"
|
|
50
50
|
},
|
|
51
51
|
"bin": {
|
|
52
52
|
"knapsack-pro-jest": "lib/knapsack-pro-jest.js"
|
|
53
53
|
},
|
|
54
54
|
"dependencies": {
|
|
55
|
-
"@knapsack-pro/core": "^5.
|
|
55
|
+
"@knapsack-pro/core": "^5.2.0",
|
|
56
56
|
"glob": "^8.0.3",
|
|
57
57
|
"minimatch": "^5.1.0",
|
|
58
58
|
"minimist": "^1.2.6",
|