fix: resolve linting issues and prepare for CI workflow

Author: fabiendostie

.github/workflows/deploy.yml

@@ -0,0 +1,58 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          cache: 'npm'
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+        
+      - name: Install dependencies
+        run: npm install
+
+      - name: Generate static API files
+        run: npm run generate-static-api
+
+      - name: Build with Next.js
+        run: npm run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./out
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 

README.md

@@ -12,24 +12,24 @@ A modern, browser-based tool for validating, editing, and ensuring compliance of
 
 ## ✨ Features
 
-*   **CSV Handling:** Upload, edit (with code editor), save, and download CSV files.
-*   **Schema Management:** Select predefined schemas or upload custom JSON schemas.
-*   **Live Validation:** Real-time validation using Ajv, with errors/warnings shown per row/value.
-*   **Detailed Results:** Errors and warnings are clearly displayed, with row numbers and schema paths.
-*   **Save & Download:** Download your edited CSV at any time.
-*   **Auto Re-validation:** CSV is automatically re-validated shortly after edits are made in the editor.
-*   **Human-Readable Schema Docs:** View a Markdown-rendered, human-friendly version of the selected schema.
-*   **Responsive UI:** Smoothly resizing panels with light/dark mode support.
-*   **Automated Checks:** Robust CI/CD pipeline with linting, testing (unit & E2E), and security scans.
+- **CSV Handling:** Upload, edit (with code editor), save, and download CSV files.
+- **Schema Management:** Select predefined schemas or upload custom JSON schemas.
+- **Live Validation:** Real-time validation using Ajv, with errors/warnings shown per row/value.
+- **Detailed Results:** Errors and warnings are clearly displayed, with row numbers and schema paths.
+- **Save & Download:** Download your edited CSV at any time.
+- **Auto Re-validation:** CSV is automatically re-validated shortly after edits are made in the editor.
+- **Human-Readable Schema Docs:** View a Markdown-rendered, human-friendly version of the selected schema.
+- **Responsive UI:** Smoothly resizing panels with light/dark mode support.
+- **Automated Checks:** Robust CI/CD pipeline with linting, testing (unit & E2E), and security scans.
 
 ---
 
 ## 🚀 Getting Started
 
 **Prerequisites:**
 
-*   Node.js (v18+ recommended)
-*   pnpm (or npm/yarn)
+- Node.js (v18+ recommended)
+- pnpm (or npm/yarn)
 
 **Installation & Running Locally:**
 
@@ -59,9 +59,9 @@ pnpm dev
 
 ### Managing Local Schemas
 
-*   **Location:** Predefined schemas are located in the `schemas/v1/` directory.
-*   **Adding New Schemas:** To add your own schema for local validation, simply place your `.json` schema file inside the `schemas/v1/` directory. The application will automatically pick it up and list it in the schema selection dropdown after a refresh.
-*   **Schema Naming:** Ensure your schema file has a `.json` extension.
+- **Location:** Predefined schemas are located in the `schemas/v1/` directory.
+- **Adding New Schemas:** To add your own schema for local validation, simply place your `.json` schema file inside the `schemas/v1/` directory. The application will automatically pick it up and list it in the schema selection dropdown after a refresh.
+- **Schema Naming:** Ensure your schema file has a `.json` extension.
 
 ---
 
@@ -72,58 +72,56 @@ This project uses a layered approach for quality assurance:
 <details>
   <summary><strong>Automated Checks Workflow (Click to Expand)</strong></summary>
 
