ci(pie-monorepo): DSW-2400 refactor generate:component-statuses script (#1838)

xander-marjoram · web-flow · commit 8b1f579b67ed · 2024-09-17T10:18:00.000+01:00
* ci(pie-monorepo): DSW-2400 add turbo caching for generate:component-statuses script

* ci(pie-monorepo): DSW-2400 refactor generate:component-statuses script

* Increase verbosity

* Use arrow functions in docs site shortcode exports

* Update whitespace in docs site snapshot test

* Undo docs linting changes to move to another PR

* Exclude dev packages from component status cache

* Remove unneeded turbo token from copy job
diff --git a/.changeset/ninety-monkeys-run.md b/.changeset/ninety-monkeys-run.md
@@ -0,0 +1,8 @@
+---
+"pie-storybook": patch
+"pie-docs": patch
+"pie-monorepo": patch
+---
+
+[Changed] - Add caching for `generate:component-statuses` build.
+[Added] - New `copy:component-statuses` script for `pie-docs` and `pie-storybook` which copies the status file from the root.
diff --git a/apps/pie-docs/package.json b/apps/pie-docs/package.json
@@ -12,7 +12,7 @@
     "build:dev": "DEPLOYMENT_ENVIRONMENT='development' eleventy",
     "clean": "run -T rimraf dist",
     "dev": "npx @11ty/eleventy --serve --port=8080",
-    "generate:component-statuses": "npx generate-component-statuses",
+    "copy:component-statuses": "cp -v ../../component-statuses.json .",
     "lint:scripts": "run -T eslint .",
     "lint:scripts:fix": "run -T eslint . --fix",
     "lint:style": "run -T stylelint ./src/**/*.{css,scss}",
diff --git a/apps/pie-docs/turbo.json b/apps/pie-docs/turbo.json
@@ -13,7 +13,7 @@
       "dependsOn": [
         "^build",
         "clean",
-        "generate:component-statuses"
+        "copy:component-statuses"
       ],
       "outputs": [
         "dist/**"
@@ -23,7 +23,7 @@
       "cache": true,
       "dependsOn": [
         "^build",
-        "generate:component-statuses"
+        "copy:component-statuses"
       ]
     },
     "dev": {
@@ -32,6 +32,12 @@
         "build:dev"
       ]
     },
+    "copy:component-statuses": {
+      "dependsOn": [
+        "//#generate:component-statuses"
+      ],
+      "cache": false
+    },
     "test:generate-routes": {
       "cache": true,
       "dependsOn": [
diff --git a/apps/pie-storybook/package.json b/apps/pie-storybook/package.json
@@ -8,7 +8,7 @@
     "build": "storybook build --output-dir dist && cp -R ./static ./dist",
     "lint:scripts": "run -T eslint .",
     "lint:scripts:fix": "run -T eslint . --fix",
-    "generate:component-statuses": "npx generate-component-statuses"
+    "copy:component-statuses": "cp -v ../../component-statuses.json ."
   },
   "author": "Just Eat Takeaway.com - Design System Team",
   "license": "Apache-2.0",
diff --git a/apps/pie-storybook/turbo.json b/apps/pie-storybook/turbo.json
@@ -8,15 +8,21 @@
       "cache": false,
       "dependsOn": [
         "^build",
-        "generate:component-statuses"
+        "copy:component-statuses"
       ]
     },
     "build": {
       "cache": true,
       "dependsOn": [
         "^build",
-        "generate:component-statuses"
+        "copy:component-statuses"
       ]
+    },
+    "copy:component-statuses": {
+      "dependsOn": [
+        "//#generate:component-statuses"
+      ],
+      "cache": false
     }
   }
 }
diff --git a/package.json b/package.json
@@ -34,6 +34,7 @@
     "clean": "turbo run clean --filter=!pie-monorepo",
     "cz": "./packages/tools/pie-git-hooks-scripts/check-branch-name.js $(git symbolic-ref --short HEAD) && ./node_modules/cz-customizable/standalone.js",
     "dev": "turbo run dev --filter=!pie-monorepo",
+    "copy:component-statuses": "cross-env-shell turbo run copy:component-statuses --filter=!pie-monorepo",
     "generate:component-statuses": "npx generate-component-statuses",
     "generate:examples": "cross-env-shell turbo run generate:examples --filter=!pie-monorepo --token=${TURBO_TOKEN}",
     "lint:config:fix": "eslint --fix turbo.json (packages|apps)/**/turbo.json",
