add types check github action (#3960)

dimaMachina · web-flow · commit fdc0a4f6a2ff · 2025-05-17T19:46:24.000+02:00
* add types check github action

* add types check github action

* add types check github action

* rm unneeded prebuild commands for types check
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -36,11 +36,9 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     needs: [install]
-
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
-
       - id: cache-modules
         uses: actions/cache@v4
         with:
@@ -109,18 +107,15 @@ jobs:
     name: Vitest Unit Tests
     runs-on: ubuntu-latest
     needs: [build]
-
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
-
       - id: cache-modules
         uses: actions/cache@v4
         with:
           path: |
             **/node_modules
           key: modules-${{ github.sha }}
-
       - uses: actions/cache@v4
         with:
           key: build-${{ github.sha }}
@@ -131,11 +126,9 @@ jobs:
     name: ESLint
     runs-on: ubuntu-latest
     needs: [build]
-
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
-
       - id: cache-modules
         uses: actions/cache@v4
         with:
@@ -148,11 +141,29 @@ jobs:
           path: ${{ env.BUILD-CACHE-LIST }}
       - run: yarn eslint
 
+  types-check:
+    name: Types Check
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - id: cache-modules
+        uses: actions/cache@v4
+        with:
+          path: |
+            **/node_modules
+          key: modules-${{ github.sha }}
+      - uses: actions/cache@v4
+        with:
+          key: build-${{ github.sha }}
+          path: ${{ env.BUILD-CACHE-LIST }}
+      - run: yarn types:check
+
   e2e:
     name: Cypress
     runs-on: ubuntu-latest
     needs: [build]
-
     steps:
       - uses: actions/checkout@v4
       - id: cache-modules
diff --git a/packages/cm6-graphql/package.json b/packages/cm6-graphql/package.json
@@ -3,6 +3,7 @@
   "version": "0.2.1",
   "description": "GraphQL language support for CodeMirror 6",
   "scripts": {
+    "types:check": "tsc --noEmit",
     "build": "cm-buildhelper src/index.ts",
     "prepare": "yarn build",
     "test": "vitest run"
diff --git a/packages/codemirror-graphql/package.json b/packages/codemirror-graphql/package.json
@@ -35,6 +35,7 @@
     "!jest.config.js"
   ],
   "scripts": {
+    "types:check": "tsc --noEmit",
     "build": "node ../../scripts/renameFileExtensions.js './esm/{**,!**/__tests__/}/*.js' . .esm.js",
     "test": "vitest"
   },
diff --git a/packages/graphiql-plugin-code-exporter/package.json b/packages/graphiql-plugin-code-exporter/package.json
@@ -27,11 +27,10 @@
     ".": "./dist/index.js"
   },
   "scripts": {
+    "types:check": "tsc --noEmit",
     "dev": "vite build --watch",
     "build": "vite build && UMD=true vite build",
-    "prebuild": "yarn types:check",
-    "postbuild": "cp src/graphiql-code-exporter.d.ts dist/graphiql-code-exporter.d.ts",
-    "types:check": "tsc --noEmit"
+    "postbuild": "cp src/graphiql-code-exporter.d.ts dist/graphiql-code-exporter.d.ts"
   },
   "dependencies": {
     "graphiql-code-exporter": "^3.0.3"
diff --git a/packages/graphiql-plugin-doc-explorer/package.json b/packages/graphiql-plugin-doc-explorer/package.json
@@ -30,10 +30,10 @@
     "dist"
   ],
   "scripts": {
+    "types:check": "tsc --noEmit",
     "dev": "vite build --watch",
     "build": "vite build",
-    "test": "vitest",
-    "types:check": "tsc --noEmit"
+    "test": "vitest"
   },
   "peerDependencies": {
     "react": "^18 || ^19",
diff --git a/packages/graphiql-plugin-doc-explorer/src/components/__tests__/doc-explorer.spec.tsx b/packages/graphiql-plugin-doc-explorer/src/components/__tests__/doc-explorer.spec.tsx
@@ -1,7 +1,6 @@
 import { act, render } from '@testing-library/react';
 import { GraphQLInt, GraphQLObjectType, GraphQLSchema } from 'graphql';
 import { FC, useEffect } from 'react';
-import type { SchemaContextType } from '@graphiql/react';
 import {
   DocExplorerContextProvider,
   useDocExplorer,
@@ -29,22 +28,17 @@ function makeSchema(fieldName = 'field') {
   });
 }
 
