fix: docs ci script (#298)

matus-vacula · roncohen · commit ca22529cb271 · 2025-02-04T11:19:32.000+01:00
If typedoc fails, so should the whole script
diff --git a/.github/workflows/package-ci.yml b/.github/workflows/package-ci.yml
@@ -34,6 +34,8 @@ jobs:
       - id: build
         name: Build the project
         run: yarn build
+      - name: Build docs
+        run: yarn docs
       - id: test
         name: Test the project
         run: yarn test:ci
diff --git a/docs.sh b/docs.sh
@@ -1,5 +1,7 @@
 #!/bin/sh
 
+set -e
+
 typedoc
 
 # We need to fix the links in the generated markdown files.
diff --git a/package.json b/package.json
@@ -14,6 +14,7 @@
     "test:ci": "lerna run test:ci --stream",
     "test": "lerna run test --stream",
     "prettier": "lerna run prettier --stream",
+    "prettier:fix": "lerna run prettier -- --write",
     "lint": "lerna run lint --stream",
     "lint:ci": "lerna run lint:ci --stream",
     "version": "lerna version --exact --no-push",
diff --git a/packages/browser-sdk/package.json b/packages/browser-sdk/package.json
@@ -45,7 +45,7 @@
     "@bucketco/eslint-config": "0.0.2",
     "@bucketco/tsconfig": "0.0.2",
     "@playwright/test": "^1.49.1",
-    "@types/node": "^20.14.0",
+    "@types/node": "^22.12.0",
     "@types/webpack": "^5.28.5",
     "css-loader": "^6.9.0",
     "eslint": "^8.57.0",
@@ -57,7 +57,7 @@
     "postcss-preset-env": "^9.3.0",
     "prettier": "^3.2.5",
     "style-loader": "^3.3.4",
-    "typescript": "^5.4.5",
+    "typescript": "^5.7.3",
     "vite": "^5.3.5",
     "vite-plugin-dts": "^4.0.0-beta.1",
     "vitest": "^2.0.4",
diff --git a/packages/browser-sdk/tsconfig.json b/packages/browser-sdk/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "extends": "@bucketco/tsconfig/library",
   "compilerOptions": {
+    "lib": [],
     "outDir": "./dist/",
     "jsx": "react",
     "jsxFactory": "h",
diff --git a/packages/flag-evaluation/package.json b/packages/flag-evaluation/package.json
@@ -27,11 +27,11 @@
   "devDependencies": {
     "@bucketco/eslint-config": "workspace:^",
     "@bucketco/tsconfig": "workspace:^",
-    "@types/node": "^20.11.0",
+    "@types/node": "^22.12.0",
     "eslint": "^8.57.0",
     "prettier": "^3.3.3",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3",
+    "typescript": "^5.7.3",
     "vitest": "^2.0.5"
   }
 }
diff --git a/packages/flag-evaluation/tsconfig.json b/packages/flag-evaluation/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "extends": "@bucketco/tsconfig/library",
   "compilerOptions": {
+    "lib": [],
     "outDir": "./dist/"
   },
   "include": ["src"],
diff --git a/packages/node-sdk/package.json b/packages/node-sdk/package.json
@@ -31,14 +31,14 @@
     "@babel/core": "~7.24.7",
     "@bucketco/eslint-config": "~0.0.2",
     "@bucketco/tsconfig": "~0.0.2",
-    "@types/node": "~20.14.9",
+    "@types/node": "^22.12.0",
     "@vitest/coverage-v8": "~1.6.0",
     "c8": "~10.1.0",
     "eslint": "~8.56.0",
     "flush-promises": "~1.0.2",
     "prettier": "~3.3.2",
     "ts-node": "~10.9.2",
-    "typescript": "~5.5.3",
+    "typescript": "^5.7.3",
     "vite": "~5.3.3",
     "vite-plugin-dts": "~3.9.1",
     "vitest": "~1.6.0"
diff --git a/packages/node-sdk/tsconfig.json b/packages/node-sdk/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "extends": "@bucketco/tsconfig/library",
   "compilerOptions": {
+    "lib": [],
     "outDir": "./dist/",
     "declarationDir": "./dist/types",
     "declarationMap": true
diff --git a/packages/openfeature-browser-provider/example/package.json b/packages/openfeature-browser-provider/example/package.json
@@ -17,13 +17,13 @@
     "react-dom": "^18"
   },
   "devDependencies": {
-    "@types/node": "^20",
+    "@types/node": "^22.12.0",
     "@types/react": "^18",
     "@types/react-dom": "^18",
     "eslint": "^8",
     "eslint-config-next": "14.2.5",
     "postcss": "^8",
     "tailwindcss": "^3.4.1",
-    "typescript": "^5"
+    "typescript": "^5.7.3"
   }
 }
diff --git a/packages/openfeature-browser-provider/package.json b/packages/openfeature-browser-provider/package.json
@@ -42,11 +42,11 @@
     "@bucketco/tsconfig": "0.0.2",
     "@openfeature/core": "1.5.0",
     "@openfeature/web-sdk": "^1.3.0",
-    "@types/node": "^20.14.0",
+    "@types/node": "^22.12.0",
     "eslint": "^8.57.0",
     "jsdom": "^24.1.0",
     "prettier": "^3.2.5",
