Skip to content

Commit f16e2db

Browse files
[docs] Improve markdownlint (mui#6518)
1 parent fe56c20 commit f16e2db

6 files changed

+90
-112
lines changed

.markdownlint-cli2.cjs

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
const baseline = require('@mui/monorepo/.markdownlint-cli2.cjs');
2+
3+
module.exports = baseline;

.markdownlint.jsonc

-26
This file was deleted.

.markdownlintignore

-4
This file was deleted.

CHANGELOG.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
1717
- [`MultiInputDateRangeField` / `SingleInputDateRangeField`](https://next.mui.com/x/react-date-pickers/date-range-field/) to edit date range
1818
- [`MultiInputTimeRangeField`](https://next.mui.com/x/react-date-pickers/time-range-field/) to edit time range with two inputs
1919
- [`MultiInputDateTimeRangeField`](https://next.mui.com/x/react-date-pickers/date-time-range-field/) to edit date and time range with two inputs
20-
20+
2121
⚠️ These components are unstable.
2222
They might receive breaking changes on their props to have the best components possible by the time of the stable release.
2323

@@ -71,7 +71,7 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
7171
The `DialogProps` prop has been replaced by a `dialog` component props slot on responsive and mobile pickers:
7272

7373
```diff
74-
// Same on MobileDatePicker, DateTimePicker, MobileDateTimePicker,
74+
// Same on MobileDatePicker, DateTimePicker, MobileDateTimePicker,
7575
// TimePicker, MobileTimePicker, DateRangePicker and MobileDateRangePicker.
7676
<DatePicker
7777
- DialogProps={{ backgroundColor: 'red' }}
@@ -82,7 +82,7 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
8282
The `PaperProps` prop has been replaced by a `desktopPaper` component props slot on all responsive and desktop pickers:
8383

8484
```diff
85-
// Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
85+
// Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
8686
// TimePicker, DesktopTimePicker, DateRangePicker and DesktopDateRangePicker.
8787
<DatePicker
8888
- PaperProps={{ backgroundColor: 'red' }}
@@ -93,7 +93,7 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
9393
The `PopperProps` prop has been replaced by a `popper` component props slot on all responsive and desktop pickers:
9494

9595
```diff
96-
// Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
96+
// Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
9797
// TimePicker, DesktopTimePicker, DateRangePicker and DesktopDateRangePicker.
9898
<DatePicker
9999
- PopperProps={{ onClick: handleClick }}
@@ -104,7 +104,7 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
104104
The `TransitionComponent` prop has been replaced by a `DesktopTransition` component slot on all responsive and desktop pickers:
105105

106106
```diff
107-
// Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
107+
// Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
108108
// TimePicker, DesktopTimePicker, DateRangePicker and DesktopDateRangePicker.
109109
<DatePicker
110110
- TransitionComponent={Fade}
@@ -115,14 +115,14 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
115115
The `TrapFocusProps` prop has been replaced by a `desktopTrapFocus` component props slot on all responsive and desktop pickers:
116116

117117
```diff
118-
// Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
118+
// Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
119119
// TimePicker, DesktopTimePicker, DateRangePicker and DesktopDateRangePicker.
120120
<DatePicker
121121
- TrapFocusProps={{ isEnabled: () => false }}
122122
+ componentsProps={{ desktopTrapFocus: { isEnabled: () => false }}}
123123
/>
124124
```
125-
125+
126126
- The view components allowing to pick a date or parts of a date without an input have been renamed to better fit their usage:
127127

128128
```diff
@@ -506,9 +506,9 @@ You can find more information about the new api, including how to set those tran
506506
- The deprecated `locale` prop of the `LocalizationProvider` component have been renamed `adapterLocale`:
507507

508508
```diff
509-
<LocalizationProvider
509+
<LocalizationProvider
510510
dateAdapter={AdapterDayjs}
511-
- locale="fr"
511+
- locale="fr"
512512
+ adapterLocale="fr"
513513
>
514514
{children}

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"jsonlint": "node ./scripts/jsonlint.js",
2020
"eslint": "eslint . --cache --report-unused-disable-directives --ext .js,.ts,.tsx --max-warnings 0",
2121
"eslint:ci": "eslint . --report-unused-disable-directives --ext .js,.ts,.tsx --max-warnings 0",
22-
"markdownlint": "markdownlint '**/*.md' --config .markdownlint.jsonc",
22+
"markdownlint": "markdownlint-cli2 \"**/*.md\"",
2323
"prettier": "node ./scripts/prettier.js --branch next",
2424
"prettier:all": "node ./scripts/prettier.js write",
2525
"proptypes": "cross-env BABEL_ENV=development babel-node -i \"/node_modules/(?!@mui)/\" -x .ts,.tsx,.js ./docs/scripts/generateProptypes.ts",
@@ -145,7 +145,7 @@
145145
"karma-sourcemap-loader": "^0.3.8",
146146
"karma-webpack": "^5.0.0",
147147
"lerna": "^5.6.2",
148-
"markdownlint-cli": "^0.31.1",
148+
"markdownlint-cli2": "^0.5.1",
149149
"mocha": "^10.0.0",
150150
"nyc": "^15.1.0",
151151
"playwright": "^1.21.1",

0 commit comments

Comments
 (0)