Merge branch 'main' into feature/optimised-highlighter

Author: barrymun

.github/workflows/consolidate-snippets.yml

@@ -35,5 +35,5 @@ jobs:
           git config --global user.email "action@github.com"
           git add public/consolidated/*
           git add public/icons/*
-          git commit -m "Update consolidated snippets"
+          git diff-index --quiet HEAD || git commit -m "Update consolidated snippets"
           git push

CONTRIBUTING.md

@@ -79,7 +79,19 @@ console.log(formatDate(new Date())); // Output: '2024-12-10'
     - Specify the language after the first set of backticks for syntax highlighting.
 
 6. **Test your snippet:**
-   - Ensure your code runs as expected.
+   - Ensure your code runs as expected. \
+        To test that your snippets are formatted correctly use the `snippets:check` script:
+        ```
+        $ npm run snippets:check
+        ```
+        It will return nothing if they are well formatted, otherwise it will tell you what the error is.
+
+        ---
+        To preview the snippets, you need to consolidate them, use the `snippets:consolidate` script:
+        ```
+        $ npm run snippets:consolidate
+        ```
+        It will update the snippets in the `/public` folder, making them available to the frontend.
 
 Expected file structure:
 

README.md

@@ -80,6 +80,19 @@ Expected file structure:
 
 > Please do **NOT** add or edit anything in `/public` folder. It will be used for consolidating snippets.
 
+To test that your snippets are formatted correctly use the `snippets:check` script:
+```
+$ npm run snippets:check
+```
+It will return nothing if they are well formatted, otherwise it will tell you what the error is.
+
+---
+To preview the snippets, you need to consolidate them, use the `snippets:consolidate` script:
+```
+$ npm run snippets:consolidate
+```
+It will update the snippets in the `/public` folder, making them available to the frontend.
+
 For more details about adding new categories or programming languages, check out the [CONTRIBUTING.md](/CONTRIBUTING.md) file.
 
 ## Guidelines for Contributions

package.json

@@ -10,7 +10,9 @@
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "preview": "vite preview",
-    "prepare": "husky"
+    "prepare": "husky",
+    "snippets:check": "node ./utils/checkSnippetFormatting.js",
+    "snippets:consolidate": "node ./utils/consolidateSnippets.js"
   },
   "dependencies": {
     "framer-motion": "^11.15.0",