mrva/vscode-codeql
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

MRVA: Support both local and gist links when generating markdown

Browse Source
This commit is contained in:
Charis Kyriakou
2022-05-03 13:27:53 +01:00
committed by GitHub
parent 9b6eddddae
commit a97c5fe836
2 changed files with 24 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
extensions/ql-vscode/src/remote-queries/remote-queries-markdown-generation.ts
View File

@@ -6,13 +6,19 @@ import { convertNonPrintableChars } from '../text-utils';
import { RemoteQuery } from './remote-query';
import { AnalysisAlert, AnalysisRawResults, AnalysisResults, CodeSnippet, FileLink, getAnalysisResultCount, HighlightedRegion } from './shared/analysis-result';
export type MarkdownLinkType = 'local' | 'gist';
// Each array item is a line of the markdown file.
export type MarkdownFile = string[];
/**
* Generates markdown files with variant analysis results.
*/
export function generateMarkdown(query: RemoteQuery, analysesResults: AnalysisResults[]): MarkdownFile[] {
export function generateMarkdown(
query: RemoteQuery,
analysesResults: AnalysisResults[],
linkType: MarkdownLinkType
): MarkdownFile[] {
const files: MarkdownFile[] = [];
// Generate summary file with links to individual files
const summaryLines: MarkdownFile = generateMarkdownSummary(query);
@@ -24,7 +30,7 @@ export function generateMarkdown(query: RemoteQuery, analysesResults: AnalysisRe
// Append nwo and results count to the summary table
const nwo = analysisResult.nwo;
const link = createGistRelativeLink(nwo);
const link = createRelativeLink(nwo, linkType);
summaryLines.push(`| ${nwo} | [${resultsCount} result(s)](${link}) |`);
// Generate individual markdown file for each repository
@@ -290,13 +296,18 @@ function buildExpandableMarkdownSection(title: string, contents: MarkdownFile):
return expandableLines;
}
/**
* Creates anchor link to a file in the gist. This is of the form:
* '#file-<name>-<file-extension>'
*
* TODO: Make sure these names align with the actual file names once we upload them to a gist.
*/
function createGistRelativeLink(nwo: string): string {
function createRelativeLink(nwo: string, linkType: MarkdownLinkType): string {
const [owner, repo] = nwo.split('/');
return `#file-${owner}-${repo}-md`;
switch (linkType) {
case 'local':
return `./${owner}-${repo}.md`;
case 'gist':
// Creates anchor link to a file in the gist. This is of the form:
// '#file-<name>-<file-extension>'
//
// TODO: Make sure these names align with the actual file names once we upload them to a gist.
return `#file-${owner}-${repo}-md`;
}
}

6
extensions/ql-vscode/test/pure-tests/remote-queries/markdown-generation/markdown-generation.test.ts
View File

@@ -13,7 +13,7 @@ describe('markdown generation', async function() {
const analysesResults = JSON.parse(
await fs.readFile(path.join(__dirname, 'data/interpreted-results/path-problem/analyses-results.json'), 'utf8')
);
const markdownFiles = generateMarkdown(pathProblemQuery, analysesResults);
const markdownFiles = generateMarkdown(pathProblemQuery, analysesResults, 'gist');
// Check that query has results for two repositories, plus a summary file
expect(markdownFiles.length).to.equal(3);
@@ -42,7 +42,7 @@ describe('markdown generation', async function() {
const analysesResults = JSON.parse(
await fs.readFile(path.join(__dirname, 'data/interpreted-results/problem/analyses-results.json'), 'utf8')
);
const markdownFiles = generateMarkdown(problemQuery, analysesResults);
const markdownFiles = generateMarkdown(problemQuery, analysesResults, 'gist');
// Check that query has results for two repositories, plus a summary file
expect(markdownFiles.length).to.equal(3);
@@ -71,7 +71,7 @@ describe('markdown generation', async function() {
await fs.readFile(path.join(__dirname, 'data/raw-results/analyses-results.json'), 'utf8')
);
const markdownFiles = generateMarkdown(query, analysesResults);
const markdownFiles = generateMarkdown(query, analysesResults, 'gist');
// Check that query has results for two repositories, plus a summary file
expect(markdownFiles.length).to.equal(3);