Skip to content

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

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.

Sign up for GitHub

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 2 commits into from
Apr 30, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a40d38
[docs-infra] Fix Vale no longer working
oliviertassinari Apr 29, 2025
ff3ce9b
more
oliviertassinari Apr 29, 2025
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/4.docs-feedback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: 'Docs feedback'
about: 'Help us improve Base UI documentation.'
about: 'Help us improve Base UI documentation.'

Check warning on line 3 in .github/ISSUE_TEMPLATE/4.docs-feedback.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'us'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'us'.", "location": {"path": ".github/ISSUE_TEMPLATE/4.docs-feedback.md", "range": {"start": {"line": 3, "column": 14}}}, "severity": "WARNING"}
labels: ['status: waiting for maintainer']
---

Expand Down
8 changes: 8 additions & 0 deletions .github/workflows/vale-action.yml
View file
Open in desktop
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
4 changes: 1 addition & 3 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,5 @@ node_modules
package-lock.json
size-snapshot.json
# vale downloaded config
.github/styles/Google
.github/styles/MUI
.github/styles/.vale-config
.github/styles/
.nx/cache
2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"eslint:ci": "eslint . --report-unused-disable-directives --ext .js,.ts,.tsx --max-warnings 0",
"stylelint": "stylelint --reportInvalidScopeDisables --reportNeedlessDisables \"docs/**/*.{js,ts,tsx}\" \"**/*.css\" --ignore-path .gitignore",
"markdownlint": "markdownlint-cli2 \"**/*.{md,mdx}\"",
"valelint": "pnpm vale sync && git ls-files | grep -h \".md$\" | xargs pnpm vale --filter='.Level==\"error\"'",
"prettier": "pretty-quick --ignore-path .eslintignore",
"prettier:all": "prettier --write . --ignore-path .eslintignore",
"size:snapshot": "node --max-old-space-size=4096 ./scripts/sizeSnapshot/create",
Expand Down Expand Up @@ -83,6 +84,7 @@
"@types/yargs": "^17.0.33",
"@typescript-eslint/eslint-plugin": "^7.18.0",
"@typescript-eslint/parser": "^7.18.0",
"@vvago/vale": "^3.11.2",
"@vitejs/plugin-react": "^4.4.1",
"@vitest/browser": "^3.1.2",
"@vitest/coverage-istanbul": "3.1.1",
Expand Down
122 changes: 122 additions & 0 deletions pnpm-lock.yaml
View file
Open in desktop

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

Loading