[docs-infra] Share vale-config (#41176)

mui · Feb 21, 2024 · fdb8cdf · fdb8cdf
1 parent b923a63
commit fdb8cdf
Show file tree

Hide file tree

Showing 13 changed files with 46 additions and 13 deletions.
diff --git a/.github/styles/Vocab/accept.txt b/.github/styles/Vocab/accept.txt
diff --git a/.github/styles/Vocab/reject.txt b/.github/styles/Vocab/reject.txt
diff --git a/.gitignore b/.gitignore
@@ -39,6 +39,5 @@ package-lock.json
 size-snapshot.json
 docs/public/static/blog/feed/*
 # vale downloaded config
-.github/styles/Google
-.github/styles/write-good
+.github/styles/
 .nx/cache
diff --git a/.vale.ini b/.vale.ini
@@ -2,20 +2,14 @@
 StylesPath = .github/styles
 MinAlertLevel = suggestion
 
-Packages = Google
+# The docs/writing-rules.zip is generated by `pnpm docs:zipRules`
+Packages = Google, docs/writing-rules.zip
 
 [*.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, ...'.

diff --git a/docs/writing-rules.zip b/docs/writing-rules.zip
diff --git a/.github/styles/Blog/BrandName.yml → docs/writing-rules/BrandName.yml b/.github/styles/Blog/BrandName.yml → docs/writing-rules/BrandName.yml
@@ -14,3 +14,7 @@ swap:
   MUI Core: MUI Core
   MUI Toolpad: MUI Toolpad
   MUI Connect: MUI Connect
+# Don't forget to run the following command to generate the package writing-rules.zip file
+# Vale uses that ZIP file and not the YAML files.
+#
+# pnpm docs:zipRules
diff --git a/docs/writing-rules/ComponentNameConventions.yml b/docs/writing-rules/ComponentNameConventions.yml
@@ -0,0 +1,16 @@
+extends: substitution
+message: To be consistent with component name, consider using '%s' instead of '%s'.
+level: error
+ignorecase: true
+# swap maps tokens in form of bad: good
+# for more information: https://vale.sh/docs/topics/styles/#substitution
+swap:
+  'Heat map': Heatmap
+  'Tree map': Treemap
+  'Sparkline Chart': Sparkline
+  'Gauge Chart': Gauge
+  'Treemap Chart': Treemap
+# Don't forget to run the following command to generate the package writing-rules.zip file
+# Vale uses that ZIP file and not the YAML files.
+#
+# pnpm docs:zipRules
diff --git a/.github/styles/Blog/ComposedWords.yml → docs/writing-rules/ComposedWords.yml b/.github/styles/Blog/ComposedWords.yml → docs/writing-rules/ComposedWords.yml
@@ -11,3 +11,9 @@ swap:
   'sub components': subcomponents
   'use-case': 'use case'
   'usecase': 'use case'
+  'client side': 'client-side'
+  'server side': 'server-side'
+# Don't forget to run the following command to generate the package writing-rules.zip file
+# Vale uses that ZIP file and not the YAML files.
+#
+# pnpm docs:zipRules
diff --git a/.github/styles/Blog/NamingConventions.yml → docs/writing-rules/NamingConventions.yml b/.github/styles/Blog/NamingConventions.yml → docs/writing-rules/NamingConventions.yml
@@ -17,3 +17,7 @@ swap:
   Css: CSS
   NPM: npm # https://css-tricks.com/start-sentence-npm/
   Github: GitHub
+# Don't forget to run the following command to generate the package writing-rules.zip file
+# Vale uses that ZIP file and not the YAML files.
+#
+# pnpm docs:zipRules
diff --git a/.github/styles/Blog/NoCompanyName.yml → docs/writing-rules/NoCompanyName.yml b/.github/styles/Blog/NoCompanyName.yml → docs/writing-rules/NoCompanyName.yml
@@ -12,3 +12,8 @@ exceptions:
   - 'MUI Toolpad'
   - 'MUI Connect'
   - 'MUI organization' # valid use of a regular space
+
+# Don't forget to run the following command to generate the package writing-rules.zip file
+# Vale uses that ZIP file and not the YAML files.
+#
+# pnpm docs:zipRules
diff --git a/.github/styles/Blog/Typos.yml → docs/writing-rules/Typos.yml b/.github/styles/Blog/Typos.yml → docs/writing-rules/Typos.yml
@@ -9,3 +9,7 @@ swap:
   eg: e.g.
   eg.: e.g.
   'e.g ': 'e.g. '
+# Don't forget to run the following command to generate the package writing-rules.zip file
+# Vale uses that ZIP file and not the YAML files.
+#
+# pnpm docs:zipRules
diff --git a/package.json b/package.json
@@ -34,6 +34,7 @@
     "docs:typescript:check": "pnpm --filter docs typescript",
     "docs:typescript:formatted": "tsx ./docs/scripts/formattedTSDemos",
     "docs:mdicons:synonyms": "cross-env BABEL_ENV=development babel-node --extensions \".tsx,.ts,.js,.mjs\" ./docs/scripts/updateIconSynonyms && pnpm prettier",
+    "docs:zipRules": "cd docs && rm writing-rules.zip && zip -r writing-rules.zip writing-rules",
     "extract-error-codes": "cross-env MUI_EXTRACT_ERROR_CODES=true lerna run --concurrency 8 build:modern",
     "rsc:build": "tsx ./packages/rsc-builder/buildRsc.ts",
     "template:screenshot": "cross-env BABEL_ENV=development babel-node --extensions \".tsx,.ts,.js\" ./docs/scripts/generateTemplateScreenshots",

diff --git a/packages/mui-material/src/Select/Select.d.ts b/packages/mui-material/src/Select/Select.d.ts
@@ -184,8 +184,8 @@ export type SelectProps<
   (Variant extends 'filled'
     ? FilledSelectProps
     : Variant extends 'standard'
-    ? StandardSelectProps
-    : OutlinedSelectProps);
+      ? StandardSelectProps
+      : OutlinedSelectProps);
 
 /**
  *