Merge remote-tracking branch 'dostonnabotov/main' into basic-search

.gitattributes

@@ -0,0 +1 @@
+text eol=lf

.github/CODEOWNERS

@@ -0,0 +1,28 @@
+# ---------- Our awesome maintainers ----------
+
+# Global maintainers
+* @Mathys-Gasnier
+
+# Code maintainers
+/src/ @psychlone77 @saminjay
+
+# Snippets maintainers
+/snippets @Mathys-Gasnier
+
+
+# ---------- What is a maintainer ----------
+
+# Maintainers will be notified when there is a pull request 
+# with a change in the folder/file assigned to them. They will 
+# have to approve the pull request before it can be merged.
+
+
+# ---------- How to be a maintainer ----------
+
+# To maintain trust and collaboration with reviewers, first, 
+# we will need to prove that you can contribute to the project well. 
+# As you contribute more, the more responsibility you will have.
+
+# We will assign maintainers for specific languages as well.
+# As we notice more contribution from your side, we will let you know 
+# and assign you a language.

.github/ISSUE_TEMPLATE/bugs.yml

@@ -0,0 +1,15 @@
+name: "Bug Report"
+description: "File a bug report to fix issues in the codebase"
+title: "[Bug] - "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: "# Bug report"
+  - type: textarea
+    id: description
+    attributes:
+      label: "What bug did you find in the codebase?"
+      description: "Please explain the issue in as much detail as possible. Provide screenshots as necessary"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/docs.yml

@@ -0,0 +1,15 @@
+name: Documentation
+description: Request to update documentation or fix typos
+title: "[Docs] - "
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: "# Update documentation"
+  - type: textarea
+    id: docs
+    attributes:
+      label: What changes would you like to make in the documentation?
+      description: Please explain the issue and what the change should be
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/features.yml

@@ -0,0 +1,13 @@
+name: Feature request
+description: Request for feature
+title: "[Feature] - "
+labels: ["feature"]
+body:
+  - type: markdown
+    attributes:
+      value: "# Feature request"
+  - type: textarea
+    id: feature
+    attributes:
+      label: What feature would you like to see?
+      description: Please provide a detailed description for the new feature.

.github/ISSUE_TEMPLATE/general.yml

@@ -0,0 +1,12 @@
+name: General report
+description: This is a general issue that does not fit in the other categories
+title: "[General] - "
+body:
+  - type: markdown
+    attributes:
+      value: "# General"
+  - type: textarea
+    id: description
+    attributes:
+      label: What general issue would you like to create?
+      description: Please be as detailed as possible. Include code snippets or screenshots if necessary.

.github/pull_request_template.md

