@eagleoutice/flowr-dev/project/plugins/file-plugins/flowr-analyzer-description-file-plugin.d.ts

Static Dataflow Analyzer and Program Slicer for the R Programming Language

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 { FlowrDescriptionFile } from './files/flowr-description-file';
import { type FlowrFileProvider } from '../../context/flowr-file';
export declare const descriptionFileLog: import("tslog").Logger<import("tslog").ILogObj>;
/** Access to the `DESCRIPTION` file of the analyzed project. */
export declare const DescriptionFile: {
    readonly name: "DescriptionFile";
    /** The project's only `DESCRIPTION` file, `undefined` if there is none; `missing` states what cannot be done then. */
    readonly single: (this: void, ctx: FlowrAnalyzerContext, missing: string) => FlowrDescriptionFile | undefined;
};
/**
 * This plugin provides support for R `DESCRIPTION` files.
 */
export declare class FlowrAnalyzerDescriptionFilePlugin extends FlowrAnalyzerFilePlugin {
    readonly name = "flowr-analyzer-description-file-plugin";
    readonly description = "Reads DESCRIPTION files into key-value pairs.";
    readonly version: SemVer;
    private readonly pattern;
    /**
     * Creates a new instance of the DESCRIPTION file plugin.
     * @param filePattern - The pattern to identify DESCRIPTION files, see {@link DescriptionFilePattern} for the default pattern.
     */
    constructor(filePattern?: RegExp);
    applies(file: PathLike): boolean;
    process(_ctx: FlowrAnalyzerContext, file: FlowrFileProvider): FlowrDescriptionFile;
}