[docs-infra] Improve Vale config

mui · Mar 17, 2024 · b579513 · b579513
1 parent 98a08c9
commit b579513
Show file tree

Hide file tree

Showing 10 changed files with 11 additions and 10 deletions.
diff --git a/.vale.ini b/.vale.ini
@@ -3,7 +3,7 @@ StylesPath = .github/styles
 MinAlertLevel = warning
 
 # The docs/mui-vale.zip is generated by `pnpm docs:zipRules`
-Packages = Google,docs/mui-vale.zip
+Packages = Google, docs/mui-vale.zip
 
 [*.md]
 # Ignore code injections that start with {{...

diff --git a/docs/data/base/components/badge/badge.md b/docs/data/base/components/badge/badge.md
@@ -99,7 +99,7 @@ You may not need to use hooks unless you find that you're limited by the customi
 
 :::info
 The following features can be used with both components and hooks.
-For the sake of simplicity, demos and code snippets primarily feature components.
+For the sake of simplicity, demos, and code snippets primarily feature components.
 :::
 
 ### Badge content

diff --git a/docs/data/base/components/button/button.md b/docs/data/base/components/button/button.md
@@ -115,7 +115,7 @@ Do not add the `ref` parameter to the button element manually, as the correct re
 
 :::info
 The following features can be used with both components and hooks.
-For the sake of simplicity, demos and code snippets primarily feature components.
+For the sake of simplicity, demos, and code snippets primarily feature components.
 :::
 
 ### Custom elements

diff --git a/docs/data/base/components/form-control/form-control.md b/docs/data/base/components/form-control/form-control.md
@@ -97,7 +97,7 @@ Learn more about controlled and uncontrolled components in the [React documentat
 
 :::info
 The following features can be used with both components and hooks.
-For the sake of simplicity, demos and code snippets primarily feature components.
+For the sake of simplicity, demos, and code snippets primarily feature components.
 :::
 
 ### Accessing the form control state

diff --git a/docs/data/base/components/input/input.md b/docs/data/base/components/input/input.md
@@ -105,7 +105,7 @@ The demo below shows how to use the `useInput` hook to create a custom input com
 
 :::info
 The following features can be used with both components and hooks.
-For the sake of simplicity, demos and code snippets primarily feature components.
+For the sake of simplicity, demos, and code snippets primarily feature components.
 :::
 
 ### Adornments

diff --git a/docs/data/base/components/menu/menu.md b/docs/data/base/components/menu/menu.md
@@ -166,7 +166,7 @@ The `useMenuItemContextStabilizer` hook ensures that the context value changes o
 
 :::info
 The following features can be used with both components and hooks.
-For the sake of simplicity, demos and code snippets primarily feature components.
+For the sake of simplicity, demos, and code snippets primarily feature components.
 :::
 
 ### Wrapping Menu Items

diff --git a/docs/data/base/components/select/select.md b/docs/data/base/components/select/select.md
@@ -242,7 +242,7 @@ The `useOptionContextStabilizer` hook ensures that the context value changes onl
 
 :::info
 The following features can be used with both components and hooks.
-For the sake of simplicity, demos and code snippets primarily feature components.
+For the sake of simplicity, demos, and code snippets primarily feature components.
 :::
 
 ### Selected value appearance

diff --git a/docs/data/base/components/snackbar/snackbar.md b/docs/data/base/components/snackbar/snackbar.md
@@ -109,7 +109,7 @@ You may not need to use hooks unless you find that you're limited by the customi
 
 :::info
 The following features can be used with both components and hooks.
-For the sake of simplicity, demos and code snippets primarily feature components.
+For the sake of simplicity, demos, and code snippets primarily feature components.
 :::
 
 ### Transitions

diff --git a/docs/mui-vale.zip b/docs/mui-vale.zip
diff --git a/docs/mui-vale/styles/MUI/CorrectReferenceAllCases.yml b/docs/mui-vale/styles/MUI/CorrectReferenceAllCases.yml
@@ -6,9 +6,10 @@ ignorecase: true
 # swap maps tokens in form of bad: good
 # for more information: https://vale.sh/docs/topics/styles/#substitution
 swap:
-  api: API
+  ' api': API
   typescript: TypeScript
-  ts: TypeScript
+  ' ts': TypeScript
+  ' js': JavaScript
   javascript: JavaScript
   ' css ': CSS
   ' html ': HTML