Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[code-infra] Shift aliasing from babel to webpack #13051

Merged
merged 6 commits into from
May 13, 2024
Merged

[code-infra] Shift aliasing from babel to webpack #13051

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
214e2aa
Shift aliasing from babel to webpack
Janpot May 8, 2024
f5b4827
Remove all aliases
Janpot May 8, 2024
873db4c
resolveLoader
Janpot May 8, 2024
5a9d7fe
Update next.config.mjs
Janpot May 8, 2024
6b313c1
Update next.config.mjs
Janpot May 8, 2024
fe3fb39
Merge remote-tracking branch 'upstream/master' into babel-aliasing
Janpot May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 1 addition & 30 deletions docs/babel.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,6 @@
const fse = require('fs-extra');
const getBaseConfig = require('../babel.config');

const alias = {
'@mui/x-data-grid': '../packages/x-data-grid/src',
'@mui/x-data-grid-generator': '../packages/x-data-grid-generator/src',
'@mui/x-data-grid-pro': '../packages/x-data-grid-pro/src',
'@mui/x-data-grid-premium': '../packages/x-data-grid-premium/src',
'@mui/x-date-pickers': '../packages/x-date-pickers/src',
'@mui/x-date-pickers-pro': '../packages/x-date-pickers-pro/src',
'@mui/x-charts': '../packages/x-charts/src',
'@mui/x-tree-view': '../packages/x-tree-view/src',
'@mui/x-tree-view-pro': '../packages/x-tree-view-pro/src',
'@mui/x-license': '../packages/x-license/src',
'@mui/docs': '../node_modules/@mui/monorepo/packages/mui-docs/src',
'@mui/monorepo': '../node_modules/@mui/monorepo',
'@mui/material-nextjs': '../node_modules/@mui/monorepo/packages/mui-material-nextjs/src',
'@mui-internal/api-docs-builder': '../node_modules/@mui/monorepo/packages/api-docs-builder',
docs: '../node_modules/@mui/monorepo/docs',
docsx: './',
};

const { version: transformRuntimeVersion } = fse.readJSONSync(
require.resolve('@babel/runtime-corejs2/package.json'),
);
Expand All @@ -33,17 +14,7 @@ module.exports = function getBabelConfig(api) {
// backport of https://github.com/zeit/next.js/pull/9511
['next/babel', { 'transform-runtime': { corejs: 2, version: transformRuntimeVersion } }],
],
plugins: [
...baseConfig.plugins,
'babel-plugin-preval',
[
'babel-plugin-module-resolver',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can remove this package now if it is no longer used? 🤔

Copy link
Member Author

@Janpot Janpot May 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's still used by some of the tests. Mocha doesn't have a straightforward way to do aliasing.

{
alias,
transformFunctions: ['require', 'require.context'],
},
],
],
plugins: [...baseConfig.plugins, 'babel-plugin-preval'],
ignore: [...baseConfig.ignore, /@mui[\\|/]docs[\\|/]markdown/],
};
};
69 changes: 50 additions & 19 deletions docs/next.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,34 @@ import constants from './constants.js';
const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));
const require = createRequire(import.meta.url);

const workspaceRoot = path.join(currentDirectory, '../');
const WORKSPACE_ROOT = path.resolve(currentDirectory, '../');
const MONOREPO_PATH = path.resolve(WORKSPACE_ROOT, './node_modules/@mui/monorepo');
const MONOREPO_ALIASES = {
'@mui/docs': path.resolve(MONOREPO_PATH, './packages/mui-docs/src'),
};

const WORKSPACE_ALIASES = {
'@mui/x-data-grid': path.resolve(WORKSPACE_ROOT, './packages/x-data-grid/src'),
'@mui/x-data-grid-generator': path.resolve(
WORKSPACE_ROOT,
'./packages/x-data-grid-generator/src',
),
'@mui/x-data-grid-pro': path.resolve(WORKSPACE_ROOT, './packages/x-data-grid-pro/src'),
'@mui/x-data-grid-premium': path.resolve(WORKSPACE_ROOT, './packages/x-data-grid-premium/src'),
'@mui/x-date-pickers': path.resolve(WORKSPACE_ROOT, './packages/x-date-pickers/src'),
'@mui/x-date-pickers-pro': path.resolve(WORKSPACE_ROOT, './packages/x-date-pickers-pro/src'),
'@mui/x-charts': path.resolve(WORKSPACE_ROOT, './packages/x-charts/src'),
'@mui/x-tree-view': path.resolve(WORKSPACE_ROOT, './packages/x-tree-view/src'),
'@mui/x-tree-view-pro': path.resolve(WORKSPACE_ROOT, './packages/x-tree-view-pro/src'),
'@mui/x-license': path.resolve(WORKSPACE_ROOT, './packages/x-license/src'),
};

/**
* @param {string} pkgPath
* @returns {{version: string}}
*/
function loadPkg(pkgPath) {
const pkgContent = fs.readFileSync(path.resolve(workspaceRoot, pkgPath, 'package.json'), 'utf8');
const pkgContent = fs.readFileSync(path.resolve(WORKSPACE_ROOT, pkgPath, 'package.json'), 'utf8');
return JSON.parse(pkgContent);
}

