Class FlowrAnalyzerRdFileBasePlugin<F>`Abstract`

Shared body of the .Rd-family plugins below; a concrete class only adds its name, description, default pattern, lift, and (twice) applies.

Type Parameters

F extends FlowrFileProvider

Hierarchy (View Summary)

FlowrAnalyzerPatternFilePlugin
- FlowrAnalyzerRdFileBasePlugin

Index

Constructors

constructor

new FlowrAnalyzerRdFileBasePlugin<
    F extends FlowrFileProvider<{ toString(): string }>,
>(
    pattern: RegExp,
    part?: (p: string) => string,
): FlowrAnalyzerRdFileBasePlugin<F>
Type Parameters
- F extends FlowrFileProvider<{ toString(): string }>
Parameters
- pattern: RegExp
  The pattern to identify the files of this plugin, see the respective subclass for its default.
- part: (p: string) => string = PathPart.Basename
  The part of the path the pattern is matched against.
Returns FlowrAnalyzerRdFileBasePlugin<F>
Inherited from FlowrAnalyzerPatternFilePlugin.constructor
- Defined in src/project/plugins/file-plugins/flowr-analyzer-file-plugin.ts:75

Properties

`Abstract` `Readonly`description

description: string

A short description of what the plugin does.

`Protected` `Abstract` `Readonly`lift

lift: (file: FlowrFileProvider) => F

Lifts a matched file into this plugin's FlowrXFile, tagged with its FileRole.

`Abstract` `Readonly`name

name: string

A unique, human-readable name of the plugin.

`Protected` `Readonly`pattern

pattern: RegExp

`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 FlowrAnalyzerPatternFilePlugin.defaultPlugin
- Defined in src/project/plugins/file-plugins/flowr-analyzer-file-plugin.ts:30

applies

applies(file: PathLike): boolean
Determine whether this plugin applies to the given file.
Parameters
- file: PathLike
Returns boolean
Inherited from FlowrAnalyzerPatternFilePlugin.applies
- Defined in src/project/plugins/file-plugins/flowr-analyzer-file-plugin.ts:81

process

process(_ctx: FlowrAnalyzerContext, file: FlowrFileProvider): F
Parameters
- _ctx: FlowrAnalyzerContext
- file: FlowrFileProvider
Returns F
Overrides FlowrAnalyzerPatternFilePlugin.process
- Defined in src/project/plugins/file-plugins/flowr-analyzer-rd-file-plugin.ts:37

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 FlowrAnalyzerPatternFilePlugin.processor
- Defined in src/project/plugins/flowr-analyzer-plugin.ts:110

Class FlowrAnalyzerRdFileBasePlugin<F>`Abstract`

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns FlowrAnalyzerRdFileBasePlugin<F>

Properties

`Abstract` `Readonly`description

`Protected` `Abstract` `Readonly`lift

`Abstract` `Readonly`name

`Protected` `Readonly`pattern

`Readonly`type

`Readonly`version

Methods

`Static`defaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

process

Parameters

Returns F

processor

Parameters

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

Settings

On This Page

Class FlowrAnalyzerRdFileBasePlugin<F>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns FlowrAnalyzerRdFileBasePlugin<F>

Properties

Abstract Readonlydescription

Protected Abstract Readonlylift

Abstract Readonlyname

Protected Readonlypattern

Readonlytype

Readonlyversion

Methods

StaticdefaultPlugin

Returns FlowrAnalyzerFilePlugin

applies

Parameters

Returns boolean

process

Parameters

Returns F

processor

Parameters

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

Settings

On This Page

Class FlowrAnalyzerRdFileBasePlugin<F>`Abstract`

`Abstract` `Readonly`description

`Protected` `Abstract` `Readonly`lift

`Abstract` `Readonly`name

`Protected` `Readonly`pattern

`Readonly`type

`Readonly`version

`Static`defaultPlugin

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