[docs] Type check docs in CI

.circleci/config.yml

@@ -96,8 +96,8 @@ jobs:
       - checkout
       - install_js
       - run:
-          name: Check Typescript types
-          command: pnpm check-types
+          name: Tests TypeScript definitions
+          command: pnpm typescript
           environment:
             NODE_OPTIONS: --max-old-space-size=3584
   test_static:

docs/data/toolpad/core/components/sign-in-page/ThemeSignInPage.tsx

@@ -6,6 +6,7 @@ import {
   type AuthResponse,
 } from '@toolpad/core/SignInPage';
 import { createTheme } from '@mui/material/styles';
+// @ts-ignore
 import { useColorSchemeShim } from 'docs/src/modules/components/ThemeContext';
 import { getDesignTokens, inputsCustomizations } from './customTheme';
 

docs/next.config.mjs

@@ -8,10 +8,10 @@ const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));
 
 const require = createRequire(import.meta.url);
 
+// @ts-ignore
 const withDocsInfra = require('@mui/monorepo/docs/nextConfigDocsInfra');
 
-const pkg = require('../package.json');
-const { findPages } = require('./src/modules/utils/find');
+const { findPages } = require('./src/modules/utils/find.js');
 
 const WORKSPACE_ROOT = path.resolve(currentDirectory, '../');
 const MONOREPO_PATH = path.resolve(currentDirectory, '../node_modules/@mui/monorepo');
@@ -44,6 +44,7 @@ export default withDocsInfra({
     TOOLPAD_CORE_VERSION: toolpadCorePkg.version,
     TOOLPAD_STUDIO_VERSION: toolpadStudioPkg.version,
   },
+  // @ts-ignore
   webpack: (config, options) => {
     return {
       ...config,
@@ -126,11 +127,14 @@ export default withDocsInfra({
     const pages = findPages();
     const map = {};
 
+    // @ts-ignore
     function traverse(pages2, userLanguage) {
       const prefix = userLanguage === 'en' ? '' : `/${userLanguage}`;
 
+      // @ts-ignore
       pages2.forEach((page) => {
         if (!page.children) {
+          // @ts-ignore
           map[`${prefix}${page.pathname.replace(/^\/api-docs\/(.*)/, '/api/$1')}`] = {
             page: page.pathname,
             query: {
@@ -153,21 +157,21 @@ export default withDocsInfra({
   // Used to signal we run pnpm build
   ...(process.env.NODE_ENV === 'production'
     ? {
-        output: 'export',
-      }
+      output: 'export',
+    }
     : {
-        rewrites: async () => {
-          return [
-            { source: `/:lang(${LANGUAGES.join('|')})?/:rest*`, destination: '/:rest*' },
-            { source: '/api/:rest*', destination: '/api-docs/:rest*' },
-          ];
+      rewrites: async () => {
+        return [
+          { source: `/:lang(${LANGUAGES.join('|')})?/:rest*`, destination: '/:rest*' },
+          { source: '/api/:rest*', destination: '/api-docs/:rest*' },
+        ];
+      },
+      redirects: async () => [
+        {
+          source: '/',
+          destination: '/toolpad/',
+          permanent: false,
         },
-        redirects: async () => [
-          {
-            source: '/',
-            destination: '/toolpad/',
-            permanent: false,
-          },
-        ],
-      }),
+      ],
+    }),
 });

docs/src/components/landing/ToolpadAuthDemo.tsx

@@ -1,6 +1,7 @@
 import * as React from 'react';
 import Paper from '@mui/material/Paper';
 import { HighlightedCode } from '@mui/docs/HighlightedCode';
+// @ts-ignore
 import DemoSandbox from 'docs/src/modules/components/DemoSandbox';
 import { AppProvider } from '@toolpad/core/AppProvider';
 import { SignInPage, type AuthProvider } from '@toolpad/core/SignInPage';
@@ -16,9 +17,9 @@ const providers = [
   { id: 'facebook', name: 'Facebook' },
 ];
 
-const signIn = async (provider) => {  
-    try {  
-    await signIn(provider.id);    
+const signIn = async (provider) => {
+    try {
+      await signIn(provider.id);
     } catch (error) {
      // Handle errors
     }
@@ -28,7 +29,7 @@ export default function OAuthSignInPage() {
   return (
     <AppProvider>
       <SignInPage signIn={signIn} providers={providers} />
-    </AppProvider>    
+    </AppProvider>
   );
 }
 

docs/src/components/landing/ToolpadDashboardLayout.tsx

@@ -1,7 +1,6 @@
 import * as React from 'react';
 import Paper from '@mui/material/Paper';
 import { HighlightedCode } from '@mui/docs/HighlightedCode';
-
 import DashboardIcon from '@mui/icons-material/Dashboard';
 import ShoppingCartIcon from '@mui/icons-material/ShoppingCart';
 import BarChartIcon from '@mui/icons-material/BarChart';
@@ -10,6 +9,7 @@ import LayersIcon from '@mui/icons-material/Layers';
 import { AppProvider, type Navigation, type Router } from '@toolpad/core/AppProvider';
 import { DashboardLayout } from '@toolpad/core/DashboardLayout';
 import { PageContainer } from '@toolpad/core/PageContainer';
+// @ts-ignore
 import DemoSandbox from 'docs/src/modules/components/DemoSandbox';
 import Grid from '@mui/material/Grid2';
 import { styled } from '@mui/material/styles';

docs/src/components/landing/ToolpadPageContainerDemo.tsx

@@ -1,6 +1,7 @@
 import * as React from 'react';
 import Frame from 'docs/src/components/action/Frame';
 import Paper from '@mui/material/Paper';
+// @ts-ignore
 import DemoSandbox from 'docs/src/modules/components/DemoSandbox';
 import { HighlightedCode } from '@mui/docs/HighlightedCode';
 import { AppProvider } from '@toolpad/core/AppProvider';

docs/src/modules/components/Examples/FeaturedExamples.tsx

@@ -15,6 +15,7 @@ import Visibility from '@mui/icons-material/Visibility';
 import CodeRoundedIcon from '@mui/icons-material/CodeRounded';
 import OpenInNewRoundedIcon from '@mui/icons-material/OpenInNewRounded';
 import { useTheme } from '@mui/material/styles';
+// @ts-ignore
 import { sxChip } from 'docs/src/modules/components/AppNavDrawerItem';
 import type { Example } from './types';
 

docs/src/modules/components/SchemaReference.tsx

@@ -441,16 +441,6 @@ function JsonSchemaNameValueDisplay({
   );
 }
 
-interface HeadingProps {
-  hash: string;
-  level: 'h2' | 'h3';
-  title: string;
-}
-
-function Heading({ hash, level: Level, title }: HeadingProps) {
-  return <SectionTitle title={title} id={hash} level={Level} />;
-}
-
 interface JsonSchemaDisplayProps {
   name: string;
   hash: string;
@@ -461,7 +451,7 @@ interface JsonSchemaDisplayProps {
 function JsonSchemaDisplay({ name, hash, schema, idPrefix = '' }: JsonSchemaDisplayProps) {
   return (
     <React.Fragment>
-      <Heading hash={hash} level="h3" title={name} />
+      <SectionTitle hash={hash} level="h3" title={name} />
       <Typography>{schema.description}</Typography>
       <Wrapper>
         <JsonSchemaValueDisplay schema={schema} idPrefix={idPrefix} />
@@ -525,7 +515,7 @@ export default function SchemaReference(props: SchemaReferenceProps) {
           {toc.map((tocNode) => {
             return (
               <React.Fragment key={tocNode.hash}>
-                <Heading hash={tocNode.hash} level="h2" title={tocNode.text} />
+                <SectionTitle hash={tocNode.hash} level="h2" title={tocNode.text} />
                 <Typography>{tocNode.introduction}</Typography>
                 {tocNode.children.map((tocItemNode) => {
                   invariant(typeof tocItemNode.content !== 'boolean', 'Invalid top level schema');

docs/src/modules/utils/babel-plugin-jsx-preview.js

@@ -1,4 +1,3 @@
-// @ts-check
 const fs = require('fs');
 
 const pluginName = 'babel-plugin-jsx-preview';

docs/tsconfig.json

@@ -14,6 +14,6 @@
     "noImplicitAny": true,
     "jsx": "preserve"
   },
-  "include": ["docs-env.d.ts", "pages/**/*", "src/**/*", "data/**/*", "next.config.mjs"],
-  "exclude": ["docs/.next", "docs/export"]
+  "include": ["docs-env.d.ts", "src", "pages/**/*.ts*", "data", "next.config.mjs"],
+  "exclude": ["docs/.next", "docs/export", "node_modules"]
 }

package.json

@@ -33,7 +33,8 @@
     "test:browser": "FORCE_COLOR=1 pnpm run -r test:browser",
     "test:argos": "node ./scripts/pushArgos.mjs",
     "test": "lerna run test --stream",
-    "check-types": "lerna run --concurrency 1 check-types",
+    "typescript": "lerna run --concurrency 1 --no-bail typescript",
+    "typescript:ci": "lerna run --concurrency 2 --no-bail typescript",
     "toolpad-studio": "node --enable-source-maps packages/toolpad-studio/cli.mjs",
     "jsonSchemas": "tsx ./scripts/docs/generateJsonSchemas.ts",
     "monorepo:update": "tsx ./scripts/updateMonorepo.ts",

packages/create-toolpad-app/package.json

@@ -23,7 +23,7 @@
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
-    "check-types": "tsc --noEmit",
+    "typescript": "tsc --noEmit",
     "test": "vitest run"
   },
   "engines": {

packages/toolpad-core/package.json

@@ -47,7 +47,7 @@
     "build:types": "tsc -b tsconfig.build.json",
     "predev": "pnpm clean",
     "dev": "mkdir -p build && concurrently \"pnpm build:stable --watch\" \"pnpm build:types --watch --preserveWatchOutput\" \"pnpm build:copy-files\"",
-    "check-types": "pnpm build:types && tsc --noEmit",
+    "typescript": "pnpm build:types && tsc --noEmit",
     "test": "vitest run --coverage",
     "test:dev": "vitest",
     "test:browser": "vitest run --browser.enabled",

packages/toolpad-studio-components/package.json

@@ -34,7 +34,7 @@
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
-    "check-types": "tsup && tsc --noEmit",
+    "typescript": "tsup && tsc --noEmit",
     "build:types": "tsc --declaration --emitDeclarationOnly"
   },
   "bugs": {

packages/toolpad-studio-runtime/package.json

@@ -37,7 +37,7 @@
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
-    "check-types": "tsup && tsc --noEmit"
+    "typescript": "tsup && tsc --noEmit"
   },
   "bugs": {
     "url": "https://github.com/mui/toolpad/issues"

packages/toolpad-studio/package.json

@@ -13,7 +13,7 @@
     "fix": "prettier --write .",
     "build:cli": "tsup",
     "dev:cli": "tsup --watch",
-    "check-types": "tsup && tsc --noEmit",
+    "typescript": "tsup && tsc --noEmit",
     "test": "vitest run"
   },
   "keywords": [

packages/toolpad-utils/package.json

@@ -45,7 +45,7 @@
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
-    "check-types": "tsup && tsc --noEmit",
+    "typescript": "tsup && tsc --noEmit",
     "test": "vitest run --coverage"
   },
   "bugs": {