merged

.github/workflows/codeql-codescan.yml

@@ -20,7 +20,8 @@ on:
       - '**'   
 jobs:
   CodeQL:
-    name: Analyse code with codeQL on push
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    name: Analyse Code With CodeQL
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false

.github/workflows/eslint_disable_check.py

@@ -36,9 +36,15 @@ def has_eslint_disable(file_path):
     Returns:
         bool: True if eslint-disable statement is found, False otherwise.
     """
-    with open(file_path, 'r') as file:
-        content = file.read()
-        return re.search(r'//\s*eslint-disable', content)
+    eslint_disable_pattern = re.compile(r'//\s*eslint-disable(?:-next-line|-line)?', re.IGNORECASE)
+
+    try:
+        with open(file_path, 'r', encoding='utf-8') as file:
+            content = file.read()
+            return bool(eslint_disable_pattern.search(content))
+    except Exception as e:
+        print(f"Error reading file {file_path}: {e}")
+        return False
 
 def check_eslint(directory):
     """
@@ -72,7 +78,6 @@ def arg_parser_resolver():
 
     Returns:
         result: Parsed argument object
-
     """
     parser = argparse.ArgumentParser()
     parser.add_argument(
@@ -98,7 +103,6 @@ def main():
     Raises:
         SystemExit: If an error occurs during execution.
     """
-
     args = arg_parser_resolver()
 
     if not os.path.exists(args.directory):

.github/workflows/pull-request.yml

@@ -56,7 +56,7 @@ jobs:
         if: steps.changed-files.outputs.only_changed != 'true'
         env: 
           CHANGED_FILES: ${{ steps.changed_files.outputs.all_changed_files }}
-        run: npx eslint ${CHANGED_FILES} 
+        run: npx eslint ${CHANGED_FILES} && python .github/workflows/eslint_disable_check.py
 
       - name: Check for TSDoc comments
         run: npm run check-tsdoc # Run the TSDoc check script
@@ -80,6 +80,7 @@ jobs:
           exit 1
 
   Check-Unauthorized-Changes:
+    if: ${{ github.actor != 'dependabot[bot]' }}
     name: Checks if no unauthorized files are changed
     runs-on: ubuntu-latest
     steps:
@@ -122,6 +123,7 @@ jobs:
           exit 1
 
   Count-Changed-Files:
+    if: ${{ github.actor != 'dependabot[bot]' }}
     name: Checks if number of files changed is acceptable
     runs-on: ubuntu-latest
     steps:
@@ -212,6 +214,7 @@ jobs:
           min_coverage: 95.0
 
   Graphql-Inspector:
+    if: ${{ github.actor != 'dependabot[bot]' }}
     name: Runs Introspection on the GitHub talawa-api repo on the schema.graphql file
     runs-on: ubuntu-latest
     steps:
@@ -239,6 +242,7 @@ jobs:
         run: graphql-inspector validate './src/GraphQl/**/*.ts' './talawa-api/schema.graphql'
 
   Check-Target-Branch:
+    if: ${{ github.actor != 'dependabot[bot]' }}
     name: Check Target Branch
     runs-on: ubuntu-latest
     steps:

.github/workflows/push.yml

@@ -21,6 +21,8 @@ env:
 
 jobs:
   Code-Coverage:
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    name: Test and Calculate Code Coverage
     runs-on: ubuntu-latest
     strategy:
       matrix:

.github/workflows/talawa_admin_md_mdx_format_adjuster.py

@@ -0,0 +1,96 @@
+#!/usr/bin/env python3
+# -*- coding: UTF-8 -*-
+"""
+Script to make Markdown files MDX compatible.
+
+This script scans Markdown files and escapes special characters (<, >, {, })
+to make them compatible with the MDX standard used in Docusaurus v3.
+
+This script complies with:
+    1) Pylint
+    2) Pydocstyle
+    3) Pycodestyle
+    4) Flake8
+"""
+import os
+import argparse
+import re
+
+def escape_mdx_characters(text):
+    """
+    Escape special characters in a text string for MDX compatibility.
+    Avoids escaping already escaped characters.
+
+    Args:
+        text: A string containing the text to be processed.
+
+    Returns:
+        A string with special characters (<, >, {, }) escaped, avoiding
+        double escaping.
+    """
+    # Regular expressions to find unescaped special characters
+    patterns = {
+        "<": r"(?<!\\)<",
+        ">": r"(?<!\\)>",
+        "{": r"(?<!\\){",
+        "}": r"(?<!\\)}"
+    }
+
+    # Replace unescaped special characters
+    for char, pattern in patterns.items():
+        text = re.sub(pattern, f"\\{char}", text)
+
+    return text
+
+def process_file(filepath):
+    """
+    Process a single Markdown file for MDX compatibility.
+
+    Args:
+        filepath: The path to the Markdown file to process.
+
+    Returns:
+        None, writes the processed content back to the file only if there are changes.
+    """
+    with open(filepath, 'r', encoding='utf-8') as file:
+        content = file.read()
+
+    # Escape MDX characters
+    new_content = escape_mdx_characters(content)
+
+    # Write the processed content back to the file only if there is a change
+    if new_content != content:
+        with open(filepath, 'w', encoding='utf-8') as file:
+            file.write(new_content)
+
+def main():
+    """
+    Main function to process all Markdown files in a given directory.
+
+    Scans for all Markdown files in the specified directory and processes each
+    one for MDX compatibility.
+
+    Args:
+        None
+
+    Returns:
+        None
+    """
+    parser = argparse.ArgumentParser(description="Make Markdown files MDX compatible.")
+    parser.add_argument(
+        "--directory",
+        type=str,
+        required=True,
+        help="Directory containing Markdown files to process."
+    )
+
+    args = parser.parse_args()
+
+    # Process each Markdown file in the directory
+    for root, _, files in os.walk(args.directory):
+        for file in files:
+            if file.lower().endswith(".md"):
+                process_file(os.path.join(root, file))
+
+if __name__ == "__main__":
+    main()

README.md

@@ -50,7 +50,7 @@ Core features include:
 1. The `talawa` documentation can be found at our [docs.talawa.io](https://docs.talawa.io) site.
     1. It is automatically generated from the markdown files stored in our [Talawa-Docs GitHub repository](https://github.com/PalisadoesFoundation/talawa-docs). This makes it easy for you to update our documenation.
 
-# Videos
+#  Videos
 
 1. Visit our [YouTube Channel playlists](https://www.youtube.com/@PalisadoesOrganization/playlists) for more insights
    1. The "[Getting Started - Developers](https://www.youtube.com/watch?v=YpBUoHxEeyg&list=PLv50qHwThlJUIzscg9a80a9-HmAlmUdCF&index=1)" videos are extremely helpful for new open source contributors.