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-infra] Test new vale config sharing #12132

Open
wants to merge 6 commits into
base: next
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions .github/styles/Blog/BrandName.yml

This file was deleted.

24 changes: 0 additions & 24 deletions .github/styles/Blog/ComponentNaming.yml

This file was deleted.

15 changes: 0 additions & 15 deletions .github/styles/Blog/ComposedWords.yml

This file was deleted.

19 changes: 0 additions & 19 deletions .github/styles/Blog/NamingConventions.yml

This file was deleted.

14 changes: 0 additions & 14 deletions .github/styles/Blog/NoCompanyName.yml

This file was deleted.

11 changes: 0 additions & 11 deletions .github/styles/Blog/Typos.yml

This file was deleted.

Empty file removed .github/styles/Vocab/accept.txt
Empty file.
Empty file removed .github/styles/Vocab/reject.txt
Empty file.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,4 @@ dist
node_modules
size-snapshot.json
performance-snapshot.json
.github/styles/Google
.github/styles/write-good
.github/styles/
14 changes: 4 additions & 10 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,13 @@
StylesPath = .github/styles
MinAlertLevel = suggestion

Packages = Google
Packages = Google, https://github.com/alexfauquette/material-ui/raw/comon-vale-config/docs/writing-rules.zip
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To update after mui/material-ui#41176 is merged


