@slashgear/gdpr-cookie-scanner 1.3.0 → 2.0.0

package/src/cli.ts

@@ -5,7 +5,7 @@ import ora from "ora";
 import { join, resolve } from "path";
 import { Scanner } from "./scanner/index.js";
 import { ReportGenerator } from "./report/generator.js";
-import type { ScanOptions } from "./types.js";
+import type { ScanOptions, ReportFormat } from "./types.js";
 
 const program = new Command();
 
@@ -23,6 +23,11 @@ program
   .option("--no-screenshots", "Disable screenshot capture")
   .option("-l, --locale <locale>", "Browser locale for language detection", "fr-FR")
   .option("-v, --verbose", "Show detailed output", false)
+  .option(
+    "-f, --format <formats>",
+    "Output formats: md, html, json, pdf (comma-separated)",
+    "md,pdf",
+  )
   .action(async (url: string, opts) => {
     console.log();
     console.log(chalk.bold.blue("  GDPR Cookie Scanner"));
@@ -35,6 +40,17 @@ program
     console.log(chalk.gray(`  Output : ${outputDir}`));
     console.log();
 
+    const validFormats = new Set<ReportFormat>(["md", "html", "json", "pdf"]);
+    const formats = (opts.format as string)
+      .split(",")
+      .map((f) => f.trim().toLowerCase())
+      .filter((f): f is ReportFormat => validFormats.has(f as ReportFormat));
+
+    if (formats.length === 0) {
+      console.error(chalk.red("  Invalid --format value. Valid options: md, html, json, pdf"));
+      process.exit(2);
+    }
+
     const options: ScanOptions = {
       url: normalizedUrl,
       outputDir,
@@ -42,6 +58,7 @@ program
       screenshots: opts.screenshots !== false,
       locale: opts.locale,
       verbose: opts.verbose,
+      formats,
     };
 
     const spinner = ora("Launching browser...").start();
@@ -58,7 +75,7 @@ program
       console.log();
 
       const generator = new ReportGenerator(options);
-      const { reportPath, pdfPath } = await generator.generate(result);
+      const paths = await generator.generate(result);
 
       console.log(
         chalk.bold(
@@ -81,8 +98,15 @@ program
         console.log();
       }
 
-      console.log(chalk.green(`  Report saved: ${reportPath}`));
-      console.log(chalk.green(`  PDF saved:    ${pdfPath}`));
+      const labels: Record<string, string> = {
+        md: "Markdown",
+        html: "HTML",
+        json: "JSON",
+        pdf: "PDF",
+      };
+      for (const [fmt, path] of Object.entries(paths)) {
+        console.log(chalk.green(`  ${(labels[fmt] ?? fmt).padEnd(8)} ${path}`));
+      }
       console.log();
 
       process.exit(result.compliance.grade === "F" ? 1 : 0);

package/src/report/generator.ts

@@ -5,6 +5,7 @@ import { promisify } from "util";
 import { fileURLToPath } from "url";
 import { Marked } from "marked";
 import { generatePdf } from "./pdf.js";
+import { generateHtmlReport } from "./html.js";
 
 const execFileAsync = promisify(execFile);
 const oxfmtBin = join(dirname(fileURLToPath(import.meta.url)), "../../node_modules/.bin/oxfmt");
@@ -20,39 +21,63 @@ import type { ScanOptions } from "../types.js";
 export class ReportGenerator {
   constructor(private readonly options: ScanOptions) {}
 
-  async generate(result: ScanResult): Promise<{ reportPath: string; pdfPath: string }> {
+  async generate(result: ScanResult): Promise<Record<string, string>> {
     await mkdir(this.options.outputDir, { recursive: true });
 
     const hostname = new URL(result.url).hostname.replace(/^www\./, "");
     const date = new Date(result.scanDate).toISOString().split("T")[0];
-    const filename = `gdpr-report-${hostname}-${date}.md`;
-    const outputPath = join(this.options.outputDir, filename);
-
-    const markdown = this.buildMarkdown(result);
-    await writeFile(outputPath, markdown, "utf-8");
-    await execFileAsync(oxfmtBin, [outputPath]).catch(() => {});
-
-    const checklistFilename = `gdpr-checklist-${hostname}-${date}.md`;
-    const checklistPath = join(this.options.outputDir, checklistFilename);
-    const checklist = this.buildChecklist(result);
-    await writeFile(checklistPath, checklist, "utf-8");
-    await execFileAsync(oxfmtBin, [checklistPath]).catch(() => {});
-
-    const cookiesFilename = `gdpr-cookies-${hostname}-${date}.md`;
-    const cookiesPath = join(this.options.outputDir, cookiesFilename);
-    const cookiesInventory = this.buildCookiesInventory(result);
-    await writeFile(cookiesPath, cookiesInventory, "utf-8");
-    await execFileAsync(oxfmtBin, [cookiesPath]).catch(() => {});
-
-    const combined = [markdown, checklist, cookiesInventory].join("\n\n---\n\n");
-    const rawBody = await this.buildHtmlBody(combined);
-    const body = await this.inlineImages(rawBody, this.options.outputDir);
-    const html = this.wrapHtml(body, hostname);
-    const pdfFilename = `gdpr-report-${hostname}-${date}.pdf`;
-    const pdfPath = join(this.options.outputDir, pdfFilename);
-    await generatePdf(html, pdfPath);
-
-    return { reportPath: outputPath, pdfPath };
+    const base = `gdpr-report-${hostname}-${date}`;
+    const formats = this.options.formats;
+
+    const paths: Record<string, string> = {};
+
+    // ── Markdown ──────────────────────────────────────────────────
+    if (formats.includes("md")) {
+      const mdPath = join(this.options.outputDir, `${base}.md`);
+      await writeFile(mdPath, this.buildMarkdown(result), "utf-8");
+      await execFileAsync(oxfmtBin, [mdPath]).catch(() => {});
+      paths.md = mdPath;
+
+      const checklistPath = join(this.options.outputDir, `gdpr-checklist-${hostname}-${date}.md`);
+      await writeFile(checklistPath, this.buildChecklist(result), "utf-8");
+      await execFileAsync(oxfmtBin, [checklistPath]).catch(() => {});
+
+      const cookiesPath = join(this.options.outputDir, `gdpr-cookies-${hostname}-${date}.md`);
+      await writeFile(cookiesPath, this.buildCookiesInventory(result), "utf-8");
+      await execFileAsync(oxfmtBin, [cookiesPath]).catch(() => {});
+    }
+
+    // ── HTML ──────────────────────────────────────────────────────
+    if (formats.includes("html")) {
+      const htmlPath = join(this.options.outputDir, `${base}.html`);
+      await writeFile(htmlPath, generateHtmlReport(result), "utf-8");
+      paths.html = htmlPath;
+    }
+
+    // ── JSON ──────────────────────────────────────────────────────
+    if (formats.includes("json")) {
+      const jsonPath = join(this.options.outputDir, `${base}.json`);
+      await writeFile(jsonPath, JSON.stringify(result, null, 2), "utf-8");
+      paths.json = jsonPath;
+    }
+
+    // ── PDF (via Markdown → HTML → Playwright) ────────────────────
+    if (formats.includes("pdf")) {
+      const markdown = paths.md
+        ? await import("fs/promises").then((m) => m.readFile(paths.md!, "utf-8"))
+        : this.buildMarkdown(result);
+      const checklist = this.buildChecklist(result);
+      const cookiesInventory = this.buildCookiesInventory(result);
+      const combined = [markdown, checklist, cookiesInventory].join("\n\n---\n\n");
+      const rawBody = await this.buildHtmlBody(combined);
+      const body = await this.inlineImages(rawBody, this.options.outputDir);
+      const html = this.wrapHtml(body, hostname);
+      const pdfPath = join(this.options.outputDir, `${base}.pdf`);
+      await generatePdf(html, pdfPath);
+      paths.pdf = pdfPath;
+    }
+
+    return paths;
   }
 
   private async buildHtmlBody(markdown: string): Promise<string> {