-
Notifications
You must be signed in to change notification settings - Fork 34
[docs-infra] Fix Material UI docs links in code-infra-dashboard PR comment #1770
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.
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
Merged
brijeshb42
merged 5 commits into
mui:master
from
ZeeshanTamboli:fix-netlify-material-ui-docs-links
Aug 17, 2026
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
876c89d
Fix Material UI docs links in code-infra-dashboard PR comment
ZeeshanTamboli 2234031
Merge branch 'master' into fix-netlify-material-ui-docs-links
ZeeshanTamboli 0ff13fc
Update logic
ZeeshanTamboli 7b0a60b
Update test
ZeeshanTamboli cf30b85
Merge branch 'master' into fix-netlify-material-ui-docs-links
ZeeshanTamboli File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
apps/code-infra-dashboard/src/lib/ciReports/formatMaterialUiDocPath.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| import { describe, expect, it } from 'vitest'; | ||
| import { formatMaterialUiDocPath } from './formatMaterialUiDocPath'; | ||
|
|
||
| describe('formatMaterialUiDocPath', () => { | ||
| it.each([ | ||
| ['buttons', 'react-button'], | ||
| ['radio-buttons', 'react-radio-button'], | ||
| ['tabs', 'react-tabs'], | ||
| ['icons', 'icons'], | ||
| ['transitions', 'transitions'], | ||
| ['new-component', 'react-new-component'], | ||
| ])('should map the %s source directory to %s', (sourceDirectory, routeSegment) => { | ||
| expect( | ||
| formatMaterialUiDocPath(`docs/data/material/components/${sourceDirectory}/ExampleDemo.tsx`), | ||
| ).toBe(`/material-ui/${routeSegment}/`); | ||
| }); | ||
|
|
||
| it('should map non-component Material UI pages without duplicating the product prefix', () => { | ||
| expect(formatMaterialUiDocPath('docs/data/material/guides/testing/testing.md')).toBe( | ||
| '/material-ui/guides/testing', | ||
| ); | ||
| }); | ||
|
|
||
| it('should map root Material UI data files to the product root', () => { | ||
| expect(formatMaterialUiDocPath('docs/data/material/pages.ts')).toBe('/material-ui/'); | ||
| }); | ||
|
|
||
| it('should map shared documentation data to its containing directory', () => { | ||
| expect(formatMaterialUiDocPath('docs/data/about/teamMembers.json')).toBe('/about'); | ||
| }); | ||
|
|
||
| it('should return null for unsupported files', () => { | ||
| expect(formatMaterialUiDocPath('docs/data/material/components/tabs/preview.png')).toBeNull(); | ||
| expect(formatMaterialUiDocPath('packages/mui-material/src/Tabs/Tabs.tsx')).toBeNull(); | ||
| }); | ||
| }); |
79 changes: 79 additions & 0 deletions
79
apps/code-infra-dashboard/src/lib/ciReports/formatMaterialUiDocPath.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| const DOCS_DATA_PREFIX = 'docs/data/'; | ||
| const MATERIAL_UI_COMPONENTS_PREFIX = 'material/components/'; | ||
| const MATERIAL_UI_PREFIX = 'material/'; | ||
| const SUPPORTED_DOC_FILE_EXTENSIONS = ['.md', '.mdx', '.js', '.jsx', '.ts', '.tsx', '.json']; | ||
|
|
||
| const MATERIAL_UI_ROUTES_WITHOUT_REACT_PREFIX = new Set([ | ||
| 'about-the-lab', | ||
| 'icons', | ||
| 'material-icons', | ||
| 'transitions', | ||
| ]); | ||
|
|
||
| const MATERIAL_UI_COMPONENT_ROUTE_ALIASES = new Map([ | ||
| ['avatars', 'avatar'], | ||
| ['badges', 'badge'], | ||
| ['buttons', 'button'], | ||
| ['cards', 'card'], | ||
| ['checkboxes', 'checkbox'], | ||
| ['dialogs', 'dialog'], | ||
| ['dividers', 'divider'], | ||
| ['drawers', 'drawer'], | ||
| ['links', 'link'], | ||
| ['lists', 'list'], | ||
| ['menus', 'menu'], | ||
| ['radio-buttons', 'radio-button'], | ||
| ['selects', 'select'], | ||
| ['snackbars', 'snackbar'], | ||
| ['steppers', 'stepper'], | ||
| ['switches', 'switch'], | ||
| ['text-fields', 'text-field'], | ||
| ['tooltips', 'tooltip'], | ||
| ]); | ||
|
|
||
| /** | ||
| * Maps a Material UI documentation source file to its public page path. | ||
| */ | ||
| export function formatMaterialUiDocPath(filePath: string): string | null { | ||
| if ( | ||
| !filePath.startsWith(DOCS_DATA_PREFIX) || | ||
| !SUPPORTED_DOC_FILE_EXTENSIONS.some((extension) => filePath.endsWith(extension)) | ||
| ) { | ||
| return null; | ||
| } | ||
|
|
||
| const fileNameSeparatorIndex = filePath.lastIndexOf('/'); | ||
| if (fileNameSeparatorIndex < DOCS_DATA_PREFIX.length) { | ||
| return null; | ||
| } | ||
|
|
||
| const pageDirectory = filePath.slice(DOCS_DATA_PREFIX.length, fileNameSeparatorIndex); | ||
| if (pageDirectory === 'material') { | ||
| return '/material-ui/'; | ||
| } | ||
|
|
||
| if (pageDirectory.startsWith(MATERIAL_UI_COMPONENTS_PREFIX)) { | ||
| const componentPath = pageDirectory.slice(MATERIAL_UI_COMPONENTS_PREFIX.length); | ||
| const nestedDirectorySeparatorIndex = componentPath.indexOf('/'); | ||
| const componentDirectory = | ||
| nestedDirectorySeparatorIndex === -1 | ||
| ? componentPath | ||
| : componentPath.slice(0, nestedDirectorySeparatorIndex); | ||
|
|
||
| // Get from exception route alias collection for plural folders to singlular routes or fallback | ||
| // to normal component directory for other and new components without plural folders to singular routes. | ||
| // This will keep the logic in sync for newly introduced components. | ||
| const routeName = | ||
| MATERIAL_UI_COMPONENT_ROUTE_ALIASES.get(componentDirectory) ?? componentDirectory; | ||
| const routeSegment = MATERIAL_UI_ROUTES_WITHOUT_REACT_PREFIX.has(componentDirectory) | ||
| ? routeName | ||
| : `react-${routeName}`; | ||
| return `/material-ui/${routeSegment}/`; | ||
| } | ||
|
|
||
| if (pageDirectory.startsWith(MATERIAL_UI_PREFIX)) { | ||
| return `/material-ui/${pageDirectory.slice(MATERIAL_UI_PREFIX.length)}`; | ||
| } | ||
|
|
||
| return `/${pageDirectory}`; | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One could make this a set as well and do the check with
to avoid the O(n) complexity. It's not that critical for this use-case though.