@code-pushup/cli 0.12.4 → 0.12.6

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.
Files changed (3) hide show
  1. package/README.md +11 -4
  2. package/index.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -43,11 +43,15 @@ _If you're looking for programmatic usage, then refer to the underlying [@code-p
43
43
  2. Create a `code-pushup.config.ts` configuration file (`.js` or `.mjs` extensions are also supported).
44
44
 
45
45
  ```ts
46
- export default {
46
+ import type { CoreConfig } from '@code-pushup/models';
47
+
48
+ const config: CoreConfig = {
47
49
  plugins: [
48
50
  // ...
49
51
  ],
50
52
  };
53
+
54
+ export default config;
51
55
  ```
52
56
 
53
57
  3. Add plugins as per your project needs (e.g. [@code-pushup/eslint-plugin](../plugin-eslint/README.md)).
@@ -58,14 +62,17 @@ _If you're looking for programmatic usage, then refer to the underlying [@code-p
58
62
 
59
63
  ```ts
60
64
  import eslintPlugin from '@code-pushup/eslint-plugin';
65
+ import type { CoreConfig } from '@code-pushup/models';
61
66
 
62
- export default {
67
+ const config: CoreConfig = {
63
68
  // ...
64
69
  plugins: [
65
70
  // ...
66
71
  await eslintPlugin({ eslintrc: '.eslintrc.js', patterns: ['src/**/*.js'] }),
67
72
  ],
68
73
  };
74
+
75
+ export default config;
69
76
  ```
70
77
 
71
78
  4. Run the CLI with `npx code-pushup` (see `--help` for list of commands and arguments).
@@ -77,7 +84,7 @@ _If you're looking for programmatic usage, then refer to the underlying [@code-p
77
84
  1. Define your custom categories.
78
85
 
79
86
  ```ts
80
- export default {
87
+ const config: CoreConfig = {
81
88
  // ...
82
89
  categories: [
83
90
  {
@@ -108,7 +115,7 @@ _If you're looking for programmatic usage, then refer to the underlying [@code-p
108
115
  If you have access to the Code PushUp portal, provide credentials in order to upload reports.
109
116
 
110
117
  ```ts
111
- export default {
118
+ const config: CoreConfig = {
112
119
  // ...
113
120
  upload: {
114
121
  server: 'https://ip-or-domain/path/to/portal/api/graphql',
package/index.js CHANGED
@@ -1533,7 +1533,7 @@ var verboseUtils = (verbose) => ({
1533
1533
 
1534
1534
  // packages/core/package.json
1535
1535
  var name = "@code-pushup/core";
1536
- var version = "0.12.4";
1536
+ var version = "0.12.6";
1537
1537
 
1538
1538
  // packages/core/src/lib/implementation/execute-plugin.ts
1539
1539
  import chalk4 from "chalk";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@code-pushup/cli",
3
- "version": "0.12.4",
3
+ "version": "0.12.6",
4
4
  "license": "MIT",
5
5
  "bin": {
6
6
  "code-pushup": "index.js"