@eagleoutice/flowr/project/plugins/file-plugins/flowr-analyzer-vignette-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 type { FlowrFileProvider } from '../../context/flowr-file';
/**
 * This plugin provides supports for the loading of Vignette files.
 * If you use multiple plugins, this should be included *before* other plugins.
 */
export declare class FlowrAnalyzerMetaVignetteFilesPlugin extends FlowrAnalyzerFilePlugin {
    readonly name = "flowr-analyzer-vignette-files-plugin";
    readonly description = "This plugin provides support for loading vignette files.";
    readonly version: SemVer;
    private readonly pathPattern;
    /**
     * Creates a new instance of the VIGNETTE file plugin.
     * @param pathPattern - The pathPattern to identify VIGNETTE files, see {@link VignettePathPattern} for the default pathPattern.
     */
    constructor(pathPattern?: RegExp);
    applies(file: PathLike): boolean;
    /**
     * Processes the given file, assigning it the {@link FileRole.Vignette} role.
     * Given that the file may still need to be processed by other plugins, this method returns the `true` flag for that purpose.
     */
    process(_ctx: FlowrAnalyzerContext, file: FlowrFileProvider): [FlowrFileProvider, true];
}