Merge pull request #2079 from github/koesie10/markdown-generation-tests

Add tests for Markdown generation

Author: koesie10

extensions/ql-vscode/src/databases/config/db-config-validator.ts

@@ -2,7 +2,7 @@ import { readJsonSync } from "fs-extra";
 import { resolve } from "path";
 import Ajv from "ajv";
 import { clearLocalDbConfig, DbConfig } from "./db-config";
-import { findDuplicateStrings } from "../../text-utils";
+import { findDuplicateStrings } from "../../pure/text-utils";
 import {
   DbConfigValidationError,
   DbConfigValidationErrorKind,

extensions/ql-vscode/src/text-utils.ts …ensions/ql-vscode/src/pure/text-utils.tsextensions/ql-vscode/src/text-utils.ts renamed to extensions/ql-vscode/src/pure/text-utils.ts extensions/ql-vscode/src/text-utils.ts renamed to extensions/ql-vscode/src/pure/text-utils.ts

@@ -18,7 +18,7 @@ import {
   generateVariantAnalysisMarkdown,
   MarkdownFile,
   RepositorySummary,
-} from "./remote-queries-markdown-generation";
+} from "./markdown-generation";
 import { pluralize } from "../pure/word";
 import { VariantAnalysisManager } from "./variant-analysis-manager";
 import { assertNever } from "../pure/helpers-pure";

extensions/ql-vscode/src/remote-queries/export-results.ts

@@ -2,20 +2,20 @@ import { CellValue } from "../pure/bqrs-cli-types";
 import { tryGetRemoteLocation } from "../pure/bqrs-utils";
 import { createRemoteFileRef } from "../pure/location-link-utils";
 import { parseHighlightedLine, shouldHighlightLine } from "../pure/sarif-utils";
-import { convertNonPrintableChars } from "../text-utils";
-import {
+import { convertNonPrintableChars } from "../pure/text-utils";
+import type {
   AnalysisAlert,
   AnalysisRawResults,
   CodeSnippet,
   FileLink,
   HighlightedRegion,
 } from "./shared/analysis-result";
-import {
+import type {
   VariantAnalysis,
   VariantAnalysisScannedRepository,
   VariantAnalysisScannedRepositoryResult,
 } from "./shared/variant-analysis";
-import { RepositoryWithMetadata } from "./shared/repository";
+import type { RepositoryWithMetadata } from "./shared/repository";
 
 export type MarkdownLinkType = "local" | "gist";
 
@@ -39,7 +39,7 @@ export interface VariantAnalysisMarkdown {
  * Generates markdown files with variant analysis results.
  */
 export async function generateVariantAnalysisMarkdown(
-  variantAnalysis: VariantAnalysis,
+  variantAnalysis: Pick<VariantAnalysis, "query">,
   results: AsyncIterable<
     [VariantAnalysisScannedRepository, VariantAnalysisScannedRepositoryResult]
   >,
@@ -91,7 +91,7 @@ export async function generateVariantAnalysisMarkdown(
 
   // Generate summary file with links to individual files
   const summaryFile: MarkdownFile = generateVariantAnalysisMarkdownSummary(
-    variantAnalysis,
+    variantAnalysis.query,
     summaries,
     linkType,
   );
@@ -103,20 +103,16 @@ export async function generateVariantAnalysisMarkdown(
 }
 
 export function generateVariantAnalysisMarkdownSummary(
-  variantAnalysis: VariantAnalysis,
+  query: VariantAnalysis["query"],
   summaries: RepositorySummary[],
   linkType: MarkdownLinkType,
 ): MarkdownFile {
   const lines: string[] = [];
   // Title
-  lines.push(`### Results for "${variantAnalysis.query.name}"`, "");
+  lines.push(`### Results for "${query.name}"`, "");
 
   // Expandable section containing query text
-  const queryCodeBlock = [
-    "```ql",
-    ...variantAnalysis.query.text.split("\n"),
-    "```",
-  ];
+  const queryCodeBlock = ["```ql", ...query.text.split("\n"), "```"];
   lines.push(...buildExpandableMarkdownSection("Query", queryCodeBlock));
 
   // Padding between sections

…es/remote-queries-markdown-generation.ts …rc/remote-queries/markdown-generation.tsextensions/ql-vscode/src/remote-queries/remote-queries-markdown-generation.ts renamed to extensions/ql-vscode/src/remote-queries/markdown-generation.ts extensions/ql-vscode/src/remote-queries/remote-queries-markdown-generation.ts renamed to extensions/ql-vscode/src/remote-queries/markdown-generation.ts

@@ -9,7 +9,7 @@ import {
 } from "../../pure/interface-types";
 import { assertNever } from "../../pure/helpers-pure";
 import { vscode } from "../vscode-api";
-import { convertNonPrintableChars } from "../../text-utils";
+import { convertNonPrintableChars } from "../../pure/text-utils";
 import { sendTelemetry } from "../common/telemetry";
 
 export interface ResultTableProps {

extensions/ql-vscode/src/view/results/result-table-utils.tsx

@@ -9,7 +9,7 @@ import {
 } from "../../pure/bqrs-cli-types";
 import { tryGetRemoteLocation } from "../../pure/bqrs-utils";
 import TextButton from "../common/TextButton";
-import { convertNonPrintableChars } from "../../text-utils";
+import { convertNonPrintableChars } from "../../pure/text-utils";
 import { sendTelemetry, useTelemetryOnChange } from "../common/telemetry";
 
 const numOfResultsInContractedMode = 5;