feat(plugin): support license file (#2196)

Author: EagleoutIce

src/project/context/flowr-analyzer-files-context.ts

@@ -43,6 +43,7 @@ export type RoleBasedFiles = {
     /* currently no special support */
 	[FileRole.Vignette]:    FlowrFileProvider[];
 	[FileRole.Test]:        FlowrFileProvider[];
+	[FileRole.License]:     FlowrFileProvider[];
 	[FileRole.Source]:      FlowrFileProvider[];
 	[FileRole.Data]:        FlowrFileProvider[];
 	[FileRole.Other]:       FlowrFileProvider[];

src/project/context/flowr-file.ts

@@ -26,6 +26,8 @@ export enum FileRole {
 	Test        = 'test',
 	/** Data files, e.g., `R/sysdata.rda`, currently not specially supported. */
 	Data        = 'data',
+	/** Signals separate license files, but please note, that DESCRIPTION files may contain license info too */
+	License     = 'license',
 	/**
 	 * Catch-all for any file that provides usable R source code to incorporate into the analysis.
 	 * Please note, that the loading order/inclusion and even potential relevance of these source files

src/project/plugins/file-plugins/flowr-analyzer-license-file-plugin.ts

@@ -0,0 +1,42 @@
+import { FlowrAnalyzerFilePlugin } from './flowr-analyzer-file-plugin';
+import { SemVer } from 'semver';
+import type { PathLike } from 'fs';
+import type { FlowrAnalyzerContext } from '../../context/flowr-analyzer-context';
+import type { FlowrFileProvider } from '../../context/flowr-file';
+import { FileRole } from '../../context/flowr-file';
+import {
+	platformBasename
+} from '../../../dataflow/internal/process/functions/call/built-in/built-in-source';
+
+const FileNamePattern = /license(\.md|\.txt)?$/i;
+
+/**
+ * This plugin provides supports for the identification of license files.
+ */
+export class FlowrAnalyzerLicenseFilePlugin extends FlowrAnalyzerFilePlugin {
+	public readonly name = 'flowr-analyzer-license-files-plugin';
+	public readonly description = 'This plugin provides support for loading license files.';
+	public readonly version = new SemVer('0.1.0');
+	private readonly pathPattern: RegExp;
+
+	/**
+	 * Creates a new instance of the TEST file plugin.
+	 * @param pathPattern - The pathPattern to identify TEST files, see {@link FileNamePattern} for the default pathPattern.
+	 */
+	constructor(pathPattern: RegExp = FileNamePattern) {
+		super();
+		this.pathPattern = pathPattern;
+	}
+
+	public applies(file: PathLike): boolean {
+		return this.pathPattern.test(platformBasename(file.toString()));
+	}
+
+	/**
+	 * Processes the given file, assigning it the {@link FileRole.License} role.
+	 */
+	public process(_ctx: FlowrAnalyzerContext, file: FlowrFileProvider): FlowrFileProvider {
+		file.assignRole(FileRole.License);
+		return file;
+	}
+}

src/project/plugins/flowr-analyzer-plugin-defaults.ts

@@ -13,6 +13,7 @@ import { FlowrAnalyzerNamespaceFilesPlugin } from './file-plugins/flowr-analyzer
 import { FlowrAnalyzerNewsFilePlugin } from './file-plugins/flowr-analyzer-news-file-plugin';
 import { FlowrAnalyzerMetaVignetteFilesPlugin } from './file-plugins/flowr-analyzer-vignette-file-plugin';
 import { FlowrAnalyzerMetaTestFilesPlugin } from './file-plugins/flowr-analyzer-test-file-plugin';
+import { FlowrAnalyzerLicenseFilePlugin } from './file-plugins/flowr-analyzer-license-file-plugin';
 
 /**
  * Provides the default set of Flowr Analyzer plugins.
@@ -26,6 +27,7 @@ export function FlowrAnalyzerPluginDefaults(): FlowrAnalyzerPlugin[] {
 		new FlowrAnalyzerLoadingOrderDescriptionFilePlugin(),
 		new FlowrAnalyzerRmdFilePlugin(),
 		new FlowrAnalyzerQmdFilePlugin(),
+		new FlowrAnalyzerLicenseFilePlugin(),
 		new FlowrAnalyzerJupyterFilePlugin(),
 		new FlowrAnalyzerNamespaceFilesPlugin(),
 		new FlowrAnalyzerNewsFilePlugin()

src/project/plugins/plugin-registry.ts

@@ -14,6 +14,7 @@ import { FlowrAnalyzerNamespaceFilesPlugin } from './file-plugins/flowr-analyzer
 import { FlowrAnalyzerNewsFilePlugin } from './file-plugins/flowr-analyzer-news-file-plugin';
 import { FlowrAnalyzerMetaVignetteFilesPlugin } from './file-plugins/flowr-analyzer-vignette-file-plugin';
 import { FlowrAnalyzerMetaTestFilesPlugin } from './file-plugins/flowr-analyzer-test-file-plugin';
+import { FlowrAnalyzerLicenseFilePlugin } from './file-plugins/flowr-analyzer-license-file-plugin';
 
 /**
  * The built-in Flowr Analyzer plugins that are always available.
@@ -28,7 +29,8 @@ export const BuiltInPlugins = [
 	['file:qmd', FlowrAnalyzerQmdFilePlugin],
 	['file:ipynb', FlowrAnalyzerJupyterFilePlugin],
 	['file:namespace', FlowrAnalyzerNamespaceFilesPlugin],
-	['file:news', FlowrAnalyzerNewsFilePlugin]
+	['file:news', FlowrAnalyzerNewsFilePlugin],
+	['file:license', FlowrAnalyzerLicenseFilePlugin]
 ] as const satisfies [string, PluginProducer][];
 
 export type BuiltInFlowrPluginName = typeof BuiltInPlugins[number][0];

test/functionality/project/plugin/license-file.test.ts

@@ -0,0 +1,29 @@
+import { assert, describe, test } from 'vitest';
+import { FlowrAnalyzerContext } from '../../../../src/project/context/flowr-analyzer-context';
+import { arraysGroupBy } from '../../../../src/util/collections/arrays';
+import { FileRole, FlowrInlineTextFile } from '../../../../src/project/context/flowr-file';
+import { defaultConfigOptions } from '../../../../src/config';
+import {
+	FlowrAnalyzerLicenseFilePlugin
+} from '../../../../src/project/plugins/file-plugins/flowr-analyzer-license-file-plugin';
+
+
+describe('License-file', function() {
+	const ctx = new FlowrAnalyzerContext(
+		defaultConfigOptions,
+		arraysGroupBy([
+			new FlowrAnalyzerLicenseFilePlugin()
+		], p => p.type)
+	);
+
+	ctx.addFile(new FlowrInlineTextFile('LICENSE', 'Hey'));
+	ctx.resolvePreAnalysis();
+
+	test('Get the License!', () => {
+		const files = ctx.files.getFilesByRole(FileRole.License);
+		assert.lengthOf(files, 1, 'There should be exactly one License file');
+
+		const content = files[0].content();
+		assert.strictEqual(content, 'Hey', 'The content of the LICENSE file should match');
+	});
+});