Expand All @@ -38,10 +58,18 @@ const treeViewPkg = loadPkg('./packages/x-tree-view');

let localSettings = {};
try {
// eslint-disable-next-line import/no-unresolved
localSettings = require('./next.config.local.js');
} catch (_) {}
} catch (_) {
// Ignore
}

export default withDocsInfra({
transpilePackages: [
// TODO, those shouldn't be needed in the first place
'@mui/monorepo', // Migrate everything to @mui/docs until the @mui/monorepo dependency becomes obsolete
'@mui/docs',
],
// Avoid conflicts with the other Next.js apps hosted under https://mui.com/
assetPrefix: process.env.DEPLOY_ENV === 'development' ? undefined : '/x',
env: {
Expand Down Expand Up @@ -73,20 +101,29 @@ export default withDocsInfra({
);
}

const includesMonorepo = [/(@mui[\\/]monorepo)$/, /(@mui[\\/]monorepo)[\\/](?!.*node_modules)/];

return {
...config,
plugins,
// TODO, this shouldn't be needed in the first place
// Migrate everything from @mui/monorepo to @mui/docs and embed @mui/internal-markdown in @mui/docs
resolveLoader: {
...config.resolveLoader,
alias: {
...config.resolveLoader.alias,
'@mui/internal-markdown/loader': path.resolve(
MONOREPO_PATH,
'./packages/markdown/loader',
),
},
},
resolve: {
...config.resolve,
alias: {
...config.resolve.alias,
'@mui/docs': path.resolve(
currentDirectory,
'../node_modules/@mui/monorepo/packages/mui-docs/src',
),
docs: path.resolve(currentDirectory, '../node_modules/@mui/monorepo/docs'),
...MONOREPO_ALIASES,
...WORKSPACE_ALIASES,
// TODO: get rid of this, replace with @mui/docs
docs: path.resolve(MONOREPO_PATH, './docs'),
docsx: path.resolve(currentDirectory, '../docs'),
},
},
Expand All @@ -102,9 +139,9 @@ export default withDocsInfra({
use: [
options.defaultLoaders.babel,
{
loader: require.resolve('@mui/internal-markdown/loader'),
loader: '@mui/internal-markdown/loader',
options: {
workspaceRoot,
workspaceRoot: WORKSPACE_ROOT,
ignoreLanguagePages: LANGUAGES_IGNORE_PAGES,
languagesInProgress: LANGUAGES_IN_PROGRESS,
env: {
Expand All @@ -119,13 +156,7 @@ export default withDocsInfra({
},
{
test: /\.+(js|jsx|mjs|ts|tsx)$/,
include: includesMonorepo,
use: options.defaultLoaders.babel,
},
{
test: /\.(js|mjs|ts|tsx)$/,
include: [workspaceRoot],
exclude: /node_modules/,
include: [/(@mui[\\/]monorepo)$/, /(@mui[\\/]monorepo)[\\/](?!.*node_modules)/],
use: options.defaultLoaders.babel,
},
{
Expand Down
1 change: 1 addition & 0 deletions docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"@mui/joy": "^5.0.0-beta.32",
"@mui/lab": "^5.0.0-alpha.169",
"@mui/material": "^5.15.14",
"@mui/material-nextjs": "^5.15.11",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was the addition needed for something? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this alias https://github.com/mui/mui-x/pull/13051/files#diff-2ed4f5b03d34a87ef641e9e36af4a98a1c0ddaf74d07ce93665957be69b7b09aL17

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm... But is it even needed in mui-x? 🤔
Does removing it break something?

Copy link
Member Author

@Janpot Janpot May 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's an implicit dependency of the monorepo docs. Dependencies of @mui/monorepo/docs are not installed by package managers. Will be explicit once we move the _app.js content to @mui/docs.

"@mui/styles": "^5.15.14",
"@mui/system": "^5.15.14",
"@mui/utils": "^5.15.14",
Expand Down
5 changes: 3 additions & 2 deletions docs/scripts/formattedTSDemos.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ const yargs = require('yargs');
const ts = require('typescript');
const { fixBabelGeneratorIssues, fixLineEndings } = require('./helpers');

const tsConfigPath = path.resolve(__dirname, '../tsconfig.json');
const DOCS_ROOT = path.resolve(__dirname, '..');
const tsConfigPath = path.resolve(DOCS_ROOT, './tsconfig.json');
const tsConfigFile = ts.readConfigFile(tsConfigPath, (filePath) =>
fs.readFileSync(filePath).toString(),
);
Expand Down Expand Up @@ -95,7 +96,7 @@ async function transpileFile(tsxPath, program, ignoreCache = false) {
if (enableJSXPreview) {
transformOptions.plugins = transformOptions.plugins.concat([
[
require.resolve('docsx/src/modules/utils/babel-plugin-jsx-preview'),
path.resolve(DOCS_ROOT, './src/modules/utils/babel-plugin-jsx-preview'),
{ maxLines: 16, outputFilename: `${tsxPath}.preview` },
],
]);
Expand Down
30 changes: 30 additions & 0 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.