-  *   **Pre-Commit (`lint-staged`):** 
-      *   *Purpose:* Auto-formats and fixes basic lint errors on staged files.
-      *   *Benefit:* Ensures clean commit history; fast feedback.
-  *   **Pre-Push (`husky`):** 
-      *   *Purpose:* Local safeguard checking lint, types (`tsc --noEmit`), and unit tests (`pnpm test:unit`) on the entire code being pushed.
-      *   *Benefit:* Prevents pushing broken code; catches issues missed by pre-commit.
-  *   **CI (`GitHub Actions`):** 
-      *   *Purpose:* Definitive quality gate (lint, all tests, build, security scans) in a clean environment.
-      *   *Benefit:* Ensures merged code meets all standards; catches anything missed locally.
+- **Pre-Commit (`lint-staged`):**
+  - _Purpose:_ Auto-formats and fixes basic lint errors on staged files.
+  - _Benefit:_ Ensures clean commit history; fast feedback.
+- **Pre-Push (`husky`):**
+  - _Purpose:_ Local safeguard checking lint, types (`tsc --noEmit`), and unit tests (`pnpm test:unit`) on the entire code being pushed.
+  - _Benefit:_ Prevents pushing broken code; catches issues missed by pre-commit.
+- **CI (`GitHub Actions`):** \* _Purpose:_ Definitive quality gate (lint, all tests, build, security scans) in a clean environment. \* _Benefit:_ Ensures merged code meets all standards; catches anything missed locally.
 </details>
 
 **Manual Checks:**
 
-  ```sh
+```sh
 # Lint check
-  pnpm lint
+pnpm lint
 
 # Format check (Prettier)
-  pnpm format --check
+pnpm format --check
 
 # Run unit tests
-pnpm test:unit 
+pnpm test:unit
 
 # Run all tests (unit + integration)
-  pnpm test
+pnpm test
 
 # Run E2E tests (Playwright)
-  pnpm e2e
-  ```
+pnpm e2e
+```
 
 ---
 
 ## ⚙️ CI/CD & Deployment
 
-*   **CI (`.github/workflows/CI.yml`):** Runs automatically on pushes/PRs to `main` and `develop`. Includes lint, format check, full tests (`pnpm test`), build, and E2E tests.
-*   **CodeQL (`.github/workflows/codeql-analysis.yml`):** Performs security analysis.
-*   **CD (`.github/workflows/CD.yml`):** Deploys the static export to GitHub Pages from the `main` branch.
-*   **Static Export:** Generated via `pnpm build && pnpm run export` (outputs to `./out`).
-*   **GitHub Pages:** Configure repo settings to serve from the `gh-pages` branch.
+- **CI (`.github/workflows/CI.yml`):** Runs automatically on pushes/PRs to `main` and `develop`. Includes lint, format check, full tests (`pnpm test`), build, and E2E tests.
+- **CodeQL (`.github/workflows/codeql-analysis.yml`):** Performs security analysis.
+- **CD (`.github/workflows/CD.yml`):** Deploys the static export to GitHub Pages from the `main` branch.
+- **Static Export:** Generated via `pnpm build && pnpm run export` (outputs to `./out`).
+- **GitHub Pages:** Configure repo settings to serve from the `gh-pages` branch.
 
 ---
 
 ## 💻 Tech Stack
 
-*   **Framework:** Next.js 15+ (React 19)
-*   **Language:** TypeScript 5+
-*   **UI:** Shadcn/ui, Radix UI, Tailwind CSS
-*   **Validation:** Ajv
-*   **CSV Parsing:** PapaParse
-*   **Editor:** Monaco Editor
-*   **Testing:** Jest (Unit), Playwright (E2E)
-*   **CI/CD:** GitHub Actions, Husky, lint-staged
+- **Framework:** Next.js 15+ (React 19)
+- **Language:** TypeScript 5+
+- **UI:** Shadcn/ui, Radix UI, Tailwind CSS
+- **Validation:** Ajv
+- **CSV Parsing:** PapaParse
+- **Editor:** Monaco Editor
+- **Testing:** Jest (Unit), Playwright (E2E)
+- **CI/CD:** GitHub Actions, Husky, lint-staged
 
 ---
 

app/api/generate-schema-doc/route.ts

@@ -4,7 +4,7 @@ import * as JsonSchemaStaticDocsLib from "json-schema-static-docs"; // Use names
 import fs from "fs/promises";
 import path from "path";
 import os from "os";
