Visualizer UI lib

[tinsaeDev]

how to visualize the data received from analyzer ?
const report = dolos.analyzePaths(["./file1.js", "./file2.js"]);

[rien]

Hi @tinsaeDev, apologies for the late response.

Visualizing takes two steps:

• Writing the report data to CSV files
• Hosting the Web UI and CSV files, and opening this page with a browser

This functionality is currently implemented in dolos-cli, you can take a look here:

dolos/cli/src/cli/commands/run.ts

Lines 187 to 220 in dc96168

	await tryCatch(options.verbose, async () => {
	const dolos = new Dolos({
	reportName: options.name,
	kgramData: options.compare,
	kgramLength: options.kgramLength,
	kgramsInWindow: options.kgramsInWindow,
	language: options.language,
	maxFingerprintCount: options.maxFingerprintCount,
	maxFingerprintPercentage: options.maxFingerprintPercentage,
	minFragmentLength: options.minFragmentLength,
	minSimilarity: options.minSimilarity,
	limitResults: options.limitResults,
	sortBy: options.sortBy,
	fragmentSortBy: options.fragmentSortBy,
	});
	const report = await dolos.analyzePaths(locations);
	if (report.warnings.length > 0) {
	report.warnings.forEach(warn => warning(warn));
	}
	const view = closestMatch(options.outputFormat, {
	"terminal": () => new TerminalView(report, options),
	"console": () => new TerminalView(report, options),
	"csv": () => new FileView(report, options),
	"html": () => new WebView(report, options),
	"web": () => new WebView(report, options),
	});
	if (view == null) {
	throw new Error(`Invalid output format: ${options.outputFormat}`);
	}
	await view().show();

The WebView responsible for hosting the Web UI, actually depends on the FileView to write the CSV-files.

However, these classes are present in the package @dodona/dolos where we don't export these classes, so you currently cannot do the visualization programmatically in your own code by importing these classes..

What is your use case for this? I could make these packages available or even provide some useful functions that would make this possible (for example a function report.visualize() that starts the Web UI).