Merge pull request #15396 from adamdmharvey/adamdmharvey/refactor-spell-checking

chore: Refactor Vale spell checking to better support local development

.github/vale/config.ini

@@ -1,6 +0,0 @@
-StylesPath = .
-Vocab = Backstage
-
-[*.md]
-BasedOnStyles = Vale
-Vale.Terms = NO

.vale.ini

@@ -1,4 +1,7 @@
-StylesPath = .github/styles
+StylesPath = .github/vale
+
+Vocab = Backstage
 
 [*.md]
 BasedOnStyles = Vale
+Vale.Terms = NO

scripts/check-docs-quality.js

@@ -23,6 +23,7 @@ const IGNORED = [
   /^.*[/\\]CHANGELOG\.md$/,
   /^.*[/\\]api-report\.md$/,
   /^docs[/\\]releases[/\\].*-changelog\.md$/,
+  /^docs[/\\]reference[/\\]/,
 ];
 
 const rootDir = resolvePath(__dirname, '..');
@@ -55,6 +56,7 @@ async function listFiles(dir = '') {
 // caused by the script. In CI, we want to ensure vale linter is run.
 async function exitIfMissingVale() {
   try {
+    // eslint-disable-next-line import/no-extraneous-dependencies
     await require('command-exists')('vale');
   } catch (e) {
     if (process.env.CI) {
@@ -72,7 +74,7 @@ async function exitIfMissingVale() {
 async function runVale(files) {
   const result = spawnSync(
     'vale',
-    ['--config', resolvePath(rootDir, '.github/vale/config.ini'), ...files],
+    ['--config', resolvePath(rootDir, '.vale.ini'), ...files],
     {
       stdio: 'inherit',
     },
@@ -97,7 +99,7 @@ async function main() {
   if (process.argv.includes('--ci-args')) {
     process.stdout.write(
       // Workaround for not being able to pass arguments to the vale action
-      JSON.stringify(['--config=.github/vale/config.ini', ...files]),
+      JSON.stringify([...files]),
     );
     return;
   }