Skip to content

Commit c1ae102

Browse files
[docs] Enforce no trailing spaces (mui#34762)
1 parent 02451c6 commit c1ae102

File tree

6 files changed

+43
-26
lines changed

6 files changed

+43
-26
lines changed

Diff for: .markdownlint-cli2.cjs

+8
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
const straightQuotes = require('./packages/markdownlint-rule-mui/straight-quotes');
22
const gitDiff = require('./packages/markdownlint-rule-mui/git-diff');
33

4+
// https://github.com/DavidAnson/markdownlint#rules--aliases
45
module.exports = {
56
config: {
67
default: true,
78
MD004: false, // MD004/ul-style. Buggy
9+
MD009: {
10+
// MD009/no-trailing-spaces
11+
br_spaces: 0,
12+
strict: true,
13+
list_item_empty_lines: false,
14+
},
815
MD013: false, // MD013/line-length. Already handled by Prettier.
916
MD014: false, // MD014/commands-show-output. It's OK.
1017
MD024: { siblings_only: true }, // MD024/no-duplicate-heading/no-duplicate-header
@@ -31,6 +38,7 @@ module.exports = {
3138
'**/node_modules/**',
3239
'**/*-zh.md',
3340
'**/*-pt.md',
41+
'**/build/**',
3442
'.github/PULL_REQUEST_TEMPLATE.md',
3543
],
3644
};

Diff for: CHANGELOG.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1701,7 +1701,8 @@ All contributors of this release in alphabetical order: @abhinav-22-tech, @ainat
17011701

17021702
_Apr 18, 2022_
17031703

1704-
A big thanks to the 11 contributors who made this release possible. This release is mostly about 🐛 bug fixes and 📚 documentation improvements.
1704+
A big thanks to the 11 contributors who made this release possible.
1705+
This release is mostly about 🐛 bug fixes and 📚 documentation improvements.
17051706

17061707
17071708

@@ -1760,7 +1761,7 @@ All contributors of this release in alphabetical order: @abaker93, @cherniavskii
17601761

17611762
_Apr 11, 2022_
17621763

1763-
A big thanks to the 8 contributors who made this release possible.
1764+
A big thanks to the 8 contributors who made this release possible.
17641765
This release is mostly about 🐛 bug fixes and 📚 documentation improvements.
17651766

17661767

Diff for: docs/data/material/components/material-icons/material-icons.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ includes the 2,100+ official [Material Icons](https://fonts.google.com/icons?ico
1616

1717
:::info
1818
The `@mui/icons-material` package depends on `@mui/material`, which requires Emotion packages.
19+
If you don't use Material UI in your project yet, install the icons package with:
20+
`npm install @mui/icons-material @mui/material @emotion/styled @emotion/react`.
1921

20-
If you don't use Material UI in your project yet, install the icons package with `npm install @mui/icons-material @mui/material @emotion/styled @emotion/react`.
2122
See the [Installation](/material-ui/getting-started/installation/) page for additional docs about how to make sure everything is set up correctly.
2223
:::
2324

Diff for: docs/data/material/guides/interoperability/interoperability.md

-5
Original file line numberDiff line numberDiff line change
@@ -883,8 +883,3 @@ There is [an ESLint plugin](https://docs.tss-react.dev/detecting-unused-classes)
883883
⚠️ **Keep `@emotion/styled` as a dependency of your project**. Even if you never use it explicitly,
884884
it's a peer dependency of `@mui/material`.
885885
:::
886-
887-
:::warning
888-
For [Storybook](https://storybook.js.org): At the time of this writing, Storybook still uses Emotion 10 by default.
889-
Material UI and TSS use Emotion 11, so you must make [some changes](https://github.com/InseeFrLab/onyxia-ui/blob/324de62248074582b227e584c53fb2e123f5325f/.storybook/main.js#L31-L32) to `.storybook/main.js` in order to use Storybook with Material UI.
890-
:::

Diff for: docs/pages/blog/mui-x-v6-alpha-zero.md

+29-17
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ authors: ['josefreitas']
66
tags: ['MUI X', 'News']
77
---
88

9-
We're kicking off the development of [MUI X v6](https://github.com/mui/mui-x/releases/tag/v6.0.0-alpha.0). Both the Data Grid and the Date and Time Pickers will get a new major version. We want to share our plans and invite you to join us on this next step.
9+
We're kicking off the development of [MUI X v6](https://github.com/mui/mui-x/releases/tag/v6.0.0-alpha.0).
10+
Both the Data Grid and the Date and Time Pickers will get a new major version.
11+
We want to share our plans and invite you to join us on this next step.
1012

1113
:::warning
1214
It's important to note that only MUI X is getting a new version—MUI Core (including Material UI) will remain in v5 for now.
@@ -15,11 +17,15 @@ You can rest assured that all MUI X v6 components will be fully compatible with
1517

1618
## What's the plan to get to a stable release?
1719

18-
Before officially releasing v6, we'll go through a few months with pre-releases. We'll follow the current weekly release process and [semver versioning](https://semver.org/); the difference now is that instead of v5, we'll ship v6 pre-release packages.
20+
Before officially releasing v6, we'll go through a few months with pre-releases.
21+
We'll follow the current weekly release process and [semver versioning](https://semver.org/); the difference now is that instead of v5, we'll ship v6 pre-release packages.
1922

20-
First, in the alpha phase, we'll introduce all the breaking changes planned for this major. We'll be exploring a bit, so it's expected that some APIs will be unstable—not in terms of functionality, but we may need to rename or adjust parameters. This phase is planned to take about two months.
23+
First, in the alpha phase, we'll introduce all the breaking changes planned for this major.
24+
We'll be exploring a bit, so it's expected that some APIs will be unstable—not in terms of functionality, but we may need to rename or adjust parameters.
25+
This phase is planned to take about two months.
2126

22-
Next comes the beta phase, where the APIs will be more stable, and we'll focus on fixing bugs and polishing the hard edges. This phase is planned to take about one month.
27+
Next comes the beta phase, where the APIs will be more stable, and we'll focus on fixing bugs and polishing the hard edges.
28+
This phase is planned to take about one month.
2329

2430
:::info
2531
Disclaimer: This timeline—2 months in alpha, 1 month in beta—is purely for reference.
@@ -49,19 +55,20 @@ The next version's documentation is in the `next` subdomain.
4955

5056
## What's coming next?
5157

52-
The following is a list of enhancements in the pipeline for v6. It contains the highlights that will be included in the first versions.
58+
The following is a list of enhancements in the pipeline for v6.
59+
It contains the highlights that will be included in the first versions.
5360

5461
### Data Grid
5562

56-
- **Extended customization abilities**.
57-
We want to empower more users to employ the Data Grid for complex use cases.
63+
- **Extended customization abilities**.\
64+
We want to empower more users to employ the Data Grid for complex use cases.
5865

5966
- [ApiRef in the community package](https://github.com/mui/mui-x/issues/6147).
6067
- [Filtering on header](https://github.com/mui/mui-x/issues/6247).
6168
- [Use the Data Grid internal components outside the grid](https://github.com/mui/mui-x/issues/2522).
6269

63-
- **Improved look & feel**
64-
We're polishing edges in terms of design and usability.
70+
- **Improved look & feel**\
71+
We're polishing edges in terms of design and usability.
6572

6673
- [New column menu](https://github.com/mui/mui-x/issues/4929).
6774
- [New column visibility panel](https://github.com/mui/mui-x/issues/5700).
@@ -72,16 +79,17 @@ The following is a list of enhancements in the pipeline for v6. It contains the
7279

7380
### Date and Time Pickers
7481

75-
- **Improved UX**
76-
In the previous version we focused on developer experience and overall stability of the components. Now we're tackling ways to improve usability.
82+
- **Improved UX**\
83+
In the previous version we focused on developer experience and overall stability of the components.
84+
Now we're tackling ways to improve usability.
7785

7886
- [Remove the clock view on time pickers (for desktop)](https://github.com/mui/mui-x/issues/4483).
7987
- [Visually edit a range by dragging date markers](https://github.com/mui/mui-x/issues/5311).
8088
- [Range shortcuts](https://github.com/mui/mui-x/issues/4563).
8189
- [A new text input for date and time values, retiring the mask solution (early preview)](https://next.mui.com/x/react-date-pickers/date-field/).
8290

83-
- **Improved Customization**
84-
v6 will be packed with new customization abilities and support for new use cases.
91+
- **Improved Customization**\
92+
v6 will be packed with new customization abilities and support for new use cases.
8593
- [The new fields are based on a headless approach with custom hooks. (Documentation is coming soon)](https://next.mui.com/x/react-date-pickers/date-field/#headless-usage).
8694
- [Single Input for Date Range](https://github.com/mui/mui-x/issues/5193).
8795
- [Enable customization through component slots on every component](https://github.com/mui/mui-x/issues/4466).
@@ -92,13 +100,17 @@ You can check our [roadmap](https://github.com/mui/mui-x/projects/1) for the ful
92100

93101
## How to migrate?
94102

95-
We've prepared a [migration guide](https://deploy-preview-6235--material-ui-x.netlify.app/x/react-data-grid/migration-v5/), and we'll continuously update it as we make any breaking changes during the pre-releases. It lists every update you need to make to your code to use the most recent packages.
103+
We've prepared a [migration guide](https://deploy-preview-6235--material-ui-x.netlify.app/x/react-data-grid/migration-v5/), and we'll continuously update it as we make any breaking changes during the pre-releases.
104+
It lists every update you need to make to your code to use the most recent packages.
96105

97-
We highly encourage you to try the new version. It is, after all, an improvement over the solid foundation we established with v5.
106+
We highly encourage you to try the new version.
107+
It is, after all, an improvement over the solid foundation we established with v5.
98108

99109
## How to get involved?
100110

101-
Please consider joining our alpha testers group channel and [connecting with us](https://forms.gle/vsBv6CLPz9h57xg8A) for a user interview.
111+
Please consider joining our alpha testers group channel and [connecting with us](https://forms.gle/vsBv6CLPz9h57xg8A) for a user interview.
102112
You'll get an insider's perspective on the development, and you'll be able to help us iterate early on the new features.
103113

104-
As always, we're happy to get your feedback. You can participate in the discussion by commenting on new features or reporting bugs in our [GitHub repository](https://github.com/mui/mui-x/issues/new/choose). Finally, you can follow every step of the development through our [changelog](https://github.com/mui/mui-x/releases).
114+
As always, we're happy to get your feedback.
115+
You can participate in the discussion by commenting on new features or reporting bugs in our [GitHub repository](https://github.com/mui/mui-x/issues/new/choose).
116+
Finally, you can follow every step of the development through our [changelog](https://github.com/mui/mui-x/releases).

Diff for: packages/markdownlint-rule-mui/straight-quotes.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ module.exports = {
1111
// closing double quote: \xE2\x80\x9D
1212
if (line.match('[‘’“”]')) {
1313
onError({
14-
lineNumber,
14+
lineNumber: lineNumber + 1,
1515
details: `For line: ${line}`,
1616
});
1717
}

0 commit comments

Comments
 (0)