Merge branch 'dostonnabotov:main' into main

Author: gihanrangana

.github/workflows/consolidate-snippets.yml

@@ -35,5 +35,5 @@ jobs:
           git config --global user.email "[email protected]"
           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

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

@@ -0,0 +1,31 @@
+name: Pre-commit checks
+
+on:
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  pre-commit-checks:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run cspell
+        run: npm run cspell
+
+      - name: Run lint
+        run: npm run lint
+
+      - name: Run build
+        run: npm run build

.husky/pre-commit

@@ -1,2 +1,3 @@
+npm run cspell
 npm run lint
 npm run build

.prettierignore

@@ -1,5 +1,7 @@
 node_modules
 dist
+snippets
+public
 .vite
 coverage
 package-lock.json

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

cspell-dict.txt

@@ -0,0 +1 @@
+quicksnip

cspell.json

@@ -0,0 +1,16 @@
+{
+  "dictionaryDefinitions": [
+    {
+      "name": "workspace",
+      "path": "./cspell-dict.txt",
+      "description": "Custom Workspace Dictionary",
+      "addWords": true
+    }
+  ],
+  "dictionaries": ["workspace"],
+  "ignorePaths": [
+    "node_modules",
+    "dist",
+    "public"
+  ]
+}