-    "typescript": "^5.4.5",
+    "typescript": "^5.7.3",
     "vite": "^5.3.5",
     "vite-plugin-dts": "^4.0.0-beta.1",
     "vitest": "^2.0.4"
diff --git a/packages/openfeature-node-provider/package.json b/packages/openfeature-node-provider/package.json
@@ -33,12 +33,12 @@
     "@bucketco/tsconfig": "~0.0.2",
     "@openfeature/core": "^1.5.0",
     "@openfeature/server-sdk": ">=1.16.1",
-    "@types/node": "~20.14.9",
+    "@types/node": "^22.12.0",
     "eslint": "~8.56.0",
     "flush-promises": "~1.0.2",
     "prettier": "~3.3.2",
     "ts-node": "~10.9.2",
-    "typescript": "~5.5.3",
+    "typescript": "^5.7.3",
     "vite": "~5.3.3",
     "vite-plugin-dts": "~3.9.1",
     "vitest": "~1.6.0"
diff --git a/packages/react-sdk/dev/nextjs-flag-demo/package.json b/packages/react-sdk/dev/nextjs-flag-demo/package.json
@@ -15,13 +15,13 @@
     "react-dom": "^18"
   },
   "devDependencies": {
-    "@types/node": "^20",
+    "@types/node": "^22.12.0",
     "@types/react": "^18",
     "@types/react-dom": "^18",
     "eslint": "^8",
     "eslint-config-next": "14.2.5",
     "postcss": "^8",
     "tailwindcss": "^3.4.1",
-    "typescript": "^5"
+    "typescript": "^5.7.3"
   }
 }
diff --git a/packages/react-sdk/package.json b/packages/react-sdk/package.json
@@ -46,7 +46,7 @@
     "@bucketco/tsconfig": "workspace:^",
     "@testing-library/react": "^15.0.7",
     "@types/jsdom": "^21.1.6",
-    "@types/node": "^20.14.0",
+    "@types/node": "^22.12.0",
     "@types/react": "^18.3.2",
     "@types/react-dom": "^18.3.0",
     "@types/webpack": "^5.28.5",
@@ -58,7 +58,7 @@
     "react-dom": "*",
     "rollup-preserve-directives": "^1.1.2",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.5",
+    "typescript": "^5.7.3",
     "vite": "^5.0.13",
     "vite-plugin-dts": "^4.0.0-beta.1",
     "vitest": "^2.0.4",
diff --git a/packages/react-sdk/tsconfig.json b/packages/react-sdk/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "extends": "@bucketco/tsconfig/library",
   "compilerOptions": {
+    "lib": [],
     "outDir": "./dist/",
     "declarationDir": "./dist/types",
     "jsx": "react",
diff --git a/packages/tracking-sdk/package.json b/packages/tracking-sdk/package.json
@@ -37,7 +37,7 @@
     "@preact/preset-vite": "^2.8.1",
     "@types/js-cookie": "^3.0.6",
     "@types/jsdom": "^21.1.6",
-    "@types/node": "^20.14.11",
+    "@types/node": "^22.12.0",
     "@types/webpack": "^5.28.5",
     "@types/webpack-node-externals": "^3.0.4",
     "@vitest/coverage-v8": "^1.1.3",
@@ -57,7 +57,7 @@
     "style-loader": "^3.3.4",
     "ts-loader": "^9.5.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3",
+    "typescript": "^5.7.3",
     "vite": "^5.0.13",
     "vite-plugin-dts": "^3.7.0",
     "vitest": "^1.1.3",
diff --git a/packages/tracking-sdk/tsconfig.json b/packages/tracking-sdk/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "extends": "@bucketco/tsconfig/library",
   "compilerOptions": {
+    "lib": [],
     "outDir": "./dist/",
     "jsx": "react",
     "jsxFactory": "h",
diff --git a/packages/tsconfig/library.json b/packages/tsconfig/library.json
@@ -1,7 +1,6 @@
 {
   "compilerOptions": {
     "strict": true,
-    "lib": ["ESNext", "DOM"],
     "target": "ES6",
     "module": "commonjs",
     "moduleResolution": "node",
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -1,5 +1,7 @@ @@
 #!/bin/sh
 +set -e
++
 typedoc
 # We need to fix the links in the generated markdown files.
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "@bucketco/tsconfig/library",`
`3`	`3`	`"compilerOptions": {`
	`4`	`+ "lib": [],`
`4`	`5`	`"outDir": "./dist/",`
`5`	`6`	`"jsx": "react",`
`6`	`7`	`"jsxFactory": "h",`
Original file line number	Diff line number	Diff line change
`@@ -27,11 +27,11 @@`
`27`	`27`	`"devDependencies": {`
`28`	`28`	`"@bucketco/eslint-config": "workspace:^",`
`29`	`29`	`"@bucketco/tsconfig": "workspace:^",`
`30`		`- "@types/node": "^20.11.0",`
	`30`	`+ "@types/node": "^22.12.0",`
`31`	`31`	`"eslint": "^8.57.0",`
`32`	`32`	`"prettier": "^3.3.3",`
`33`	`33`	`"ts-node": "^10.9.2",`
`34`		`- "typescript": "^5.3.3",`
	`34`	`+ "typescript": "^5.7.3",`
`35`	`35`	`"vitest": "^2.0.5"`
`36`	`36`	`}`
`37`	`37`	`}`