Class FlowrAnalyzerDescriptionFilePlugin

This plugin provides support for R DESCRIPTION files.

Hierarchy (View Summary)

FlowrAnalyzerFilePlugin
- FlowrAnalyzerDescriptionFilePlugin

Index

Constructors

constructor

new FlowrAnalyzerDescriptionFilePlugin(
filePattern?: RegExp,
): FlowrAnalyzerDescriptionFilePlugin
Creates a new instance of the DESCRIPTION file plugin.
Parameters
- filePattern: RegExp = DescriptionFilePattern
  The pattern to identify DESCRIPTION files, see DescriptionFilePattern for the default pattern.
Returns FlowrAnalyzerDescriptionFilePlugin
Overrides FlowrAnalyzerFilePlugin.constructor
- Defined in src/project/plugins/file-plugins/flowr-analyzer-description-file-plugin.ts:43

Properties

`Readonly`description

description: "Reads DESCRIPTION files into key-value pairs." = 'Reads DESCRIPTION files into key-value pairs.'

A short description of what the plugin does.

`Readonly`name

name: "flowr-analyzer-description-file-plugin" = 'flowr-analyzer-description-file-plugin'

A unique, human-readable name of the plugin.

`Readonly`type

type: FileLoad = PluginType.FileLoad

The type of the plugin, determining when and for what purpose it is applied during the analysis.

`Readonly`version

version: SemVer = ...

The version of the plugin, ideally following semver.

Methods

`Static`defaultPlugin

defaultPlugin(): FlowrAnalyzerFilePlugin
Returns a default/dummy implementation to be used when no plugin of this type is registered or triggered.

Returns FlowrAnalyzerFilePlugin
Inherited from FlowrAnalyzerFilePlugin.defaultPlugin
- Defined in src/project/plugins/file-plugins/flowr-analyzer-file-plugin.ts:29

applies

applies(file: PathLike): boolean
Determine whether this plugin applies to the given file.
Parameters
- file: PathLike
Returns boolean
Overrides FlowrAnalyzerFilePlugin.applies
- Defined in src/project/plugins/file-plugins/flowr-analyzer-description-file-plugin.ts:48

process

process(
_ctx: FlowrAnalyzerContext,
file: FlowrFileProvider,
): FlowrDescriptionFile
Parameters
- _ctx: FlowrAnalyzerContext
- file: FlowrFileProvider
Returns FlowrDescriptionFile
Overrides FlowrAnalyzerFilePlugin.process
- Defined in src/project/plugins/file-plugins/flowr-analyzer-description-file-plugin.ts:52

processor

processor(
    context: FlowrAnalyzerContext,
    args: FlowrFileProvider,
):
    | FlowrFileProvider<{ toString(): string }>
    | [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]
Run the plugin with the given context and arguments.
Parameters
- context: FlowrAnalyzerContext
- args: FlowrFileProvider
Returns
| FlowrFileProvider<{ toString(): string }>
| [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]
Inherited from FlowrAnalyzerFilePlugin.processor
- Defined in src/project/plugins/flowr-analyzer-plugin.ts:110

Class FlowrAnalyzerDescriptionFilePlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerDescriptionFilePlugin

Properties

`Readonly`description

`Readonly`name

`Readonly`type

`Readonly`version

Methods

`Static`defaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

process

Parameters

Returns FlowrDescriptionFile

processor

Parameters

Returns
| FlowrFileProvider<{ toString(): string }>
| [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]

Settings

On This Page

Class FlowrAnalyzerDescriptionFilePlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerDescriptionFilePlugin

Properties

Readonlydescription

Readonlyname

Readonlytype

Readonlyversion

Methods

StaticdefaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

process

Parameters

Returns FlowrDescriptionFile

processor

Parameters

Returns | FlowrFileProvider<{ toString(): string }> | [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]

Settings

On This Page

`Readonly`description

`Readonly`name

`Readonly`type

`Readonly`version

`Static`defaultPlugin

Returns
| FlowrFileProvider<{ toString(): string }>
| [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]