[docs] Improve markdownlint (mui#6518)

alexfauquette · Oct 15, 2022 · f16e2db · f16e2db
1 parent fe56c20
commit f16e2db
Show file tree

Hide file tree

Showing 6 changed files with 90 additions and 112 deletions.
diff --git a/.markdownlint-cli2.cjs b/.markdownlint-cli2.cjs
@@ -0,0 +1,3 @@
+const baseline = require('@mui/monorepo/.markdownlint-cli2.cjs');
+
+module.exports = baseline;
diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc
diff --git a/.markdownlintignore b/.markdownlintignore
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,7 +17,7 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
   - [`MultiInputDateRangeField` / `SingleInputDateRangeField`](https://next.mui.com/x/react-date-pickers/date-range-field/) to edit date range
   - [`MultiInputTimeRangeField`](https://next.mui.com/x/react-date-pickers/time-range-field/) to edit time range with two inputs
   - [`MultiInputDateTimeRangeField`](https://next.mui.com/x/react-date-pickers/date-time-range-field/) to edit date and time range with two inputs
-  
+
   ⚠️ These components are unstable.
   They might receive breaking changes on their props to have the best components possible by the time of the stable release.
 
@@ -71,7 +71,7 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
   The `DialogProps` prop has been replaced by a `dialog` component props slot on responsive and mobile pickers:
 
   ```diff
-  // Same on MobileDatePicker, DateTimePicker, MobileDateTimePicker, 
+  // Same on MobileDatePicker, DateTimePicker, MobileDateTimePicker,
   // TimePicker, MobileTimePicker, DateRangePicker and MobileDateRangePicker.
   <DatePicker
   -  DialogProps={{ backgroundColor: 'red' }}
@@ -82,7 +82,7 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
   The `PaperProps` prop has been replaced by a `desktopPaper` component props slot on all responsive and desktop pickers:
 
   ```diff
-  // Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker, 
+  // Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
   // TimePicker, DesktopTimePicker, DateRangePicker and DesktopDateRangePicker.
   <DatePicker
   -  PaperProps={{ backgroundColor: 'red' }}
@@ -93,7 +93,7 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
   The `PopperProps` prop has been replaced by a `popper` component props slot on all responsive and desktop pickers:
 
   ```diff
-  // Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker, 
+  // Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
   // TimePicker, DesktopTimePicker, DateRangePicker and DesktopDateRangePicker.
   <DatePicker
   -  PopperProps={{ onClick: handleClick }}
@@ -104,7 +104,7 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
   The `TransitionComponent` prop has been replaced by a `DesktopTransition` component slot on all responsive and desktop pickers:
 
   ```diff
-  // Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker, 
+  // Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
   // TimePicker, DesktopTimePicker, DateRangePicker and DesktopDateRangePicker.
   <DatePicker
   -  TransitionComponent={Fade}
@@ -115,14 +115,14 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss
   The `TrapFocusProps` prop has been replaced by a `desktopTrapFocus` component props slot on all responsive and desktop pickers:
 
   ```diff
-  // Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker, 
+  // Same on DesktopDatePicker, DateTimePicker, DesktopDateTimePicker,
   // TimePicker, DesktopTimePicker, DateRangePicker and DesktopDateRangePicker.
   <DatePicker
   -  TrapFocusProps={{ isEnabled: () => false }}
   +  componentsProps={{ desktopTrapFocus: { isEnabled: () => false }}}
   />
   ```
-  
+
 - The view components allowing to pick a date or parts of a date without an input have been renamed to better fit their usage:
 
   ```diff
@@ -506,9 +506,9 @@ You can find more information about the new api, including how to set those tran
 - The deprecated `locale` prop of the `LocalizationProvider` component have been renamed `adapterLocale`:
 
   ```diff
-  <LocalizationProvider 
+  <LocalizationProvider
     dateAdapter={AdapterDayjs}
-  -  locale="fr" 
+  -  locale="fr"
   +  adapterLocale="fr"
   >
     {children}

diff --git a/package.json b/package.json
@@ -19,7 +19,7 @@
     "jsonlint": "node ./scripts/jsonlint.js",
     "eslint": "eslint . --cache --report-unused-disable-directives --ext .js,.ts,.tsx --max-warnings 0",
     "eslint:ci": "eslint . --report-unused-disable-directives --ext .js,.ts,.tsx --max-warnings 0",
-    "markdownlint": "markdownlint '**/*.md' --config .markdownlint.jsonc",
+    "markdownlint": "markdownlint-cli2 \"**/*.md\"",
     "prettier": "node ./scripts/prettier.js --branch next",
     "prettier:all": "node ./scripts/prettier.js write",
     "proptypes": "cross-env BABEL_ENV=development babel-node -i \"/node_modules/(?!@mui)/\" -x .ts,.tsx,.js ./docs/scripts/generateProptypes.ts",
@@ -145,7 +145,7 @@
     "karma-sourcemap-loader": "^0.3.8",
     "karma-webpack": "^5.0.0",
     "lerna": "^5.6.2",
-    "markdownlint-cli": "^0.31.1",
+    "markdownlint-cli2": "^0.5.1",
     "mocha": "^10.0.0",
     "nyc": "^15.1.0",
     "playwright": "^1.21.1",
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		const baseline = require('@mui/monorepo/.markdownlint-cli2.cjs');

		module.exports = baseline;