diff --git a/turbo.json b/turbo.json
@@ -6,7 +6,7 @@
       "dependsOn": [
         "^build",
         "build:react-wrapper",
-        "generate:component-statuses"
+        "//#generate:component-statuses"
       ],
       "outputs": [
         "dist/**"
@@ -55,12 +55,19 @@
         ".output/**"
       ]
     },
-    "generate:component-statuses": {
-      "cache": false,
+    "//#generate:component-statuses": {
+      "cache": true,
+      "inputs": [
+        "packages/components/**/package.json",
+        "!packages/components/pie-webc",
+        "!packages/components/pie-webc-core",
+        "!packages/components/pie-webc-testing"
+      ],
       "outputs": [
-        "**/component-statuses.json"
+        "component-statuses.json"
       ]
     },
+    "copy:component-statuses": {},
     "watch": {
       "cache": true,
       "dependsOn": []
@@ -167,7 +174,7 @@
       "cache": false,
       "dependsOn": [
         "^build",
-        "generate:component-statuses"
+        "//#generate:component-statuses"
       ]
     }
   }
diff --git a/yarn.lock b/yarn.lock
@@ -5453,7 +5453,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@justeattakeaway/generator-pie-component@0.22.0, @justeattakeaway/generator-pie-component@workspace:packages/tools/generator-pie-component":
+"@justeattakeaway/generator-pie-component@0.22.1, @justeattakeaway/generator-pie-component@workspace:packages/tools/generator-pie-component":
   version: 0.0.0-use.local
   resolution: "@justeattakeaway/generator-pie-component@workspace:packages/tools/generator-pie-component"
   dependencies:
@@ -5493,7 +5493,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@justeattakeaway/pie-card@0.20.0, @justeattakeaway/pie-card@workspace:packages/components/pie-card":
+"@justeattakeaway/pie-card@0.20.1, @justeattakeaway/pie-card@workspace:packages/components/pie-card":
   version: 0.0.0-use.local
   resolution: "@justeattakeaway/pie-card@workspace:packages/components/pie-card"
   dependencies:
@@ -5532,7 +5532,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@justeattakeaway/pie-chip@0.8.2, @justeattakeaway/pie-chip@workspace:packages/components/pie-chip":
+"@justeattakeaway/pie-chip@0.8.3, @justeattakeaway/pie-chip@workspace:packages/components/pie-chip":
   version: 0.0.0-use.local
   resolution: "@justeattakeaway/pie-chip@workspace:packages/components/pie-chip"
   dependencies:
@@ -5736,7 +5736,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@justeattakeaway/pie-lottie-player@0.0.1, @justeattakeaway/pie-lottie-player@workspace:packages/components/pie-lottie-player":
+"@justeattakeaway/pie-lottie-player@0.0.2, @justeattakeaway/pie-lottie-player@workspace:packages/components/pie-lottie-player":
   version: 0.0.0-use.local
   resolution: "@justeattakeaway/pie-lottie-player@workspace:packages/components/pie-lottie-player"
   dependencies:
@@ -5770,7 +5770,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@justeattakeaway/pie-notification@0.10.2, @justeattakeaway/pie-notification@workspace:packages/components/pie-notification":
+"@justeattakeaway/pie-notification@0.11.0, @justeattakeaway/pie-notification@workspace:packages/components/pie-notification":
   version: 0.0.0-use.local
   resolution: "@justeattakeaway/pie-notification@workspace:packages/components/pie-notification"
   dependencies:
@@ -5785,7 +5785,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@justeattakeaway/pie-radio-group@0.0.0, @justeattakeaway/pie-radio-group@workspace:packages/components/pie-radio-group":
+"@justeattakeaway/pie-radio-group@0.1.0, @justeattakeaway/pie-radio-group@workspace:packages/components/pie-radio-group":
   version: 0.0.0-use.local
   resolution: "@justeattakeaway/pie-radio-group@workspace:packages/components/pie-radio-group"
   dependencies:
@@ -5917,27 +5917,27 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@justeattakeaway/pie-webc@0.5.31, @justeattakeaway/pie-webc@workspace:packages/components/pie-webc":
+"@justeattakeaway/pie-webc@0.5.33, @justeattakeaway/pie-webc@workspace:packages/components/pie-webc":
   version: 0.0.0-use.local
   resolution: "@justeattakeaway/pie-webc@workspace:packages/components/pie-webc"
   dependencies:
     "@justeattakeaway/pie-assistive-text": 0.7.1
     "@justeattakeaway/pie-button": 0.49.1
-    "@justeattakeaway/pie-card": 0.20.0
+    "@justeattakeaway/pie-card": 0.20.1
     "@justeattakeaway/pie-checkbox": 0.12.3
     "@justeattakeaway/pie-checkbox-group": 0.7.0
-    "@justeattakeaway/pie-chip": 0.8.2
+    "@justeattakeaway/pie-chip": 0.8.3
     "@justeattakeaway/pie-components-config": 0.18.0
     "@justeattakeaway/pie-cookie-banner": 0.26.4
     "@justeattakeaway/pie-divider": 0.14.0
     "@justeattakeaway/pie-form-label": 0.14.1
     "@justeattakeaway/pie-icon-button": 0.28.12
     "@justeattakeaway/pie-link": 0.18.0
-    "@justeattakeaway/pie-lottie-player": 0.0.1
+    "@justeattakeaway/pie-lottie-player": 0.0.2
     "@justeattakeaway/pie-modal": 0.46.2
-    "@justeattakeaway/pie-notification": 0.10.2
+    "@justeattakeaway/pie-notification": 0.11.0
     "@justeattakeaway/pie-radio": 0.0.0
-    "@justeattakeaway/pie-radio-group": 0.0.0
+    "@justeattakeaway/pie-radio-group": 0.1.0
     "@justeattakeaway/pie-spinner": 0.7.0
     "@justeattakeaway/pie-switch": 0.30.1
     "@justeattakeaway/pie-tag": 0.10.0
@@ -26174,7 +26174,7 @@ __metadata:
     "@commitlint/config-conventional": 17.4.4
     "@justeat/pie-design-tokens": 6.4.0
     "@justeattakeaway/browserslist-config-pie": 0.2.0
-    "@justeattakeaway/generator-pie-component": 0.22.0
+    "@justeattakeaway/generator-pie-component": 0.22.1
     "@justeattakeaway/pie-icons": 4.19.1
     "@justeattakeaway/pie-webc-testing": 0.13.3
     "@justeattakeaway/pie-wrapper-react": 0.14.1
@@ -26236,10 +26236,10 @@ __metadata:
     "@justeat/pie-design-tokens": 6.3.1
     "@justeattakeaway/pie-assistive-text": 0.7.1
     "@justeattakeaway/pie-button": 0.49.1
-    "@justeattakeaway/pie-card": 0.20.0
+    "@justeattakeaway/pie-card": 0.20.1
     "@justeattakeaway/pie-checkbox": 0.12.3
     "@justeattakeaway/pie-checkbox-group": 0.7.0
-    "@justeattakeaway/pie-chip": 0.8.2
+    "@justeattakeaway/pie-chip": 0.8.3
     "@justeattakeaway/pie-cookie-banner": 0.26.4
     "@justeattakeaway/pie-css": 0.12.1
     "@justeattakeaway/pie-divider": 0.14.0
@@ -26249,9 +26249,9 @@ __metadata:
     "@justeattakeaway/pie-icons-webc": 0.25.1
     "@justeattakeaway/pie-link": 0.18.0
     "@justeattakeaway/pie-modal": 0.46.2
-    "@justeattakeaway/pie-notification": 0.10.2
+    "@justeattakeaway/pie-notification": 0.11.0
     "@justeattakeaway/pie-radio": 0.0.0
-    "@justeattakeaway/pie-radio-group": 0.0.0
+    "@justeattakeaway/pie-radio-group": 0.1.0
     "@justeattakeaway/pie-spinner": 0.7.0
     "@justeattakeaway/pie-switch": 0.30.1
     "@justeattakeaway/pie-tag": 0.10.0
@@ -34188,7 +34188,7 @@ __metadata:
     "@angular/platform-browser-dynamic": 15.2.0
     "@angular/router": 15.2.0
     "@justeattakeaway/pie-css": 0.12.1
-    "@justeattakeaway/pie-webc": 0.5.31
+    "@justeattakeaway/pie-webc": 0.5.33
     rxjs: 7.8.0
     tslib: 2.3.0
     typescript: 4.9.4
@@ -34205,7 +34205,7 @@ __metadata:
     "@babel/preset-env": 7.24.5
     "@babel/preset-react": 7.24.1
     "@justeattakeaway/pie-css": 0.12.1
-    "@justeattakeaway/pie-webc": 0.5.31
+    "@justeattakeaway/pie-webc": 0.5.33
     "@lit/react": 1.0.2
     babel-loader: 8
     eslint: 8.37.0
@@ -34222,7 +34222,7 @@ __metadata:
   resolution: "wc-next13@workspace:apps/examples/wc-next13"
   dependencies:
     "@justeattakeaway/pie-css": 0.12.1
-    "@justeattakeaway/pie-webc": 0.5.31
+    "@justeattakeaway/pie-webc": 0.5.33
     "@lit-labs/nextjs": 0.2.0
     "@lit/react": 1.0.5
     "@types/react": 18.3.3
@@ -34245,7 +34245,7 @@ __metadata:
   dependencies:
     "@babel/preset-env": 7.24.5
     "@justeattakeaway/pie-css": 0.12.1
-    "@justeattakeaway/pie-webc": 0.5.31
+    "@justeattakeaway/pie-webc": 0.5.33
     babel-loader: 8
     core-js: 3.30.0
     nuxt: 2.17.0
@@ -34260,7 +34260,7 @@ __metadata:
   resolution: "wc-nuxt3@workspace:apps/examples/wc-nuxt3"
   dependencies:
     "@justeattakeaway/pie-css": 0.12.1
-    "@justeattakeaway/pie-webc": 0.5.31
+    "@justeattakeaway/pie-webc": 0.5.33
     "@types/node": 18
     nuxt: 3.4.3
     nuxt-ssr-lit: 1.6.5
@@ -34272,7 +34272,7 @@ __metadata:
   resolution: "wc-react17@workspace:apps/examples/wc-react17"
   dependencies:
     "@justeattakeaway/pie-css": 0.12.1
-    "@justeattakeaway/pie-webc": 0.5.31
+    "@justeattakeaway/pie-webc": 0.5.33
     "@lit/react": 1.0.5
     "@types/react": ^17.0.2
     "@types/react-dom": ^17.0.2
@@ -34292,7 +34292,7 @@ __metadata:
   resolution: "wc-react18@workspace:apps/examples/wc-react18"
   dependencies:
     "@justeattakeaway/pie-css": 0.12.1
-    "@justeattakeaway/pie-webc": 0.5.31
+    "@justeattakeaway/pie-webc": 0.5.33
     "@lit/react": 1.0.5
     "@types/react": 18.3.3
     "@types/react-dom": 18.3.0
@@ -34314,7 +34314,7 @@ __metadata:
     "@justeat/pie-design-tokens": 6.3.1
     "@justeattakeaway/pie-css": 0.12.1
     "@justeattakeaway/pie-icons-webc": 0.25.1
-    "@justeattakeaway/pie-webc": 0.5.31
+    "@justeattakeaway/pie-webc": 0.5.33
     vite: 4.5.3
   languageName: unknown
   linkType: soft
@@ -34324,7 +34324,7 @@ __metadata:
   resolution: "wc-vue3@workspace:apps/examples/wc-vue3"
   dependencies:
     "@justeattakeaway/pie-css": 0.12.1
-    "@justeattakeaway/pie-webc": 0.5.31
+    "@justeattakeaway/pie-webc": 0.5.33
     "@types/node": 18.15.11
     "@vitejs/plugin-vue": 4.0.0
     "@vue/tsconfig": 0.1.3

Original file line number	Diff line number	Diff line change
`@@ -8,15 +8,21 @@`
`8`	`8`	`"cache": false,`
`9`	`9`	`"dependsOn": [`
`10`	`10`	`"^build",`
`11`		`- "generate:component-statuses"`
	`11`	`+ "copy:component-statuses"`
`12`	`12`	`]`
`13`	`13`	`},`
`14`	`14`	`"build": {`
`15`	`15`	`"cache": true,`
`16`	`16`	`"dependsOn": [`
`17`	`17`	`"^build",`
`18`		`- "generate:component-statuses"`
	`18`	`+ "copy:component-statuses"`
`19`	`19`	`]`
	`20`	`+ },`
	`21`	`+ "copy:component-statuses": {`
	`22`	`+ "dependsOn": [`
	`23`	`+ "//#generate:component-statuses"`
	`24`	`+ ],`
	`25`	`+ "cache": false`
`20`	`26`	`}`
`21`	`27`	`}`
`22`	`28`	`}`