-const defaultSchemaContext: SchemaContextType = {
-  fetchError: null,
+const defaultSchemaContext = {
+  ...schemaStore.getInitialState(),
   introspect() {},
-  isFetching: false,
   schema: makeSchema(),
-  validationErrors: [],
 };
 
-const withErrorSchemaContext: SchemaContextType = {
+const withErrorSchemaContext = {
+  ...schemaStore.getInitialState(),
   fetchError: 'Error fetching schema',
   introspect() {},
-  isFetching: false,
   schema: new GraphQLSchema({ description: 'GraphQL Schema for testing' }),
-  validationErrors: [],
-  schemaReference: null!,
-  setSchemaReference: null!,
 };
 
 const DocExplorerWithContext: FC = () => {
diff --git a/packages/graphiql-plugin-doc-explorer/src/context.ts b/packages/graphiql-plugin-doc-explorer/src/context.ts
@@ -15,8 +15,12 @@ import {
   isUnionType,
 } from 'graphql';
 import { FC, ReactElement, ReactNode, useEffect } from 'react';
-import { SchemaContextType, useSchemaStore } from '@graphiql/react';
-import { createStore, useStore } from 'zustand';
+import {
+  createBoundedUseStore,
+  SchemaContextType,
+  useSchemaStore,
+} from '@graphiql/react';
+import { createStore } from 'zustand';
 
 export type DocExplorerFieldDef =
   | GraphQLField<unknown, unknown>
@@ -150,7 +154,7 @@ export const docExplorerStore = createStore<DocExplorerContextType>(
         set(state => {
           const oldNavStack = state.explorerNavStack;
           if (oldNavStack.length === 1) {
-            return oldNavStack;
+            return state;
           }
           // Spread is needed
           const newNavStack: DocExplorerNavStack = [...INITIAL_NAV_STACK];
@@ -257,11 +261,7 @@ export const DocExplorerContextProvider: FC<{
   return children as ReactElement;
 };
 
-function useDocExplorerStore<T>(
-  selector: (state: DocExplorerContextType) => T,
-): T {
-  return useStore(docExplorerStore, selector);
-}
+const useDocExplorerStore = createBoundedUseStore(docExplorerStore);
 
 export const useDocExplorer = () =>
   useDocExplorerStore(state => state.explorerNavStack);
diff --git a/packages/graphiql-plugin-explorer/package.json b/packages/graphiql-plugin-explorer/package.json
@@ -26,11 +26,10 @@
     ".": "./dist/index.js"
   },
   "scripts": {
+    "types:check": "tsc --noEmit",
     "dev": "vite build --watch",
     "build": "vite build && UMD=true vite build",
-    "postbuild": "cp src/graphiql-explorer.d.ts dist/graphiql-explorer.d.ts",
-    "prebuild": "yarn types:check",
-    "types:check": "tsc --noEmit"
+    "postbuild": "cp src/graphiql-explorer.d.ts dist/graphiql-explorer.d.ts"
   },
   "dependencies": {
     "graphiql-explorer": "^0.9.0"
diff --git a/packages/graphiql-plugin-history/package.json b/packages/graphiql-plugin-history/package.json
@@ -29,10 +29,10 @@
     "dist"
   ],
   "scripts": {
+    "types:check": "tsc --noEmit",
     "dev": "vite build --watch",
     "build": "vite build",
-    "test": "vitest",
-    "types:check": "tsc --noEmit"
+    "test": "vitest"
   },
   "peerDependencies": {
     "react": "^18 || ^19",
diff --git a/packages/graphiql-plugin-history/src/context.tsx b/packages/graphiql-plugin-history/src/context.tsx
@@ -1,11 +1,12 @@
 // eslint-disable-next-line react/jsx-filename-extension -- TODO
 import { FC, ReactElement, ReactNode, useEffect } from 'react';
-import { createStore, useStore } from 'zustand';
+import { createStore } from 'zustand';
 import { HistoryStore, QueryStoreItem } from '@graphiql/toolkit';
 import {
   useExecutionContext,
   useEditorContext,
   useStorage,
+  createBoundedUseStore,
 } from '@graphiql/react';
 
 const historyStore = createStore<HistoryContextType>((set, get) => ({
@@ -146,9 +147,7 @@ export const HistoryContextProvider: FC<HistoryContextProviderProps> = ({
   return children as ReactElement;
 };
 
-function useHistoryStore<T>(selector: (state: HistoryContextType) => T): T {
-  return useStore(historyStore, selector);
-}
+const useHistoryStore = createBoundedUseStore(historyStore);
 
 export const useHistory = () =>
   useHistoryStore(state => state.historyStorage.queries);
diff --git a/packages/graphiql-react/package.json b/packages/graphiql-react/package.json
@@ -30,10 +30,10 @@
     "font"
   ],
   "scripts": {
+    "types:check": "tsc --noEmit",
     "dev": "vite build --watch",
     "build": "vite build",
-    "test": "vitest",
-    "types:check": "tsc --noEmit"
+    "test": "vitest"
   },
   "peerDependencies": {
     "graphql": "^15.5.0 || ^16.0.0 || ^17.0.0",
diff --git a/packages/graphiql-react/src/plugin.tsx b/packages/graphiql-react/src/plugin.tsx
@@ -1,6 +1,7 @@
 // eslint-disable-next-line react/jsx-filename-extension -- TODO
 import { ComponentType, FC, ReactElement, ReactNode, useEffect } from 'react';
-import { createStore, useStore } from 'zustand';
+import { createStore } from 'zustand';
+import { createBoundedUseStore } from './utility';
 
 export type GraphiQLPlugin = {
   /**
@@ -129,8 +130,6 @@ export const PluginContextProvider: FC<PluginContextProviderProps> = ({
   return children as ReactElement;
 };
 
-export function usePluginStore() {
-  return useStore(pluginStore);
-}
+export const usePluginStore = createBoundedUseStore(pluginStore);
 
 // const STORAGE_KEY = 'visiblePlugin';
diff --git a/packages/graphiql-react/src/schema.ts b/packages/graphiql-react/src/schema.ts
@@ -16,9 +16,10 @@ import {
   validateSchema,
 } from 'graphql';
 import { Dispatch, FC, ReactElement, ReactNode, useEffect } from 'react';
-import { createStore, useStore } from 'zustand';
+import { createStore } from 'zustand';
 import { useEditorContext } from './editor';
 import type { SchemaReference } from 'codemirror-graphql/utils/SchemaReference';
+import { createBoundedUseStore } from './utility';
 
 type MaybeGraphQLSchema = GraphQLSchema | null | undefined;
 
@@ -373,11 +374,7 @@ export const SchemaContextProvider: FC<SchemaContextProviderProps> = ({
   return children as ReactElement;
 };
 
-export function useSchemaStore<T>(
-  selector?: (state: SchemaContextType) => T,
-): T {
-  return useStore(schemaStore, selector!);
-}
+export const useSchemaStore = createBoundedUseStore(schemaStore);
 
 type IntrospectionArgs = {
   /**
diff --git a/packages/graphiql-react/src/storage.tsx b/packages/graphiql-react/src/storage.tsx
@@ -1,7 +1,8 @@
 // eslint-disable-next-line react/jsx-filename-extension -- TODO
 import { Storage, StorageAPI } from '@graphiql/toolkit';
 import { FC, ReactElement, ReactNode, useEffect } from 'react';
-import { useStore, createStore } from 'zustand';
+import { createStore } from 'zustand';
+import { createBoundedUseStore } from './utility';
 
 type StorageContextType = {
   storage: StorageAPI;
@@ -26,17 +27,20 @@ export const StorageContextProvider: FC<StorageContextProviderProps> = ({
   storage,
   children,
 }) => {
-  const $storage = useStorage();
+  const isMounted = useStorageStore(store => Boolean(store.storage));
 
   useEffect(() => {
     storageStore.setState({ storage: new StorageAPI(storage) });
   }, [storage]);
 
-  return $storage && (children as ReactElement);
+  if (!isMounted) {
+    // Ensure storage was initialized
+    return null;
+  }
+
+  return children as ReactElement;
 };
 
-function useStorage() {
-  return useStore(storageStore, state => state.storage);
-}
+const useStorageStore = createBoundedUseStore(storageStore);
 
-export { useStorage };
+export const useStorage = () => useStorageStore(store => store.storage);
diff --git a/packages/graphiql-react/src/utility/create-bounded-use-store.ts b/packages/graphiql-react/src/utility/create-bounded-use-store.ts
@@ -0,0 +1,10 @@
+import { ExtractState, StoreApi, useStore } from 'zustand';
+
+// https://zustand.docs.pmnd.rs/guides/typescript#bounded-usestore-hook-for-vanilla-stores
+export const createBoundedUseStore = (store => selector =>
+  useStore(store, selector)) as <S extends StoreApi<unknown>>(
+  store: S,
+) => {
+  (): ExtractState<S>;
+  <T>(selector: (state: ExtractState<S>) => T): T;
+};
diff --git a/packages/graphiql-react/src/utility/index.ts b/packages/graphiql-react/src/utility/index.ts
@@ -1,3 +1,4 @@
+export { createBoundedUseStore } from './create-bounded-use-store';
 export { createNullableContext, createContextHook } from './context';
 export { debounce } from './debounce';
 export { isMacOs } from './is-macos';
diff --git a/packages/graphiql-toolkit/package.json b/packages/graphiql-toolkit/package.json
@@ -19,10 +19,9 @@
   "module": "dist/esm/index.js",
   "typings": "dist/esm/index.d.mts",
   "scripts": {
+    "types:check": "tsc --noEmit",
     "build": "tsup",
     "dev": "tsup --watch",
-    "prebuild": "yarn types:check",
-    "types:check": "tsc --noEmit",
     "test": "vitest run"
   },
   "dependencies": {
diff --git a/packages/graphiql/package.json b/packages/graphiql/package.json
@@ -36,7 +36,6 @@
     ".": "./dist/index.js"
   },
   "scripts": {
-    "prebuild": "yarn types:check",
     "types:check": "tsc --noEmit",
     "build": "vite build && UMD=true vite build",
     "cypress-open": "yarn dev 'cypress open --browser electron'",
diff --git a/packages/graphql-language-service-cli/package.json b/packages/graphql-language-service-cli/package.json
@@ -25,6 +25,7 @@
     "src"
   ],
   "scripts": {
+    "types:check": "tsc --noEmit",
     "test": "vitest"
   },
   "keywords": [
diff --git a/packages/graphql-language-service-server/package.json b/packages/graphql-language-service-server/package.json
@@ -30,6 +30,9 @@
     "svelte",
     "typescript"
   ],
+  "scripts": {
+    "types:check": "tsc --noEmit"
+  },
   "main": "dist/index.js",
   "module": "esm/index.js",
   "typings": "esm/index.d.ts",
diff --git a/packages/graphql-language-service/package.json b/packages/graphql-language-service/package.json
@@ -53,6 +53,7 @@
     "typescript": "^4.6.3"
   },
   "scripts": {
+    "types:check": "tsc --noEmit",
     "benchmark": "ts-node benchmark/index.ts",
     "test": "vitest"
   }
diff --git a/packages/monaco-graphql/package.json b/packages/monaco-graphql/package.json
diff --git a/packages/vscode-graphql-execution/package.json b/packages/vscode-graphql-execution/package.json
diff --git a/packages/vscode-graphql-syntax/package.json b/packages/vscode-graphql-syntax/package.json
diff --git a/packages/vscode-graphql/package.json b/packages/vscode-graphql/package.json
