Update typescript setup, take 2 (#1554)

guardian · Jun 18, 2024 · 490384d · 490384d
1 parent 9ecd710
commit 490384d
Show file tree

Hide file tree

Showing 54 changed files with 2,435 additions and 774 deletions.
diff --git a/.changeset/serious-bulldogs-unite.md b/.changeset/serious-bulldogs-unite.md
@@ -0,0 +1,8 @@
+---
+'@guardian/source-development-kitchen': major
+'@guardian/source': major
+---
+
+Now has a peer dependency of `@emotion/react@^11.11.3` (from `^11.11.1`).
+
+Fixes conflicting types between Emotion's deps, as outlined in https://github.com/emotion-js/emotion/pull/3141.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,6 +13,7 @@ jobs:
       matrix:
         include:
           - task: formatting:check
+          - task: tsc
           - task: lint
           - task: test
           - task: e2e

diff --git a/Makefile b/Makefile
@@ -52,27 +52,33 @@ verify-dist: env
 
 # checks all projects for lint errors
 .PHONY: lint
-lint: install
+lint: env
 	$(call log,"Linting projects")
 	@corepack pnpm -r lint
 	@node ./tools/scripts/check-packages-for-tslib.mjs
 
 # check repo for formatting errors
 .PHONY: formatting\:check
-formatting\:check: install
+formatting\:check: env
 	$(call log,"Checking formatting across repo")
 	@corepack pnpm prettier --ignore-unknown --cache --check .
 
 # attemps to fix lint errors across all projects
 .PHONY: fix
-fix: install
+fix: env
 	$(call log,"Attempting to fix issues across all projects")
 	@corepack pnpm -r fix
 	@corepack pnpm prettier --ignore-unknown --cache --write .
 
+# type-checking all projects
+.PHONY: tsc
+tsc: env
+	$(call log,"Checking types across all projects")
+	@corepack pnpm -r tsc
+
 # makes sure absolutely everything is working
 .PHONY: validate
-validate: env lint test e2e build verify-dist build-storybook
+validate: env tsc lint test e2e build verify-dist build-storybook
 
 ##################################### BUILD ####################################
 
@@ -163,6 +169,10 @@ install: check-node-version
 @guardian/ab-core\:test: env
 	@corepack pnpm --filter @guardian/ab-core test
 
+.PHONY: @guardian/ab-core\:tsc
+@guardian/ab-core\:tsc: env
+	@corepack pnpm --filter @guardian/ab-core tsc
+
 .PHONY: @guardian/ab-core\:verify-dist
 @guardian/ab-core\:verify-dist: env
 	@corepack pnpm --filter @guardian/ab-core verify-dist
@@ -187,6 +197,10 @@ install: check-node-version
 @guardian/ab-react\:test: env
 	@corepack pnpm --filter @guardian/ab-react test
 
+.PHONY: @guardian/ab-react\:tsc
+@guardian/ab-react\:tsc: env
+	@corepack pnpm --filter @guardian/ab-react tsc
+
 .PHONY: @guardian/ab-react\:verify-dist
 @guardian/ab-react\:verify-dist: env
 	@corepack pnpm --filter @guardian/ab-react verify-dist
@@ -199,6 +213,10 @@ install: check-node-version
 @guardian/browserslist-config\:lint: env
 	@corepack pnpm --filter @guardian/browserslist-config lint
 
+.PHONY: @guardian/browserslist-config\:tsc
+@guardian/browserslist-config\:tsc: env
+	@corepack pnpm --filter @guardian/browserslist-config tsc
+
 .PHONY: @guardian/browserslist-config\:update-readme
 @guardian/browserslist-config\:update-readme: env
 	@corepack pnpm --filter @guardian/browserslist-config update-readme
@@ -211,6 +229,10 @@ install: check-node-version
 @guardian/cobalt-plugin-ts\:lint: env
 	@corepack pnpm --filter @guardian/cobalt-plugin-ts lint
 
+.PHONY: @guardian/cobalt-plugin-ts\:tsc
+@guardian/cobalt-plugin-ts\:tsc: env
+	@corepack pnpm --filter @guardian/cobalt-plugin-ts tsc
+
 .PHONY: @guardian/core-web-vitals\:build
 @guardian/core-web-vitals\:build: env
 	@corepack pnpm --filter @guardian/core-web-vitals build
@@ -231,6 +253,10 @@ install: check-node-version
 @guardian/core-web-vitals\:test: env
 	@corepack pnpm --filter @guardian/core-web-vitals test
 
+.PHONY: @guardian/core-web-vitals\:tsc
+@guardian/core-web-vitals\:tsc: env
+	@corepack pnpm --filter @guardian/core-web-vitals tsc
+
 .PHONY: @guardian/core-web-vitals\:verify-dist
 @guardian/core-web-vitals\:verify-dist: env
 	@corepack pnpm --filter @guardian/core-web-vitals verify-dist
@@ -247,6 +273,10 @@ install: check-node-version
 @guardian/design-tokens\:lint: env
 	@corepack pnpm --filter @guardian/design-tokens lint
 
+.PHONY: @guardian/design-tokens\:tsc
+@guardian/design-tokens\:tsc: env
+	@corepack pnpm --filter @guardian/design-tokens tsc
+
 .PHONY: @guardian/eslint-config\:fix
 @guardian/eslint-config\:fix: env
 	@corepack pnpm --filter @guardian/eslint-config fix
@@ -255,6 +285,10 @@ install: check-node-version
 @guardian/eslint-config\:lint: env
 	@corepack pnpm --filter @guardian/eslint-config lint
 
+.PHONY: @guardian/eslint-config\:tsc
+@guardian/eslint-config\:tsc: env
+	@corepack pnpm --filter @guardian/eslint-config tsc
+
 .PHONY: @guardian/eslint-config-typescript\:fix
 @guardian/eslint-config-typescript\:fix: env
 	@corepack pnpm --filter @guardian/eslint-config-typescript fix
@@ -263,6 +297,10 @@ install: check-node-version
 @guardian/eslint-config-typescript\:lint: env
 	@corepack pnpm --filter @guardian/eslint-config-typescript lint
 
+.PHONY: @guardian/eslint-config-typescript\:tsc
+@guardian/eslint-config-typescript\:tsc: env
+	@corepack pnpm --filter @guardian/eslint-config-typescript tsc
+
 .PHONY: @guardian/identity-auth\:build
 @guardian/identity-auth\:build: env
 	@corepack pnpm --filter @guardian/identity-auth build
@@ -283,6 +321,10 @@ install: check-node-version
 @guardian/identity-auth\:test: env
 	@corepack pnpm --filter @guardian/identity-auth test
 
+.PHONY: @guardian/identity-auth\:tsc
+@guardian/identity-auth\:tsc: env
+	@corepack pnpm --filter @guardian/identity-auth tsc
+
 .PHONY: @guardian/identity-auth\:verify-dist
 @guardian/identity-auth\:verify-dist: env
 	@corepack pnpm --filter @guardian/identity-auth verify-dist
@@ -307,6 +349,10 @@ install: check-node-version
 @guardian/identity-auth-frontend\:test: env
 	@corepack pnpm --filter @guardian/identity-auth-frontend test
 
+.PHONY: @guardian/identity-auth-frontend\:tsc
+@guardian/identity-auth-frontend\:tsc: env
+	@corepack pnpm --filter @guardian/identity-auth-frontend tsc
+
 .PHONY: @guardian/identity-auth-frontend\:verify-dist
 @guardian/identity-auth-frontend\:verify-dist: env
 	@corepack pnpm --filter @guardian/identity-auth-frontend verify-dist
@@ -339,6 +385,10 @@ install: check-node-version
 @guardian/libs\:test: env
 	@corepack pnpm --filter @guardian/libs test
 
+.PHONY: @guardian/libs\:tsc
+@guardian/libs\:tsc: env
+	@corepack pnpm --filter @guardian/libs tsc
+
 .PHONY: @guardian/libs\:verify-dist
 @guardian/libs\:verify-dist: env
 	@corepack pnpm --filter @guardian/libs verify-dist
@@ -359,6 +409,10 @@ install: check-node-version
 @guardian/newsletter-types\:lint: env
 	@corepack pnpm --filter @guardian/newsletter-types lint
 
+.PHONY: @guardian/newsletter-types\:tsc
+@guardian/newsletter-types\:tsc: env
+	@corepack pnpm --filter @guardian/newsletter-types tsc
+
 .PHONY: @guardian/prettier\:fix
 @guardian/prettier\:fix: env
 	@corepack pnpm --filter @guardian/prettier fix
@@ -367,6 +421,10 @@ install: check-node-version
 @guardian/prettier\:lint: env
 	@corepack pnpm --filter @guardian/prettier lint
 
+.PHONY: @guardian/prettier\:tsc
+@guardian/prettier\:tsc: env
+	@corepack pnpm --filter @guardian/prettier tsc
+
 .PHONY: @guardian/source\:build
 @guardian/source\:build: env
 	@corepack pnpm --filter @guardian/source build
@@ -403,6 +461,10 @@ install: check-node-version
 @guardian/source\:test: env
 	@corepack pnpm --filter @guardian/source test
 
+.PHONY: @guardian/source\:tsc
+@guardian/source\:tsc: env
+	@corepack pnpm --filter @guardian/source tsc
+
 .PHONY: @guardian/source\:verify-dist
 @guardian/source\:verify-dist: env
 	@corepack pnpm --filter @guardian/source verify-dist
@@ -435,6 +497,10 @@ install: check-node-version
 @guardian/source-development-kitchen\:test: env
 	@corepack pnpm --filter @guardian/source-development-kitchen test
 
+.PHONY: @guardian/source-development-kitchen\:tsc
+@guardian/source-development-kitchen\:tsc: env
+	@corepack pnpm --filter @guardian/source-development-kitchen tsc
+
 .PHONY: @guardian/source-development-kitchen\:verify-dist
 @guardian/source-development-kitchen\:verify-dist: env
 	@corepack pnpm --filter @guardian/source-development-kitchen verify-dist
@@ -451,6 +517,10 @@ github-pages\:dev: env
 github-pages\:start: env
 	@corepack pnpm --filter github-pages start
 
+.PHONY: github-pages\:tsc
+github-pages\:tsc: env
+	@corepack pnpm --filter github-pages tsc
+
 .PHONY: storybooks\:dev
 storybooks\:dev: env
 	@corepack pnpm --filter storybooks dev

diff --git a/apps/github-pages/package.json b/apps/github-pages/package.json
@@ -6,7 +6,8 @@
 	"scripts": {
 		"build": "wireit",
 		"dev": "wireit",
-		"start": "wireit"
+		"start": "wireit",
+		"tsc": "wireit"
 	},
 	"devDependencies": {
 		"@astrojs/check": "0.7.0",
@@ -54,6 +55,18 @@
 			"files": [
 				"dist/**"
 			]
+		},
+		"tsc": {
+			"command": "tsc --pretty",
+			"files": [
+				"src/**/*",
+				"tsconfig.json",
+				"../../libs/@guardian/tsconfig/tsconfig.json",
+				"../../@types/**",
+				"../../tsconfig.base.json",
+				"!(dist)/**"
+			],
+			"output": []
 		}
 	}
 }
