From 13c2eda77f384ff6a1d974c71f1f3a2d83c3818c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Dudak?= Date: Thu, 14 Mar 2024 23:08:15 +0100 Subject: [PATCH 1/4] Rename the package --- .codesandbox/ci.json | 4 ++-- babel.config.js | 2 +- docs/package.json | 2 +- docs/scripts/formattedTSDemos.js | 2 +- .../components/ApiPage/list/ClassesList.tsx | 2 +- .../ApiPage/sections/ClassesSection.tsx | 2 +- .../components/ApiPage/table/ClassesTable.tsx | 2 +- package.json | 2 +- packages-internal/scripts/CHANGELOG.md | 2 +- packages-internal/scripts/package.json | 2 +- .../src/getPropTypesFromFile.ts | 2 +- .../test/typescript-to-proptypes.test.ts | 2 +- .../ApiBuilders/ComponentApiBuilder.ts | 2 +- packages/api-docs-builder/ProjectSettings.ts | 2 +- packages/api-docs-builder/buildApiUtils.ts | 2 +- packages/api-docs-builder/package.json | 2 +- packages/api-docs-builder/tsconfig.json | 2 +- .../utils/parseSlotsAndClasses.ts | 2 +- packages/docs-utils/README.md | 2 +- packages/docs-utils/package.json | 2 +- pnpm-lock.yaml | 16 ++++++++-------- scripts/generateProptypes.ts | 2 +- tsconfig.json | 2 +- webpackBaseConfig.js | 2 +- 24 files changed, 32 insertions(+), 32 deletions(-) diff --git a/.codesandbox/ci.json b/.codesandbox/ci.json index 6b395d8ebe8487..67c49e758c799f 100644 --- a/.codesandbox/ci.json +++ b/.codesandbox/ci.json @@ -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/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/babel.config.js b/babel.config.js index 4c98dcc08596b0..89f67c18168400 100644 --- 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/docs-utils/src'), docs: resolveAliasPath('./docs'), test: resolveAliasPath('./test'), }; diff --git a/docs/package.json b/docs/package.json index dc1b044b649314..dcdfb7796159dc 100644 --- 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 index 18248d3b10b769..abdf96b6263d12 100644 --- 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 index fdf4497f465f4b..d7366af1b60239 100644 --- 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 index 5f6badcd5150c8..bc09404849b40c 100644 --- 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 index b2c98cf1674cf9..f2546202208eb1 100644 --- 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 index 3fe522de0f0ea8..e27bbd1eae44b9 100644 --- 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-internal/scripts/CHANGELOG.md b/packages-internal/scripts/CHANGELOG.md index dd86612b025856..92cc3433251004 100644 --- 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 index 673d0907edf534..e9175a68b90f9e 100644 --- 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/typescript-to-proptypes/src/getPropTypesFromFile.ts b/packages-internal/scripts/typescript-to-proptypes/src/getPropTypesFromFile.ts index 9b0d034cadcde6..521274b1a9cbd4 100644 --- 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 index 769925840e26b8..6b29900311a4a5 100644 --- 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 index b4e834cb840fbe..cc28ee9f3a0135 100644 --- 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 index 9ab9ff5ad9c55a..2ba937f0a4e9b2 100644 --- 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 index a62c632111ae4a..726e47069ff899 100644 --- 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 index 5f21f9ed85ebbc..6c1f1051f4694d 100644 --- 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 index 41e0c9ff506e27..4c8cb67b09768f 100644 --- 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 index 92582e71355370..64a27b69b8dc4a 100644 --- 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/docs-utils/README.md b/packages/docs-utils/README.md index 8a19bc3cbc5e1a..92be36e77819af 100644 --- a/packages/docs-utils/README.md +++ b/packages/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 b/packages/docs-utils/package.json index a199a615938c69..cc5f34fb491074 100644 --- a/packages/docs-utils/package.json +++ b/packages/docs-utils/package.json @@ -1,5 +1,5 @@ { - "name": "@mui-internal/docs-utils", + "name": "@mui/internal-docs-utils", "version": "1.0.2", "author": "MUI Team", "description": "Utilities for MUI docs. This is an internal package not meant for general use.", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 5af7b9880151c0..0964b7685eabdf 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -101,12 +101,12 @@ importers: '@mui-internal/api-docs-builder-core': specifier: workspace:^ version: link:packages/api-docs-builder-core - '@mui-internal/docs-utils': - specifier: workspace:^ - version: link:packages/docs-utils '@mui-internal/test-utils': specifier: workspace:^ version: link:packages/test-utils + '@mui/internal-docs-utils': + specifier: workspace:^ + version: link:packages/docs-utils '@mui/internal-scripts': specifier: workspace:^ version: link:packages-internal/scripts @@ -723,12 +723,12 @@ importers: '@babel/preset-typescript': specifier: ^7.23.3 version: 7.23.3(@babel/core@7.23.9) - '@mui-internal/docs-utils': - specifier: workspace:^ - version: link:../packages/docs-utils '@mui-internal/test-utils': specifier: workspace:^ version: link:../packages/test-utils + '@mui/internal-docs-utils': + specifier: workspace:^ + version: link:../packages/docs-utils '@mui/internal-scripts': specifier: workspace:^ version: link:../packages-internal/scripts @@ -813,7 +813,7 @@ importers: '@babel/types': specifier: ^7.23.9 version: 7.23.9 - '@mui-internal/docs-utils': + '@mui/internal-docs-utils': specifier: workspace:^ version: link:../../packages/docs-utils doctrine: @@ -880,7 +880,7 @@ importers: '@babel/traverse': specifier: ^7.23.9 version: 7.23.9 - '@mui-internal/docs-utils': + '@mui/internal-docs-utils': specifier: workspace:^ version: link:../docs-utils '@mui/internal-markdown': diff --git a/scripts/generateProptypes.ts b/scripts/generateProptypes.ts index f029876db67f78..98096417239b3d 100644 --- 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 index ac3aa8a81841b1..ead0fd37de146e 100644 --- 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/docs-utils/src"], "@mui/internal-scripts/typescript-to-proptypes": [ "./packages-internal/scripts/typescript-to-proptypes/src" ] diff --git a/webpackBaseConfig.js b/webpackBaseConfig.js index a6bfc4370679f9..139edef4d3ae7b 100644 --- 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/docs-utils/src'), '@mui/internal-scripts/typescript-to-proptypes': path.resolve( __dirname, './packages-internal/scripts/typescript-to-proptypes/src', From 2d67cf204ad6f6bf9d36cd19b19a064bd4eac0a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Dudak?= Date: Thu, 14 Mar 2024 23:11:05 +0100 Subject: [PATCH 2/4] Move the package into packages-internal --- {packages => packages-internal}/docs-utils/.npmignore | 0 {packages => packages-internal}/docs-utils/CHANGELOG.md | 0 {packages => packages-internal}/docs-utils/README.md | 0 {packages => packages-internal}/docs-utils/package.json | 0 .../docs-utils/src/ComponentClassDefinition.ts | 0 .../docs-utils/src/createTypeScriptProject.ts | 0 .../docs-utils/src/getPropsFromComponentNode.ts | 0 {packages => packages-internal}/docs-utils/src/index.ts | 0 {packages => packages-internal}/docs-utils/tsconfig.build.json | 0 {packages => packages-internal}/docs-utils/tsconfig.json | 0 10 files changed, 0 insertions(+), 0 deletions(-) rename {packages => packages-internal}/docs-utils/.npmignore (100%) rename {packages => packages-internal}/docs-utils/CHANGELOG.md (100%) rename {packages => packages-internal}/docs-utils/README.md (100%) rename {packages => packages-internal}/docs-utils/package.json (100%) rename {packages => packages-internal}/docs-utils/src/ComponentClassDefinition.ts (100%) rename {packages => packages-internal}/docs-utils/src/createTypeScriptProject.ts (100%) rename {packages => packages-internal}/docs-utils/src/getPropsFromComponentNode.ts (100%) rename {packages => packages-internal}/docs-utils/src/index.ts (100%) rename {packages => packages-internal}/docs-utils/tsconfig.build.json (100%) rename {packages => packages-internal}/docs-utils/tsconfig.json (100%) diff --git a/packages/docs-utils/.npmignore b/packages-internal/docs-utils/.npmignore similarity index 100% rename from packages/docs-utils/.npmignore rename to packages-internal/docs-utils/.npmignore diff --git a/packages/docs-utils/CHANGELOG.md b/packages-internal/docs-utils/CHANGELOG.md similarity index 100% rename from packages/docs-utils/CHANGELOG.md rename to packages-internal/docs-utils/CHANGELOG.md diff --git a/packages/docs-utils/README.md b/packages-internal/docs-utils/README.md similarity index 100% rename from packages/docs-utils/README.md rename to packages-internal/docs-utils/README.md diff --git a/packages/docs-utils/package.json b/packages-internal/docs-utils/package.json similarity index 100% rename from packages/docs-utils/package.json rename to packages-internal/docs-utils/package.json diff --git a/packages/docs-utils/src/ComponentClassDefinition.ts b/packages-internal/docs-utils/src/ComponentClassDefinition.ts similarity index 100% rename from packages/docs-utils/src/ComponentClassDefinition.ts rename to packages-internal/docs-utils/src/ComponentClassDefinition.ts diff --git a/packages/docs-utils/src/createTypeScriptProject.ts b/packages-internal/docs-utils/src/createTypeScriptProject.ts similarity index 100% rename from packages/docs-utils/src/createTypeScriptProject.ts rename to packages-internal/docs-utils/src/createTypeScriptProject.ts diff --git a/packages/docs-utils/src/getPropsFromComponentNode.ts b/packages-internal/docs-utils/src/getPropsFromComponentNode.ts similarity index 100% rename from packages/docs-utils/src/getPropsFromComponentNode.ts rename to packages-internal/docs-utils/src/getPropsFromComponentNode.ts diff --git a/packages/docs-utils/src/index.ts b/packages-internal/docs-utils/src/index.ts similarity index 100% rename from packages/docs-utils/src/index.ts rename to packages-internal/docs-utils/src/index.ts diff --git a/packages/docs-utils/tsconfig.build.json b/packages-internal/docs-utils/tsconfig.build.json similarity index 100% rename from packages/docs-utils/tsconfig.build.json rename to packages-internal/docs-utils/tsconfig.build.json diff --git a/packages/docs-utils/tsconfig.json b/packages-internal/docs-utils/tsconfig.json similarity index 100% rename from packages/docs-utils/tsconfig.json rename to packages-internal/docs-utils/tsconfig.json From 028cd92c1f4116350e791b884d4bcb15194d9978 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Dudak?= Date: Thu, 14 Mar 2024 23:14:05 +0100 Subject: [PATCH 3/4] Update paths --- .codesandbox/ci.json | 4 +-- apps/pnpm-workspace.yaml | 2 +- babel.config.js | 2 +- packages-internal/docs-utils/package.json | 2 +- .../scripts/tsconfig.typecheck.json | 2 +- packages/markdown/package.json | 2 +- pnpm-lock.yaml | 26 +++++++++---------- tsconfig.json | 2 +- webpackBaseConfig.js | 2 +- 9 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.codesandbox/ci.json b/.codesandbox/ci.json index 67c49e758c799f..71283d06fdff0c 100644 --- 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,7 +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/docs-utils", + "@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", diff --git a/apps/pnpm-workspace.yaml b/apps/pnpm-workspace.yaml index d770d322ad42ee..da23d95e53e26f 100644 --- 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 index 89f67c18168400..9b3ca62593f763 100644 --- 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/packages-internal/docs-utils/package.json b/packages-internal/docs-utils/package.json index cc5f34fb491074..40c0761040ef70 100644 --- a/packages-internal/docs-utils/package.json +++ b/packages-internal/docs-utils/package.json @@ -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/packages-internal/scripts/tsconfig.typecheck.json b/packages-internal/scripts/tsconfig.typecheck.json index ae133d71c10945..0d271133c6cee3 100644 --- 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/markdown/package.json b/packages/markdown/package.json index e7067fa50d9507..e11064d3a73af8 100644 --- 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 index 0964b7685eabdf..820052c68f5cae 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -106,7 +106,7 @@ importers: version: link:packages/test-utils '@mui/internal-docs-utils': specifier: workspace:^ - version: link:packages/docs-utils + version: link:packages-internal/docs-utils '@mui/internal-scripts': specifier: workspace:^ version: link:packages-internal/scripts @@ -728,7 +728,7 @@ importers: version: link:../packages/test-utils '@mui/internal-docs-utils': specifier: workspace:^ - version: link:../packages/docs-utils + version: link:../packages-internal/docs-utils '@mui/internal-scripts': specifier: workspace:^ version: link:../packages-internal/scripts @@ -796,6 +796,15 @@ importers: specifier: ^17.7.2 version: 17.7.2 + packages-internal/docs-utils: + dependencies: + rimraf: + specifier: ^5.0.5 + version: 5.0.5 + typescript: + specifier: ^5.3.3 + version: 5.3.3 + packages-internal/scripts: dependencies: '@babel/core': @@ -815,7 +824,7 @@ importers: version: 7.23.9 '@mui/internal-docs-utils': specifier: workspace:^ - version: link:../../packages/docs-utils + version: link:../docs-utils doctrine: specifier: ^3.0.0 version: 3.0.0 @@ -882,7 +891,7 @@ importers: version: 7.23.9 '@mui/internal-docs-utils': specifier: workspace:^ - version: link:../docs-utils + version: link:../../packages-internal/docs-utils '@mui/internal-markdown': specifier: workspace:^ version: link:../markdown @@ -991,15 +1000,6 @@ importers: specifier: ^5.3.3 version: 5.3.3 - packages/docs-utils: - dependencies: - rimraf: - specifier: ^5.0.5 - version: 5.0.5 - typescript: - specifier: ^5.3.3 - version: 5.3.3 - packages/eslint-plugin-material-ui: dependencies: emoji-regex: diff --git a/tsconfig.json b/tsconfig.json index ead0fd37de146e..3ac48ed213e804 100644 --- 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 index 139edef4d3ae7b..71fe74b5af9740 100644 --- 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', From c84483efa66aa180a36c41678b3770e518ff3c6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Dudak?= Date: Fri, 15 Mar 2024 09:03:07 +0100 Subject: [PATCH 4/4] Update the changelog --- packages-internal/docs-utils/CHANGELOG.md | 4 ++++ packages-internal/docs-utils/package.json | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/packages-internal/docs-utils/CHANGELOG.md b/packages-internal/docs-utils/CHANGELOG.md index 3255c1a72040cf..f466e1ffab289d 100644 --- a/packages-internal/docs-utils/CHANGELOG.md +++ b/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-internal/docs-utils/package.json b/packages-internal/docs-utils/package.json index 40c0761040ef70..a33264cd53e1a5 100644 --- a/packages-internal/docs-utils/package.json +++ b/packages-internal/docs-utils/package.json @@ -1,6 +1,6 @@ { "name": "@mui/internal-docs-utils", - "version": "1.0.2", + "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",