[code-infra] Rename @mui-internal/docs-utils to @mui/internal-docs-ut…

…ils (#41498)
mui · Mar 15, 2024 · c76a373 · c76a373
1 parent f4f337c
commit c76a373
Show file tree

Hide file tree

Showing 35 changed files with 53 additions and 49 deletions.
diff --git a/.codesandbox/ci.json b/.codesandbox/ci.json
@@ -3,7 +3,6 @@
   "installCommand": "install:codesandbox",
   "node": "18",
   "packages": [
-    "packages/docs-utils",
     "packages/markdown",
     "packages/mui-babel-macros",
     "packages/mui-base",
@@ -23,6 +22,7 @@
     "packages/mui-system",
     "packages/mui-types",
     "packages/mui-utils",
+    "packages-internal/docs-utils",
     "packages-internal/scripts"
   ],
   "publishDirectory": {
@@ -32,6 +32,7 @@
     "@mui/docs": "packages/mui-docs/build",
     "@mui/icons-material": "packages/mui-icons-material/build",
     "@mui/internal-babel-macros": "packages/mui-babel-macros",
+    "@mui/internal-docs-utils": "packages-internal/docs-utils",
     "@mui/internal-markdown": "packages/markdown",
     "@mui/internal-scripts": "packages-internal/scripts",
     "@mui/joy": "packages/mui-joy/build",
@@ -45,8 +46,7 @@
     "@mui/styles": "packages/mui-styles/build",
     "@mui/system": "packages/mui-system/build",
     "@mui/types": "packages/mui-types/build",
-    "@mui/utils": "packages/mui-utils/build",
-    "@mui-internal/docs-utils": "packages/docs-utils"
+    "@mui/utils": "packages/mui-utils/build"
   },
   "sandboxes": [
     "/examples/material-ui-cra-ts",

diff --git a/apps/pnpm-workspace.yaml b/apps/pnpm-workspace.yaml
@@ -2,7 +2,7 @@ packages:
   - 'local-ui-lib'
   - 'pigment-*'
   - '../packages/waterfall'
-  - '../packages/docs-utils'
+  - '../packages-internal/docs-utils'
   - '../packages/test-utils'
   - '../packages-internal/*'
   - '../packages/mui-*'

diff --git a/babel.config.js b/babel.config.js
@@ -33,7 +33,7 @@ module.exports = function getBabelConfig(api) {
     '@mui/material-next': resolveAliasPath('./packages/mui-material-next/src'),
     '@mui/joy': resolveAliasPath('./packages/mui-joy/src'),
     '@pigment-css/react': resolveAliasPath('./packages/pigment-css-react/src'),
-    '@mui-internal/docs-utils': resolveAliasPath('./packages/docs-utils/src'),
+    '@mui/internal-docs-utils': resolveAliasPath('./packages-internal/docs-utils/src'),
     docs: resolveAliasPath('./docs'),
     test: resolveAliasPath('./test'),
   };

diff --git a/docs/package.json b/docs/package.json
@@ -116,8 +116,8 @@
   "devDependencies": {
     "@babel/plugin-transform-react-constant-elements": "^7.23.3",
     "@babel/preset-typescript": "^7.23.3",
+    "@mui/internal-docs-utils": "workspace:^",
     "@mui/internal-scripts": "workspace:^",
-    "@mui-internal/docs-utils": "workspace:^",
     "@mui-internal/test-utils": "workspace:^",
     "@types/autosuggest-highlight": "^3.2.3",
     "@types/chai": "^4.3.12",

diff --git a/docs/scripts/formattedTSDemos.js b/docs/scripts/formattedTSDemos.js
@@ -23,7 +23,7 @@ const {
   createTypeScriptProjectBuilder,
 } = require('@mui-internal/api-docs-builder/utils/createTypeScriptProject');
 const yargs = require('yargs');
-const { fixBabelGeneratorIssues, fixLineEndings } = require('@mui-internal/docs-utils');
+const { fixBabelGeneratorIssues, fixLineEndings } = require('@mui/internal-docs-utils');
 const { default: CORE_TYPESCRIPT_PROJECTS } = require('../../scripts/coreTypeScriptProjects');
 
 const babelConfig = {

diff --git a/docs/src/modules/components/ApiPage/list/ClassesList.tsx b/docs/src/modules/components/ApiPage/list/ClassesList.tsx
@@ -2,7 +2,7 @@
 import * as React from 'react';
 import { styled } from '@mui/material/styles';
 import kebabCase from 'lodash/kebabCase';
-import { ComponentClassDefinition } from '@mui-internal/docs-utils';
+import { ComponentClassDefinition } from '@mui/internal-docs-utils';
 import { useTranslate } from '@mui/docs/i18n';
 import ExpandableApiItem, {
   ApiItemContaier,

diff --git a/docs/src/modules/components/ApiPage/sections/ClassesSection.tsx b/docs/src/modules/components/ApiPage/sections/ClassesSection.tsx
@@ -1,7 +1,7 @@
 /* eslint-disable react/no-danger */
 import * as React from 'react';
 import { useTranslate } from '@mui/docs/i18n';
-import { ComponentClassDefinition } from '@mui-internal/docs-utils';
+import { ComponentClassDefinition } from '@mui/internal-docs-utils';
 import Box from '@mui/material/Box';
 import ToggleDisplayOption, {
   ApiDisplayOptions,

diff --git a/docs/src/modules/components/ApiPage/table/ClassesTable.tsx b/docs/src/modules/components/ApiPage/table/ClassesTable.tsx
@@ -1,6 +1,6 @@
 /* eslint-disable react/no-danger */
 import * as React from 'react';
-import { ComponentClassDefinition } from '@mui-internal/docs-utils';
+import { ComponentClassDefinition } from '@mui/internal-docs-utils';
 import { styled, alpha } from '@mui/material/styles';
 import {
   brandingDarkTheme as darkTheme,

diff --git a/package.json b/package.json
@@ -105,10 +105,10 @@
     "@babel/preset-typescript": "^7.23.3",
     "@babel/register": "^7.23.7",
     "@mnajdova/enzyme-adapter-react-18": "^0.2.0",
+    "@mui/internal-docs-utils": "workspace:^",
     "@mui/internal-scripts": "workspace:^",
     "@mui-internal/api-docs-builder": "workspace:^",
     "@mui-internal/api-docs-builder-core": "workspace:^",
-    "@mui-internal/docs-utils": "workspace:^",
     "@mui-internal/test-utils": "workspace:^",
     "@mui/joy": "workspace:*",
     "@mui/material": "workspace:^",

diff --git a/packages/docs-utils/.npmignore → packages-internal/docs-utils/.npmignore b/packages/docs-utils/.npmignore → packages-internal/docs-utils/.npmignore
diff --git a/packages/docs-utils/CHANGELOG.md → packages-internal/docs-utils/CHANGELOG.md b/packages/docs-utils/CHANGELOG.md → packages-internal/docs-utils/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.3
+
+Renamed the package to @mui/internal-docs-utils
+
 ## 1.0.2
 
 Fixed incorrectly released package.

diff --git a/packages/docs-utils/README.md → packages-internal/docs-utils/README.md b/packages/docs-utils/README.md → packages-internal/docs-utils/README.md
@@ -1,4 +1,4 @@
-# @mui-internal/docs-utils
+# @mui/internal-docs-utils
 
 This package contains utilities shared between MUI docs generation scripts.
 This is an internal package not meant for general use.

diff --git a/packages/docs-utils/package.json → packages-internal/docs-utils/package.json b/packages/docs-utils/package.json → packages-internal/docs-utils/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "@mui-internal/docs-utils",
-  "version": "1.0.2",
+  "name": "@mui/internal-docs-utils",
+  "version": "1.0.3",
   "author": "MUI Team",
   "description": "Utilities for MUI docs. This is an internal package not meant for general use.",
   "main": "./build/index.js",
@@ -11,7 +11,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/mui/material-ui.git",
-    "directory": "packages/docs-utils"
+    "directory": "packages-internal/docs-utils"
   },
   "scripts": {
     "prebuild": "rimraf ./build",

diff --git a/...ocs-utils/src/ComponentClassDefinition.ts → ...ocs-utils/src/ComponentClassDefinition.ts b/...ocs-utils/src/ComponentClassDefinition.ts → ...ocs-utils/src/ComponentClassDefinition.ts
diff --git a/...docs-utils/src/createTypeScriptProject.ts → ...docs-utils/src/createTypeScriptProject.ts b/...docs-utils/src/createTypeScriptProject.ts → ...docs-utils/src/createTypeScriptProject.ts
diff --git a/...cs-utils/src/getPropsFromComponentNode.ts → ...cs-utils/src/getPropsFromComponentNode.ts b/...cs-utils/src/getPropsFromComponentNode.ts → ...cs-utils/src/getPropsFromComponentNode.ts
diff --git a/packages/docs-utils/src/index.ts → packages-internal/docs-utils/src/index.ts b/packages/docs-utils/src/index.ts → packages-internal/docs-utils/src/index.ts
diff --git a/packages/docs-utils/tsconfig.build.json → ...s-internal/docs-utils/tsconfig.build.json b/packages/docs-utils/tsconfig.build.json → ...s-internal/docs-utils/tsconfig.build.json
diff --git a/packages/docs-utils/tsconfig.json → packages-internal/docs-utils/tsconfig.json b/packages/docs-utils/tsconfig.json → packages-internal/docs-utils/tsconfig.json
diff --git a/packages-internal/scripts/CHANGELOG.md b/packages-internal/scripts/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 ## 1.0.1
 
-- Unpinned version of the @mui-internal/docs-utils dependency.
+- Unpinned version of the @mui/internal-docs-utils dependency.
 - Corrected the README file.
 
 ## 1.0.0

diff --git a/packages-internal/scripts/package.json b/packages-internal/scripts/package.json
@@ -30,7 +30,7 @@
     "@babel/plugin-syntax-jsx": "^7.23.3",
     "@babel/plugin-syntax-typescript": "^7.23.3",
     "@babel/types": "^7.23.9",
-    "@mui-internal/docs-utils": "workspace:^",
+    "@mui/internal-docs-utils": "workspace:^",
     "doctrine": "^3.0.0",
     "lodash": "^4.17.21",
     "typescript": "^5.3.3",

diff --git a/packages-internal/scripts/tsconfig.typecheck.json b/packages-internal/scripts/tsconfig.typecheck.json
@@ -7,5 +7,5 @@
   },
   "include": ["./**/*.ts"],
   "exclude": ["./build", "./node_modules"],
-  "references": [{ "path": "../../packages/docs-utils/tsconfig.build.json" }]
+  "references": [{ "path": "../../packages-internal/docs-utils/tsconfig.build.json" }]
 }
diff --git a/packages-internal/scripts/typescript-to-proptypes/src/getPropTypesFromFile.ts b/packages-internal/scripts/typescript-to-proptypes/src/getPropTypesFromFile.ts
@@ -4,7 +4,7 @@ import {
   GetPropsFromComponentDeclarationOptions,
   getPropsFromComponentNode,
   TypeScriptProject,
-} from '@mui-internal/docs-utils';
+} from '@mui/internal-docs-utils';
 import {
   createUnionType,
   createUndefinedType,

diff --git a/packages-internal/scripts/typescript-to-proptypes/test/typescript-to-proptypes.test.ts b/packages-internal/scripts/typescript-to-proptypes/test/typescript-to-proptypes.test.ts
@@ -4,7 +4,7 @@ import * as ts from 'typescript';
 import { expect } from 'chai';
 import glob from 'fast-glob';
 import prettier from 'prettier';
-import { TypeScriptProject, createTypeScriptProjectBuilder } from '@mui-internal/docs-utils';
+import { TypeScriptProject, createTypeScriptProjectBuilder } from '@mui/internal-docs-utils';
 import { generatePropTypes } from '../src/generatePropTypes';
 import { injectPropTypesInFile } from '../src/injectPropTypesInFile';
 import { getPropTypesFromFile } from '../src/getPropTypesFromFile';

diff --git a/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts b/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/internal-markdown';
-import { ComponentClassDefinition } from '@mui-internal/docs-utils';
+import { ComponentClassDefinition } from '@mui/internal-docs-utils';
 import { ProjectSettings, SortingStrategiesType } from '../ProjectSettings';
 import { ComponentInfo, toGitHubPath, writePrettifiedFile } from '../buildApiUtils';
 import muiDefaultPropsHandler from '../utils/defaultPropsHandler';

diff --git a/packages/api-docs-builder/ProjectSettings.ts b/packages/api-docs-builder/ProjectSettings.ts
@@ -1,4 +1,4 @@
-import { ComponentClassDefinition } from '@mui-internal/docs-utils';
+import { ComponentClassDefinition } from '@mui/internal-docs-utils';
 import { ComponentInfo, HookInfo } from './buildApiUtils';
 import { CreateTypeScriptProjectOptions } from './utils/createTypeScriptProject';
 import { CreateDescribeablePropSettings } from './utils/createDescribeableProp';

diff --git a/packages/api-docs-builder/buildApiUtils.ts b/packages/api-docs-builder/buildApiUtils.ts
@@ -3,7 +3,7 @@ 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 } from '@mui/internal-docs-utils';
 import { replaceComponentLinks } from './utils/replaceUrl';
 import { TypeScriptProject } from './utils/createTypeScriptProject';
 

diff --git a/packages/api-docs-builder/package.json b/packages/api-docs-builder/package.json
@@ -11,7 +11,7 @@
     "@babel/core": "^7.23.9",
     "@babel/preset-typescript": "^7.23.3",
     "@babel/traverse": "^7.23.9",
-    "@mui-internal/docs-utils": "workspace:^",
+    "@mui/internal-docs-utils": "workspace:^",
     "@mui/internal-markdown": "workspace:^",
     "ast-types": "^0.14.2",
     "doctrine": "^3.0.0",

diff --git a/packages/api-docs-builder/tsconfig.json b/packages/api-docs-builder/tsconfig.json
@@ -14,7 +14,7 @@
     "strict": true,
     "baseUrl": "./",
     "paths": {
-      "@mui-internal/docs-utils": ["../docs-utils/src"]
+      "@mui/internal-docs-utils": ["../docs-utils/src"]
     }
   },
   "include": ["./**/*.ts", "./**/*.js"],

diff --git a/packages/api-docs-builder/utils/parseSlotsAndClasses.ts b/packages/api-docs-builder/utils/parseSlotsAndClasses.ts
@@ -1,5 +1,5 @@
 import * as ts from 'typescript';
-import { ComponentClassDefinition } from '@mui-internal/docs-utils';
+import { ComponentClassDefinition } from '@mui/internal-docs-utils';
 import { renderMarkdown } from '@mui/internal-markdown';
 import { getSymbolDescription, getSymbolJSDocTags } from '../buildApiUtils';
 import { TypeScriptProject } from './createTypeScriptProject';

diff --git a/packages/markdown/package.json b/packages/markdown/package.json
@@ -13,7 +13,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/mui/material-ui.git",
-    "directory": "packages/docs-utils"
+    "directory": "packages/markdown"
   },
   "scripts": {
     "release:publish": "pnpm publish --tag latest",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/generateProptypes.ts b/scripts/generateProptypes.ts
@@ -10,7 +10,7 @@ import {
   fixBabelGeneratorIssues,
   fixLineEndings,
   getUnstyledFilename,
-} from '@mui-internal/docs-utils';
+} from '@mui/internal-docs-utils';
 import {
   getPropTypesFromFile,
   injectPropTypesInFile,

diff --git a/tsconfig.json b/tsconfig.json
@@ -50,7 +50,7 @@
       "@pigment-css/react/*": ["./packages/pigment-css-react/src/*"],
       "@pigment-css/vite-plugin": ["./packages/pigment-css-vite-plugin/src"],
       "@pigment-css/vite-plugin/*": ["./packages/pigment-css-vite-plugin/src/*"],
-      "@mui-internal/docs-utils": ["./packages/docs-utils/src"],
+      "@mui/internal-docs-utils": ["./packages-internal/docs-utils/src"],
       "@mui/internal-scripts/typescript-to-proptypes": [
         "./packages-internal/scripts/typescript-to-proptypes/src"
       ]

diff --git a/webpackBaseConfig.js b/webpackBaseConfig.js
@@ -25,7 +25,7 @@ module.exports = {
       '@mui/material-nextjs': path.resolve(__dirname, './packages/mui-material-nextjs/src'),
       '@mui/joy': path.resolve(__dirname, './packages/mui-joy/src'),
       '@pigment-css/react': path.resolve(__dirname, './packages/pigment-css-react/src'),
-      '@mui-internal/docs-utils': path.resolve(__dirname, './packages/docs-utils/src'),
+      '@mui/internal-docs-utils': path.resolve(__dirname, './packages-internal/docs-utils/src'),
       '@mui/internal-scripts/typescript-to-proptypes': path.resolve(
         __dirname,
         './packages-internal/scripts/typescript-to-proptypes/src',