-import { createRequire } from "module"; // Import createRequire
+// import { createRequire } from "module"; // Import createRequire
 import prettier from "prettier";
 import parserTypescript from "prettier/parser-typescript";
 // import { DocGenerator } from "json-schema-static-docs"; // Removed
@@ -28,7 +28,9 @@ async function copyDirRecursive(src: string, dest: string) {
 }
 
 // Helper to create a temporary file
-async function writeTempSchemaFile(schema: Record<string, unknown>): Promise<string> {
+async function writeTempSchemaFile(
+  schema: Record<string, unknown>,
+): Promise<string> {
   const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), "schema-"));
   const tempFilePath = path.join(tempDir, "schema.json");
   await fs.writeFile(tempFilePath, JSON.stringify(schema, null, 2));
@@ -81,13 +83,13 @@ interface JsonSchemaStaticDocsOptions {
   createIndex: boolean;
   addFrontMatter: boolean;
   // Replace 'any' with 'unknown' for stricter checking
-  [key: string]: unknown; 
+  [key: string]: unknown;
 }
 
 interface JsonSchemaStaticDocsInstance {
   generate: () => Promise<void>;
   // Add other known methods/properties if available
-  [key: string]: unknown; 
+  [key: string]: unknown;
 }
 
 // Type for the constructor, assuming it's the default export or the module itself
@@ -104,30 +106,35 @@ type JsonSchemaStaticDocsModule =
   | { [key: string]: unknown }; // Fallback for other structures
 
 // Custom Type Guard for the Constructor