diff --git a/apps/storybooks/package.json b/apps/storybooks/package.json
@@ -7,7 +7,7 @@
 		"dev": "wireit"
 	},
 	"devDependencies": {
-		"storybook": "8.0.5",
+		"storybook": "8.1.8",
 		"wireit": "0.14.4"
 	},
 	"wireit": {

diff --git a/configs/jest.config.js b/configs/jest.config.js
@@ -5,12 +5,7 @@ export const config = {
 	testPathIgnorePatterns: ['/node_modules/', '/.wireit/'],
 	transformIgnorePatterns: ['node_modules/.pnpm/(?!@guardian)'],
 	transform: {
-		'^.+\\.[tj]sx?$': [
-			'ts-jest',
-			{
-				tsconfig: '<rootDir>/tsconfig.spec.json',
-			},
-		],
+		'^.+\\.[tj]sx?$': ['ts-jest'],
 	},
 	coveragePathIgnorePatterns: ['/__generated__/'],
 };
diff --git a/configs/storybook/package.json b/configs/storybook/package.json
@@ -10,17 +10,17 @@
 		"@babel/preset-react": "7.24.1",
 		"@babel/preset-typescript": "7.24.1",
 		"@emotion/babel-plugin": "11.11.0",
-		"@emotion/react": "11.11.1",
+		"@emotion/react": "11.11.3",
 		"@guardian/source": "workspace:*",
-		"@storybook/addon-a11y": "8.0.5",
-		"@storybook/addon-docs": "8.0.5",
-		"@storybook/addon-essentials": "8.0.5",
-		"@storybook/addon-links": "8.0.5",
-		"@storybook/addon-viewport": "8.0.5",
-		"@storybook/manager-api": "8.0.5",
-		"@storybook/react": "8.0.5",
-		"@storybook/react-webpack5": "8.0.5",
-		"@storybook/theming": "8.0.5",
+		"@storybook/addon-a11y": "8.1.8",
+		"@storybook/addon-docs": "8.1.8",
+		"@storybook/addon-essentials": "8.1.8",
+		"@storybook/addon-links": "8.1.8",
+		"@storybook/addon-viewport": "8.1.8",
+		"@storybook/manager-api": "8.1.8",
+		"@storybook/react": "8.1.8",
+		"@storybook/react-webpack5": "8.1.8",
+		"@storybook/theming": "8.1.8",
 		"@types/babel__core": "7.20.5",
 		"@types/react": "18.2.11",
 		"babel-loader": "9.1.3",

diff --git a/docs/source/storybook.md b/docs/source/storybook.md
@@ -65,7 +65,7 @@ export default {
 	title: 'Source/src-my-component/MyComponent',
 	component: MyComponent,
 	argTypes: {
-		id: { control: null },
+		id: { control: { disable: true } },
 	},
 	args: {
 		label: 'Label',

diff --git a/libs/@guardian/ab-core/package.json b/libs/@guardian/ab-core/package.json
@@ -22,6 +22,7 @@
 		"fix": "wireit",
 		"lint": "wireit",
 		"test": "wireit",
+		"tsc": "wireit",
 		"verify-dist": "wireit"
 	},
 	"devDependencies": {
@@ -93,6 +94,19 @@
 			],
 			"output": []
 		},
+		"tsc": {
+			"command": "tsc --pretty",
+			"files": [
+				"**",
+				"tsconfig.json",
+				"../tsconfig/tsconfig.json",
+				"../../../@types/**",
+				"../../../tsconfig.base.json",
+				"!(dist)/**",
+				"!.eslintcache"
+			],
+			"output": []
+		},
 		"verify-dist": {
 			"command": "jest --setupFilesAfterEnv ./jest.dist.setup.js",
 			"dependencies": [

diff --git a/libs/@guardian/ab-core/tsconfig.json b/libs/@guardian/ab-core/tsconfig.json
@@ -1,11 +1,5 @@
 {
 	"extends": "../../../tsconfig.base.json",
-	"files": ["../../../@types/window.d.ts"],
-	"include": ["."],
-	"exclude": ["node_modules", "dist", ".wireit"],
-	"references": [
-		{
-			"path": "./tsconfig.spec.json"
-		}
-	]
+	"include": ["**/*"],
+	"exclude": ["node_modules", "dist", ".wireit", "jest.dist.setup.js"]
 }
diff --git a/libs/@guardian/ab-core/tsconfig.spec.json b/libs/@guardian/ab-core/tsconfig.spec.json