Skip to content

Commit f510678

Browse files
committed
docs: update Nx example
1 parent e8ac86f commit f510678

File tree

1 file changed

+39
-37
lines changed

1 file changed

+39
-37
lines changed

packages/cli/docs/nx-caching.md

Lines changed: 39 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -28,41 +28,6 @@ export default {
2828
} satisfies CoreConfig;
2929
```
3030

31-
## `nx.json`
32-
33-
```json
34-
{
35-
"defaultTarget": {
36-
"code-pushup": {
37-
"cache": true,
38-
"outputs": ["{options.outputPath}"],
39-
"executor": "nx:run-commands",
40-
"options": {
41-
"command": "node packages/cli/src/index.ts",
42-
"config": "{projectRoot}/code-pushup.config.ts",
43-
"cache.read": true,
44-
"upload.project": "{projectName}",
45-
"outputPath": "{projectRoot}/.code-pushup"
46-
}
47-
}
48-
},
49-
"code-pushup:coverage": {
50-
"cache": true,
51-
"outputs": ["{options.outputPath}"],
52-
"executor": "nx:run-commands",
53-
"options": {
54-
"command": "npx @code-pushup/cli collect",
55-
"config": "{projectRoot}/code-pushup.config.ts",
56-
"cache.write": true,
57-
"persist.skipReports": true,
58-
"persist.outputDir": "{projectRoot}/.code-pushup",
59-
"upload.project": "{projectName}",
60-
"outputPath": "{projectRoot}/.code-pushup/coverage"
61-
}
62-
}
63-
}
64-
```
65-
6631
## `{projectRoot}/package.json`
6732

6833
```json
@@ -88,10 +53,47 @@ export default {
8853
}
8954
},
9055
"code-pushup:coverage": {
56+
"cache": true,
57+
"outputs": ["{options.outputPath}"],
58+
"executor": "nx:run-commands",
59+
"options": {
60+
"command": "npx @code-pushup/cli collect",
61+
"config": "{projectRoot}/code-pushup.config.ts",
62+
"cache.write": true,
63+
"persist.skipReports": true,
64+
"persist.outputDir": "{projectRoot}/.code-pushup",
65+
"upload.project": "{projectName}",
66+
"outputPath": "{projectRoot}/.code-pushup/coverage"
67+
},
9168
"dependsOn": ["unit-test", "int-test"]
9269
},
70+
"code-pushup:js-packages": {
71+
"cache": true,
72+
"outputs": ["{options.outputPath}"],
73+
"executor": "nx:run-commands",
74+
"options": {
75+
"command": "npx @code-pushup/cli collect",
76+
"config": "{projectRoot}/code-pushup.config.ts",
77+
"cache.write": true,
78+
"persist.skipReports": true,
79+
"persist.outputDir": "{projectRoot}/.code-pushup",
80+
"upload.project": "{projectName}",
81+
"onlyPlugins": "js-packages",
82+
"outputPath": "{projectRoot}/.code-pushup/js-packages"
83+
}
84+
},
9385
"code-pushup": {
94-
"dependsOn": ["code-pushup:coverage"]
86+
"cache": true,
87+
"outputs": ["{options.outputPath}"],
88+
"executor": "nx:run-commands",
89+
"options": {
90+
"command": "node packages/cli/src/index.ts",
91+
"config": "{projectRoot}/code-pushup.config.ts",
92+
"cache.read": true,
93+
"upload.project": "{projectName}",
94+
"outputPath": "{projectRoot}/.code-pushup"
95+
},
96+
"dependsOn": ["code-pushup:coverage", "code-pushup:js-packages"]
9597
}
9698
}
9799
}
@@ -107,7 +109,7 @@ This configuration creates the following task dependency graph:
107109

108110
```mermaid
109111
graph TD
110-
A[lib-a:code-pushup 🐳] --> B[lib-a:code-pushup:coverage]
112+
A[lib-a:code-pushup 🐳] --> B[lib-a:code-pushup:coverage 🐳]
111113
A --> E[lib-a:code-pushup:js-packages]
112114
B --> C[lib-a:unit-test 🐳]
113115
B --> D[lib-a:int-test 🐳]

0 commit comments

Comments
 (0)