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.

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

[docs] Run the TypeScript version only #18358

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Nov 13, 2019

Based on this comment: #18337 (comment).

Aim to improve Google performance metrics:

Capture-d-ecran-2019-11-13-a-19 45 34 (1)

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation performance labels Nov 13, 2019
@oliviertassinari oliviertassinari force-pushed the docs-run-typescript-only-when-possible branch 2 times, most recently from 7e74e78 to 5105013 Compare November 13, 2019 22:56
@mui-pr-bot
Copy link

mui-pr-bot commented Nov 13, 2019

Details of bundle changes.

Comparing: d9ce3b9...8a92ab1

bundle Size Change Size Gzip Change Gzip
docs.main ▲ +194 B (+0.03% ) 606 kB ▲ +24 B (+0.01% ) 193 kB
@material-ui/core -- 351 kB -- 95.9 kB
@material-ui/core[umd] -- 310 kB -- 89.2 kB
@material-ui/lab -- 171 kB -- 51.6 kB
@material-ui/styles -- 50.8 kB -- 15.4 kB
@material-ui/system -- 14.8 kB -- 4.06 kB
AppBar -- 62.2 kB -- 19.5 kB
Autocomplete -- 126 kB -- 39.8 kB
Avatar -- 61.2 kB -- 19.3 kB
Backdrop -- 66.2 kB -- 20.4 kB
Badge -- 63.8 kB -- 19.7 kB
BottomNavigation -- 60.8 kB -- 19 kB
BottomNavigationAction -- 73.9 kB -- 23.3 kB
Box -- 69.2 kB -- 20.9 kB
Breadcrumbs -- 66.4 kB -- 20.8 kB
Button -- 77.8 kB -- 23.8 kB
ButtonBase -- 72.3 kB -- 22.6 kB
ButtonGroup -- 80.4 kB -- 24.7 kB
Card -- 61.2 kB -- 19.1 kB
CardActionArea -- 73.4 kB -- 23.2 kB
CardActions -- 60.5 kB -- 18.9 kB
CardContent -- 60.4 kB -- 18.9 kB
CardHeader -- 63.5 kB -- 20 kB
CardMedia -- 60.8 kB -- 19.1 kB
Checkbox -- 80.2 kB -- 25.1 kB
Chip -- 80.9 kB -- 24.7 kB
CircularProgress -- 62.5 kB -- 19.7 kB
ClickAwayListener -- 3.87 kB -- 1.56 kB
Collapse -- 66.3 kB -- 20.5 kB
colorManipulator -- 3.83 kB -- 1.52 kB
Container -- 61.6 kB -- 19.2 kB
CssBaseline -- 56 kB -- 17.5 kB
Dialog -- 80.9 kB -- 25.1 kB
DialogActions -- 60.5 kB -- 18.9 kB
DialogContent -- 60.6 kB -- 19 kB
DialogContentText -- 62.5 kB -- 19.6 kB
DialogTitle -- 62.7 kB -- 19.7 kB
Divider -- 61 kB -- 19.2 kB
docs.landing -- 55.8 kB -- 14.3 kB
Drawer -- 82.7 kB -- 25.6 kB
ExpansionPanel -- 69.6 kB -- 21.7 kB
ExpansionPanelActions -- 60.5 kB -- 19 kB
ExpansionPanelDetails -- 60.4 kB -- 18.9 kB
ExpansionPanelSummary -- 76.5 kB -- 24.1 kB
Fab -- 75.2 kB -- 23.3 kB
Fade -- 22 kB -- 7.6 kB
FilledInput -- 72 kB -- 22.3 kB
FormControl -- 62.8 kB -- 19.5 kB
FormControlLabel -- 63.9 kB -- 20.1 kB
FormGroup -- 60.4 kB -- 18.9 kB
FormHelperText -- 61.7 kB -- 19.3 kB
FormLabel -- 61.9 kB -- 19.1 kB
Grid -- 63.5 kB -- 19.9 kB
GridList -- 60.9 kB -- 19.1 kB
GridListTile -- 62.2 kB -- 19.5 kB
GridListTileBar -- 61.6 kB -- 19.3 kB
Grow -- 22.6 kB -- 7.72 kB
Hidden -- 64.5 kB -- 20.2 kB
Icon -- 61.2 kB -- 19.2 kB
IconButton -- 74.5 kB -- 23.2 kB
Input -- 70.9 kB -- 22.1 kB
InputAdornment -- 63.5 kB -- 20 kB
InputBase -- 69 kB -- 21.6 kB
InputLabel -- 63.7 kB -- 19.8 kB
LinearProgress -- 63.8 kB -- 19.9 kB
Link -- 65 kB -- 20.6 kB
List -- 60.8 kB -- 18.9 kB
ListItem -- 75.5 kB -- 23.5 kB
ListItemAvatar -- 60.5 kB -- 18.9 kB
ListItemIcon -- 60.6 kB -- 19 kB
ListItemSecondaryAction -- 60.4 kB -- 18.9 kB
ListItemText -- 63.4 kB -- 19.9 kB
ListSubheader -- 61.2 kB -- 19.2 kB
Menu -- 86.6 kB -- 27.2 kB
MenuItem -- 76.5 kB -- 23.8 kB
MenuList -- 64.4 kB -- 20.1 kB
MobileStepper -- 66.2 kB -- 20.6 kB
Modal -- 14.2 kB -- 4.96 kB
NativeSelect -- 75.2 kB -- 23.7 kB
NoSsr -- 2.19 kB -- 1.04 kB
OutlinedInput -- 72.5 kB -- 22.5 kB
Paper -- 60.7 kB -- 18.9 kB
Popover -- 81 kB -- 25 kB
Popper -- 28.5 kB -- 10.2 kB
Portal -- 2.87 kB -- 1.3 kB
Radio -- 81 kB -- 25.4 kB
RadioGroup -- 61.7 kB -- 19.3 kB
Rating -- 68.4 kB -- 21.9 kB
RootRef -- 4.43 kB -- 1.67 kB
Select -- 112 kB -- 33.4 kB
Skeleton -- 60.9 kB -- 19.1 kB
Slide -- 24.1 kB -- 8.21 kB
Slider -- 74 kB -- 23.3 kB
Snackbar -- 75.6 kB -- 23.5 kB
SnackbarContent -- 64.1 kB -- 20.1 kB
SpeedDial -- 84.4 kB -- 26.6 kB
SpeedDialAction -- 115 kB -- 36.3 kB
SpeedDialIcon -- 63 kB -- 19.8 kB
Step -- 61 kB -- 19.1 kB
StepButton -- 80.7 kB -- 25.3 kB
StepConnector -- 61.1 kB -- 19.2 kB
StepContent -- 67.4 kB -- 21 kB
StepIcon -- 63.1 kB -- 19.6 kB
StepLabel -- 67 kB -- 21 kB
Stepper -- 63.2 kB -- 19.9 kB
styles/createMuiTheme -- 15.2 kB -- 5.36 kB
SvgIcon -- 61.5 kB -- 19.1 kB
SwipeableDrawer -- 90.1 kB -- 28 kB
Switch -- 79.5 kB -- 24.7 kB
Tab -- 74.7 kB -- 23.7 kB
Table -- 61 kB -- 19.1 kB
TableBody -- 60.5 kB -- 18.9 kB
TableCell -- 62.5 kB -- 19.6 kB
TableFooter -- 60.5 kB -- 18.9 kB
TableHead -- 60.5 kB -- 18.9 kB
TablePagination -- 139 kB -- 40.5 kB
TableRow -- 61 kB -- 19.1 kB
TableSortLabel -- 75.7 kB -- 23.9 kB
Tabs -- 83.8 kB -- 26.7 kB
TextareaAutosize -- 5.06 kB -- 2.11 kB
TextField -- 121 kB -- 35.4 kB
ToggleButton -- 74.5 kB -- 23.5 kB
ToggleButtonGroup -- 61.6 kB -- 19.4 kB
Toolbar -- 60.8 kB -- 19 kB
Tooltip -- 98.9 kB -- 31.3 kB
TreeItem -- 72 kB -- 22.7 kB
TreeView -- 64.8 kB -- 20.3 kB
Typography -- 62.1 kB -- 19.3 kB
useAutocomplete -- 12.1 kB -- 4.47 kB
useMediaQuery -- 2.49 kB -- 1.05 kB
Zoom -- 22.1 kB -- 7.6 kB