@@ -0,0 +1,46 @@
+<!-- **ANY PULL REQUEST NOT FOLLOWING GUIDELINES OR NOT INCLUDING A DESCRIPTION WILL BE CLOSED !** -->
+
+# Description
+
+<!-- Include a summary of your changes. -->
+
+## Type of Change
+
+<!-- What kind of change does this pull request introduce? (Check all that apply) -->
+
+- [ ] ✨ New snippet
+- [ ] 🛠 Improvement to an existing snippet
+- [ ] 🐞 Bug fix
+- [ ] 📖 Documentation update
+- [ ] 🔧 Other (please describe):
+
+## Checklist
+
+<!--  Before submitting, ensure your pull request meets these requirements: -->
+
+- [ ] I have tested my code and verified it works as expected.
+- [ ] My code follows the style and contribution guidelines of this project.
+- [ ] Comments are added where necessary for clarity.
+- [ ] Documentation has been updated (if applicable).
+- [ ] There are no new warnings or errors from my changes.
+
+## Related Issues
+
+<!-- Link any relevant issues (use #issue-number syntax). If not, leave it empty -->
+
+Closes #
+
+## Additional Context
+
+<!-- Add any extra details, questions, or considerations here. -->
+
+## Screenshots (Optional)
+
+<!-- If your changes affect visuals, please include screenshots. -->
+
+<details> 
+<summary>Click to view screenshots</summary>
+
+<!-- Add your screenshots here -->
+
+</details>

.github/workflows/check-snippets.yml

@@ -0,0 +1,31 @@
+name: Checks snippets syntax
+
+on:
+  pull_request:
+    paths:
+      - "snippets/**"
+
+jobs:
+  check-snippets:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - 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
+          post-on-failure: |
+            ## :x: Snippet Format Error
+            ${run.output}

.github/workflows/consolidate-snippets.yml

@@ -3,7 +3,7 @@ name: Consolidate JSON Files
 on:
   push:
     paths:
-      - "public/data/**"
+      - "snippets/**"
 
 permissions:
   contents: write
@@ -14,25 +14,26 @@ 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: |
           npm install
 
-      - name: Consolidate JSON files
+      - name: Consolidate Snippets
         run: |
-          node utils/consolidate.js  # Run the script located in the utils/ folder
+          node utils/consolidateSnippets.js  # Run the script located in the utils/ folder
 
       - name: Commit and push changes
         run: |
           git config --global user.name "GitHub Action"
           git config --global user.email "[email protected]"
-          git add public/consolidated/all_snippets.json
-          git commit -m "Update consolidated snippets"
+          git add public/consolidated/*
+          git add public/icons/*
+          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

.gitignore

@@ -11,6 +11,7 @@ node_modules
 dist
 dist-ssr
 *.local
+*.tsbuildinfo
 
 # Editor directories and files
 .vscode/*

.husky/pre-commit

@@ -0,0 +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

CODE_OF_CONDUCT.md

@@ -0,0 +1,37 @@
+## QuickSnip Code of Conduct
+
+QuickSnip is a welcoming and collaborative community for developers to organize, share, and discover code snippets. By participating in QuickSnip, you agree to uphold this code of conduct to maintain a friendly and inclusive environment.
+
+### Short Version
+
+- Be respectful to everyone in the community.
+- Avoid harassment, trolling, or spamming.
+- Ensure QuickSnip remains a safe and productive space for all.
+- Report any inappropriate behavior to [me](mailto:[email protected]), the owner of QuickSnip, or our [Discord team](https://discord.gg/UtJJcnsN).
+- No unauthorized bots without prior permission.
+
+---
+
+### Long Version
+
+#### Harassment-Free Environment
+
+We are committed to providing a harassment-free experience for everyone, regardless of gender, gender identity and expression, age, sexual orientation, disability, physical appearance, body size, race, ethnicity, national origin, or religion (or lack thereof). Examples of unacceptable behavior include:
+
+- **Harassment:** Includes sexual language or imagery, deliberate intimidation, stalking, name-calling, unwelcome attention, libel, and malicious hacking or social engineering.
+- **Trolling:** Posting inflammatory comments to provoke an emotional response or disrupt discussions.
+- **Spamming:** Posting off-topic messages, promoting unrelated products, soliciting donations, advertising jobs or gigs, or flooding discussions with files or text.
+
+#### Reporting Issues
+
+If you experience or witness harassment, trolling, spamming, or any other inappropriate behavior, please report it to [me](mailto:[email protected]), the owner of QuickSnip, or our QuickSnip [Discord team](https://discord.gg/UtJJcnsN). Include details like screenshots and URLs, if possible, to help us address the issue effectively.
+
+I, or the QuickSnip team will review all reports and take appropriate actions, which may include warnings, temporary bans, or permanent removal from the community.
+
+#### Respectful Use of Bots
+
+No bots are allowed within the QuickSnip community without prior written permission from the QuickSnip team. Unauthorized bots will be removed.
+
+#### Final Notes
+
+This code of conduct is inspired by [FreeCodeCamp’s approach](https://www.freecodecamp.org/news/code-of-conduct), emphasizing clarity and friendliness. Let’s work together to make QuickSnip a supportive and productive space for all developers!