Merge branch 'main' into feature/optimised-highlighter

Author: barrymun

.github/workflows/check-snippets.yml

@@ -9,15 +9,23 @@ jobs:
   check-snippets:
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: read
+      pull-requests: write
+
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: "16"
+          node-version: 22
 
       - name: Check if snippets are formated correctly
-        run: |
-          node utils/checkSnippetFormatting.js # Run the script located in the utils/ folder
+        uses: int128/comment-action@v1
+        with:
+          run: node utils/checkSnippetFormatting.js # Run the script located in the utils/ folder
+          post-on-failure: |
+            ## :x: Snippet Format Error
+            ${run.output}

.github/workflows/consolidate-snippets.yml

@@ -14,12 +14,12 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: "16"
+          node-version: 22
 
       - name: Install dependencies
         run: |
@@ -34,5 +34,6 @@ jobs:
           git config --global user.name "GitHub Action"
           git config --global user.email "[email protected]"
           git add public/consolidated/*
+          git add public/icons/*
           git commit -m "Update consolidated snippets"
           git push

.prettierignore

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

CONTRIBUTING.md

@@ -43,51 +43,55 @@ To add a new code snippet:
 
     - Use the following format to structure your snippet:
 
-```md
+````md
 ---
 title: Name of the snippet
 description: A short explanation of what the snippet does
 tags: tag1, tag2, tag3
 author: your-github-username
 ---
 
+```lang
 // Your code here
 ```
+````
 
 Here’s an example for JavaScript:
 
-```
+````md
 ---
 title: Format Date
 description: Formats a date in 'YYYY-MM-DD' format.
 author: dostonnabotov
-tags: javascript,date,format,utility
+tags: javascript,date,format
 ---
 
+```js
 const formatDate = (date) => date.toISOString().split('T')[0];
 
 // Usage:
 console.log(formatDate(new Date())); // Output: '2024-12-10'
 ```
+````
 
 5. **Use syntax highlighting:**
     - Enclose your code with triple backticks (```).
     - Specify the language after the first set of backticks for syntax highlighting.
 
-![snippet code example in markdown file](https://github.com/user-attachments/assets/be650cfe-fd17-49e7-ae82-e1c88e30d4c9)
-
 6. **Test your snippet:**
    - Ensure your code runs as expected.
 
-Expected structure:
+Expected file structure:
 
-```txt
-snippets
+```md
+/snippets
   |- language
-    |- category
+    |- category-name
       |- your-snippet-here.md
 ```
 
+> Please do **NOT** add or edit anything in `/public` folder. It will be used for consolidating snippets.
+
 ### Editing a Existing Snippet
 
 If you’d like to refine or improve an existing snippet:
@@ -96,7 +100,7 @@ If you’d like to refine or improve an existing snippet:
 
     - Include your GitHub username under the `contributors` field in the metadata section.
 
-```md
+````md
 ---
 title: Name of the snippet
 description: A short explanation of what the snippet does
@@ -105,8 +109,10 @@ author: original-author
 contributors: your-github-username
 ---
 
+```
 Updated code here
 ```
+````
 
 2. **Credit all contributors:**
 
@@ -118,9 +124,9 @@ contributors: contributor1, contributor2, your-github-username
 
 3. **Document changes:**
 
-Clearly indicate what you updated and why in your pull request description.
+    - Clearly indicate what you updated and why in your pull request description.
 
-We want to make sure that original author and contributor(s) are credited for their work.
+> We want to make sure that original author and contributor(s) are credited for their work.
 
 
 ### Adding a New Category
@@ -141,10 +147,10 @@ Example structure:
 
 ```md
 /snippets
-  |_ python
-       |_ file-handling
-       |_ list-manipulation
-       |_ ....
+  |- python
+    |- file-handling
+    |- list-manipulation
+    |- ....
 ```
 
 ### Adding a New Language

README.md

@@ -2,9 +2,11 @@
 
 An open-source project that categorizes handy code snippets across various programming languages. Built with love and powered by an awesome community. 🚀
 
-<a href="https://youtu.be/BhRi7fJzPgk?si=z1sVXU7uRS0bkSEt" target="_blank" style="text-decoration: none;">
-  <img src="https://img.shields.io/static/v1?label=&message=Watch%20on%20YouTube&labelColor=FFFFFF&color=FF0000&style=for-the-badge&logo=youtube&logoColor=FF0000" alt="Watch on YouTube" style="margin-right: 20px">
+<div>
+<a href="https://youtu.be/BhRi7fJzPgk?si=z1sVXU7uRS0bkSEt" target="_blank">
+  <img src="https://img.shields.io/static/v1?label=&message=Watch%20on%20YouTube&labelColor=FFFFFF&color=FF0000&style=for-the-badge&logo=youtube&logoColor=FF0000" alt="Watch on YouTube">
 </a>
+<div>
 
 <br>
 
@@ -36,20 +38,47 @@ The snippets database is located in the `/snippets` folder.
 
 3. Create a markdown file and add your snippet using the following format:
 
-```md
+````md
 ---
 title: Name of the snippet
 description: A short explanation of what the snippet does
 tags: tag1, tag2, tag3
 author: your-github-username
 ---
 
+```lang
 // Your code here
 ```
+````
 
 Here's an example for JavaScript:
 
-![code example in markdown file](https://github.com/user-attachments/assets/dba9fda3-76fe-4d92-b12a-8bc065286b90)
+````md
+---
+title: Format Date
+description: Formats a date in 'YYYY-MM-DD' format.
+author: dostonnabotov
+tags: javascript,date,format
+---
+
+```js
+const formatDate = (date) => date.toISOString().split('T')[0];
+
+// Usage:
+console.log(formatDate(new Date())); // Output: '2024-12-10'
+```
+````
+
+Expected file structure:
+
+```md
+/snippets
+  |- language
+    |- category-name
+      |- your-snippet-here.md
+```
+
+> Please do **NOT** add or edit anything in `/public` folder. It will be used for consolidating snippets.
 
 For more details about adding new categories or programming languages, check out the [CONTRIBUTING.md](/CONTRIBUTING.md) file.
 

package-lock.json

@@ -13,6 +13,7 @@
     "prepare": "husky"
   },
   "dependencies": {
+    "framer-motion": "^11.15.0",
     "prismjs": "^1.29.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",

package.json

@@ -7,10 +7,18 @@
         "lang": "CPP",
         "icon": "/icons/cpp.svg"
     },
+    {
+        "lang": "CSHARP",
+        "icon": "/icons/csharp.svg"
+    },
     {
         "lang": "CSS",
         "icon": "/icons/css.svg"
     },
+    {
+        "lang": "HASKELL",
+        "icon": "/icons/haskell.svg"
+    },
     {
         "lang": "HTML",
         "icon": "/icons/html.svg"

public/consolidated/_index.json

@@ -17,6 +17,41 @@
             }
         ]
     },
+    {
+        "categoryName": "Data Structure Conversion",
+        "snippets": [
+            {
+                "title": "Vector to Queue",
+                "description": "Convert vector into queue quickly",
+                "author": "mrityunjay2003",
+                "tags": [
+                    "cpp",
+                    "data structures",
+                    "queue",
+                    "vector"
+                ],
+                "contributors": [],
+                "code": "#include<queue>\n#include<vector>\n#include<deque>\n\nstd::queue<int> vectorToQueue(const std::vector<int>& v) {\n    return std::queue<int>(std::deque<int>(v.begin(), v.end()));\n}\n"
+            }
+        ]
+    },
+    {
+        "categoryName": "Math And Numbers",
+        "snippets": [
+            {
+                "title": "Check Prime Number",
+                "description": "Check if an integer is a prime number",
+                "author": "MihneaMoso",
+                "tags": [
+                    "cpp",
+                    "number",
+                    "prime"
+                ],
+                "contributors": [],
+                "code": "bool is_prime(int n) {\n    if (n < 2) return false;\n    if (n == 2 || n == 3) return true;\n    if (n % 2 == 0) return false;\n    for (int i = 3; i * i <= n; i += 2) {\n        if (n % i == 0) return false;\n    }\n    return true;\n}\n\n// Usage\n#include <iostream>\n\nint main() {\n    std::cout << is_prime(29) << std::endl; // Output: 1\n    return 0;\n}\n"
+            }
+        ]
+    },
     {
         "categoryName": "String Manipulation",
         "snippets": [