-function isDocConstructor(obj: unknown): obj is JsonSchemaStaticDocsConstructor {
-  return typeof obj === 'function' && obj.prototype !== undefined;
+function isDocConstructor(
+  obj: unknown,
+): obj is JsonSchemaStaticDocsConstructor {
+  return typeof obj === "function" && obj.prototype !== undefined;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 async function formatMarkdown(markdown: string): Promise<string> {
   try {
-    const result: string = await prettier.format(markdown, { 
+    const result: string = await prettier.format(markdown, {
       parser: "markdown",
-      plugins: [parserTypescript], 
+      plugins: [parserTypescript],
       printWidth: 80,
       proseWrap: "always",
     });
     return result;
-  } catch (error: unknown) { // Type error as unknown
+  } catch (error: unknown) {
+    // Type error as unknown
     console.warn("Could not parse error response from generate-schema-doc");
     // Safe access to properties
     let statusText = "Unknown status";
-    if (typeof error === 'object' && error !== null && 'statusText' in error) {
-        statusText = String((error as { statusText: unknown }).statusText);
+    if (typeof error === "object" && error !== null && "statusText" in error) {
+      statusText = String((error as { statusText: unknown }).statusText);
     }
     const errorDetails = `: ${statusText}`; // Use const as errorDetails is not reassigned after this block
     const message = error instanceof Error ? error.message : String(error);
-    throw new Error(`Markdown formatting failed${errorDetails}. Original error: ${message}`);
+    throw new Error(
+      `Markdown formatting failed${errorDetails}. Original error: ${message}`,
+    );
   }
 }
 
@@ -138,7 +145,9 @@ export async function POST(request: Request) {
   const cleanupPaths: string[] = []; // Keep track of all paths to clean
 
   try {
-    const { schema } = (await request.json()) as { schema: Record<string, unknown> }; // Added type assertion
+    const { schema } = (await request.json()) as {
+      schema: Record<string, unknown>;
+    }; // Added type assertion
 
     if (!schema) {
       return NextResponse.json(
@@ -193,30 +202,47 @@ export async function POST(request: Request) {
 
     // 4. Instantiate and run json-schema-static-docs
     // Attempt to find the constructor more safely
-    const LibraryModule: JsonSchemaStaticDocsModule = JsonSchemaStaticDocsLib; 
+    const LibraryModule = JsonSchemaStaticDocsLib as JsonSchemaStaticDocsModule; // ADDED TYPE ASSERTION
     let Constructor: JsonSchemaStaticDocsConstructor | null = null;
 
     // Use the type guard first for the direct constructor case
     if (isDocConstructor(LibraryModule)) {
-         Constructor = LibraryModule;
-    // Check if it's an object before checking properties
-    } else if (LibraryModule && typeof LibraryModule === 'object') { 
-        // Use 'in' operator for safer property checking
-        if ('default' in LibraryModule && LibraryModule.default && isDocConstructor(LibraryModule.default)) {
-            // Add type assertion
-            Constructor = LibraryModule.default as JsonSchemaStaticDocsConstructor;
-        } else if ('JsonSchemaStaticDocs' in LibraryModule && LibraryModule.JsonSchemaStaticDocs && isDocConstructor(LibraryModule.JsonSchemaStaticDocs)) {
-           // Add type assertion
-           Constructor = LibraryModule.JsonSchemaStaticDocs as JsonSchemaStaticDocsConstructor;
-        } else if ('DocGenerator' in LibraryModule && LibraryModule.DocGenerator && isDocConstructor(LibraryModule.DocGenerator)) {
-           // Add type assertion
-           Constructor = LibraryModule.DocGenerator as JsonSchemaStaticDocsConstructor;
-        }
+      Constructor = LibraryModule;
+      // Check if it's an object before checking properties
+    } else if (LibraryModule && typeof LibraryModule === "object") {
+      // Use 'in' operator for safer property checking
+      if (
+        "default" in LibraryModule &&
+        LibraryModule.default &&
+        isDocConstructor(LibraryModule.default)
+      ) {
+        // Add type assertion
+        Constructor = LibraryModule.default;
+      } else if (
+        "JsonSchemaStaticDocs" in LibraryModule &&
+        LibraryModule.JsonSchemaStaticDocs &&
+        isDocConstructor(LibraryModule.JsonSchemaStaticDocs)
+      ) {
+        // Add type assertion
+        Constructor = LibraryModule.JsonSchemaStaticDocs;
+      } else if (
+        "DocGenerator" in LibraryModule &&
+        LibraryModule.DocGenerator &&
+        isDocConstructor(LibraryModule.DocGenerator)
+      ) {
+        // Add type assertion
+        Constructor = LibraryModule.DocGenerator;
+      }
     }
 
     if (!Constructor) {
-        console.error("API: Could not find JsonSchemaStaticDocs constructor in the imported module.", LibraryModule);
-        throw new Error("Failed to load the documentation generator library correctly.");
+      console.error(
+        "API: Could not find JsonSchemaStaticDocs constructor in the imported module.",
+        LibraryModule,
+      );
+      throw new Error(
+        "Failed to load the documentation generator library correctly.",
+      );
     }
 
     // Instantiate using the found constructor
@@ -238,12 +264,14 @@ export async function POST(request: Request) {
       // Call generate method (type safety from interface)
       await generator.generate();
       console.log("API: Generator finished.");
-    } catch (genError: unknown) { // Ensure genError is unknown
+    } catch (genError: unknown) {
+      // Ensure genError is unknown
       console.error("API: Error during generator.generate():", genError);
       // Use type guard for message
-      const message = genError instanceof Error ? genError.message : "Generator failed";
-        
-        throw new Error(`Schema documentation generation failed: ${message}`); 
+      const message =
+        genError instanceof Error ? genError.message : "Generator failed";
+
+      throw new Error(`Schema documentation generation failed: ${message}`);
     }
 
     // 5. Read the generated Markdown file
@@ -257,7 +285,8 @@ export async function POST(request: Request) {
 
     // 7. Return the Markdown content
     return NextResponse.json({ markdown });
-  } catch (error: unknown) { // Changed to unknown
+  } catch (error: unknown) {
+    // Changed to unknown
     console.error("API Error generating schema doc:", error);
 
     // Ensure cleanup happens even on error