Generated by 🚫 dangerJS against 8a92ab1

@oliviertassinari oliviertassinari force-pushed the docs-run-typescript-only-when-possible branch 2 times, most recently from 1948488 to 03b1475 Compare November 13, 2019 23:47
@eps1lon
Copy link
Member

eps1lon commented Nov 14, 2019

This forces docs contributions to use typescript. We are not there yet. If anything we should only run js. Hot reloading for TS is already possible

@oliviertassinari
Copy link
Member Author

What's the issue with forcing TypeScript? It seems that most of the valuable contributions comes from developers that know TypeScript. Also, I believe that new contributors could still write JavaScript in the .tsx file, iterate on it until somebody help for fixing the typing errors.

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Nov 14, 2019

In any case, my main interest was to get the Netlify build working to measure the performance impact. If we move forward or not would be a next step to consider after we get the results. I'm trying to get a sense on what's the biggest bottleneck in performance and so we can have a better idea of what we should prioritize. (my second suspect is markdown).

@oliviertassinari oliviertassinari force-pushed the docs-run-typescript-only-when-possible branch 6 times, most recently from ea09e5b to b207383 Compare November 14, 2019 11:19
@oliviertassinari oliviertassinari force-pushed the docs-run-typescript-only-when-possible branch from b207383 to f224cfc Compare November 14, 2019 11:34
@oliviertassinari
Copy link
Member Author

oliviertassinari commented Nov 14, 2019

The performance impact doesn't seem very significant.

@oliviertassinari oliviertassinari force-pushed the docs-run-typescript-only-when-possible branch 2 times, most recently from c74704f to 10a4779 Compare November 14, 2019 12:17
@oliviertassinari oliviertassinari force-pushed the docs-run-typescript-only-when-possible branch from 10a4779 to 8a92ab1 Compare November 14, 2019 12:35
@oliviertassinari
Copy link
Member Author

The markdown comment doesn't seem to have a significant impact either.

@eps1lon
Copy link
Member

eps1lon commented Nov 14, 2019

What's the issue with forcing TypeScript?

Every time this topic comes up I have to push back against this and get upvoted by people who contribute the most to this repository. The type story for react can be very frustrating which I can navigate because I'm familiar with almost every issue by now. I would not want anybody to waste a single second on an issue that can be solved with as any or @ts-ignore. At that point why not just write JS?

We can start this discussion again in a few weeks if you want but so far we've always settled on "don't migrate to TS yet". It seems reopening this issue without any change in the TS infra will result in the same conclusion.

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Nov 14, 2019

I'm sorry, I don't have the whole context. I don't understand the problems it would create. My incentive is to put structures in place that help to have a great TypeScript support.

From your perspective, what's the main issue with such change? Thank you!

@oliviertassinari oliviertassinari deleted the docs-run-typescript-only-when-possible branch February 8, 2020 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation performance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants