Create a package with proptypes builder

Author: michaldudak

docs/scripts/formattedTSDemos.js

@@ -19,11 +19,12 @@ const {
   getPropTypesFromFile,
   injectPropTypesInFile,
 } = require('@mui-internal/typescript-to-proptypes');
+const yargs = require('yargs');
 const {
+  fixBabelGeneratorIssues,
+  fixLineEndings,
   createTypeScriptProjectBuilder,
-} = require('@mui-internal/api-docs-builder/utils/createTypeScriptProject');
-const yargs = require('yargs');
-const { fixBabelGeneratorIssues, fixLineEndings } = require('@mui-internal/docs-utils');
+} = require('@mui-internal/docs-utils');
 const { default: CORE_TYPESCRIPT_PROJECTS } = require('../../scripts/coreTypeScriptProjects');
 
 const babelConfig = {

package.json

@@ -4,7 +4,7 @@
   "private": true,
   "scripts": {
     "preinstall": "npx only-allow pnpm",
-    "proptypes": "tsx ./scripts/generateProptypes.ts",
+    "proptypes": "tsx ./packages/proptypes-builder/cli.ts",
     "deduplicate": "pnpm dedupe",
     "benchmark:browser": "pnpm --filter benchmark browser",
     "build": "lerna run --scope \"@mui/*\" build",
@@ -103,6 +103,7 @@
     "@mui-internal/api-docs-builder": "workspace:^",
     "@mui-internal/api-docs-builder-core": "workspace:^",
     "@mui-internal/docs-utils": "workspace:^",
+    "@mui-internal/proptypes-builder": "workspace:^",
     "@mui-internal/test-utils": "workspace:^",
     "@mui-internal/typescript-to-proptypes": "workspace:^",
     "@mui/joy": "workspace:*",

packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts

@@ -10,7 +10,7 @@ import remarkVisit from 'unist-util-visit';
 import type { Link } from 'mdast';
 import { defaultHandlers, parse as docgenParse, ReactDocgenApi } from 'react-docgen';
 import { renderMarkdown } from '@mui/markdown';
-import { ComponentClassDefinition } from '@mui-internal/docs-utils';
+import { ComponentClassDefinition, TypeScriptProject } from '@mui-internal/docs-utils';
 import { ProjectSettings, SortingStrategiesType } from '../ProjectSettings';
 import { ComponentInfo, toGitHubPath, writePrettifiedFile } from '../buildApiUtils';
 import muiDefaultPropsHandler from '../utils/defaultPropsHandler';
@@ -21,7 +21,6 @@ import createDescribeableProp, {
   DescribeablePropDescriptor,
 } from '../utils/createDescribeableProp';
 import generatePropDescription from '../utils/generatePropDescription';
-import { TypeScriptProject } from '../utils/createTypeScriptProject';
 import parseSlotsAndClasses, { Slot } from '../utils/parseSlotsAndClasses';
 import generateApiTranslations from '../utils/generateApiTranslation';
 import { sortAlphabetical } from '../utils/sortObjects';

packages/api-docs-builder/ApiBuilders/HookApiBuilder.ts

@@ -9,6 +9,7 @@ import { defaultHandlers, parse as docgenParse, ReactDocgenApi } from 'react-doc
 import kebabCase from 'lodash/kebabCase';
 import upperFirst from 'lodash/upperFirst';
 import { renderMarkdown } from '@mui/markdown';
+import { TypeScriptProject } from '@mui-internal/docs-utils';
 import { ProjectSettings } from '../ProjectSettings';
 import { computeApiDescription } from './ComponentApiBuilder';
 import {
@@ -19,7 +20,6 @@ import {
   toGitHubPath,
   writePrettifiedFile,
 } from '../buildApiUtils';
-import { TypeScriptProject } from '../utils/createTypeScriptProject';
 import generateApiTranslations from '../utils/generateApiTranslation';
 
 interface ParsedProperty {

packages/api-docs-builder/ProjectSettings.ts

@@ -1,6 +1,5 @@
-import { ComponentClassDefinition } from '@mui-internal/docs-utils';
+import { ComponentClassDefinition, CreateTypeScriptProjectOptions } from '@mui-internal/docs-utils';
 import { ComponentInfo, HookInfo } from './buildApiUtils';
-import { CreateTypeScriptProjectOptions } from './utils/createTypeScriptProject';
 import { CreateDescribeablePropSettings } from './utils/createDescribeableProp';
 import { ReactApi as ComponentReactApi } from './ApiBuilders/ComponentApiBuilder';
 import { ReactApi as HookReactApi } from './ApiBuilders/HookApiBuilder';

packages/api-docs-builder/buildApi.ts

@@ -1,18 +1,18 @@
 import { mkdirSync } from 'fs';
 import path from 'path';
 import * as fse from 'fs-extra';
+import {
+  CreateTypeScriptProjectOptions,
+  TypeScriptProjectBuilder,
+  createTypeScriptProjectBuilder,
+} from '@mui-internal/docs-utils';
 import findComponents from './utils/findComponents';
 import findHooks from './utils/findHooks';
 import { writePrettifiedFile } from './buildApiUtils';
 import generateComponentApi, {
   ReactApi as ComponentReactApi,
 } from './ApiBuilders/ComponentApiBuilder';
 import generateHookApi from './ApiBuilders/HookApiBuilder';
-import {
-  CreateTypeScriptProjectOptions,
-  TypeScriptProjectBuilder,
-  createTypeScriptProjectBuilder,
-} from './utils/createTypeScriptProject';
 import { ProjectSettings } from './ProjectSettings';
 
 async function removeOutdatedApiDocsTranslations(

packages/api-docs-builder/buildApiUtils.ts

@@ -3,9 +3,8 @@ import path from 'path';
 import * as ts from 'typescript';
 import * as prettier from 'prettier';
 import kebabCase from 'lodash/kebabCase';
-import { getLineFeed } from '@mui-internal/docs-utils';
+import { getLineFeed, TypeScriptProject } from '@mui-internal/docs-utils';
 import { replaceComponentLinks } from './utils/replaceUrl';
-import { TypeScriptProject } from './utils/createTypeScriptProject';
 
 /**
  * TODO: this should really be fixed in findPagesMarkdown().

packages/api-docs-builder/utils/createTypeScriptProject.ts

@@ -1,5 +1,5 @@
 import * as ts from 'typescript';
-import { TypeScriptProject } from './createTypeScriptProject';
+import { TypeScriptProject } from '@mui-internal/docs-utils';
 
 export interface ParsedProp {
   /**

packages/api-docs-builder/utils/getPropsFromComponentNode.ts

@@ -1,8 +1,7 @@
 import * as ts from 'typescript';
-import { ComponentClassDefinition } from '@mui-internal/docs-utils';
+import { ComponentClassDefinition, TypeScriptProject } from '@mui-internal/docs-utils';
 import { renderMarkdown } from '@mui/markdown';
 import { getSymbolDescription, getSymbolJSDocTags } from '../buildApiUtils';
-import { TypeScriptProject } from './createTypeScriptProject';
 import { getPropsFromComponentNode } from './getPropsFromComponentNode';
 import resolveExportSpecifier from './resolveExportSpecifier';
 import { ProjectSettings } from '../ProjectSettings';

packages/api-docs-builder/utils/parseSlotsAndClasses.ts

@@ -1,5 +1,5 @@
 import * as ts from 'typescript';
-import { TypeScriptProject } from './createTypeScriptProject';
+import { TypeScriptProject } from '@mui-internal/docs-utils';
 
 function shouldAliasSymbol(symbol: ts.Symbol) {
   const declaration = symbol.declarations?.[0];

packages/api-docs-builder/utils/resolveExportSpecifier.ts

@@ -0,0 +1,5 @@
+module.exports = {
+  rules: {
+    'import/prefer-default-export': 'off',
+  },
+};

packages/proptypes-builder/.eslintrc.js

@@ -0,0 +1,8 @@
+import { CreateTypeScriptProjectOptions } from '@mui-internal/docs-utils';
+
+export interface ProjectSettings {
+  typeScriptProject: CreateTypeScriptProjectOptions;
+  rootPath: string;
+  useExternalDocumentation?: Record<string, '*' | readonly string[]>;
+  ignoreExternalDocumentation?: Record<string, readonly string[]>;
+}