seventh work session; finish basic functionality

trueberryless-org · Jan 7, 2025 · 3db838a · 3db838a
1 parent 709c6e6
commit 3db838a
Show file tree

Hide file tree

Showing 8 changed files with 650 additions and 109 deletions.
diff --git a/docs/astro.config.ts b/docs/astro.config.ts
@@ -19,7 +19,16 @@ export default defineConfig({
           label: "Deutsch",
         },
       },
-      plugins: [starlightSpellChecker()],
+      plugins: [
+        starlightSpellChecker({
+          usage: {
+            enabled: true,
+          },
+          spell: {
+            ignore: ["astro.config.mjs"],
+          },
+        }),
+      ],
       sidebar: [
         {
           label: "Start Here",

diff --git a/docs/src/content/docs/de/test.mdx b/docs/src/content/docs/de/test.mdx
diff --git a/docs/src/content/docs/getting-started.mdx b/docs/src/content/docs/getting-started.mdx
@@ -6,7 +6,7 @@ Check your documentation for spelling mistakes; multilingual support.
 
 ## Prerequisites
 
-You will need to have a Starlight websit set up.
+You will need to have a Starlight website set up.
 If you don't have one yet, you can follow the ["Getting Started"](https://starlight.astro.build/getting-started) guide in the Starlight docs to create one.
 
 ## Installation

diff --git a/packages/starlight-spell-checker/index.ts b/packages/starlight-spell-checker/index.ts
@@ -5,9 +5,10 @@ import {
   type StarlightSpellCheckerConfig,
   type StarlightSpellCheckerUserConfig,
 } from "./libs/config";
-import { logErrors, validateTexts } from "./libs/validation";
+import { logErrors, logWarnings, validateTexts } from "./libs/validation";
 import { clearContentLayerCache } from "./libs/astro";
 import { remarkStarlightSpellChecker } from "./libs/remark";
+import { green } from "kleur/colors";
 
 export { type StarlightSpellCheckerConfig };
 
@@ -42,17 +43,22 @@ export default function starlightSpellChecker(
               });
             },
             "astro:build:done": async ({ dir, pages }) => {
-              const misspellings = await validateTexts(
+              const { warnings, errors } = await validateTexts(
                 pages,
                 dir,
                 astroConfig,
                 starlightConfig,
                 config
               );
 
-              logErrors(logger, misspellings);
+              logWarnings(logger, warnings);
+              logErrors(logger, errors);
 
-              if (misspellings.size > 0) {
+              if (warnings.size <= 0 && errors.size <= 0) {
+                logger.info(green("✓ All words spelled correctly.\n"));
+              }
+
+              if (errors.size > 0) {
                 throwPluginError("Spelling validation failed.");
               }
             },