[*.md]
# Ignore code injection which start with {{...
BlockIgnores = {{.*

# Custom syle
# BasedOnStyles = Blog

Blog.ComposedWords = YES
Blog.NamingConventions = YES
Blog.Typos = YES
Blog.BrandName = YES
Blog.NoCompanyName = YES
BasedOnStyles = writing-rules

# Google:
Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'.
Expand All @@ -24,10 +17,11 @@ Google.OxfordComma = YES
Google.Quotes = YES # Commas and periods go inside quotation marks.
Google.Spelling = YES # In general, use American spelling (word ending with 'nised' or 'logue')
Google.We = YES # Try to avoid using first-person plural
Google.Latin = YES # Try to avoid latin expressions e.g. and i.e.

# Those rules are not repected a lot
# Google.Passive = YES # In general, use active voice instead of passive voice.
# Google.Will = YES # Avoid using will
Google.Will = YES # Avoid using will

# False positives with "1st" nearly no use in our doc
# Google.Units = YES # Put a nonbreaking space between the number and the unit
12 changes: 6 additions & 6 deletions docs/data/charts/gauge/gauge.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: React Gauge chart
title: React Gauge
productId: x-charts
components: Gauge, GaugeContainer
packageName: '@mui/x-charts'
Expand All @@ -9,7 +9,7 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/meter/

# Charts - Gauge

<p class="description">Gauge charts let the user evaluate metrics.</p>
<p class="description">Gauge let the user evaluate metrics.</p>

{{"component": "modules/components/ComponentLinkHeader.js", "design": false}}

Expand All @@ -21,7 +21,7 @@ The Gauge displays a numeric value that varies within a defined range.

## Value range

The Gauge chart's value is provided through the `value` props, which accept a value range between 0 and 100.
The Gauge value is provided through the `value` props, which accept a value range between 0 and 100.
To modify it, use the `valueMin` and `valueMax` props.

{{"demo": "GaugeValueRangeNoSnap.js"}}
Expand All @@ -37,7 +37,7 @@ Modify the arc shape with the following props:
{{"demo": "ArcPlaygroundNoSnap.js", "bg": "playground", "hideToolbar": true }}

:::success
Notice that the arc position is computed to let the Gauge chart take as much space as possible in the drawing area.
Notice that the arc position is computed to let the Gauge take as much space as possible in the drawing area.

Use the `cx` and/or `cy` props to fix the coordinate of the arc center.
:::
Expand Down Expand Up @@ -66,7 +66,7 @@ For a full reference list, visit the [API page](/x/api/charts/gauge/#classes).

### Using the default Gauge

To insert more elements into the Gauge chart, the first option would be to add them as children, which means they will be stacked on top of the default rendering.
To insert more elements into the Gauge, the first option would be to add them as children, which means they will be stacked on top of the default rendering.

```tsx
import { Gauge } from '@mui/x-charts/Gauge';
Expand Down Expand Up @@ -113,7 +113,7 @@ To create your own components, use the `useGaugeState` hook which provides all y

## Accessibility

The MUI X Gauge chart is compliant with the [Meter ARIA pattern](https://www.w3.org/WAI/ARIA/apg/patterns/meter/), which includes the addition of the `meter` role to the parent container and correct usage of the `aria-valuenow`, `aria-valuemin`, and `aria-valuemax` attributes.
The MUI X Gauge is compliant with the [Meter ARIA pattern](https://www.w3.org/WAI/ARIA/apg/patterns/meter/), which includes the addition of the `meter` role to the parent container and correct usage of the `aria-valuenow`, `aria-valuemin`, and `aria-valuemax` attributes.

### Label

Expand Down
2 changes: 1 addition & 1 deletion docs/data/charts/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ packageName: '@mui/x-charts'
The `@mui/x-charts` is an MIT library for rendering charts relying on [D3.js](https://d3js.org/) for data manipulation and SVG for rendering.
And, like other MUI X components, charts are production-ready components that integrate smoothly into your app.

With a high level of customization, MUI X Charts provides on three levels of customization layers: **single components** with great defaults, extensive **configuration props**, and **subcomponents** for flexible composition.
With a high level of customization, MUI Charts provides on three levels of customization layers: **single components** with great defaults, extensive **configuration props**, and **subcomponents** for flexible composition.
Additionally, you can also use all the [MUI System](https://mui.com/system/getting-started/) tools, such as the theme override or the `sx` prop.

{{"demo": "ChartsOverviewDemo.js", "defaultCodeOpen": true}}
Expand Down
2 changes: 1 addition & 1 deletion docs/data/charts/sparkline/sparkline.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To modify the curve interpolation, use the `curve` prop. Read the full documenta

## Interaction

Compared to line and bar charts, the sparkline chart has some additional props to simplify interaction configuration.
Compared to line and bar charts, the sparkline has some additional props to simplify interaction configuration.
You can use `showTooltip` and `showHighlight` to display the default tooltip and highlight in your sparkline.

Those are helpers.
Expand Down
8 changes: 4 additions & 4 deletions docs/data/charts/tree-map/tree-map.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: React Tree map chart
title: React Treemap
productId: x-charts
---

# Charts - Tree map 🚧
# Charts - Treemap 🚧

<p class="description">Tree map allows to display data with a hierarchical structure.</p>
<p class="description">Treemap allows to display data with a hierarchical structure.</p>

:::warning
The Tree map Chart component isn't available yet, but you can upvote [**this GitHub issue**](https://github.com/mui/mui-x/issues/7924) to see it arrive sooner.
The Treemap component isn't available yet, but you can upvote [**this GitHub issue**](https://github.com/mui/mui-x/issues/7924) to see it arrive sooner.

Don't hesitate to leave a comment there to influence what gets built.
Especially if you already have a use case for this component, or if you're facing a pain point with your current solution.
Expand Down
2 changes: 1 addition & 1 deletion docs/data/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ const pages: MuiPage[] = [
children: [
{ pathname: '/x/react-charts/heat-map', title: 'Heatmap', planned: true },
{ pathname: '/x/react-charts/radar', title: 'Radar', planned: true },
{ pathname: '/x/react-charts/tree-map', title: 'Tree map', planned: true },
{ pathname: '/x/react-charts/tree-map', title: 'Treemap', planned: true },
{ pathname: '/x/react-charts/funnel', title: 'Funnel', plan: 'pro', planned: true },
{ pathname: '/x/react-charts/gantt', title: 'Gantt', plan: 'pro', planned: true },
{ pathname: '/x/react-charts/sankey', title: 'Sankey', plan: 'pro', planned: true },
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
"@mnajdova/enzyme-adapter-react-18": "^0.2.0",
"@mui/icons-material": "^5.15.9",
"@mui/material": "^5.15.9",
"@mui/monorepo": "https://github.com/mui/material-ui.git#master",
"@mui/monorepo": "https://github.com/alexfauquette/material-ui.git#comon-vale-config",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not usefull now

"@mui/utils": "^5.15.9",
"@next/eslint-plugin-next": "14.0.4",
"@octokit/plugin-retry": "^6.0.1",
Expand Down
4 changes: 2 additions & 2 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -1890,9 +1890,9 @@
react-is "^18.2.0"
react-transition-group "^4.4.5"

"@mui/monorepo@https://github.com/mui/material-ui.git#master":
"@mui/monorepo@https://github.com/alexfauquette/material-ui.git#comon-vale-config":
version "5.15.10"
resolved "https://github.com/mui/material-ui.git#c5b4ebac51979272121a3b4369e43cf41509dad8"
resolved "https://github.com/alexfauquette/material-ui.git#44bb08750d8e2f58c937e1f9a2cda61aa7713e91"
dependencies:
"@googleapis/sheets" "^5.0.5"
"@slack/bolt" "^3.17.1"
Expand Down
Loading