Prepare proptypes-builder for publishing

michaldudak · michaldudak · commit 20d13e2df93f · 2024-01-29T14:11:18.000+01:00
diff --git a/.codesandbox/ci.json b/.codesandbox/ci.json
@@ -20,6 +20,7 @@
     "packages/mui-types",
     "packages/mui-utils",
     "packages/docs-utils",
+    "packages/proptypes-builder",
     "packages/typescript-to-proptypes"
   ],
   "publishDirectory": {
@@ -40,6 +41,7 @@
     "@mui/types": "packages/mui-types/build",
     "@mui/utils": "packages/mui-utils/build",
     "@mui-internal/docs-utils": "packages/docs-utils",
+    "@mui-internal/proptypes-builder": "packages/proptypes-builder",
     "@mui-internal/typescript-to-proptypes": "packages/typescript-to-proptypes"
   },
   "sandboxes": [
diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
   "private": true,
   "scripts": {
     "preinstall": "npx only-allow pnpm",
-    "proptypes": "tsx ./scripts/generateProptypes.ts",
+    "proptypes": "nx run scripts:proptypes",
     "deduplicate": "pnpm dedupe",
     "benchmark:browser": "pnpm --filter benchmark browser",
     "build": "lerna run --scope \"@mui/*\" build",
@@ -222,5 +222,6 @@
     ],
     "sourceMap": false,
     "instrument": false
-  }
+  },
+  "nx": {}
 }
diff --git a/packages/proptypes-builder/CHANGELOG.md b/packages/proptypes-builder/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+Initial release as an npm package.
diff --git a/packages/proptypes-builder/README.md b/packages/proptypes-builder/README.md
@@ -0,0 +1,9 @@
+# @mui-internal/proptypes-builder
+
+A utility to create prop types based on TS definitions in MUI codebase.
+This is an internal package not meant for general use.
+
+## Release
+
+1. Build the project: `pnpm build`
+2. Publish the build artifacts to npm: `pnpm release:publish`
diff --git a/packages/proptypes-builder/package.json b/packages/proptypes-builder/package.json
@@ -1,20 +1,34 @@
 {
   "name": "@mui-internal/proptypes-builder",
   "version": "1.0.0",
-  "private": "true",
-  "main": "./index.ts",
+  "author": "MUI Team",
+  "description": "A utility to create prop types based on TS definitions in MUI codebase. This is an internal package not meant for general use.",
+  "main": "./build/index.js",
+  "exports": {
+    ".": "./build/index.js"
+  },
+  "types": "./build/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mui/material-ui.git",
+    "directory": "packages/proptypes-builder"
+  },
   "scripts": {
-    "typescript": "tsc -p tsconfig.json"
+    "prebuild": "rimraf ./build",
+    "build": "tsc -b tsconfig.build.json",
+    "typescript": "tsc -b tsconfig.json",
+    "release:publish": "pnpm publish --tag latest",
+    "release:publish:dry-run": "pnpm publish --tag latest --registry=\"http://localhost:4873/\""
   },
   "dependencies": {
-    "@mui-internal/api-docs-builder": "workspace:^",
     "@mui-internal/docs-utils": "workspace:^",
     "@mui-internal/typescript-to-proptypes": "workspace:^",
     "fast-glob": "^3.3.2",
     "fs-extra": "^11.2.0",
     "prettier": "^2.8.8"
   },
   "devDependencies": {
+    "rimraf": "^5.0.5",
     "typescript": "^5.3.3"
   }
 }
