Merge pull request #137 from barrymun/feature/vitest-test-suite

Feature - Vitest test suite for utility functions

.github/workflows/check-snippets.yml

@@ -22,10 +22,13 @@ jobs:
         with:
           node-version: 22
 
+      - name: Install dependencies
+        run: npm ci
+
       - name: Check if snippets are formated correctly
         uses: int128/comment-action@v1
         with:
-          run: node utils/checkSnippetFormatting.js # Run the script located in the utils/ folder
+          run: npx tsx utils/checkSnippetFormatting.ts # Run the script located in the utils/ folder
           post-on-failure: |
             ## :x: Snippet Format Error
-            ${run.output}
+            ${run.output}

.github/workflows/pre-commit-checks.yml

@@ -27,5 +27,8 @@ jobs:
       - name: Run lint
         run: npm run lint
 
+      - name: Run tests
+        run: npm run test-ci
+
       - name: Run build
         run: npm run build

.gitignore

@@ -10,6 +10,7 @@ lerna-debug.log*
 node_modules
 dist
 dist-ssr
+coverage
 *.local
 *.tsbuildinfo
 

.husky/pre-commit

@@ -1,3 +1,5 @@
+npm run snippets:check
 npm run cspell
 npm run lint
+npm run test-ci
 npm run build

.prettierignore

@@ -1,8 +1,9 @@
 node_modules
 dist
+coverage
 snippets
 public
 .vite
 coverage
 package-lock.json
-.md
+.md

cspell-dict.txt

@@ -1,2 +1,3 @@
 quicksnip
+slugified
 slugifyed

cspell.json

@@ -11,6 +11,7 @@
   "ignorePaths": [
     "node_modules",
     "dist",
+    "coverage",
     "public"
   ]
 }

eslint.config.js

@@ -1,12 +1,12 @@
 import { fixupPluginRules } from "@eslint/compat";
 import { FlatCompat } from "@eslint/eslintrc";
 import js from "@eslint/js";
-import globals from "globals";
+import prettier from "eslint-plugin-prettier/recommended";
 import reactPlugin from "eslint-plugin-react";
 import reactHooks from "eslint-plugin-react-hooks";
 import reactRefresh from "eslint-plugin-react-refresh";
+import globals from "globals";
 import tseslint from "typescript-eslint";
-import prettier from "eslint-plugin-prettier/recommended";
 
 const project = "./tsconfig.app.json";
 // eslint flat structure backwards compatibility
@@ -23,7 +23,7 @@ function legacyPlugin(name, alias = name) {
 }
 
 export default tseslint.config(
-  { ignores: ["node_modules", "dist", "build"] },
+  { ignores: ["node_modules", "dist", "coverage"] },
   {
     extends: [
       js.configs.recommended,
@@ -32,7 +32,7 @@ export default tseslint.config(
       ...compat.extends("plugin:import/typescript"),
       reactPlugin.configs.flat.recommended,
     ],
-    files: ["**/*.{ts,tsx}"],
+    files: ["**/*.{js,ts,tsx}"],
     languageOptions: {
       ecmaVersion: 2020,
       globals: globals.browser,