Merge branch 'main' of https://github.com/dibyam-jalan27/quicksnip

Author: dibyam-jalan27

.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/consolidate-snippets.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

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

@@ -10,6 +10,7 @@ lerna-debug.log*
 node_modules
 dist
 dist-ssr
+coverage
 *.local
 *.tsbuildinfo
 
@@ -23,3 +24,7 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
+
+# Consolidated snippets
+public/consolidated
+public/icons

.gitignore

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

.husky/pre-commit

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

.prettierignore

@@ -117,7 +117,7 @@ Here’s an example for JavaScript:
 title: Format Date
 description: Formats a date in 'YYYY-MM-DD' format.
 author: dostonnabotov
-tags: javascript,date,format
+tags: date,format
 ---
 
 ```js
@@ -141,11 +141,11 @@ console.log(formatDate(new Date())); // Output: '2024-12-10'
         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:
+        To preview the snippets, start the vite server using:
         ```
-        $ npm run snippets:consolidate
+        $ npm run dev
         ```
-        It will update the snippets in the `/public` folder, making them available to the frontend.
+        It will use HMR to update the snippets in the `/public` folder, making them available to the frontend.
 
 Expected file structure:
 

CONTRIBUTING.md

@@ -63,7 +63,7 @@ Here's an example for JavaScript:
 title: Format Date
 description: Formats a date in 'YYYY-MM-DD' format.
 author: dostonnabotov
-tags: javascript,date,format
+tags: date,format
 ---
 
 ```js

README.md

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

cspell-dict.txt

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