@ziacik/upgrade-verify 0.0.1 → 0.0.2
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/CHANGELOG.md +19 -0
- package/README.md +44 -6
- package/package.json +17 -7
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [0.0.2] - 2023-07-07
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
|
|
14
|
+
- READMEs updated and props added to package.json.
|
|
15
|
+
- A _Package subpath './package.json' is not defined by "exports"_ error hopefully fixed.
|
|
16
|
+
|
|
17
|
+
[unreleased]: https://github.com/ziacik/nx-tools/compare/upgrade-verify-0.0.2...HEAD
|
|
18
|
+
[0.0.2]: https://github.com/ziacik/nx-tools/compare/upgrade-verify-0.0.1...upgrade-verify-0.0.2
|
|
19
|
+
[0.0.1]: https://github.com/ziacik/nx-tools/releases/tag/upgrade-verify-0.0.1
|
package/README.md
CHANGED
|
@@ -1,11 +1,49 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Nx Upgrade Verify Plugin
|
|
2
2
|
|
|
3
|
-
This
|
|
3
|
+
This plugin provides functionality to verify the build of a project after NX upgrade by comparing distribution statistics and detecting any significant differences.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
On each run, the executor builds the project for each configuration from the build target. At the first run, the executor generates stats in the `.stats` directory of the project from the built files.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
At every subsequent run, the executor compares the current saved stats with the new ones, writes out difference percentages to the output, and then updates the stats.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
The stats can be committed to the repository for future use.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
If the percentage differences cross a threshold of 10%, the executor will report a failure.
|
|
12
|
+
|
|
13
|
+
Please note that the plugin is in the early development stage and configuration options will be added in future updates.
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
To install the plugin, run the following command:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install -D @ziacik/upgrade-verify
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
Once the plugin is installed, you can use it as a custom executor in your project's configuration. Here's an example configuration:
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"name": "my-app",
|
|
30
|
+
...
|
|
31
|
+
"targets": {
|
|
32
|
+
"verify-build": {
|
|
33
|
+
"executor": "@ziacik/upgrade-verify:verify-build"
|
|
34
|
+
},
|
|
35
|
+
...
|
|
36
|
+
},
|
|
37
|
+
...
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Then to use the plugin, run
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
nx verify-build my-app
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## License
|
|
48
|
+
|
|
49
|
+
This project is licensed under the MIT License.
|
package/package.json
CHANGED
|
@@ -1,18 +1,28 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ziacik/upgrade-verify",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"type": "commonjs",
|
|
5
5
|
"executors": "./executors.json",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"nx",
|
|
8
|
+
"upgrade-verify",
|
|
9
|
+
"verify-build",
|
|
10
|
+
"build",
|
|
11
|
+
"verify",
|
|
12
|
+
"upgrade",
|
|
13
|
+
"plugin"
|
|
14
|
+
],
|
|
15
|
+
"author": "František Žiačik",
|
|
16
|
+
"repository": {
|
|
17
|
+
"type": "git",
|
|
18
|
+
"url": "https://github.com/ziacik/nx-tools"
|
|
19
|
+
},
|
|
20
|
+
"license": "MIT",
|
|
6
21
|
"dependencies": {
|
|
7
22
|
"@nx/devkit": "16.4.0"
|
|
8
23
|
},
|
|
9
24
|
"peerDependencies": {
|
|
10
25
|
"@swc/helpers": "0.5.1"
|
|
11
26
|
},
|
|
12
|
-
"main": "./src/index.js"
|
|
13
|
-
"exports": {
|
|
14
|
-
".": {
|
|
15
|
-
"require": "./src/index.js"
|
|
16
|
-
}
|
|
17
|
-
}
|
|
27
|
+
"main": "./src/index.js"
|
|
18
28
|
}
|