feat:script to check ts-ignore (#3246)

* feat:script for ts-ignore

* fix:improved codequality

* fix:added logging

* fix:improved code-quality

* fix:trailing commas

Author: shivasankaran18

.github/workflows/pull-request.yml

@@ -48,8 +48,8 @@ jobs:
           echo "Error: Close this PR and try again."          
           exit 1
 
-  check_biome_ignore:
-    name: Check for biome_ignore
+  python_checks:
+    name: Run Python Checks
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -64,30 +64,19 @@ jobs:
         with:
           python-version: 3.9
 
-      - name: Run Python script
+      - name: Run Biome Ignore Check
         run: |
           python .github/workflows/scripts/biome_disable_check.py --files ${{ steps.changed-files.outputs.all_changed_files }}
 
-  check_code_coverage_disable:
-    name: Check for code coverage disable
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Get changed files
-        id: changed-files
-        uses: tj-actions/changed-files@v45
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.9
-
-      - name: Run Python script
+      - name: Run Code Coverage Disable Check
         run: |
           python .github/workflows/scripts/code_coverage_disable_check.py --files ${{ steps.changed-files.outputs.all_changed_files }}
 
+      - name: Run TS Ignore Check
+        run: |
+          python .github/workflows/scripts/detect_ts_ignore.py --files ${{ steps.changed-files.outputs.all_changed_files }}
+
   check_gql_tada:
     name: Check gql tada files and configuration
     runs-on: ubuntu-latest
@@ -195,7 +184,7 @@ jobs:
   Run-Tests:
     name: Run tests for talawa api
     runs-on: ubuntu-latest
-    needs: [Code-Quality-Checks, check_code_coverage_disable]
+    needs: [Code-Quality-Checks, python_checks]
     env:
       CODECOV_UNIQUE_NAME: ${{github.workflow}}-${{github.ref_name}}
     steps:

.github/workflows/scripts/detect_ts_ignore.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python3
+"""Script to detect and report usage of @ts-ignore comments in TypeScript."""
+
+import argparse
+import re
+import sys
+import logging
+
+# Configure logging
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(levelname)s: %(message)s",
+)
+
+TS_IGNORE_PATTERN = r"(?://|/\*)\s*@ts-ignore(?:\s+|$)"
+
+
+def check_ts_ignore(files: list[str]) -> int:
+    """Check for occurrences of '@ts-ignore' in the given files.
+
+    Args:
+        files (list[str]): List of file paths to check.
+
+    Returns:
+        int: 0 if no violations, 1 if violations are found.
+    """
+    ts_ignore_found = False
+
+    for file in files:
+        try:
+            logging.info("Checking file: %s", file)
+            with open(file, encoding="utf-8") as f:
+                for line_num, line in enumerate(f, start=1):
+                    # Handle more variations of @ts-ignore
+                    if re.search(
+                        TS_IGNORE_PATTERN,
+                        line.strip(),
+                    ):
+                        print(
+                            "❌ Error: '@ts-ignore' found in %s at line %d",
+                            file,
+                            line_num,
+                        )
+                        logging.debug(
+                            "Found @ts-ignore in line: %s",
+                            line.strip(),
+                        )
+                        ts_ignore_found = True
+        except FileNotFoundError:
+            logging.warning("File not found: %s", file)
+        except OSError:
+            logging.exception("Could not read %s", file)
+    if not ts_ignore_found:
+        print("✅ No '@ts-ignore' comments found in the files.")
+
+    return 1 if ts_ignore_found else 0
+
+
+def main() -> None:
+    """Main function to parse arguments and run the check.
+
+    This function sets up argument parsing for file paths and runs the ts-ignore
+    check on the specified files.
+
+    Args:
+        None
+
+    Returns:
+        None: The function exits the program with status code 0 if no ts-ignore
+        comments are found, or 1 if any are detected.
+    """
+    parser = argparse.ArgumentParser(
+        description="Check for @ts-ignore in changed files.",
+    )
+    parser.add_argument(
+        "--files",
+        nargs="+",
+        help="List of changed files",
+        required=True,
+    )
+    args = parser.parse_args()
+
+    # Filter TypeScript files
+    ts_files = [f for f in args.files if f.endswith((".ts", ".tsx"))]
+    if not ts_files:
+        logging.info("No TypeScript files to check.")
+        sys.exit(0)
+
+    exit_code = check_ts_ignore(args.files)
+    sys.exit(exit_code)
+
+
+if __name__ == "__main__":
+    main()