Skip to content

[docs-infra] Fix Vale no longer working #17602

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

Merged
merged 13 commits into from
Apr 30, 2025
8 changes: 8 additions & 0 deletions .github/workflows/vale-action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,17 @@ jobs:
pull-requests: write
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Extract Vale version from pnpm-lock.yaml
id: vale-version
run: |
# Extract version from lock file
VERSION=$(awk -F"@|'" '/@vvago\/vale@/ {print $4}' pnpm-lock.yaml | head -n1)
echo "Extracted Vale version: $VERSION"
echo "vale_version=$VERSION" >> $GITHUB_OUTPUT
- uses: errata-ai/vale-action@d89dee975228ae261d22c15adcd03578634d429c # v2.1.1
continue-on-error: true # GitHub Action flag needed until https://github.com/errata-ai/vale-action/issues/89 is fixed
with:
version: ${{ steps.vale-version.outputs.vale_version }}
# Errors should be more visible
fail_on_error: true
# The other reports don't work, not really https://github.com/reviewdog/reviewdog#reporters
Expand Down
7 changes: 2 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,5 @@ dist
node_modules
size-snapshot.json
performance-snapshot.json
# vale downloaded config
.github/styles/Google
.github/styles/MUI
.github/styles/.vale-config
test-results
.github/styles/
test-results
2 changes: 1 addition & 1 deletion docs/data/charts/gauge/gauge.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/meter/

# Charts - Gauge

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

{{"component": "@mui/docs/ComponentLinkHeader", "design": false}}

Expand Down
2 changes: 1 addition & 1 deletion docs/data/charts/treemap/treemap.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ productId: x-charts

# Charts - Treemap 🚧

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

:::warning
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.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/components/WhatsNewLayout.js
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ const entries = [
url: 'https://mui.com/blog/mui-x-end-v6-features/#column-autosizing',
},
{
title: 'Sparkline Charts on the Data Grid ',
title: 'Sparkline charts on the Data Grid ',
url: 'https://mui.com/blog/mui-x-end-v6-features/#sparkline-as-a-column-type',
},
],
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"eslint:fix": "pnpm eslint --fix",
"eslint:ci": "eslint . --report-unused-disable-directives --ext .js,.ts,.tsx --max-warnings 0",
"markdownlint": "markdownlint-cli2 \"**/*.md\"",
"valelint": "git ls-files | grep -h \".md$\" | xargs vale --filter='.Level==\"error\"'",
"valelint": "pnpm vale sync && git ls-files | grep -h \".md$\" | xargs pnpm vale --filter='.Level==\"error\"'",
"prettier": "pretty-quick --branch master --ignore-path .eslintignore",
"prettier:all": "prettier --write . --ignore-path .eslintignore",
"prettier:check": "prettier --check . --ignore-path .eslintignore",
Expand Down Expand Up @@ -111,6 +111,7 @@
"@types/yargs": "^17.0.33",
"@typescript-eslint/eslint-plugin": "^8.31.0",
"@typescript-eslint/parser": "^8.31.0",
"@vvago/vale": "^3.11.2",
"autoprefixer": "^10.4.21",
"axe-core": "4.10.3",
"babel-loader": "^10.0.0",
Expand Down
24 changes: 24 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.