@code-pushup/js-packages-plugin 0.35.0 → 0.42.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 +17 -3
- package/bin.js +547 -147
- package/index.js +527 -100
- package/package.json +5 -4
- package/src/lib/package-managers/yarn-classic/constants.d.ts +4 -0
- package/src/lib/package-managers/yarn-classic/outdated-result.d.ts +3 -1
- package/src/lib/package-managers/yarn-classic/types.d.ts +4 -11
- package/src/lib/runner/outdated/constants.d.ts +3 -2
- package/src/lib/runner/outdated/transform.d.ts +4 -5
- package/src/lib/runner/outdated/types.d.ts +5 -5
package/README.md
CHANGED
|
@@ -22,7 +22,21 @@ It supports the following package managers:
|
|
|
22
22
|
|
|
23
23
|
1. If you haven't already, install [@code-pushup/cli](../cli/README.md) and create a configuration file.
|
|
24
24
|
|
|
25
|
-
2.
|
|
25
|
+
2. Install as a dev dependency with your package manager:
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
npm install --save-dev @code-pushup/js-packages-plugin
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
yarn add --dev @code-pushup/js-packages-plugin
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
pnpm add --save-dev @code-pushup/js-packages-plugin
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
3. Insert plugin configuration with your package manager. By default, both `audit` and `outdated` checks will be run. The result should look as follows:
|
|
26
40
|
|
|
27
41
|
```js
|
|
28
42
|
import jsPackagesPlugin from '@code-pushup/js-packages-plugin';
|
|
@@ -50,7 +64,7 @@ It supports the following package managers:
|
|
|
50
64
|
};
|
|
51
65
|
```
|
|
52
66
|
|
|
53
|
-
|
|
67
|
+
4. (Optional) Reference individual audits or the provided plugin groups which you wish to include in custom categories (use `npx code-pushup print-config` to list audits and groups).
|
|
54
68
|
|
|
55
69
|
💡 Assign weights based on what influence each command should have on the overall category score (assign weight 0 to only include as extra info, without influencing category score).
|
|
56
70
|
|
|
@@ -88,7 +102,7 @@ It supports the following package managers:
|
|
|
88
102
|
};
|
|
89
103
|
```
|
|
90
104
|
|
|
91
|
-
|
|
105
|
+
5. Run the CLI with `npx code-pushup collect` and view or upload report (refer to [CLI docs](../cli/README.md)).
|
|
92
106
|
|
|
93
107
|
## Plugin architecture
|
|
94
108
|
|