diff --git a/packages/proptypes-builder/src/ProjectSettings.ts b/packages/proptypes-builder/src/ProjectSettings.ts
diff --git a/packages/proptypes-builder/src/generatePropTypes.ts b/packages/proptypes-builder/src/generatePropTypes.ts
diff --git a/packages/proptypes-builder/src/index.ts b/packages/proptypes-builder/src/index.ts
diff --git a/packages/proptypes-builder/tsconfig.build.json b/packages/proptypes-builder/tsconfig.build.json
@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./build",
+    "declaration": true,
+    "noEmit": false,
+    "composite": true,
+    "tsBuildInfoFile": "./build/.tsbuildinfo",
+    "target": "ES2020",
+    "module": "commonjs",
+    "types": ["node"]
+  }
+}
diff --git a/packages/proptypes-builder/tsconfig.json b/packages/proptypes-builder/tsconfig.json
@@ -1,22 +1,15 @@
 {
   "compilerOptions": {
-    "allowJs": true,
-    "isolatedModules": true,
     "noEmit": true,
-    "noUnusedLocals": false,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "types": ["node", "mocha"],
-    "target": "ES2020",
-    "module": "CommonJS",
     "moduleResolution": "node",
+    "types": ["node", "mocha"],
     "strict": true,
-    "baseUrl": "./",
-    "paths": {
-      "react-docgen": ["./react-docgen.d.ts"]
-    }
+    "esModuleInterop": true,
+    "isolatedModules": true
   },
-  "include": ["./**/*.ts", "./**/*.js"],
-  "exclude": ["node_modules"]
+  "include": ["./src/*.ts", "./test/*.ts"],
+  "references": [
+    { "path": "../docs-utils/tsconfig.build.json" },
+    { "path": "../typescript-to-proptypes/tsconfig.build.json" }
+  ]
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
@@ -5,3 +5,4 @@ packages:
   - 'docs'
   - 'test'
   - 'apps/*'
+  - 'scripts'
diff --git a/scripts/generateProptypes.ts b/scripts/generateProptypes.ts
@@ -2,6 +2,8 @@ import path from 'node:path';
 import yargs from 'yargs';
 import { generatePropTypes, ProjectSettings } from '@mui-internal/proptypes-builder';
 
+const workspaceRoot = path.resolve(__dirname, '..');
+
 const useExternalPropsFromInputBase = [
   'autoComplete',
   'autoFocus',
@@ -118,10 +120,10 @@ interface CommandOptions {
 
 const projectSettings: ProjectSettings[] = [
   {
-    rootPath: path.resolve(process.cwd(), 'packages/mui-system/src'),
+    rootPath: path.resolve(workspaceRoot, 'packages/mui-system/src'),
     typeScriptProject: {
       name: 'system',
-      rootPath: path.join(process.cwd(), 'packages/mui-system'),
+      rootPath: path.join(workspaceRoot, 'packages/mui-system'),
       entryPointPath: 'src/index.d.ts',
     },
     useExternalDocumentation: {
@@ -130,49 +132,49 @@ const projectSettings: ProjectSettings[] = [
     },
   },
   {
-    rootPath: path.resolve(process.cwd(), 'packages/mui-base/src'),
+    rootPath: path.resolve(workspaceRoot, 'packages/mui-base/src'),
     typeScriptProject: {
       name: 'base',
-      rootPath: path.join(process.cwd(), 'packages/mui-base'),
+      rootPath: path.join(workspaceRoot, 'packages/mui-base'),
       entryPointPath: 'src/index.d.ts',
     },
     useExternalDocumentation: {
       Input: ['inputRef'],
     },
   },
   {
-    rootPath: path.resolve(process.cwd(), 'packages/mui-material/src'),
+    rootPath: path.resolve(workspaceRoot, 'packages/mui-material/src'),
     typeScriptProject: {
       name: 'material',
-      rootPath: path.join(process.cwd(), 'packages/mui-material'),
+      rootPath: path.join(workspaceRoot, 'packages/mui-material'),
       entryPointPath: 'src/index.d.ts',
     },
     useExternalDocumentation: useMaterialUiExternalDocumentation,
     ignoreExternalDocumentation: ignoreMaterialUiExternalDocumentation,
   },
   {
-    rootPath: path.resolve(process.cwd(), 'packages/mui-lab/src'),
+    rootPath: path.resolve(workspaceRoot, 'packages/mui-lab/src'),
     typeScriptProject: {
       name: 'lab',
-      rootPath: path.join(process.cwd(), 'packages/mui-lab'),
+      rootPath: path.join(workspaceRoot, 'packages/mui-lab'),
       entryPointPath: 'src/index.d.ts',
     },
   },
   {
-    rootPath: path.resolve(process.cwd(), 'packages/mui-material-next/src'),
+    rootPath: path.resolve(workspaceRoot, 'packages/mui-material-next/src'),
     typeScriptProject: {
       name: 'material-next',
-      rootPath: path.join(process.cwd(), 'packages/mui-material-next'),
+      rootPath: path.join(workspaceRoot, 'packages/mui-material-next'),
       entryPointPath: 'src/index.ts',
     },
     useExternalDocumentation: useMaterialUiExternalDocumentation,
     ignoreExternalDocumentation: ignoreMaterialUiExternalDocumentation,
   },
   {
-    rootPath: path.resolve(process.cwd(), 'packages/mui-joy/src'),
+    rootPath: path.resolve(workspaceRoot, 'packages/mui-joy/src'),
     typeScriptProject: {
       name: 'joy',
-      rootPath: path.join(process.cwd(), 'packages/mui-joy'),
+      rootPath: path.join(workspaceRoot, 'packages/mui-joy'),
       entryPointPath: 'src/index.ts',
     },
     useExternalDocumentation: {
diff --git a/scripts/package.json b/scripts/package.json
@@ -0,0 +1,22 @@
+{
+  "name": "scripts",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "proptypes": "tsx ./generateProptypes.ts"
+  },
+  "nx": {
+    "targets": {
+      "proptypes": {
+        "dependsOn": [
+          {
+            "projects": [
+              "@mui-internal/proptypes-builder"
+            ],
+            "target": "build"
+          }
+        ]
+      }
+    }
+  }
+}
